Zephyr Mongoose Module Example Application

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 Zephyr application skeleton
• Zephyr workspace applications
• Zephyr modules
• West T2 topology
• Custom boards
• Custom devicetree bindings
• Out-of-tree drivers
• Out-of-tree libraries
• Example CI configuration (using Github Actions)
• Custom west extension

This repository is versioned together with the Zephyr main tree. 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 Zephyr Getting Started Guide.

Initialization

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

# initialize mongoose-workspace for the example-application (main branch)
west init -m git@github.com:Sparse-Technology/mongoose-example-application.git --mr main mongoose-workspace
# update Zephyr modules
cd mongoose-workspace
west update

Building and running

Tested with stm32h747i_disco/stm32h747xx/m7. To build the application, run the following command:

cd example-application
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

Testing

open your browser or run following curl command:

curl http://10.5.194.51:8000/api/#

console output:

ID PROTO TYPE      LOCAL           REMOTE
6    TCP ACCEPTED  0.0.0.0 10.5.190.235
4    UDP CONNECTED 0.0.0.0 8.8.8.8
3    UDP CONNECTED 0.0.0.0 216.239.35.8
2    TCP LISTENING 0.0.0.0 0.0.0.0
1    TCP LISTENING 0.0.0.0 0.0.0.0