|
1 | 1 | # c2usb Zephyr sample applications |
2 | 2 |
|
3 | | -This repository contains c2usb Zephyr sample applications. |
4 | | - |
5 | | -## Initialization |
6 | | - |
7 | | -The first step is to initialize the workspace folder (``c2usb-workspace``) where |
8 | | -this repository and all Zephyr modules will be cloned. Run the following |
9 | | -command: |
10 | | - |
11 | | -```shell |
12 | | -# initialize my-workspace for the usb-keyboard (main branch) |
13 | | -west init -m https://github.com/IntergatedCircuits/c2usb-zephyr-examples c2usb-workspace |
14 | | -# update Zephyr modules |
15 | | -cd c2usb-workspace |
16 | | -west update && west patch |
17 | | -``` |
18 | | - |
19 | | -## Building and running |
20 | | - |
21 | | -To build an application, run the following command: |
22 | | -```shell |
23 | | -cd c2usb-zephyr-examples |
24 | | -west build -b nrf52840dk/nrf52840 --build-dir usb-keyboard/build usb-keyboard |
25 | | -``` |
26 | | - |
27 | | -Once you have built the application, run the following command to flash it: |
28 | | - |
29 | | -```shell |
30 | | -west flash --build-dir usb-keyboard/build |
31 | | -``` |
32 | | - |
33 | | -## Software Development |
34 | | - |
35 | | -MS Visual Studio Code is the recommended IDE for development. |
36 | | -Open the `projects.code-workspace` file in vscode, and install the recommended extensions |
37 | | -(better create a dedicated zephyr profile). |
38 | | -Use `west vscode --build-dir usb-keyboard/build` to generate vscode C/C++ indexer configuration. |
39 | | -`--build` and `--debug` additional arguments create build tasks and debug launch configurations, |
40 | | -from a successful build. |
41 | | - |
42 | | -## Application Index |
43 | | - |
44 | | -### ble-keyboard |
45 | | - |
46 | | -A straightforward BLE HID keyboard. UART shell access is needed to complete BLE pairing: |
47 | | -`bt passkey XXXXXX` |
48 | | -Use the button on the board to trigger a caps lock press, |
49 | | -and observe as the host changes the caps lock state on the board's LED. |
50 | | - |
51 | | -### usb-keyboard |
52 | | - |
53 | | -A straightforward USB HID keyboard. Use the button on the board to trigger a caps lock press, |
54 | | -and observe as the host changes the caps lock state on the board's LED. |
55 | | - |
56 | | -### usb-mouse |
57 | | - |
58 | | -A USB HID mouse, with high-resolution scrolling support. |
59 | | -The LED lights up if the host enables this feature. |
60 | | -The board's buttons 1 and 2 either scroll up and down, or move the pointer left and right, |
61 | | -depending on the state of button 4. Button 3 controls the left mouse button. |
62 | | - |
63 | | -### usb-shell |
64 | | - |
65 | | -Demonstrating USB serial port functionality with shell access to the zephyr OS. |
| 3 | +This repository is deprecated, as now the c2usb project contains zephyr sample applications in-tree. |
| 4 | +All relevant content is moved to github.com/IntergatedCircuits/c2usb |
0 commit comments