Zephyr Module

Zephyr Modules

Extend the Zephyr RTOS with reusable, out-of-tree modules that integrate seamlessly with the build system.

Core Workflows

1. Defining a Module

Create the directory structure and metadata required for auto-discovery.

• Reference: [moduledefinition.md](references/moduledefinition.md)
• Key Tools: zephyr/module.yml, zephyr/Kconfig, zephyr/CMakeLists.txt.

2. West Manifest Integration

Adding your module to a workspace for distribution and versioning.

• Reference: [westintegration.md](references/westintegration.md)
• Key Tools: west.yml, west update, west build -t list_modules.

3. Library Wrapping (Glue Code)

Wrapping external C/C++ libraries as Zephyr modules.

• Reference: [moduledefinition.md](references/moduledefinition.md#the-glue-pattern)
• Key Tools: zephyr_library(), zephyr_include_directories().

Quick Start (module.yml)

build:
  cmake: .
  kconfig: zephyr/Kconfig

Validation Checklist

• [ ] west update fetches module source from manifest without conflicts.
• [ ] west build -t list_modules shows the module as discovered.
• [ ] Module Kconfig options appear and can be enabled in build configuration.
• [ ] Module sources are compiled and linked into the target application as expected.

Automation Tools

• [modulemanifestcheck.py](scripts/modulemanifestcheck.py): Validate required build.cmake and build.kconfig fields in module.yml.

Examples & Templates

• [moduleymltemplate.yml](assets/moduleymltemplate.yml): Starter module manifest for out-of-tree integration.

Resources

• [References](references/):
• module_definition.md: Structure and module.yml specification.
• west_integration.md: Manifest configuration and discovery tools.
• [Scripts](scripts/):
• module_manifest_check.py: Module manifest consistency checker.
• [Assets](assets/):
• module_yml_template.yml: Minimal zephyr/module.yml template.

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: beriberikix
• Source: beriberikix/zephyr-agent-skills
• License: Apache-2.0

Install and usage instructions live in the source repository linked above.