The Golioth Firmware SDK has built-in support for Zephyr as well as the Zephyr-based nRF Connect SDK from Nordic Semiconductor.
API documentation: https://firmware-sdk-docs.golioth.io/
- Install the latest version of the Zephyr SDK.
- Install Python
- Install the West tool
Most platforms are already supported with mainline Zephyr RTOS. This repository can be added to any Zephyr based project as new West module. However, for making things simple, this repository can also serve as a West manifest repo.
Execute this command to download this repository together with all dependencies:
west init -m https://github.com/golioth/golioth-firmware-sdk.git --mr v0.12.2 --mf west-zephyr.yml
west update
cd modules/lib/golioth-firmware-sdk && git submodule update --init --recursiveFollow Zephyr Getting Started for details on how to setup Zephyr based projects.
Execute this command to download this repository together with all dependencies:
west init -m https://github.com/golioth/golioth-firmware-sdk.git --mr v0.12.2 --mf west-ncs.yml
west update
cd modules/lib/golioth-firmware-sdk && git submodule update --init --recursiveFollow nRF Connect SDK Getting Started for details on how to setup nRF Connect SDK based projects.
Alternatively, add the following entry to the west.yml file of an
existing
West
based project (e.g. Zephyr RTOS):
# Golioth repository.
- name: golioth
path: modules/lib/golioth-firmware-sdk
revision: main
url: https://github.com/golioth/golioth-firmware-sdk.git
submodules: true
⚠️ Warning: To ensure that default Kconfig values are propagated correctly, place the golioth entry first in your west manifest.
and clone all repositories including that one by running:
west update📝 When the Golioth Firmware SDK is added as a project in a manifest file, the
submoduleskeyword ensures that submodules are updated recursively each timewest updateis used.