Refactor BACnet settings to use settings_load as iterator.

Author: skarg

.pre-commit-config.yaml

@@ -38,10 +38,6 @@ repos:
   - repo: https://github.com/Lucas-C/pre-commit-hooks
     rev: v1.5.5
     hooks:
-      - id: remove-tabs
-        name: Remove tabs (4 spaces)
-        args: ["--whitespaces-count", "4"]
-        exclude: \.(yaml|yml|html|htm|sln|atsln|layout)$|Makefile|\.(mgw|mak|MAK)$|Dockerfile$
       - id: remove-tabs
         name: Remove tabs (2 spaces)
         args: ["--whitespaces-count", "2"]
@@ -52,12 +48,6 @@ repos:
     hooks:
       - id: clang-format
 
-  # We might enable this in future.
-  # - repo: https://github.com/pre-commit/mirrors-prettier
-  #   rev: ffb6a759a979008c0e6dff86e39f4745a2d9eac4 # v3.1.0
-  #   hooks:
-  #     - id: prettier
-
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0
     hooks:

zephyr/include/bacnet_settings/bacnet_settings.h

@@ -17,6 +17,15 @@
 #include "bacnet/bacint.h"
 #include "bacnet/wp.h"
 
+/**
+ * @brief Callback data for WriteProperty restore iterator
+ * @param write_function The WriteProperty function to call
+ * @param context The context to pass to the WriteProperty function
+ * @return true if the WriteProperty succeeded
+ */
+typedef bool (*bacnet_settings_restore_callback)(BACNET_WRITE_PROPERTY_DATA *wp_data,
+						 void *context);
+
 #ifdef __cplusplus
 extern "C" {
 #endif /* __cplusplus */
@@ -25,13 +34,7 @@ void bacnet_settings_basic_store(BACNET_OBJECT_TYPE object_type, uint32_t object
 				 BACNET_PROPERTY_ID object_property, BACNET_ARRAY_INDEX array_index,
 				 uint8_t *application_data, int application_data_len);
 bool bacnet_settings_write_property_store(BACNET_WRITE_PROPERTY_DATA *wp_data);
-bool bacnet_settings_restore(uint16_t object_type, uint32_t object_instance,
-					    uint32_t property_id, uint32_t array_index,
-						const void *data, size_t data_len,
-					    write_property_function write_function);
-bool bacnet_settings_write_property_restore(uint16_t object_type, uint32_t object_instance,
-					    uint32_t property_id, uint32_t array_index,
-					    write_property_function write_function);
+bool bacnet_settings_write_property_restore(bacnet_settings_restore_callback cb, void *context);
 
 int bacnet_settings_value_get(uint16_t object_type, uint32_t object_instance, uint32_t property_id,
 			      uint32_t array_index, BACNET_APPLICATION_DATA_VALUE *value);
@@ -71,6 +74,8 @@ int bacnet_settings_string_get(uint16_t object_type, uint32_t object_instance, u
 bool bacnet_settings_string_set(uint16_t object_type, uint32_t object_instance,
 				uint32_t property_id, uint32_t array_index, const char *value);
 
+bool bacnet_settings_init(void);
+
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */

zephyr/include/bacnet_settings/bacnet_storage.h

@@ -11,6 +11,8 @@
 
 #include <stddef.h>
 #include <stdint.h>
+#include <stdbool.h>
+#include <errno.h>
 #include <zephyr/settings/settings.h>
 
 #define BACNET_STORAGE_VALUE_SIZE_MAX   SETTINGS_MAX_VAL_LEN
@@ -25,19 +27,32 @@ typedef struct bacnet_storage_key_t {
 } BACNET_STORAGE_KEY;
 
 typedef int (*bacnet_storage_restore_callback)(BACNET_STORAGE_KEY *key, const void *data,
-					       size_t data_size);
+					       size_t data_size, void *context);
 
 #ifdef __cplusplus
 extern "C" {
 #endif /* __cplusplus */
 
-int bacnet_storage_init(bacnet_storage_restore_callback cb);
+int bacnet_storage_init(void);
+
+int bacnet_storage_load_callback_set(bacnet_storage_restore_callback cb, void *context);
+int bacnet_storage_load(void);
+
+int bacnet_storage_handler_set(const char *name, size_t len, settings_read_cb read_cb,
+			       void *cb_arg);
+int bacnet_storage_handler_commit(void);
+int bacnet_storage_handler_export(int (*cb)(const char *name, const void *value, size_t val_len));
+
+bool bacnet_storage_strtoul(const char *search_name, unsigned long *long_value);
+
 void bacnet_storage_key_init(BACNET_STORAGE_KEY *key, uint16_t object_type,
 			     uint32_t object_instance, uint32_t property_id, uint32_t array_index);
 int bacnet_storage_key_decode(const char *path, BACNET_STORAGE_KEY *key);
 int bacnet_storage_key_encode(char *buffer, size_t buffer_size, BACNET_STORAGE_KEY *key);
+
 int bacnet_storage_set(BACNET_STORAGE_KEY *key, const void *data, size_t data_size);
 int bacnet_storage_get(BACNET_STORAGE_KEY *key, void *data, size_t data_size);
+int bacnet_storage_delete(BACNET_STORAGE_KEY *key);
 
 #ifdef __cplusplus
 }

zephyr/samples/profiles/b-ld/src/main.c

@@ -64,38 +64,25 @@ void BACnet_Lighting_Output_Tracking_Value_Handler(uint32_t object_instance, flo
 		(double)value, (unsigned)steps, (unsigned)UINT16_MAX);
 }
 
+/**
+ * @brief Callback data for WriteProperty restore iterator
+ * @param write_function The WriteProperty function to call
+ * @param context The context to pass to the WriteProperty function
+ * @return true if the WriteProperty succeeded
+ */
+static bool Settings_Restore_Callback(BACNET_WRITE_PROPERTY_DATA *wp_data, void *context)
+{
+	(void)context;
+	return Device_Write_Property(wp_data);
+}
+
 /**
  * @brief BACnet Project Initialization Handler
  * @param context [in] The context to pass to the callback function
  * @note This is called from the BACnet task
  */
 static void BACnet_Lighting_Device_Init_Handler(void *context)
 {
-	uint32_t array_index = BACNET_ARRAY_ALL;
-	bool status = false;
-	int i;
-	int32_t lighting_output_writeable_property_list[] = {
-		/* list of properties to set via WriteProperty */
-		PROP_OUT_OF_SERVICE,
-		PROP_DEFAULT_FADE_TIME,
-		PROP_DEFAULT_RAMP_RATE,
-		PROP_DEFAULT_STEP_INCREMENT,
-		PROP_TRANSITION,
-		PROP_PRESENT_VALUE,
-		PROP_RELINQUISH_DEFAULT,
-		PROP_BLINK_WARN_ENABLE,
-		PROP_EGRESS_TIME,
-		PROP_DEFAULT_FADE_TIME,
-		PROP_DEFAULT_RAMP_RATE,
-		PROP_LIGHTING_COMMAND_DEFAULT_PRIORITY,
-		PROP_DEFAULT_STEP_INCREMENT,
-		PROP_TRANSITION};
-	int32_t device_writeable_property_list[] = {
-		/* list of properties to set via WriteProperty */
-		PROP_OBJECT_IDENTIFIER,
-		PROP_OBJECT_NAME,
-	};
-
 	(void)context;
 	LOG_INF("BACnet Stack Initialized");
 	/* initialize objects with default values for this basic sample */
@@ -105,25 +92,10 @@ static void BACnet_Lighting_Device_Init_Handler(void *context)
 	Lighting_Output_Create(Lighting_Instance);
 	Lighting_Output_Name_Set(Lighting_Instance, "Light-1");
 	/* restore any property values previously stored via WriteProperty */
-	for (i = 0; i < ARRAY_SIZE(device_writeable_property_list); i++) {
-		status = bacnet_settings_write_property_restore(
-			OBJECT_DEVICE, BACNET_MAX_INSTANCE, device_writeable_property_list[i],
-			array_index, Device_Write_Property_Local);
-		if (!status) {
-			/* no settings stored for this property, use defaults */
-		}
-	}
-	for (i = 0; i < ARRAY_SIZE(lighting_output_writeable_property_list); i++) {
-		status = bacnet_settings_write_property_restore(
-			OBJECT_LIGHTING_OUTPUT, Lighting_Instance,
-			lighting_output_writeable_property_list[i], array_index,
-			Lighting_Output_Write_Property);
-		if (!status) {
-			/* no settings stored for this property, use defaults */
-		}
-	}
-	/* These writable property values are stored WriteProperty.
-	   Set this callback after init to prevent recursion. */
+	bacnet_settings_init();
+	bacnet_settings_write_property_restore(&Settings_Restore_Callback, NULL);
+	/* writable property values are stored with WriteProperty.
+	   Set this callback after restore to prevent recursion. */
 	bacnet_basic_store_callback_set(bacnet_settings_basic_store);
 	/* lighting output callbacks */
 	Lighting_Output_Write_Present_Value_Callback_Set(

zephyr/samples/profiles/b-ls/src/main.c

@@ -101,6 +101,18 @@ void Binary_Lighting_Output_Blink_Warn_Handler(uint32_t object_instance)
 	LOG_INF("Binary Lighting Output[%lu]: Blink Warning", (unsigned long)object_instance);
 }
 
+/**
+ * @brief Callback data for WriteProperty restore iterator
+ * @param write_function The WriteProperty function to call
+ * @param context The context to pass to the WriteProperty function
+ * @return true if the WriteProperty succeeded
+ */
+static bool Settings_Restore_Callback(BACNET_WRITE_PROPERTY_DATA *wp_data, void *context)
+{
+	(void)context;
+	return Device_Write_Property(wp_data);
+}
+
 /**
  * @brief BACnet Project Initialization Handler
  * @param context [in] The context to pass to the callback function
@@ -109,35 +121,6 @@ void Binary_Lighting_Output_Blink_Warn_Handler(uint32_t object_instance)
 static void BACnet_Lighting_Device_Init_Handler(void *context)
 {
 	BACNET_DEVICE_OBJECT_PROPERTY_REFERENCE member;
-	uint32_t array_index = BACNET_ARRAY_ALL;
-	bool status = false;
-	int i;
-	int32_t channel_writeable_property_list[] = {
-		/* list of properties to set via WriteProperty */
-		PROP_PRESENT_VALUE,  PROP_OUT_OF_SERVICE, PROP_LIST_OF_OBJECT_PROPERTY_REFERENCES,
-		PROP_CHANNEL_NUMBER, PROP_CONTROL_GROUPS,
-	};
-	int32_t lighting_output_writeable_property_list[] = {
-		/* list of properties to set via WriteProperty */
-		PROP_OUT_OF_SERVICE,
-		PROP_DEFAULT_FADE_TIME,
-		PROP_DEFAULT_RAMP_RATE,
-		PROP_DEFAULT_STEP_INCREMENT,
-		PROP_TRANSITION,
-		PROP_PRESENT_VALUE,
-		PROP_RELINQUISH_DEFAULT,
-		PROP_BLINK_WARN_ENABLE,
-		PROP_EGRESS_TIME,
-		PROP_DEFAULT_FADE_TIME,
-		PROP_DEFAULT_RAMP_RATE,
-		PROP_LIGHTING_COMMAND_DEFAULT_PRIORITY,
-		PROP_DEFAULT_STEP_INCREMENT,
-		PROP_TRANSITION};
-	int32_t device_writeable_property_list[] = {
-		/* list of properties to set via WriteProperty */
-		PROP_OBJECT_IDENTIFIER,
-		PROP_OBJECT_NAME,
-	};
 
 	(void)context;
 	LOG_INF("BACnet Stack Initialized");
@@ -164,33 +147,10 @@ static void BACnet_Lighting_Device_Init_Handler(void *context)
 	member.deviceIdentifier.instance = Device_Instance;
 	Channel_Reference_List_Member_Element_Set(Channel_Instance, 1, &member);
 	/* restore any property values previously stored via WriteProperty */
-	for (i = 0; i < ARRAY_SIZE(device_writeable_property_list); i++) {
-		status = bacnet_settings_write_property_restore(
-			OBJECT_DEVICE, BACNET_MAX_INSTANCE, device_writeable_property_list[i],
-			array_index, Device_Write_Property_Local);
-		if (!status) {
-			/* no settings stored for this property, use defaults */
-		}
-	}
-	for (i = 0; i < ARRAY_SIZE(lighting_output_writeable_property_list); i++) {
-		status = bacnet_settings_write_property_restore(
-			OBJECT_LIGHTING_OUTPUT, Lighting_Instance,
-			lighting_output_writeable_property_list[i], array_index,
-			Lighting_Output_Write_Property);
-		if (!status) {
-			/* no settings stored for this property, use defaults */
-		}
-	}
-	for (i = 0; i < ARRAY_SIZE(channel_writeable_property_list); i++) {
-		status = bacnet_settings_write_property_restore(
-			OBJECT_CHANNEL, Channel_Instance, channel_writeable_property_list[i],
-			array_index, Channel_Write_Property);
-		if (!status) {
-			/* no settings stored for this property, use defaults */
-		}
-	}
-	/* These writable property values are stored WriteProperty.
-	   Set this callback after init to prevent recursion. */
+	bacnet_settings_init();
+	bacnet_settings_write_property_restore(&Settings_Restore_Callback, NULL);
+	/* writable property values are stored with WriteProperty.
+	   Set this callback after restore to prevent recursion. */
 	bacnet_basic_store_callback_set(bacnet_settings_basic_store);
 	/* lighting output callbacks */
 	Lighting_Output_Write_Present_Value_Callback_Set(Lighting_Output_Tracking_Value_Handler);

zephyr/samples/profiles/b-sa/src/main.c

@@ -44,27 +44,25 @@ static void BACnet_Smart_Actuator_Datalink_Init(void)
 	/* nothing to do */
 }
 
+/**
+ * @brief Callback data for WriteProperty restore iterator
+ * @param write_function The WriteProperty function to call
+ * @param context The context to pass to the WriteProperty function
+ * @return true if the WriteProperty succeeded
+ */
+static bool Settings_Restore_Callback(BACNET_WRITE_PROPERTY_DATA *wp_data, void *context)
+{
+	(void)context;
+	return Device_Write_Property(wp_data);
+}
+
 /**
  * @brief BACnet Project Initialization Handler
  * @param context [in] The context to pass to the callback function
  * @note This is called from the BACnet task
  */
 static void BACnet_Smart_Actuator_Init_Handler(void *context)
 {
-	uint32_t array_index = BACNET_ARRAY_ALL;
-	bool status = false;
-	int i;
-	int32_t analog_output_writeable_property_list[] = {
-		/* list of properties to set via WriteProperty */
-		PROP_OUT_OF_SERVICE, PROP_PRESENT_VALUE,  PROP_UNITS,
-		PROP_COV_INCREMENT,  PROP_MIN_PRES_VALUE, PROP_MAX_PRES_VALUE,
-	};
-	int32_t device_writeable_property_list[] = {
-		/* list of properties to set via WriteProperty */
-		PROP_OBJECT_IDENTIFIER,
-		PROP_OBJECT_NAME,
-	};
-
 	(void)context;
 	LOG_INF("BACnet Stack Initialized");
 	BACnet_Smart_Actuator_Datalink_Init();
@@ -78,25 +76,10 @@ static void BACnet_Smart_Actuator_Init_Handler(void *context)
 	Analog_Output_Min_Pres_Value_Set(Actuator_Instance, 0.0f);
 	Analog_Output_Max_Pres_Value_Set(Actuator_Instance, 100.0f);
 	/* restore any property values previously stored via WriteProperty */
-	for (i = 0; i < ARRAY_SIZE(device_writeable_property_list); i++) {
-		status = bacnet_settings_write_property_restore(
-			OBJECT_DEVICE, BACNET_MAX_INSTANCE, device_writeable_property_list[i],
-			array_index, Device_Write_Property_Local);
-		if (!status) {
-			/* no settings stored for this property, use defaults */
-		}
-	}
-	for (i = 0; i < ARRAY_SIZE(analog_output_writeable_property_list); i++) {
-		status = bacnet_settings_write_property_restore(
-			OBJECT_ANALOG_OUTPUT, Actuator_Instance,
-			analog_output_writeable_property_list[i], array_index,
-			Analog_Output_Write_Property);
-		if (!status) {
-			/* no settings stored for this property, use defaults */
-		}
-	}
-	/* These writable property values are stored WriteProperty.
-	   Set this callback after init to prevent recursion. */
+	bacnet_settings_init();
+	bacnet_settings_write_property_restore(&Settings_Restore_Callback, NULL);
+	/* writable property values are stored with WriteProperty.
+	   Set this callback after restore to prevent recursion. */
 	bacnet_basic_store_callback_set(bacnet_settings_basic_store);
 	LOG_INF("BACnet Device ID: %u", Device_Object_Instance_Number());
 	/* start the seconds cyclic timer */