Merge upstream reference-design-template

Signed-off-by: Marko Puric <marko@golioth.io>

Author: MarkoPura

.github/workflows/build_zephyr.yml

@@ -60,7 +60,7 @@ jobs:
 
       - name: Build with West
         run: |
-          west build -p -b ${{ inputs.BOARD }} app -- -DCONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION=\"0.0.0\"
+          west build -p -b ${{ inputs.BOARD }} app
 
       - name: Prepare artifacts
         if: inputs.ARTIFACT == true && inputs.TAG != ''

CHANGELOG.md

@@ -15,3 +15,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added support for Adafruit Feather nRF52840 Express board
 - Based on the [Reference Design Template](https://github.com/golioth/reference-design-template)
 - Added a CHANGELOG.md to track changes moving forward.
+

CMakeLists.txt

@@ -11,6 +11,6 @@ target_sources(app PRIVATE src/main.c)
 target_sources(app PRIVATE src/app_rpc.c)
 target_sources(app PRIVATE src/app_settings.c)
 target_sources(app PRIVATE src/app_state.c)
-target_sources(app PRIVATE src/app_work.c)
-target_sources(app PRIVATE src/dfu/app_dfu.c)
-target_sources_ifdef(CONFIG_BOOTLOADER_MCUBOOT app PRIVATE src/dfu/flash.c)
+target_sources(app PRIVATE src/app_sensors.c)
+
+add_subdirectory_ifdef(CONFIG_ALUDEL_BATTERY_MONITOR src/battery_monitor)

README.rst

@@ -44,15 +44,26 @@ This firmware can be built for a variety of supported hardware platforms.
           :width: 240
      - ``nrf52840dk_nrf52840``
 
+<<<<<<< HEAD
 .. list-table:: **Adafruit Hardware**
    :header-rows: 1
+=======
+Prior to building, update ``CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION`` in the ``prj.conf`` file to
+reflect the firmware version number you want to assign to this build. Then run the following
+commands to build and program the firmware onto the device.
+>>>>>>> upstream/main
 
    * - Development Board
      - Zephyr Board
 
+<<<<<<< HEAD
    * - .. image:: images/Adafurit_nRF52840_Feather.png
           :width: 240
      - ``adafruit_feather_nrf52840``
+=======
+   $ (.venv) west build -p -b aludel_mini_v1_sparkfun9160_ns app
+   $ (.venv) west flash
+>>>>>>> upstream/main
 
 
 Firmware Overview
@@ -182,6 +193,7 @@ Install ``west`` meta-tool
 
 .. code-block:: shell
 
+<<<<<<< HEAD
    pip install wheel west
 
 Use ``west`` to initialize the workspace and install dependencies
@@ -232,6 +244,15 @@ Flash the firmware
 
 .. code-block:: text
 
+=======
+Prior to building, update ``CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION`` in the ``prj.conf`` file to
+reflect the firmware version number you want to assign to this build. Then run the following
+commands to build and program the firmware onto the device.
+
+.. code-block:: text
+
+   $ (.venv) west build -p -b nrf9160dk_nrf9160_ns app
+>>>>>>> upstream/main
    $ (.venv) west flash
 
 Provision the device

prj.conf

@@ -1,14 +1,39 @@
 # Copyright (c) 2022-2023 Golioth, Inc.
 # SPDX-License-Identifier: Apache-2.0
 
-CONFIG_GOLIOTH_SAMPLES_COMMON=y
+# Enable Golioth Firmware SDK
+CONFIG_GOLIOTH_FIRMWARE_SDK=y
 
-# Application
+# Golioth services used in this app
+CONFIG_GOLIOTH_FW_UPDATE=y
+CONFIG_GOLIOTH_LIGHTDB_STATE=y
 CONFIG_LOG_BACKEND_GOLIOTH=y
-CONFIG_MAIN_STACK_SIZE=4096
+CONFIG_GOLIOTH_RPC=y
+CONFIG_GOLIOTH_SETTINGS=y
+CONFIG_GOLIOTH_STREAM=y
+
+# Enable common sample library
+CONFIG_GOLIOTH_SAMPLE_COMMON=y
 
-CONFIG_GOLIOTH_FW=y
+# Configure Golioth SDK dependencies
+CONFIG_EVENTFD_MAX=14
+CONFIG_LOG_PROCESS_THREAD_STACK_SIZE=1536
+CONFIG_MBEDTLS_ENABLE_HEAP=y
+CONFIG_MBEDTLS_HEAP_SIZE=10240
+CONFIG_MBEDTLS_SSL_IN_CONTENT_LEN=2048
+CONFIG_MBEDTLS_SSL_OUT_CONTENT_LEN=2048
+CONFIG_NETWORKING=y
+CONFIG_NET_IPV4=y
+CONFIG_POSIX_MAX_FDS=23
 
+# Application
+CONFIG_MAIN_STACK_SIZE=2048
+CONFIG_SYSTEM_WORKQUEUE_STACK_SIZE=2048
+CONFIG_NET_LOG=y
+CONFIG_NET_SHELL=y
+CONFIG_REBOOT=y
+
+# Flash memory (etc.) for firmware upgrade
 CONFIG_FLASH=y
 CONFIG_FLASH_MAP=y
 CONFIG_NVS=y
@@ -17,25 +42,28 @@ CONFIG_IMG_MANAGER=y
 CONFIG_IMG_ERASE_PROGRESSIVELY=y
 CONFIG_REBOOT=y
 
-CONFIG_SYSTEM_WORKQUEUE_STACK_SIZE=4096
-
-CONFIG_JSON_LIBRARY=y
-
+# The rest of the runtime credentials config
 CONFIG_SETTINGS=y
-CONFIG_GOLIOTH_SETTINGS=y
 CONFIG_SETTINGS_RUNTIME=y
 CONFIG_GOLIOTH_SAMPLE_PSK_SETTINGS=y
 CONFIG_GOLIOTH_SAMPLE_SETTINGS_AUTOLOAD=y
 CONFIG_GOLIOTH_SAMPLE_SETTINGS_SHELL=y
 
-CONFIG_GOLIOTH_RPC=y
-CONFIG_I2C=y
+# Misc.
+CONFIG_JSON_LIBRARY=y
+CONFIG_NETWORK_INFO=y
+# Longer response length needed for network info
+CONFIG_GOLIOTH_RPC_MAX_RESPONSE_LEN=512
 
 # Generate MCUboot compatible images
 CONFIG_BOOTLOADER_MCUBOOT=y
 
+# Firmware version used in DFU process
+CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION="2.1.0"
+
 # IMPORTANT: Change the Thread network credentials to match your Thread network setup
 CONFIG_OPENTHREAD_NORDIC_LIBRARY_MASTER=y
 CONFIG_OPENTHREAD_CHANNEL=26
 CONFIG_OPENTHREAD_NETWORKKEY="00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff"
 CONFIG_OPENTHREAD_NETWORK_NAME="OpenThreadDemo"
+

src/app_rpc.c

@@ -8,15 +8,13 @@
 #include <zephyr/logging/log_ctrl.h>
 LOG_MODULE_REGISTER(app_rpc, LOG_LEVEL_DBG);
 
-#include <net/golioth/system_client.h>
-#include <net/golioth/rpc.h>
+#include <golioth/client.h>
+#include <golioth/rpc.h>
 #include <zephyr/logging/log_ctrl.h>
 #include <zephyr/sys/reboot.h>
 
 #include "app_rpc.h"
 
-static struct golioth_client *client;
-
 static void reboot_work_handler(struct k_work *work)
 {
 	for (int8_t i = 5; i >= 0; i--) {
@@ -95,31 +93,15 @@ static void rpc_log_if_register_failure(int err)
 	}
 }
 
-int app_rpc_init(struct golioth_client *state_client)
+void app_rpc_register(struct golioth_client *client)
 {
-	client = state_client;
-	int err = app_rpc_register(client);
-	return err;
-}
+	struct golioth_rpc *rpc = golioth_rpc_init(client);
 
-int app_rpc_observe(void)
-{
-	int err = golioth_rpc_observe(client);
-	if (err) {
-		LOG_ERR("Failed to observe RPC: %d", err);
-	}
-	return err;
-}
-
-int app_rpc_register(struct golioth_client *rpc_client)
-{
 	int err;
 
-	err = golioth_rpc_register(rpc_client, "reboot", on_reboot, NULL);
+	err = golioth_rpc_register(rpc, "reboot", on_reboot, NULL);
 	rpc_log_if_register_failure(err);
 
-	err = golioth_rpc_register(rpc_client, "set_log_level", on_set_log_level, NULL);
+	err = golioth_rpc_register(rpc, "set_log_level", on_set_log_level, NULL);
 	rpc_log_if_register_failure(err);
-
-	return err;
 }

src/app_rpc.h

@@ -20,10 +20,8 @@
 #ifndef __APP_RPC_H__
 #define __APP_RPC_H__
 
-#include <net/golioth/system_client.h>
+#include <golioth/client.h>
 
-int app_rpc_init(struct golioth_client *state_client);
-int app_rpc_observe(void);
-int app_rpc_register(struct golioth_client *rpc_client);
+void app_rpc_register(struct golioth_client *client);
 
 #endif /* __APP_RPC_H__ */

src/app_work.c renamed to src/app_sensors.c

@@ -5,12 +5,14 @@
  */
 
 #include <zephyr/logging/log.h>
-LOG_MODULE_REGISTER(app_work, LOG_LEVEL_DBG);
+LOG_MODULE_REGISTER(app_sensors, LOG_LEVEL_DBG);
 
-#include <net/golioth/system_client.h>
+#include <golioth/client.h>
+#include <golioth/stream.h>
 #include <zephyr/drivers/gpio.h>
+#include <zephyr/kernel.h>
 
-#include "app_work.h"
+#include "app_sensors.h"
 
 static struct golioth_client *client;
 /* Add Sensor structs here */
@@ -19,47 +21,47 @@ static struct golioth_client *client;
 #define JSON_FMT "{\"counter\":%d}"
 
 /* Callback for LightDB Stream */
-static int async_error_handler(struct golioth_req_rsp *rsp)
+
+static void async_error_handler(struct golioth_client *client,
+				const struct golioth_response *response,
+				const char *path,
+				void *arg)
 {
-	if (rsp->err) {
-		LOG_ERR("Async task failed: %d", rsp->err);
-		return rsp->err;
+	if (response->status != GOLIOTH_OK) {
+		LOG_ERR("Async task failed: %d", response->status);
+		return;
 	}
-	return 0;
 }
 
 /* This will be called by the main() loop */
 /* Do all of your work here! */
-void app_work_sensor_read(void)
+void app_sensors_read_and_stream(void)
 {
 	int err;
 	char json_buf[256];
 
-	/* For this demo, we just send Hello to Golioth */
 	static uint8_t counter;
 
-	LOG_INF("Sending hello! %d", counter);
-
-	err = golioth_send_hello(client);
-	if (err) {
-		LOG_WRN("Failed to send hello!");
-	}
-
 	/* Send sensor data to Golioth */
 	/* For this demo we just fake it */
 	snprintk(json_buf, sizeof(json_buf), JSON_FMT, counter);
 	LOG_DBG("%s", json_buf);
 
-	err = golioth_stream_push_cb(client, "sensor", GOLIOTH_CONTENT_FORMAT_APP_JSON, json_buf,
-				     strlen(json_buf), async_error_handler, NULL);
+	err = golioth_stream_set_async(client,
+				       "sensor",
+				       GOLIOTH_CONTENT_TYPE_JSON,
+				       json_buf,
+				       strlen(json_buf),
+				       async_error_handler,
+				       NULL);
 	if (err) {
 		LOG_ERR("Failed to send sensor data to Golioth: %d", err);
 	}
 
 	++counter;
 }
 
-void app_work_init(struct golioth_client *work_client)
+void app_sensors_set_client(struct golioth_client *sensors_client)
 {
-	client = work_client;
+	client = sensors_client;
 }

src/app_sensors.h

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2022-2023 Golioth, Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef __APP_SENSORS_H__
+#define __APP_SENSORS_H__
+
+/** The `app_sensors.c` file performs the important work of this application
+ * which is to read sensor values and report them to the Golioth LightDB Stream
+ * as time-series data.
+ *
+ * For this demonstration, a `counter` value is periodically logged and pushed
+ * to the Golioth time-series database. This simulated sensor reading occurs
+ * when the loop in `main.c` calls `app_sensors_read_and_stream()`. The
+ * frequency of this loop is determined by values received from the Golioth
+ * Settings Service (see app_settings.h).
+ *
+ * https://docs.golioth.io/firmware/zephyr-device-sdk/light-db-stream/
+ */
+
+#include <golioth/client.h>
+
+void app_sensors_set_client(struct golioth_client *sensors_client);
+void app_sensors_read_and_stream(void);
+
+#endif /* __APP_SENSORS_H__ */