Getting Started#

Using with Zephyr RTOS#

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 west manifest repo.

Using Golioth SDK as manifest repository#

Execute this command to download this repository together with all dependencies:

west init -m [email protected]:golioth/zephyr.git --mr main
west update
west patch

Adding Golioth SDK to existing west project#

Alternatively add following entry to west.yml file in manifest/projects subtree of existing west based project (e.g. Zephyr RTOS):

# Golioth repository.
- name: golioth
path: modules/lib/golioth
revision: main
url: [email protected]:golioth/zephyr.git

and clone all repositories including that one by running:

west update

Follow Zephyr Getting Started for details on how to setup Zephyr based projects.

Using with nRF Connect SDK#

Platforms like nRF9160 Feather require nRF Connect SDK to make use of their distinct features, which is cellular network connectivity. Initialize nRF Connect SDK with following command:

west init -m https://github.com/nrfconnect/sdk-nrf --mr v1.6.0

Add following entry to west.yml file in manifest/projects subtree:

# Golioth repository.
- name: golioth
path: modules/lib/golioth
revision: main
url: [email protected]:golioth/zephyr.git

Now clone all repositories with:

west update

Follow nRF Connect SDK Getting Started for details on how to setup nRF Connect SDK based projects.

Sample applications#