Merge pull request #13 from golioth/merge/template_v2.4.1

Merge/template v2.4.1

Author: szczys

.github/workflows/build_zephyr.yml

@@ -60,17 +60,20 @@ jobs:
 
       - name: Build with West
         run: |
-          west build -p -b ${{ inputs.BOARD }} app
+          west build -p -b ${{ inputs.BOARD }} --sysbuild app
 
       - name: Prepare artifacts
+        shell: bash
         if: inputs.ARTIFACT == true && inputs.TAG != ''
 
         run: |
-          cd build/zephyr
+          cd build
           mkdir -p artifacts
-          mv merged.hex     ./artifacts/${{ github.event.repository.name }}_${{ inputs.TAG }}_${{ inputs.BOARD }}_full.hex
-          mv app_update.bin ./artifacts/${{ github.event.repository.name }}_${{ inputs.TAG }}_${{ inputs.BOARD }}_update.bin
-          mv zephyr.elf     ./artifacts/${{ github.event.repository.name }}_${{ inputs.TAG }}_${{ inputs.BOARD }}.elf
+          BOARD_NICENAME=${{ inputs.BOARD }}
+          BOARD_NICENAME=${BOARD_NICENAME//\//_}
+          mv merged.hex                   ./artifacts/golioth-${{ github.event.repository.name }}_${{ inputs.TAG }}_${BOARD_NICENAME}_full.hex
+          mv app/zephyr/zephyr.signed.bin ./artifacts/golioth-${{ github.event.repository.name }}_${{ inputs.TAG }}_${BOARD_NICENAME}_update.bin
+          mv app/zephyr/zephyr.elf        ./artifacts/golioth-${{ github.event.repository.name }}_${{ inputs.TAG }}_${BOARD_NICENAME}.elf
 
       # Run IDs are unique per repo but are reused on re-runs
       - name: Save artifact
@@ -79,4 +82,4 @@ jobs:
         with:
           name: build_artifacts_${{ github.run_id }}
           path: |
-            build/zephyr/artifacts/*
+            build/artifacts/*

.github/workflows/release.yml

@@ -9,15 +9,15 @@ on:
             version:
                 description: 'Release Version.'
                 required: true
-                default: 'v0.0.0'
+                default: 'template_v0.0.0'
                 type: string
 
 jobs:
     build-binaries:
         strategy:
             matrix:
               ZEPHYR_SDK: [0.16.3]
-              BOARD: ["thingy91_nrf9160_ns"]
+              BOARD: ["thingy91/nrf9160/ns"]
 
         uses: ./.github/workflows/build_zephyr.yml
         with:

.github/workflows/test.yml

@@ -7,11 +7,12 @@ on:
   pull_request:
 
   push:
+    branches: [ main ]
 
 jobs:
-  test_build:
+  test_build_thingy91:
     uses: ./.github/workflows/build_zephyr.yml
     with:
       ZEPHYR_SDK: 0.16.3
-      BOARD: thingy91_nrf9160_ns
+      BOARD: thingy91/nrf9160/ns
       ARTIFACT: false

README.rst

@@ -1,5 +1,5 @@
 ..
-   Copyright (c) 2022-2023 Golioth, Inc.
+   Copyright (c) 2024 Golioth, Inc.
    SPDX-License-Identifier: Apache-2.0
 
 Golioth Thingy91 Example Program
@@ -16,8 +16,11 @@ This repo is based on the Golioth `Reference Design Template`_.
 Local set up
 ************
 
-Do not clone this repo using git. Zephyr's ``west`` meta tool should be used to
-set up your local workspace.
+.. pull-quote::
+   [!IMPORTANT]
+
+   Do not clone this repo using git. Zephyr's ``west`` meta tool should be used to
+   set up your local workspace.
 
 Install the Python virtual environment (recommended)
 ====================================================
@@ -51,13 +54,19 @@ itself will be inside the ``app`` folder. The ``build`` and ``deps`` directories
 being one level higher prevents the repo from cataloging all of the changes to
 the dependencies and the build (so no ``.gitignore`` is needed).
 
-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.
+Prior to building, update ``VERSION`` 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.
+
+
+.. pull-quote::
+   [!IMPORTANT]
+
+   You must perform a pristine build (use ``-p`` or remove the ``build`` directory)
+   after changing the firmware version number in the ``VERSION`` file for the change to take effect.
 
 .. code-block:: text
 
-   $ (.venv) west build -p -b thingy91_nrf9160_ns app
+   $ (.venv) west build -p -b thingy91/nrf9160/ns --sysbuild app
    $ (.venv) west flash
 
 Configure PSK-ID and PSK using the device shell based on your Golioth
@@ -69,6 +78,25 @@ credentials and reboot:
    uart:~$ settings set golioth/psk <my-psk>
    uart:~$ kernel reboot cold
 
+Add Pipeline to Golioth
+***********************
+
+Golioth uses `Pipelines`_ to route stream data. This gives you flexibility to change your data
+routing without requiring updated device firmware.
+
+Whenever sending stream data, you must enable a pipeline in your Golioth project to configure how
+that data is handled. Add the contents of ``pipelines/cbor-to-lightdb.yml`` as a new pipeline as
+follows (note that this is the default pipeline for new projects and may already be present):
+
+   1. Navigate to your project on the Golioth web console.
+   2. Select ``Pipelines`` from the left sidebar and click the ``Create`` button.
+   3. Give your new pipeline a name and paste the pipeline configuration into the editor.
+   4. Click the toggle in the bottom right to enable the pipeline and then click ``Create``.
+
+All data streamed to Golioth in CBOR format will now be routed to LightDB Stream and may be viewed
+using the web console. You may change this behavior at any time without updating firmware simply by
+editing this pipeline entry.
+
 Golioth Features
 ****************
 

VERSION

@@ -0,0 +1,5 @@
+VERSION_MAJOR = 2
+VERSION_MINOR = 4
+PATCHLEVEL = 1
+VERSION_TWEAK = 0
+EXTRAVERSION =

boards/aludel_mini_nrf9160_ns.overlay

@@ -0,0 +1,10 @@
+&i2c2 {
+    /* Needed for I2C writes used by libostentus */
+    zephyr,concat-buf-size = <48>;
+
+    ostentus@12 {
+        status = "okay";
+        compatible = "golioth,ostentus";
+        reg = <0x12>;
+    };
+};

boards/thingy91_nrf9160_ns.conf

@@ -17,11 +17,11 @@ CONFIG_NET_SOCKETS_TLS_PRIORITY=35
 
 # Modem library
 CONFIG_NRF_MODEM_LIB=y
-CONFIG_NRF_MODEM_LIB_ON_FAULT_APPLICATION_SPECIFIC=y
 
 # LTE connectivity with network connection manager
-CONFIG_LTE_CONNECTIVITY=y
-CONFIG_LTE_CONNECTIVITY_AUTO_CONNECT=n
+CONFIG_NRF_MODEM_LIB_NET_IF=y
+CONFIG_NRF_MODEM_LIB_NET_IF_AUTO_START=y
+CONFIG_NRF_MODEM_LIB_NET_IF_AUTO_CONNECT=n
 CONFIG_NET_CONNECTION_MANAGER=y
 CONFIG_NET_CONNECTION_MANAGER_MONITOR_STACK_SIZE=1024
 
@@ -32,6 +32,12 @@ CONFIG_GOLIOTH_SAMPLE_NRF91_LTE_MONITOR=y
 CONFIG_MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED=n
 CONFIG_MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED=n
 
+# MbedTLS configuration to support p-384 curve. These options
+# enable using the MbedTLS built-in support for operations not
+# supported by the default nRF Oberon crypto backend
+CONFIG_NORDIC_SECURITY_BACKEND=n
+CONFIG_MBEDTLS_LEGACY_CRYPTO_C=y
+
 # Add Network Info Support
 CONFIG_MODEM_INFO=y
 

pipelines/cbor-to-lightdb.yml

@@ -0,0 +1,11 @@
+filter:
+  path: "*"
+  content_type: application/cbor
+steps:
+  - name: step-0
+    transformer:
+      type: cbor-to-json
+      version: v1
+    destination:
+      type: lightdb-stream
+      version: v1