Golioth Firmware SDK

A software development kit for connecting embedded devices to the Golioth IoT cloud.

This SDK can be used on the following firmware platforms (a.k.a. ecosystems):

• Espressif ESP-IDF
• Infineon ModusToolbox
• Linux (or POSIX-like)

SDK source: https://github.com/golioth/golioth-firmware-sdk

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

Getting Started

Hello, Golioth!

Here is a minimal example that demonstrates how to connect to Golioth cloud and send the message "Hello, Golioth!":

#include <stdbool.h>
#include <stdint.h>
#include <string.h>
#include "nvs.h"
#include "wifi.h"
#include "golioth.h"
 
void app_main(void) {
    const char* wifi_ssid = "SSID";
    const char* wifi_password = "Password";
    const char* golioth_psk_id = "[email protected]";
    const char* golioth_psk = "supersecret";
 
    nvs_init();
    wifi_init(wifi_ssid, wifi_password);
    wifi_wait_for_connected();
 
    golioth_client_config_t config = {
        .credentials = {
            .auth_type = GOLIOTH_TLS_AUTH_TYPE_PSK,
            .psk = {
                    .psk_id = golioth_psk_id,
                    .psk_id_len = strlen(golioth_psk_id),
                    .psk = golioth_psk,
                    .psk_len = strlen(golioth_psk),
            }
        }
    };
 
    golioth_client_t client = golioth_client_create(&config);
    GLTH_LOGI(client, "app_main", "Hello, Golioth!");
}

Cloning this repo

This repo uses git submodules, so you will need to clone with the --recursive option:

git clone --recursive https://github.com/golioth/golioth-firmware-sdk.git

Or, if you've already cloned but forgot the --recursive, you can update and initialize submodules with this command:

cd golioth-firmware-sdk
git submodule update --init --recursive

Trying the SDK examples

The examples directory contains example apps which you can build and run. It is organized by platform (e.g. ESP-IDF, ModusToolbox, etc), so navigate to a specific platform directory and check out the README for further instructions to build and run the examples.

The golioth_basics example (examples/<platform>/golioth_basics) is recommended as a starting point, to learn how to connect to Golioth and use services like LightDB State, LightDB Stream, Logging, and OTA.

Additional Documentation

The docs folder contains additional documentation, such as a platform integration guide and a platform porting guide.

Features Supported by Platform

The following table lists which SDK features (rows) are support for each platform (columns). The :soon:'s indicate a feature that is planned to be implemented in the future, and the :x:'s indicate a feature that is not planned (or not applicable).

Feature	ESP-IDF	ModusToolbox	Linux
OTA FW Update	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark: 1
Cloud Logging	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
LightDB State	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
LightDB Stream	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Remote Procedure Call	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Settings	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
CoAP/DTLS Client	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
PSK Auth	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Certificate Auth	:heavy_check_mark:	:soon:	:heavy_check_mark:
Sign+Verify OTA images	:soon:	:heavy_check_mark:	:soon:
OTA FW compression	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
OTA FW delta update	:heavy_check_mark:	:heavy_check_mark:	:heavy_check_mark:
Terminal shell	:heavy_check_mark:	:soon:	:x:
Remote Shell	:heavy_check_mark:	:soon:	:soon:
Serial Provisioning	:heavy_check_mark:	:soon:	:x:
BLE Provisioning	:heavy_check_mark:	:soon:	:x:

¹: partially implemented, downloads new image to file, but doesn't swap out the currently running image

Verified Devices

The following table lists the different hardware configurations we test the SDK against, and when it was last tested.

The test itself covers most major functionality of the SDK, including connecting to the Golioth server, interacting with LightDB State and Stream, and performing OTA firmware updates.

The test procedure is (e.g. for ESP-IDF):

cd examples/esp_idf/test
idf.py build
idf.py flash
python verify.py /dev/ttyUSB0

The verify.py script will return 0 on success (all tests pass), and non-zero otherwise.

Board	Platform	Module	Last Tested Commit
ESP32-S3-DevKitC-1	ESP-IDF (v5.0)	ESP32-S3-WROOM-1	Every commit, CI/CD
ESP32-DevKitC-32E	ESP-IDF (v5.0)	ESP32-WROOM-32E	v0.6.0 (Feb 24, 2023)
ESP32-C3-DevKitM-1	ESP-IDF (v5.0)	ESP32-C3-MINI-1	v0.6.0 (Feb 24, 2023)
CY8CPROTO-062-4343W	ModusToolbox (3.0.0)	PSoC® 6 CYW4343W	v0.6.0 (Feb 24, 2023)