config: Report config to shadow and unify CDDL schema

Unify desired/reported objects into single shadow-object in CDDL
schema. Add automatic reporting of current config (update_interval,
sample_interval) to cloud shadow upon connection. Simplify build
system to generate both encode and decode functions from unified
schema definition.

Update documentation and tests accordingly.

Signed-off-by: Simen S. Røstad <simen.rostad@nordicsemi.no>

Author: simensrostad

app/src/Kconfig.main

@@ -5,22 +5,27 @@
 #
 menu "App"
 
-config APP_SENSOR_SAMPLING_INTERVAL_SECONDS
-	int "Sensor sampling interval"
-	default 600
+config APP_BUFFER_MODE_SAMPLING_INTERVAL_SECONDS
+	int "Sampling interval in buffer mode"
+	default 150
 	help
-	  Interval for triggering sensor data sampling and location search.
-	  In passthrough mode, this timer also triggers cloud shadow and FOTA status polling and data sending.
-	  This is the primary sampling interval for the application.
+	  Interval in seconds that determines how often sensor and location data is
+	  collected in buffer mode.
 
 config APP_CLOUD_SYNC_INTERVAL_SECONDS
 	int "Cloud synchronization interval"
-	default 3600
+	default 600
 	help
-	  Interval for cloud synchronization activities including polling and data sending.
-	  This timer triggers cloud shadow and FOTA status polling, and data sending from storage.
-	  The data sending only applies if the storage module is in buffer mode.
-	  This interval is typically longer than the sensor sampling interval.
+	  Interval in seconds that controls how frequently the application
+	  synchronizes with cloud, performing cloud-related tasks such as:
+		* Polling the device shadow
+		* Checking for FOTA updates
+		* Transmitting buffered data to the cloud
+	  In buffer mode, this option is typically set to a longer interval
+	  than CONFIG_APP_BUFFER_MODE_SAMPLING_INTERVAL_SECONDS to reduce
+	  power consumption while allowing data aggregation.
+	  In passthrough mode, this option controls both data sampling and
+	  cloud synchronization frequency.
 
 config APP_REQUEST_NETWORK_QUALITY
 	bool "Request network quality"

app/src/cbor/CMakeLists.txt

@@ -7,13 +7,14 @@
 target_sources(app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/cbor_helper.c)
 target_include_directories(app PRIVATE .)
 
-# generate encoder code using zcbor
+# Generate encoder and decoder code using zcbor
 set(zcbor_command
         zcbor code # Invoke code generation
 	--cddl ${CMAKE_CURRENT_SOURCE_DIR}/device_shadow.cddl
 	--decode # Generate decoding functions
+	--encode # Generate encoding functions
 	--short-names # Attempt to make generated symbol names shorter (at the risk of collision)
-	-t desired-object # Create a public API for decoding the "desired-object" type from the cddl file
+	-t shadow-object # Create a public API for encoding and decoding the "shadow-object" type from the cddl file
 	--output-cmake device_shadow.cmake # The generated cmake file will be placed here
 )
 execute_process(COMMAND ${zcbor_command}

app/src/cbor/cbor_helper.c

@@ -5,46 +5,131 @@
  */
 #include <errno.h>
 #include <string.h>
+#include <zcbor_encode.h>
 
 #include "cbor_helper.h"
+#include "device_shadow_types.h"
 #include "device_shadow_decode.h"
+#include "device_shadow_encode.h"
 
 #include <zephyr/logging/log.h>
 
 LOG_MODULE_REGISTER(cbor_helper, CONFIG_APP_LOG_LEVEL);
 
-int get_parameters_from_cbor_response(const uint8_t *cbor,
-				      size_t len,
-				      uint32_t *interval_sec,
-				      uint32_t *command_type)
+int decode_shadow_parameters_from_cbor(const uint8_t *cbor,
+				       size_t len,
+				       struct config_params *config,
+				       uint32_t *command_type,
+				       uint32_t *command_id)
 {
 	int err;
-	struct desired_object desired_object = { 0 };
+	struct shadow_object shadow = { 0 };
 	size_t decode_len = len;
 
-	if (!cbor || !interval_sec || !command_type || len == 0) {
+	if (!cbor || !config || !command_type || len == 0) {
+		LOG_ERR("Invalid input");
 		return -EINVAL;
 	}
 
-	err = cbor_decode_desired_object(cbor, decode_len, &desired_object, &decode_len);
+	err = cbor_decode_shadow_object(cbor, decode_len, &shadow, &decode_len);
 	if (err) {
-		LOG_ERR("cbor_decode_desired_object, error: %d", err);
+		LOG_ERR("cbor_decode_shadow_object, error: %d", err);
 		LOG_HEXDUMP_ERR(cbor, len, "Unexpected CBOR data");
 		return -EFAULT;
 	}
 
-	if (desired_object.config_present && desired_object.config.update_interval_present) {
-		*interval_sec = desired_object.config.update_interval.update_interval;
-	} else {
-		LOG_DBG("Update interval parameter not present");
+	if (shadow.config_present) {
+		if (shadow.config.update_interval_present) {
+			config->update_interval = shadow.config.update_interval.update_interval;
+			LOG_DBG("Configuration: Decoded update_interval = %d seconds",
+				config->update_interval);
+		}
+
+		if (shadow.config.sample_interval_present) {
+			config->sample_interval = shadow.config.sample_interval.sample_interval;
+			LOG_DBG("Configuration: Decoded sample_interval = %d seconds",
+				config->sample_interval);
+		}
+
+		if (shadow.config.buffer_mode_present) {
+			config->buffer_mode = shadow.config.buffer_mode.buffer_mode;
+			config->buffer_mode_valid = true;
+			LOG_DBG("Configuration: Decoded buffer_mode = %s",
+				config->buffer_mode ? "enabled" : "disabled");
+		}
+	}
+
+	if (shadow.command_present) {
+		*command_type = shadow.command.type;
+		*command_id = shadow.command.id;
+
+		LOG_DBG("Command parameter present: type=%u, id=%u",
+			*command_type, *command_id);
+
+	}
+
+	return 0;
+}
+
+int encode_shadow_parameters_to_cbor(const struct config_params *config,
+				     uint32_t command_type,
+				     uint32_t command_id,
+				     uint8_t *buffer,
+				     size_t buffer_size,
+				     size_t *encoded_len)
+{
+	int err;
+	struct shadow_object shadow = { 0 };
+	size_t encode_len;
+
+	if (!config || !buffer || !encoded_len || buffer_size == 0) {
+		return -EINVAL;
+	}
+
+	/* Build shadow object with config section */
+	if (config->update_interval > 0) {
+		shadow.config_present = true;
+		shadow.config.update_interval_present = true;
+		shadow.config.update_interval.update_interval = config->update_interval;
 	}
 
-	if (desired_object.command_present) {
-		*command_type = desired_object.command.type;
-		/* ID entry not used */
-	} else {
-		LOG_DBG("Command parameter not present");
+	if (config->sample_interval > 0) {
+		shadow.config_present = true;
+		shadow.config.sample_interval_present = true;
+		shadow.config.sample_interval.sample_interval = config->sample_interval;
 	}
 
+	if (config->buffer_mode_valid) {
+		shadow.config_present = true;
+		shadow.config.buffer_mode_present = true;
+		shadow.config.buffer_mode.buffer_mode = config->buffer_mode;
+	}
+
+	/* Build shadow object with command section */
+	if (command_type > 0) {
+		shadow.command_present = true;
+		shadow.command.type = command_type;
+		shadow.command.id = command_id;
+	}
+
+	/* Encode the shadow object to CBOR */
+	err = cbor_encode_shadow_object(buffer, buffer_size, &shadow, &encode_len);
+	if (err) {
+		LOG_ERR("cbor_encode_shadow_object, error: %d", err);
+		return (err == ZCBOR_ERR_NO_PAYLOAD) ? -ENOMEM : -EFAULT;
+	}
+
+	*encoded_len = encode_len;
+
+	LOG_DBG("Encoded config: update_interval=%u, sample_interval=%u, "
+		"buffer_mode=%s, len=%zu; Encoded command: type=%u, id=%u, len=%zu",
+		config->update_interval,
+		config->sample_interval,
+		config->buffer_mode ? "enabled" : "disabled",
+		encode_len,
+		command_type,
+		command_id,
+		encode_len);
+
 	return 0;
 }

app/src/cbor/cbor_helper.h

@@ -7,22 +7,59 @@
 #include <zephyr/types.h>
 
 #define CLOUD_COMMAND_TYPE_PROVISION 1
-#define CLOUD_COMMAND_TYPE_REBOOT 2
+
+/** Device configuration parameters. */
+struct config_params {
+	/** Update interval in seconds. */
+	uint32_t update_interval;
+
+	/** Sample interval in seconds. */
+	uint32_t sample_interval;
+
+	/** Buffer mode flag */
+	bool buffer_mode;
+
+	/** Buffer mode validity flag */
+	bool buffer_mode_valid;
+};
 
 /**
- * @brief Get the device shadow parameters from a CBOR buffer.
+ * @brief Decode shadow parameters from CBOR buffer.
+ *	  If a parameter is not present, it is set to UINT32_MAX.
  *
- * @param[in]  cbor         The CBOR buffer.
- * @param[in]  len          The length of the CBOR buffer.
- * @param[out] interval_sec Update interval in seconds.
- * @param[out] command_type Cloud command type.
+ * @param[in]  cbor         CBOR buffer.
+ * @param[in]  len          CBOR buffer length.
+ * @param[out] config       Decoded configuration parameters.
+ * @param[out] command_type Decoded command type.
+ * @param[out] command_id   Decoded command ID.
+ *
+ * @retval 0 Success.
+ * @retval -EINVAL Invalid parameters.
+ * @retval -EFAULT Invalid CBOR data.
+ */
+int decode_shadow_parameters_from_cbor(const uint8_t *cbor,
+				       size_t len,
+				       struct config_params *config,
+				       uint32_t *command_type,
+				       uint32_t *command_id);
+
+/**
+ * @brief Encode shadow parameters to CBOR buffer.
  *
- * @returns 0 If the operation was successful.
- *	    Otherwise, a (negative) error code is returned.
- * @retval -EFAULT if the CBOR buffer is invalid.
+ * @param[in]  config       Configuration parameters.
+ * @param[in]  command_type Command type.
+ * @param[in]  command_id   Command ID.
+ * @param[out] buffer       Output buffer for encoded CBOR.
+ * @param[in]  buffer_size  Output buffer size.
+ * @param[out] encoded_len  Length of encoded data.
  *
+ * @retval 0 Success.
+ * @retval -EINVAL Invalid parameters.
+ * @retval -ENOMEM Buffer too small.
  */
-int get_parameters_from_cbor_response(const uint8_t *cbor,
-				      size_t len,
-				      uint32_t *interval_sec,
-				      uint32_t *command_type);
+int encode_shadow_parameters_to_cbor(const struct config_params *config,
+				     uint32_t command_type,
+				     uint32_t command_id,
+				     uint8_t *buffer,
+				     size_t buffer_size,
+				     size_t *encoded_len);

app/src/cbor/device_shadow.cddl

@@ -1,25 +1,43 @@
-; Device Shadow Desired Object Definition
-; ---------------------------------------
-; This section defines the structure of the "desired" object in the device shadow.
-; All sections are optional, but if present, they must appear in the specified order when decoding the CBOR buffer.
+; Device Shadow Object Definition
+; --------------------------------
+; This unified structure defines both "desired" (cloud-to-device) and "reported" (device-to-cloud)
+; objects in the device shadow. All sections are optional, but if present, they must appear in
+; the specified order when decoding the CBOR buffer.
 ;
 ; Sections:
-; 1. "config": Contains device configuration parameters.
-;    - "update_interval": (optional) A 4-byte unsigned integer specifying the update interval.
+; 1. "config": Device configuration parameters.
+;    - "update_interval": (optional) A 4-byte unsigned integer (in seconds) specifying:
+;                         - In passthrough mode: How often the device samples sensors and sends data to cloud.
+;                         - In buffer mode: How often the device sends buffered data to cloud, polls shadow, and checks for FOTA updates.
+;                         Valid range: 1 to 4294967295. Values outside this range are decoded but rejected by application.
+;    - "sample_interval": (optional) A 4-byte unsigned integer (in seconds) specifying how often the device
+;                         samples sensor data in buffer mode. This parameter is ignored in passthrough mode.
+;                         Valid range: 1 to 4294967295. Values outside this range are decoded but rejected by application.
+;    - "buffer_mode": (optional) A boolean value that controls the storage mode.
+;                     true = Buffer mode: Device samples at "sample_interval" and sends data at "update_interval".
+;                     false = Passthrough mode: Device samples and sends data at "update_interval" (sample_interval is ignored).
+;                     When not present, the device uses the default passthrough mode.
 ;    - Additional configuration parameters may be included as key-value pairs (tstr => any).
 ;
 ; 2. "command": (optional) An array specifying a command for the device to execute.
 ;    - Structure: [type, id]
 ;      - type: 4-byte unsigned integer indicating the command type.
+;              Supported command types:
+;                1 = PROVISION: Triggers device provisioning sequence
+;              Valid range: 1 to 1.
 ;      - id:   4-byte unsigned integer indicating the command ID.
+;              Used to track command execution. Increment for successive commands.
+;              Valid range: 1 to 4294967295 (excludes 0).
 ;
 ; Any additional fields may be included as key-value pairs (tstr => any).
 
-desired-object = {
+shadow-object = {
     ? "config": {
         ? "update_interval": uint .size 4,
+        ? "sample_interval": uint .size 4,
+        ? "buffer_mode": bool,
         * tstr => any
     },
-    ? "command": [type: uint .size 4, id: uint .size 4],
+    ? "command": [type: uint .size 4 .ge 1 .le 1, id: uint .size 4 .ge 1 .le 4294967295],
     * tstr => any
 }