Reference project name
Documentation / Build (1.14.0) (push) Failing after 15s
Documentation / Build (1.9.6) (push) Successful in 13s
Documentation / Deploy (push) Has been skipped
Build / Build app and tests (macos-14) (push) Has been cancelled
Build / Build app and tests (windows-2022) (push) Has been cancelled
Build / Build app and tests (ubuntu-22.04) (push) Failing after 1m43s

This commit is contained in:
2026-04-21 21:31:47 -07:00
parent b69d3363f1
commit f07adc33f6
9 changed files with 24 additions and 59 deletions
+4 -4
View File
@@ -21,7 +21,7 @@ jobs:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v4
with: with:
path: example-application path: LR-EnviroStation
persist-credentials: false persist-credentials: false
- name: Set up Python - name: Set up Python
@@ -32,12 +32,12 @@ jobs:
- name: Setup Zephyr project - name: Setup Zephyr project
uses: zephyrproject-rtos/action-zephyr-setup@v1 uses: zephyrproject-rtos/action-zephyr-setup@v1
with: with:
app-path: example-application app-path: LR-EnviroStation
toolchains: arm-zephyr-eabi toolchains: arm-zephyr-eabi
ccache-cache-key: ${{ matrix.os }} ccache-cache-key: ${{ matrix.os }}
- name: Build firmware - name: Build firmware
working-directory: example-application working-directory: LR-EnviroStation
shell: bash shell: bash
run: | run: |
if [ "${{ runner.os }}" = "Windows" ]; then if [ "${{ runner.os }}" = "Windows" ]; then
@@ -46,7 +46,7 @@ jobs:
west twister -T app -v --inline-logs --integration $EXTRA_TWISTER_FLAGS west twister -T app -v --inline-logs --integration $EXTRA_TWISTER_FLAGS
- name: Twister Tests - name: Twister Tests
working-directory: example-application working-directory: LR-EnviroStation
shell: bash shell: bash
run: | run: |
if [ "${{ runner.os }}" = "Windows" ]; then if [ "${{ runner.os }}" = "Windows" ]; then
+9 -44
View File
@@ -1,10 +1,10 @@
# Zephyr Example Application # LR-EnviroStation
<a href="https://github.com/zephyrproject-rtos/example-application/actions/workflows/build.yml?query=branch%3Amain"> <a href="https://git.dungeon.rip/Universe_Prison/LR-EnviroStation/actions/workflows/build.yml?query=branch%3Amain">
<img src="https://github.com/zephyrproject-rtos/example-application/actions/workflows/build.yml/badge.svg?event=push"> <img src="https://git.dungeon.rip/Universe_Prison/LR-EnviroStation/actions/workflows/build.yml/badge.svg?event=push">
</a> </a>
<a href="https://github.com/zephyrproject-rtos/example-application/actions/workflows/docs.yml?query=branch%3Amain"> <a href="https://git.dungeon.rip/Universe_Prison/LR-EnviroStation/actions/workflows/docs.yml?query=branch%3Amain">
<img src="https://github.com/zephyrproject-rtos/example-application/actions/workflows/docs.yml/badge.svg?event=push"> <img src="https://git.dungeon.rip/Universe_Prison/LR-EnviroStation/actions/workflows/docs.yml/badge.svg?event=push">
</a> </a>
<a href="https://zephyrproject-rtos.github.io/example-application"> <a href="https://zephyrproject-rtos.github.io/example-application">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-3D578C?logo=sphinx&logoColor=white"> <img alt="Documentation" src="https://img.shields.io/badge/documentation-3D578C?logo=sphinx&logoColor=white">
@@ -13,41 +13,6 @@
<img alt="API Documentation" src="https://img.shields.io/badge/API-documentation-3D578C?logo=c&logoColor=white"> <img alt="API Documentation" src="https://img.shields.io/badge/API-documentation-3D578C?logo=c&logoColor=white">
</a> </a>
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][app_dev] skeleton
- [Zephyr workspace applications][workspace_app]
- [Zephyr modules][modules]
- [West T2 topology][west_t2]
- [Custom boards][board_porting]
- Custom [devicetree bindings][bindings]
- Out-of-tree [drivers][drivers]
- Out-of-tree libraries
- Example CI configuration (using GitHub Actions)
- Custom [west extension][west_ext]
- Custom [Zephyr runner][runner_ext]
- Doxygen and Sphinx documentation boilerplate
This repository is versioned together with the [Zephyr main tree][zephyr]. This
means that every time that Zephyr is tagged, this repository is tagged as well
with the same version number, and the [manifest](west.yml) 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`.
[app_dev]: https://docs.zephyrproject.org/latest/develop/application/index.html
[workspace_app]: https://docs.zephyrproject.org/latest/develop/application/index.html#zephyr-workspace-app
[modules]: https://docs.zephyrproject.org/latest/develop/modules.html
[west_t2]: https://docs.zephyrproject.org/latest/develop/west/workspaces.html#west-t2
[board_porting]: https://docs.zephyrproject.org/latest/guides/porting/board_porting.html
[bindings]: https://docs.zephyrproject.org/latest/guides/dts/bindings.html
[drivers]: https://docs.zephyrproject.org/latest/reference/drivers/index.html
[zephyr]: https://github.com/zephyrproject-rtos/zephyr
[west_ext]: https://docs.zephyrproject.org/latest/develop/west/extensions.html
[runner_ext]: https://docs.zephyrproject.org/latest/develop/modules.html#external-runners
## Getting Started ## Getting Started
Before getting started, make sure you have a proper Zephyr development Before getting started, make sure you have a proper Zephyr development
@@ -57,12 +22,12 @@ environment. Follow the official
### Initialization ### Initialization
The first step is to initialize the workspace folder (``my-workspace``) where 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 the ``LR-EnviroStation`` and all Zephyr modules will be cloned. Run the following
command: command:
```shell ```shell
# initialize my-workspace for the example-application (main branch) # initialize my-workspace for the LR-EnviroStation (main branch)
west init -m https://github.com/zephyrproject-rtos/example-application --mr main my-workspace west init -m https://git.dungeon.rip/Universe_Prison/LR-EnviroStation --mr main my-workspace
# update Zephyr modules # update Zephyr modules
cd my-workspace cd my-workspace
west update west update
@@ -73,7 +38,7 @@ west update
To build the application, run the following command: To build the application, run the following command:
```shell ```shell
cd example-application cd LR-EnviroStation
west build -b $BOARD app west build -b $BOARD app
``` ```
+2 -2
View File
@@ -2,8 +2,8 @@
# the Zephyr testing tool. In this file, multiple combinations can be specified, # the Zephyr testing tool. In this file, multiple combinations can be specified,
# so that you can easily test all of them locally or in CI. # so that you can easily test all of them locally or in CI.
sample: sample:
description: Example application description: LR-EnviroStation
name: example-application name: LR-EnviroStation
common: common:
build_only: true build_only: true
integration_platforms: integration_platforms:
+1 -1
View File
@@ -2,5 +2,5 @@
`custom_plank` board is used to demonstrate how to create custom boards. It is `custom_plank` board is used to demonstrate how to create custom boards. It is
in fact a simplified version of the nRF52840-DK board, so the in fact a simplified version of the nRF52840-DK board, so the
`example-application` can be run on that development kit when using `LR-EnviroStation` can be run on that development kit when using
`custom_plank`. `custom_plank`.
+2 -2
View File
@@ -42,7 +42,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places. # title of most generated pages and in a few other places.
# The default value is: My Project. # The default value is: My Project.
PROJECT_NAME = "Example Application" PROJECT_NAME = "LR-EnviroStation"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
@@ -54,7 +54,7 @@ PROJECT_NUMBER = 1.0.0
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short. # quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = A Zephyr-based example application PROJECT_BRIEF = LR-EnviroStation
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55 # in the documentation. The maximum height of the logo should not exceed 55
+2 -2
View File
@@ -1,5 +1,5 @@
# Introduction # Introduction
This is the Doxygen documentation for [example-application]. This is the Doxygen documentation for [LR-EnviroStation].
[example-application]: https://github.com/zephyrproject-rtos/example-application [LR-EnviroStation]: https://git.dungeon.rip/Universe_Prison/LR-EnviroStation
+1 -1
View File
@@ -6,7 +6,7 @@
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'Example Application' project = 'LR-EnviroStation'
copyright = '2024, The Zephyr Community' copyright = '2024, The Zephyr Community'
author = 'The Zephyr Community' author = 'The Zephyr Community'
release = '1.0.0' release = '1.0.0'
+2 -2
View File
@@ -1,7 +1,7 @@
Welcome to Example Application's documentation! Welcome to LR-EnviroStation's documentation!
=============================================== ===============================================
This is a simple Sphinx documentation setup for ``example-application``. This is a simple Sphinx documentation setup for ``LR-EnviroStation``.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
+1 -1
View File
@@ -3,7 +3,7 @@
build: build:
# Path to the Kconfig file that will be sourced into Zephyr Kconfig tree under # Path to the Kconfig file that will be sourced into Zephyr Kconfig tree under
# Zephyr > Modules > example-application. Path is relative from root of this # Zephyr > Modules > LR-EnviroStation. Path is relative from root of this
# repository. # repository.
kconfig: Kconfig kconfig: Kconfig
# Path to the folder that contains the CMakeLists.txt file to be included by # Path to the folder that contains the CMakeLists.txt file to be included by