1
1
# Zephyr Example Application
2
2
3
3
This repository contains a Zephyr example application. The main purpose of this
4
- repository is to serve as a reference on how to structure Zephyr based
4
+ repository is to serve as a reference on how to structure Zephyr- based
5
5
applications. Some of the features demonstrated in this example are:
6
6
7
7
- Basic [ Zephyr application] [ app_dev ] skeleton
@@ -17,9 +17,9 @@ applications. Some of the features demonstrated in this example are:
17
17
This repository is versioned together with the [ Zephyr main tree] [ zephyr ] . This
18
18
means that every time that Zephyr is tagged, this repository is tagged as well
19
19
with the same version number, and the [ manifest] ( west.yml ) entry for ` zephyr `
20
- will point to the corresponding Zephyr tag. For example, ` example-application `
21
- v2.6.0 will point to Zephyr v2.6.0. Note that the ` main ` branch will always
22
- point to the development branch of Zephyr, also ` main ` .
20
+ will point to the corresponding Zephyr tag. For example, the ` example-application `
21
+ v2.6.0 will point to Zephyr v2.6.0. Note that the ` main ` branch always
22
+ points to the development branch of Zephyr, also ` main ` .
23
23
24
24
[ app_dev ] : https://docs.zephyrproject.org/latest/develop/application/index.html
25
25
[ workspace_app ] : https://docs.zephyrproject.org/latest/develop/application/index.html#zephyr-workspace-app
@@ -33,14 +33,14 @@ point to the development branch of Zephyr, also `main`.
33
33
## Getting Started
34
34
35
35
Before getting started, make sure you have a proper Zephyr development
36
- environment. You can follow the official
36
+ environment. Follow the official
37
37
[ Zephyr Getting Started Guide] ( https://docs.zephyrproject.org/latest/getting_started/index.html ) .
38
38
39
39
### Initialization
40
40
41
41
The first step is to initialize the workspace folder (`` my-workspace `` ) where
42
- the `` example-application `` and all Zephyr modules will be cloned. You can do
43
- that by running :
42
+ the `` example-application `` and all Zephyr modules will be cloned. Run the following
43
+ command :
44
44
45
45
``` shell
46
46
# initialize my-workspace for the example-application (main branch)
@@ -50,26 +50,29 @@ cd my-workspace
50
50
west update
51
51
```
52
52
53
- ### Build & Run
53
+ ### Building and running
54
54
55
- The application can be built by running :
55
+ To build the application, run the following command :
56
56
57
57
``` shell
58
58
west build -b $BOARD app
59
59
```
60
60
61
- where ` $BOARD ` is the target board. The ` custom_plank ` board found in this
62
- repository can be used. Note that Zephyr sample boards may be used if an
61
+ where ` $BOARD ` is the target board.
62
+
63
+ You can use the ` custom_plank ` board found in this
64
+ repository. Note that Zephyr sample boards may be used if an
63
65
appropriate overlay is provided (see ` app/boards ` ).
64
66
65
- A sample debug configuration is also provided. You can apply it by running:
67
+ A sample debug configuration is also provided. To apply it, run the following
68
+ command:
66
69
67
70
``` shell
68
71
west build -b $BOARD app -- -DOVERLAY_CONFIG=debug.conf
69
72
```
70
73
71
- Note that you may also use it together with ` rtt.conf ` if using Segger RTT. Once
72
- you have built the application you can flash it by running :
74
+ You can also use it together with the ` rtt.conf ` file if using Segger RTT. Once
75
+ you have built the application, run the following command to flash it :
73
76
74
77
``` shell
75
78
west flash
0 commit comments