Provides preliminary content for an example manifest+module repository. The zephyr repository is independent of this repository.

This commit includes some the infrastructure files necessary for:

• Managing a new, indepedent repository, with overview documentation
• Example manifest file
• structure for an example module
• Richly connected trivial functionality to verify module extensions for
  • include directory
  • subsystems
  • tests
  • samples
  • projects (non-sample, non-test)

Beneath the zephyr folder containing the required module.yml, this repository parallels the Zephyr repository top-level code structure to set and follow user expectations. Files required for repository management (e.g. ownership tracking, CI configuration) are left at the root of the repository.

This commit assumes the range of examples will grow to cover all module.yml capabilities and include tool and process support to fully verify the example code. Since zephyr is independent of this repository, it is also assumed that this repository will eventually have its own versioning, releases, and release notes.

Fixes #28438

Signed-off-by: Gregory Shue [email protected]

This is an attempt to provide a Zephyr example application that, based on my experience, covers what is commonly used in "real world applications":

• Basic application skeleton
• Custom boards
• Custom devicetree bindings
• Out-of-tree drivers
• CI configuration (using Github Actions)

I have tried to focus on simplicity, but it may be simplified further or even extended to cover other areas (e.g. testing).

Closes https://github.com/zephyrproject-rtos/zephyr/issues/28438

• readme: remove doc from list of features Documentation is not (yet) provided.
• drivers: sensor: examplesensor: use GPIO_DT_SPEC_INST_GET Instance version of the GPIO_DT_SPEC_GET was recently introduced.
• ci: run on pull_request Run CI on push and pull_request.

Add a working example for how to implement a west command within the user's manifest repository. There is documentation for this, but we should have some working code in here just to make life easier for people.

Signed-off-by: Martí Bolívar [email protected]

drivers: sensor: examplesensor: use gpio_pin_get_dt

Use the recently introduced GPIO API that allows obtaining pin state
using the gpio_dt_spec struct.

app: delete foo sample code

The initial idea behind this code was to showcase documentation. It does
not add any special value to the sample, so remove it. A proper library
can be added in the future.

This commit includes tests and samples discoverable and runnable by twister -T example-application, and documentation content that is valid and included in Zephyr document generation when copied into the Zephyr tree.

During this development I discovered the following:

• the Zephyr document generation process FAILS when run with this module is included in the path <<<<<
• twister does not automatically follow the list of modules to find tests.

Link to the relevant sections in the Zephyr documentation, including application development and west topologies.

Signed-off-by: Carles Cufi [email protected]

-s/--source is a legacy option. There's a proposal to actually use it for something else in Zephyr now:

https://github.com/zephyrproject-rtos/zephyr/pull/40669

Let's update README.

Zephyr includes are now prefixed with <zephyr/...>. While the old path can still be used when CONFIG_LEGACY_INCLUDE_PATH=y, it's better to be prepared for the future.

Fixes: #39270

The latest zephyrprojectrtos/ci no longer sets ZEPHYR_SDK_INSTALL_DIR in the environment and doesn't register the Zephyr-SDK as a CMake package in the CMake package registry.

To ensure the the Zephyr SDK can be correctly discovered by find_package(Zephyr-sdk) we add /opt/toolchains to the CMAKE_PREFIX_PATH environment variable which is a list containing additional search prefixes for the find_package() function.

Signed-off-by: Torsten Rasmussen [email protected]

Pin to Zephyr v2.6.0 for the v2.6.0 release of the example-application. The current v2.6.0 tag should be deleted and re-created pointing to this commit once merged. Manifest has to be updated to point to main afterwards.

Follow the Zephyr recommendation to explicitly set the module name in module.yml. Add a build check in the module-level CMakeLists.txt to verify the value of the build variable ${module_name} is the expected value so that other modules may reference this one without needing to know the path to this module.

Verified by:

1. Successfully building west build -p always -b custom_plank example-application/app with the name check and the defaulted name.
2. Unsuccessfully buildng west build -p always -b custom_plank example-application/app with the name check and an unexpected name set in module.yml
3. Unsuccessfully buildng west build -p always -b custom_plank example-application/app with the name check and the expected name set in module.yml

Fix #50866

Signed-off-by: Gregory SHUE [email protected]