Zephyr Project - West Overview
- 1. Building with Zephyr? West overview Marti Bolivar, Nordic Semiconductor
- 2. Outline: Presenter: Marti Bolivar - Zephyr and west developer - What we’re doing today: - Overview of what’s available in west - Good starting points for experimenting and getting help - Helpful if you’ve already gone through the Zephyr Getting Started Guide for v2.3.0, but not required: https://docs.zephyrproject.org/2.3.0/getting_started/index.html
- 3. What is west? Zephyr’s “meta-tool” or “swiss army knife,” used for many common development workflows. An extensible command line tool for managing a Zephyr workspace: https://docs.zephyrproject.org/2.3.0/guides/west/index.html Recommended but not required: https://docs.zephyrproject.org/2.3.0/guides/west/without-west.html Developed in its own git repository: https://github.com/zephyrproject-rtos/west
- 4. West “proper” vs. Zephyr uses West “proper” ● Workspace commands (init, update, etc.) ● Configuration command (config) ● APIs for adding extension commands (external plug- ins) Zephyr’s west usage and extensions ● Zephyr module integration ● Extension commands (build, flash, debug, etc.) In the zephyr repositoryIn the west repository
- 5. Creating a workspace: west init ● zephyrproject: the west workspace’s top level directory, or topdir. The .west directory marks the topdir. ● zephyr: the manifest repository (in this example) ● .west/config: the workspace local configuration file; tells west that “zephyr” is the manifest repository ● west.yml: the manifest file; says what other git repositories should be pulled in via west update Vocabulary $ west init -m https://github.com/zephyrproject-rtos/zephyr --mr v2.3.0 zephyrproject Results (simplified) zephyrproject ├── .west │ └── config └── zephyr └── west.yml
- 6. Manifest file, west.yml Simplified contents of zephyr/west.yml in v2.3.0. • remotes: where projects can be fetched • projects: a list of git repositories in the workspace • self: configures the manifest repository (zephyr) itself
- 7. Manifest file semantics zephyrproject-rtos/zephyr west.yml manifest: projects: - ... - … - ... zephyrproject-rtos/<project> zephyrproject-rtos/<project> zephyrproject-rtos/<project> Every element of the projects list is another Git repository that is included in the upstream Zephyr project distribution.
- 8. Updating a workspace: west update ● Modules: third-party code with Zephyr integration, can be integrated into Zephyr applications, device drivers, etc. ● Includes things like file systems, vendor HALs, etc. ● A small number west projects live outside the modules directory. Currently just the mcuboot bootloader and some additional developer tools repositories Vocabulary $ west update # run inside the “zephyrproject” workspace Results (simplified) zephyrproject ├── bootloader │ └── mcuboot ├── modules │ └── fs │ └── fatfs ├── .west │ └── config └── zephyr └── west.yml
- 9. Other workspace commands Some additional workspace management commands: list print information about projects in the west manifest manifest slice and dice the west manifest diff "git diff" for one or more projects status "git status" for one or more projects forall run a command in one or more local projects For a complete list of commands, including extensions, run: $ west help
- 10. Zephyr extension commands Some additional Zephyr development extension commands: build compile zephyr applications flash flash a compiled application to a board debug flash an application and enter a debugger (usually GDB) debugserver flash an application and start a debug server attach attach a debugger to a board without flashing
- 11. Most common extension issue If you see this when running an extension like west build: west: error: argument <command>: invalid choice: 'build' (...) Then you’re not in your workspace, so the extension can’t be found. See this item on the troubleshooting page: https://docs.zephyrproject.org/2.3.0/guides/west/troubleshooting.html#invalid -choice-build-or-flash-etc
- 12. West configuration files ● “INI-like” (Python configparser syntax) ● We saw .west/config earlier; that’s the workspace configuration file ● You can also set user- and system-wide configuration values ● Run west config to manage your configuration ● See also: https://docs.zephyrproject.org/2.3.0/guides/west/config.html
- 13. Help and troubleshooting Documentation: West page in the Zephyr guides and Troubleshooting west. Also: $ west help List all commands and one line help for each (including extensions). $ west <command> help Help for a specific <command>, like west help init $ west -v <command> Enable verbose output for <command>, like west -v init