• Stars
    star
    229
  • Rank 174,666 (Top 4 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created over 6 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

West, Zephyr's meta-tool

This is the Zephyr RTOS meta tool, west.

https://docs.zephyrproject.org/latest/guides/west/index.html

Installation

Using pip:

pip3 install west

(Use pip3 uninstall west to uninstall it.)

Basic Usage

West lets you manage multiple Git repositories under a single directory using a single file, called the west manifest file, or manifest for short. By default the manifest file is named west.yml. You use west init to set up this directory, then west update to fetch and/or update the repositories named in the manifest.

By default, west uses upstream Zephyr's manifest file, but west doesn't care if the manifest repository is zephyr or not. You can and are encouraged to make your own manifest repositories to meet your needs.

For more details, see the West guide in the Zephyr documentation.

Example usage using the upstream manifest file:

mkdir zephyrproject && cd zephyrproject
west init
west update

What just happened:

  • west init clones the upstream west manifest repository, which in this case is the zephyr repository. The manifest repository contains west.yml, a YAML description of the Zephyr installation, including Git repositories and other metadata.
  • west update clones the other repositories named in the manifest file, creating working trees in the installation directory zephyrproject.

Use west init -m to specify another manifest repository. Use --mr to use a revision to inialize from; if not given, the remote's default branch is used. Use --mf to use a manifest file other than west.yml.

Additional Commands

West has multiple sub-commands. After running west init, you can run them from anywhere under zephyrproject.

For a list of available commands, run west -h. Get help on a command with west <command> -h.

West is extensible: you can add new commands to west without modifying its source code. See Extensions in the documentation for details.

Running the Tests

First, install tox:

# macOS, Windows
pip3 install tox

# Linux
pip3 install --user tox

Then, run the test suite locally from the top level directory:

tox

See the tox configuration file, tox.ini, for more details.

Hacking on West

This section contains notes for getting started developing west itself.

Editable Install

To run west "live" from the current source code tree, run this command from the top level directory in the west repository:

pip3 install -e .

This is useful if you are actively working on west and don't want to re-package and install a wheel each time you run it.

Installing from Source

You can create and install a wheel package to install west as well. The wheel Python package is required to do this. See "Installing Wheel" below if you need to do this.

To build the west wheel file:

# macOS, Linux
python3 setup.py bdist_wheel

# Windows
py -3 setup.py bdist_wheel

This will create a file named dist/west-x.y.z-py3-none-any.whl, where x.y.z is the current version in setup.py.

To install the wheel:

pip3 install -U dist/west-x.y.z-py3-none-any.whl

You can pip3 uninstall west to remove this wheel before re-installing the version from PyPI, etc.

Installing Wheel

On macOS and Windows, you can install wheel with:

pip3 install wheel

That also works on Linux, but you may want to install wheel from your system package manager instead -- e.g. if you installed pip from your system package manager. The wheel package is likely named something like python3-wheel in that case.

More Repositories

1

zephyr

Primary Git Repository for the Zephyr Project. Zephyr is a new generation, scalable, optimized, secure RTOS for multiple hardware architectures.
C
10,781
star
2

example-application

Example out-of-tree application that is also a module
C
216
star
3

sdk-ng

Zephyr SDK (Toolchains, Development Tools)
C
181
star
4

windows-curses

Windows Curses Python module
C
162
star
5

docker-image

Docker image suitable for Zephyr development and CI
Shell
141
star
6

zscilib

An open-source scientific computing library for embedded systems running Zephyr OS or standalone.
C
136
star
7

hal_stm32

C
96
star
8

lvgl

C
64
star
9

liblc3codec

LC3 codec implementation
C++
60
star
10

hal_espressif

HAL and SDK for ESP32 and other hardware from Espressif
C
46
star
11

meta-zephyr-sdk

Zephyr SDK (obsolete)
C
45
star
12

gsoc-2022-arduino-core

Arduino Core Zephyr Module (GSoC 2022 Project)
C++
44
star
13

net-tools

Network tools for testing with Qemu
C
34
star
14

hal_nxp

HAL module for NXP SoCs
C
34
star
15

openthread

openthread module for Zephyr, not a mirror of the official openthread repository
C++
28
star
16

hal_nordic

C
28
star
17

mcumgr

Upstream repo is https://github.com/apache/mynewt-mcumgr
C
27
star
18

openocd

OpenOCD with Zephyr patches for building Zephyr SDK
C
27
star
19

trusted-firmware-m

Zephyr repository tracking https://git.trustedfirmware.org/trusted-firmware-m.git/
C
27
star
20

rtos-benchmark

RTOS Benchmark
C
27
star
21

jlink-zephyr

J-Link Zephyr RTOS plugin
C
26
star
22

mbedtls

mbedtls module for Zephyr, this is not a mirror of the official mbedtls repository.
C
20
star
23

loramac-node

Zephyr repository tracking https://github.com/Lora-net/LoRaMac-node
C
20
star
24

eclipse-plugin

Zephyr Eclipse Plugin
Java
15
star
25

littlefs

littlefs module for Zephyr, not a mirror of the official littlefs repository
C
15
star
26

python-devicetree

Python devicetree library
Python
15
star
27

zephyr-testing

Test Repo, Do not clone! Use zephyr repo instead
C
13
star
28

hal_st

C
12
star
29

zephyr-lang-rust

Support for Zephyr applications written in Rust
Rust
12
star
30

hal_atmel

C
11
star
31

fatfs

This implementation of file system is developed by ELM Chan
C
11
star
32

canopennode

Zephyr repository tracking https://github.com/CANopenNode/CANopenNode
C
10
star
33

action-zephyr-setup

GitHub Action to set up Zephyr build environment
10
star
34

twister

[DEPRICATED] Project won't be continued.
Python
10
star
35

hal_infineon

HAL for Infineon ICs
C
10
star
36

cmsis

Zephyr repository tracking https://github.com/ARM-software/CMSIS_5
C
10
star
37

gsoc-2022-thrift

Thrift Zephyr Module (GSoC 2022 Project)
C++
10
star
38

reqmgmt

Python
9
star
39

hal_ti

C
9
star
40

libmetal

The libmetal module specific for use with Zephyr. This is not a mirror of the official libmetal repo.
C
9
star
41

ci-tools

CI Tools and Scripts (obsolete)
Python
9
star
42

open-amp

open-amp module for zephyr, this is not an official mirror of the open-amp repo
C
9
star
43

hal_silabs

C
8
star
44

chre

Context Hub Runtime Environment (CHRE)
C++
8
star
45

infrastructure-old

Zephyr Infrastructure Issue Tracker (obsolete)
8
star
46

segger

C
7
star
47

action-manifest

Python
7
star
48

qm

Quality Management and QA/Verification plans and reports
Perl
7
star
49

hal_microchip

HAL module for Microchip devices
C
6
star
50

test_results

Consolidated test results
Python
6
star
51

hal_gigadevice

HAL for GigaDevice devices
C
6
star
52

ci-dockerfiles

The content of this repository has moved to https://github.com/zephyrproject-rtos/docker-image
6
star
53

oss-eu-2022-zephyr-app

Application for the OSS EU 2022 Zephyr Mini-Summit
C
6
star
54

mipi-sys-t

C
6
star
55

hal_xtensa

Zephyr repository tracking https://github.com/foss-xtensa/xtensa-hal
C
4
star
56

nffs

C
4
star
57

Kconfiglib

Canonical upstream for https://pypi.org/project/kconfiglib/ (replaces inactive https://github.com/ulfalizer/Kconfiglib)
Python
3
star
58

uoscore-uedhoc

Zephyr downstream of https://github.com/eriptic/uoscore-uedhoc
C
3
star
59

hal_renesas

HAL for Renesas devices
C
3
star
60

optiga-trust

Zephyr repository tracking Infineon's Optiga Trust X and M frameworks
3
star
61

hal_wurthelektronik

HAL for Wรผrth Elektronik devices
C
3
star
62

hal_altera

C
3
star
63

hal_ethos_u

HAL for Arm Ethos-U NPUs
C++
3
star
64

hal_nuvoton

HAL module for Nuvoton ICs
C
2
star
65

action_scancode

Python
2
star
66

sdk-ng-testing

For testing purposes only.
C
2
star
67

git2cl

Perl
2
star
68

docker-sdk-build

Docker image for building the Zephyr SDK
Dockerfile
2
star
69

docker-scancode

Docker image with scanode for Github actions
Dockerfile
2
star
70

system-dt-playground

Temp repo for sharing activities around system devicetree and Zephyr
C
2
star
71

proposals

Zephyr Enhancement Proposals and Blue Prints
2
star
72

hal_unisoc

C
2
star
73

nrf_hw_models

Mirror of https://github.com/BabbleSim/ext_NRF_hw_models/ (PRs or issues should be filed there)
C
2
star
74

tf-m-tests

Zephyr repository tracking https://git.trustedfirmware.org/TF-M/tf-m-tests.git
C
2
star
75

tinycrypt

Zephyr repository tracking https://github.com/intel/tinycrypt
C
2
star
76

newlib-cygwin

Newlib source for building Zephyr SDK
C
2
star
77

hal_nrfx

DEPRECATED repository. Do **not** change or delete.
C
2
star
78

hal_quicklogic

HAL for QuickLogic devices
C
1
star
79

infrastructure

Zephyr Project Infrastructure Management
HCL
1
star
80

hardware_test_results

A repo for collecting test results and for managing validation reports.
Python
1
star
81

hal_cypress

HAL module for Cypress devices
C
1
star
82

docker-image-testing

For testing purpose only.
Shell
1
star
83

hal_qmsi

C
1
star
84

esp-idf

C
1
star
85

.github

Special repository for GitHub public organisation profile
1
star
86

swg-scripts

Security Working Group Scripts
Rust
1
star
87

ci-test

This repository is obsolete
Shell
1
star
88

libjaylink

C
1
star
89

tests_influx_grafana

Used for footprint tracking
Python
1
star
90

edtt

Mirror of https://github.com/EDTTool/EDTT (PRs or issues should be filed there)
Python
1
star
91

docker-ci-internal

Private Docker image for Zephyr CI (inactive, for testing only)
Dockerfile
1
star
92

babblesim-manifest

Automated replica of https://github.com/BabbleSim/bsim_west. Send PR or issues there.
1
star
93

crosstool-ng-old

Zephyr fork of crosstool-NG - for building Zephyr GNU toolchains (obsolete)
Shell
1
star
94

hal_telink

HAL for Telink devices
C
1
star
95

docs-theme

Zephyr Project Documentation Theme
CSS
1
star
96

hal_hpmicro

HPMicro HAL
C
1
star
97

actions_sandbox

A sandbox for testing GH Actions
1
star
98

hal_openisa

C
1
star
99

hal_wch

HAL module for WCH CH32V
C
1
star
100

hal_ambiq

HAL for Ambiq devices
C
1
star