DEPRECATED

This repository has been deprecated. Please use the Golioth Firmware SDK. There will be no further support or updates to this repository after July 31, 2024.

---

API documentation: https://zephyr-sdk-docs.golioth.io/

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 https://github.com/golioth/golioth-zephyr-sdk.git --mf west-zephyr.yml
west update

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: https://github.com/golioth/golioth-zephyr-sdk.git
  import: west-external.yml

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 DK require nRF Connect SDK to make use of their distinct features, which is cellular network connectivity.

Using Golioth SDK as manifest repository

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

west init -m https://github.com/golioth/golioth-zephyr-sdk.git --mf west-ncs.yml
west update

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

Sample applications

• Golioth DFU sample
• Golioth Hello sample
• Golioth LightDB get sample
• Golioth LightDB observe sample
• Golioth LightDB set sample
• Golioth LightDB LED sample
• Golioth LightDB Stream sample
• Golioth Logging sample
• Golioth Settings sample

Golioth Services

• Golioth Cloud
• LightDB state
• LightDB Stream
• Logging
• OTA
• Authentication

Device matrix

This matrix gets updated on every release.

During release testing, all boards and services are verified using sample applications.

Device	Service	Last tested SDK version	Last tested Golioth version
nRF91 Development Kit +	Authentication --------------+ Logs --------------+ DFU --------------+ LightDB --------------+ LightDB Stream	v0.8.0 -------------+ v0.8.0 -------------+ v0.8.0 -------------+ v0.8.0 -------------+ v0.8.0	v0.30.7
ESP32-WROOM-32D	Authentication --------------+ Logs --------------+ DFU --------------+ LightDB --------------+ LightDB Stream	v0.8.0 -------------+ v0.8.0 -------------+ v0.8.0 -------------+ v0.8.0 -------------+ v0.8.0	v0.30.7
nRF52840 DK + ESP32-WROOM-32D +	Authentication --------------+ Logs --------------+ DFU --------------+ LightDB --------------+ LightDB Stream --------------+ Settings	v0.8.0 -------------+ v0.8.0 -------------+ v0.8.0 -------------+ v0.8.0 -------------+ v0.8.0 -------------+ v0.8.0	v0.30.7
MIMXRT1060-EVKB	Authentication --------------+ Logs --------------+ DFU --------------+ LightDB --------------+ LightDB Stream --------------+ Settings	v0.8.0 -------------+ v0.8.0 -------------+ N/A -------------+ v0.8.0 -------------+ v0.8.0 -------------+ v0.8.0	v0.30.7
QEMU x86	Authentication --------------+ Logs --------------+ DFU --------------+ LightDB --------------+ LightDB Stream	v0.8.0 -------------+ v0.8.0 -------------+ Not supported -------------+ v0.8.0 -------------+ v0.8.0	v0.30.7