zephyr-module

Creating and integrating out-of-tree Zephyr modules. Covers module.yml configuration, Kconfig and CMake integration within a module, and West manifest inclusion. Trigger when developing reusable libra

SKILL.md

GitHub

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: module_definition.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.

3. Library Wrapping (Glue Code)

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

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

Examples & Templates

Resources

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