Updated zephyr sample profiles B-LD B-LS B-SA and B-SS to use BACnet settings subsys.

Author: skarg

.pre-commit-config.yaml

@@ -16,7 +16,7 @@ exclude: build|\.git|external/|BACnet\-Server\.X/|tools/(avstack|check\-stack\-u
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: 2c9f875913ee60ca25ce70243dc24d5b6415598c # v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-merge-conflict
         args: [--assume-in-merge]
@@ -36,7 +36,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/Lucas-C/pre-commit-hooks
-    rev: a30f0d816e5062a67d87c8de753cfe499672b959 # v1.5.5
+    rev: v1.5.5
     hooks:
       - id: remove-tabs
         name: Remove tabs (4 spaces)
@@ -48,7 +48,7 @@ repos:
         files: '.*\.(yaml|yml|html|htm)|Dockerfile$'
 
   - repo: https://github.com/pre-commit/mirrors-clang-format
-    rev: 05241dc3def184dba136e62d54ff57f1c8a497a9 # v17.0.6
+    rev: v20.1.5
     hooks:
       - id: clang-format
 
@@ -59,12 +59,12 @@ repos:
   #     - id: prettier
 
   - repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.10.0 # v1.10.0
+    rev: v1.10.0
     hooks:
       - id: text-unicode-replacement-char
 
   - repo: https://github.com/editorconfig-checker/editorconfig-checker.python
-    rev: 3.2.0 #2.6.2
+    rev: 3.2.0
     hooks:
       - id: editorconfig-checker
         alias: ec

zephyr/include/bacnet_settings/bacnet_settings.h

@@ -21,6 +21,9 @@
 extern "C" {
 #endif /* __cplusplus */
 
+void bacnet_settings_basic_store(BACNET_OBJECT_TYPE object_type, uint32_t object_instance,
+				 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_write_property_restore(uint16_t object_type, uint32_t object_instance,
 					    uint32_t property_id, uint32_t array_index,

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

@@ -26,12 +26,15 @@
 #include "bacnet/basic/server/bacnet_basic.h"
 #include "bacnet/basic/server/bacnet_port.h"
 
+/* BACnet Stack Zephyr services */
+#include <bacnet_settings/bacnet_settings.h>
 /* Logging module registration is already done in ports/zephyr/main.c */
-#include "bacnet_osif/bacnet_log.h"
+#include <bacnet_osif/bacnet_log.h>
 LOG_MODULE_DECLARE(bacnet, CONFIG_BACNETSTACK_LOG_LEVEL);
 
-/* FIXME: get the device instance and name from settings! */
+/* Default values before we get the device instance and name from settings */
 static const char *Device_Name = "BACnet Lighting Device (B-LD)";
+static const uint32_t Device_Instance = 260125;
 /* object instances */
 static const uint32_t Lighting_Instance = 1;
 
@@ -68,14 +71,64 @@ void BACnet_Lighting_Output_Tracking_Value_Handler(uint32_t object_instance, flo
  */
 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 for this basic sample */
+	/* initialize objects with default values for this basic sample */
+	Device_Set_Object_Instance_Number(Device_Instance);
 	Device_Object_Name_ANSI_Init(Device_Name);
+	/* lighting output object */
 	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_basic_store_callback_set(bacnet_settings_basic_store);
+	/* lighting output callbacks */
 	Lighting_Output_Write_Present_Value_Callback_Set(
 		BACnet_Lighting_Output_Tracking_Value_Handler);
+	/* done */
 	LOG_INF("BACnet Device ID: %u", Device_Object_Instance_Number());
 	/* set the BACnet Basic Task device object timer for lighting output use */
 	bacnet_basic_task_object_timer_set(10UL);
@@ -94,24 +147,22 @@ static void BACnet_Lighting_Device_Task_Handler(void *context)
 
 int main(void)
 {
+	bool port_initialized = false;
+
 	LOG_INF("BACnet Device: %s", Device_Name);
 	LOG_INF("BACnet Stack Version " BACNET_VERSION_TEXT);
 	LOG_INF("BACnet Stack Max APDU: %d", MAX_APDU);
 	bacnet_basic_init_callback_set(BACnet_Lighting_Device_Init_Handler, NULL);
 	bacnet_basic_task_callback_set(BACnet_Lighting_Device_Task_Handler, NULL);
 	bacnet_basic_init();
-	for (;;) {
-		if (bacnet_port_init()) {
-			break;
-		} else {
-			LOG_ERR("Server: port initialization failed");
-			k_sleep(K_MSEC(1000));
-		}
-	}
 	for (;;) {
 		k_sleep(K_MSEC(CONFIG_BACNET_BASIC_SERVER_KSLEEP));
 		bacnet_basic_task();
-		bacnet_port_task();
+		if (port_initialized) {
+			bacnet_port_task();
+		} else {
+			port_initialized = bacnet_port_init();
+		}
 	}
 
 	return 0;

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

@@ -36,7 +36,7 @@
 #include <bacnet_osif/bacnet_log.h>
 LOG_MODULE_DECLARE(bacnet, CONFIG_BACNETSTACK_LOG_LEVEL);
 
-/* FIXME: get the device instance and name from settings! */
+/* Default values before we get the device instance and name from settings */
 static const uint32_t Device_Instance = 260126;
 static const char *Device_Name = "BACnet Lighting Supervisor (B-LS)";
 /* instances for our objects */
@@ -141,20 +141,15 @@ static void BACnet_Lighting_Device_Init_Handler(void *context)
 
 	(void)context;
 	LOG_INF("BACnet Stack Initialized");
-	/* initialize objects for this basic sample */
-	Device_Init(NULL);
+	/* initialize objects with default values for this basic sample */
 	Device_Set_Object_Instance_Number(Device_Instance);
 	Device_Object_Name_ANSI_Init(Device_Name);
 	/* lighting output object */
 	Lighting_Output_Create(Lighting_Instance);
 	Lighting_Output_Name_Set(Lighting_Instance, "Light-1");
-	Lighting_Output_Write_Present_Value_Callback_Set(Lighting_Output_Tracking_Value_Handler);
 	/* binary lighting output object */
 	Binary_Lighting_Output_Create(Binary_Lighting_Instance);
 	Binary_Lighting_Output_Name_Set(Binary_Lighting_Instance, "Binary-Light-1");
-	Binary_Lighting_Output_Write_Value_Callback_Set(
-		Binary_Lighting_Output_Present_Value_Handler);
-	Binary_Lighting_Output_Blink_Warn_Callback_Set(Binary_Lighting_Output_Blink_Warn_Handler);
 	/* channel object */
 	Channel_Create(Channel_Instance);
 	Channel_Name_Set(Channel_Instance, "Lights");
@@ -196,7 +191,12 @@ static void BACnet_Lighting_Device_Init_Handler(void *context)
 	}
 	/* These writable property values are stored WriteProperty.
 	   Set this callback after init to prevent recursion. */
-	Device_Write_Property_Store_Callback_Set(bacnet_settings_write_property_store);
+	bacnet_basic_store_callback_set(bacnet_settings_basic_store);
+	/* lighting output callbacks */
+	Lighting_Output_Write_Present_Value_Callback_Set(Lighting_Output_Tracking_Value_Handler);
+	Binary_Lighting_Output_Write_Value_Callback_Set(
+		Binary_Lighting_Output_Present_Value_Handler);
+	Binary_Lighting_Output_Blink_Warn_Callback_Set(Binary_Lighting_Output_Blink_Warn_Handler);
 	/* link WriteGroup service to our channel object  */
 	Write_Group_Notification.callback = Channel_Write_Group;
 	handler_write_group_notification_add(&Write_Group_Notification);

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

@@ -31,7 +31,7 @@
 #include <bacnet_osif/bacnet_log.h>
 LOG_MODULE_DECLARE(bacnet, CONFIG_BACNETSTACK_LOG_LEVEL);
 
-/* FIXME: get the device instance and name from settings! */
+/* Default values before we get the device instance and name from settings */
 static const uint32_t Device_Instance = 260124;
 static const char *Device_Name = "BACnet Smart Actuator (B-SA)";
 /* object instances */
@@ -97,7 +97,7 @@ static void BACnet_Smart_Actuator_Init_Handler(void *context)
 	}
 	/* These writable property values are stored WriteProperty.
 	   Set this callback after init to prevent recursion. */
-	Device_Write_Property_Store_Callback_Set(bacnet_settings_write_property_store);
+	bacnet_basic_store_callback_set(bacnet_settings_basic_store);
 	LOG_INF("BACnet Device ID: %u", Device_Object_Instance_Number());
 	/* start the seconds cyclic timer */
 	mstimer_set(&Actuator_Update_Timer, 1000);

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

@@ -9,7 +9,6 @@
 #include <zephyr/random/random.h>
 #include <stdint.h>
 #include <stdlib.h>
-
 /* BACnet Stack defines - first */
 #include "bacnet/bacdef.h"
 /* BACnet Stack core API */
@@ -31,7 +30,9 @@
 #include <bacnet_osif/bacnet_log.h>
 LOG_MODULE_DECLARE(bacnet, CONFIG_BACNETSTACK_LOG_LEVEL);
 
+/* Default values before we get the device instance and name from settings */
 static const char *Device_Name = "BACnet Smart Sensor (B-SS)";
+static const uint32_t Device_Instance = 260121;
 /* object instances */
 static const uint32_t Sensor_Instance = 1;
 /* timer for Sensor Update Interval */
@@ -64,6 +65,7 @@ static void BACnet_Smart_Sensor_Init_Handler(void *context)
 	(void)context;
 	LOG_INF("BACnet Stack Initialized");
 	/* initialize objects with default values for this basic sample */
+	Device_Set_Object_Instance_Number(Device_Instance);
 	Device_Object_Name_ANSI_Init(Device_Name);
 	Analog_Input_Create(Sensor_Instance);
 	Analog_Input_Name_Set(Sensor_Instance, "Sensor");
@@ -90,7 +92,7 @@ static void BACnet_Smart_Sensor_Init_Handler(void *context)
 	}
 	/* These writable property values are stored WriteProperty.
 	   Set this callback after init to prevent recursion. */
-	Device_Write_Property_Store_Callback_Set(bacnet_settings_write_property_store);
+	bacnet_basic_store_callback_set(bacnet_settings_basic_store);
 	LOG_INF("BACnet Device ID: %u", Device_Object_Instance_Number());
 	/* start the seconds cyclic timer */
 	mstimer_set(&Sensor_Update_Timer, 1000);

zephyr/subsys/bacnet_settings/bacnet_settings.c

@@ -19,6 +19,27 @@
 #include "bacnet/proplist.h"
 #include "bacnet/wp.h"
 
+/**
+ * @brief Store the BACnet data after a WriteProperty for object property
+ * @param object_type - BACnet object type
+ * @param object_instance - BACnet object instance
+ * @param object_property - BACnet object property
+ * @param array_index - BACnet array index
+ * @param application_data - pointer to the data
+ * @param application_data_len - length of the data
+ * @note Used directly with bacnet_basic_store_callback_set() function
+ */
+void bacnet_settings_basic_store(BACNET_OBJECT_TYPE object_type, uint32_t object_instance,
+				 BACNET_PROPERTY_ID object_property, BACNET_ARRAY_INDEX array_index,
+				 uint8_t *application_data, int application_data_len)
+{
+	BACNET_STORAGE_KEY key = {0};
+
+	bacnet_storage_key_init(&key, object_type, object_instance, object_property, array_index);
+	/* store the data */
+	(void)bacnet_storage_set(&key, application_data, application_data_len);
+}
+
 /**
  * @brief Store application data to an object property after a successful
  *  WriteProperty of the object property