README.md
Zephyr Example Application

Jesses Notes

To init:

(Execute from the root of the repository)

cd zephyrcontainer/zephyrproject && west init -l . && west update 
source ../zephyr/zephyr-env.sh && python3 -m venv .venv && source .venv/bin/activate && pip3 install -r ../zephyr/scripts/requirements.txt 


To build:

source ../zephyr/zephyr-env.sh && source .venv/bin/activate && west build -b esp32devkitcwroom app


To flash:

source ../zephyr/zephyr-env.sh && source .venv/bin/activate && west flash


This repository contains a Zephyr example application. The main purpose of this
repository is to serve as a reference on how to structure Zephyr-based
applications. Some of the features demonstrated in this example are:


Basic <![CDATA[]]>Zephyr application<![CDATA[]]> skeleton
<![CDATA[]]>Zephyr workspace applications<![CDATA[]]>
<![CDATA[]]>Zephyr modules<![CDATA[]]>
<![CDATA[]]>West T2 topology<![CDATA[]]>
<![CDATA[]]>Custom boards<![CDATA[]]>
Custom <![CDATA[]]>devicetree bindings<![CDATA[]]>
Out-of-tree <![CDATA[]]>drivers<![CDATA[]]>
Out-of-tree libraries
Example CI configuration (using Github Actions)
Custom <![CDATA[]]>west extension<![CDATA[]]>


This repository is versioned together with the <![CDATA[]]>Zephyr main tree<![CDATA[]]>. This
means that every time that Zephyr is tagged, this repository is tagged as well
with the same version number, and the manifest entry for zephyr
will point to the corresponding Zephyr tag. For example, the example-application
v2.6.0 will point to Zephyr v2.6.0. Note that the main branch always
points to the development branch of Zephyr, also main.

Getting Started

Before getting started, make sure you have a proper Zephyr development
environment. Follow the official
<![CDATA[]]>Zephyr Getting Started Guide<![CDATA[]]>.

Initialization

The first step is to initialize the workspace folder (my-workspace) where
the example-application and all Zephyr modules will be cloned. Run the following
command:

# initialize my-workspace for the example-application (main branch)
west init -m https://github.com/zephyrproject-rtos/example-application --mr main my-workspace


update Zephyr modules

cd my-workspace
west update


Building and running

To build the application, run the following command:

west build -b $BOARD app


where $BOARD is the target board.

You can use the custom_plank board found in this
repository. Note that Zephyr sample boards may be used if an
appropriate overlay is provided (see app/boards).

A sample debug configuration is also provided. To apply it, run the following
command:

west build -b $BOARD app -- -DOVERLAY_CONFIG=debug.conf


Once you have built the application, run the following command to flash it:

west flash