net: lwm2m: Add IPSO voltage sensor object

Add support fot the IPSO voltage sensor object

Signed-off-by: Dave Lacerte <[email protected]>

Author: DaveLacerte

include/zephyr/net/lwm2m.h

@@ -64,6 +64,7 @@
 #define IPSO_OBJECT_HUMIDITY_SENSOR_ID      3304
 #define IPSO_OBJECT_LIGHT_CONTROL_ID        3311
 #define IPSO_OBJECT_ACCELEROMETER_ID        3313
+#define IPSO_OBJECT_VOLTAGE_SENSOR_ID       3316
 #define IPSO_OBJECT_CURRENT_SENSOR_ID       3317
 #define IPSO_OBJECT_PRESSURE_ID             3323
 #define IPSO_OBJECT_BUZZER_ID               3338

subsys/net/lib/lwm2m/CMakeLists.txt

@@ -111,6 +111,9 @@ zephyr_library_sources_ifdef(CONFIG_LWM2M_IPSO_PUSH_BUTTON
 zephyr_library_sources_ifdef(CONFIG_LWM2M_IPSO_CURRENT_SENSOR
     ipso_current_sensor.c
     )
+zephyr_library_sources_ifdef(CONFIG_LWM2M_IPSO_VOLTAGE_SENSOR
+    ipso_voltage_sensor.c
+    )
 zephyr_library_sources_ifdef(CONFIG_LWM2M_IPSO_FILLING_SENSOR
     ipso_filling_sensor.c
     )

subsys/net/lib/lwm2m/Kconfig.ipso

@@ -318,6 +318,39 @@ config LWM2M_IPSO_CURRENT_SENSOR_VERSION_1_1
 
 endchoice
 
+config LWM2M_IPSO_VOLTAGE_SENSOR
+	bool "IPSO Voltage Sensor Support"
+	help
+	  This IPSO object should be used with a voltage sensor to
+	  report a voltage measurement. It also provides resources for
+	  minimum/maximum measured values and the minimum/maximum range
+	  that can be measured by the sensor.
+
+config LWM2M_IPSO_VOLTAGE_SENSOR_INSTANCE_COUNT
+	int "Maximum # of IPSO Voltage Sensor object instances"
+	default 1
+	depends on LWM2M_IPSO_VOLTAGE_SENSOR
+	help
+	  This setting establishes the total count of IPSO Voltage
+	  Sensor instances available to the LWM2M client.
+
+choice LWM2M_IPSO_VOLTAGE_SENSOR_VERSION
+	prompt "IPSO Voltage object version"
+	default LWM2M_IPSO_VOLTAGE_SENSOR_VERSION_1_0
+	depends on LWM2M_IPSO_VOLTAGE_SENSOR
+	help
+	  Select which version of the IPSO Voltage object should be used.
+
+config LWM2M_IPSO_VOLTAGE_SENSOR_VERSION_1_0
+	bool "IPSO Voltage object version 1.0"
+
+config LWM2M_IPSO_VOLTAGE_SENSOR_VERSION_1_1
+	bool "IPSO Voltage object version 1.1"
+	help
+	  Adds timestamp and measurement quality
+
+endchoice
+
 config LWM2M_IPSO_FILLING_SENSOR
 	bool "IPSO Filling sensor Support"
 	help

subsys/net/lib/lwm2m/ipso_voltage_sensor.c

@@ -0,0 +1,233 @@
+/*
+ * Copyright (c) 2021 Laird Connectivity
+ * Copyright (c) 2023 Hydro-Quebec
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/*
+ * Voltage sensor
+ * https://github.com/OpenMobileAlliance/lwm2m-registry/blob/prod/3316.xml
+ */
+
+#define LOG_MODULE_NAME net_ipso_voltage_sensor
+#define LOG_LEVEL CONFIG_LWM2M_LOG_LEVEL
+
+#include <zephyr/logging/log.h>
+LOG_MODULE_REGISTER(LOG_MODULE_NAME);
+
+#include <stdint.h>
+#include <zephyr/init.h>
+
+#include "lwm2m_object.h"
+#include "lwm2m_engine.h"
+#include "lwm2m_resource_ids.h"
+
+#define VOLTAGE_VERSION_MAJOR 1
+
+#if defined(CONFIG_LWM2M_IPSO_VOLTAGE_SENSOR_VERSION_1_1)
+#define VOLTAGE_VERSION_MINOR 1
+#define NUMBER_OF_OBJ_FIELDS 13
+#else
+#define VOLTAGE_VERSION_MINOR 0
+#define NUMBER_OF_OBJ_FIELDS 9
+#endif /* defined(CONFIG_LWM2M_IPSO_VOLTAGE_SENSOR_VERSION_1_1) */
+
+#define MAX_INSTANCE_COUNT CONFIG_LWM2M_IPSO_VOLTAGE_SENSOR_INSTANCE_COUNT
+
+#define IPSO_OBJECT_ID IPSO_OBJECT_VOLTAGE_SENSOR_ID
+
+#define UNIT_STR_MAX_SIZE 8
+#define APP_TYPE_STR_MAX_SIZE 32
+
+/*
+ * Calculate resource instances as follows:
+ * start with NUMBER_OF_OBJ_FIELDS
+ * subtract EXEC resources (1)
+ */
+#define RESOURCE_INSTANCE_COUNT (NUMBER_OF_OBJ_FIELDS - 1)
+
+/* resource state variables */
+static double sensor_value[MAX_INSTANCE_COUNT];
+static char units[MAX_INSTANCE_COUNT][UNIT_STR_MAX_SIZE];
+static double min_measured_value[MAX_INSTANCE_COUNT];
+static double max_measured_value[MAX_INSTANCE_COUNT];
+static double min_range_value[MAX_INSTANCE_COUNT];
+static double max_range_value[MAX_INSTANCE_COUNT];
+static double calibration_coefficient[MAX_INSTANCE_COUNT];
+static char app_type[MAX_INSTANCE_COUNT][APP_TYPE_STR_MAX_SIZE];
+
+static struct lwm2m_engine_obj sensor;
+static struct lwm2m_engine_obj_field fields[] = {
+	OBJ_FIELD_DATA(SENSOR_VALUE_RID, R, FLOAT),
+	OBJ_FIELD_DATA(SENSOR_UNITS_RID, R_OPT, STRING),
+	OBJ_FIELD_DATA(MIN_MEASURED_VALUE_RID, R_OPT, FLOAT),
+	OBJ_FIELD_DATA(MAX_MEASURED_VALUE_RID, R_OPT, FLOAT),
+	OBJ_FIELD_DATA(MIN_RANGE_VALUE_RID, R_OPT, FLOAT),
+	OBJ_FIELD_DATA(MAX_RANGE_VALUE_RID, R_OPT, FLOAT),
+	OBJ_FIELD_EXECUTE_OPT(RESET_MIN_MAX_MEASURED_VALUES_RID),
+	OBJ_FIELD_DATA(APPLICATION_TYPE_RID, RW_OPT, STRING),
+	OBJ_FIELD_DATA(CURRENT_CALIBRATION_RID, R_OPT, FLOAT),
+#if defined(CONFIG_LWM2M_IPSO_VOLTAGE_SENSOR_VERSION_1_1)
+	OBJ_FIELD_DATA(TIMESTAMP_RID, R_OPT, TIME),
+	OBJ_FIELD_DATA(FRACTIONAL_TIMESTAMP_RID, R_OPT, FLOAT),
+	OBJ_FIELD_DATA(MEASUREMENT_QUALITY_INDICATOR_RID, R_OPT, U8),
+	OBJ_FIELD_DATA(MEASUREMENT_QUALITY_LEVEL_RID, R_OPT, U8),
+#endif
+};
+
+static struct lwm2m_engine_obj_inst inst[MAX_INSTANCE_COUNT];
+static struct lwm2m_engine_res res[MAX_INSTANCE_COUNT][NUMBER_OF_OBJ_FIELDS];
+static struct lwm2m_engine_res_inst res_inst[MAX_INSTANCE_COUNT]
+					    [RESOURCE_INSTANCE_COUNT];
+
+static void update_min_measured(uint16_t obj_inst_id, int index)
+{
+	min_measured_value[index] = sensor_value[index];
+	lwm2m_notify_observer(IPSO_OBJECT_ID, obj_inst_id, MIN_MEASURED_VALUE_RID);
+}
+
+static void update_max_measured(uint16_t obj_inst_id, int index)
+{
+	max_measured_value[index] = sensor_value[index];
+	lwm2m_notify_observer(IPSO_OBJECT_ID, obj_inst_id, MAX_MEASURED_VALUE_RID);
+}
+
+static int reset_min_max_measured_values_cb(uint16_t obj_inst_id,
+					    uint8_t *args, uint16_t args_len)
+{
+	int i;
+
+	LOG_DBG("RESET MIN/MAX %d", obj_inst_id);
+	for (i = 0; i < MAX_INSTANCE_COUNT; i++) {
+		if (inst[i].obj && inst[i].obj_inst_id == obj_inst_id) {
+			update_min_measured(obj_inst_id, i);
+			update_max_measured(obj_inst_id, i);
+			return 0;
+		}
+	}
+
+	return -ENOENT;
+}
+
+static int sensor_value_write_cb(uint16_t obj_inst_id, uint16_t res_id,
+				 uint16_t res_inst_id, uint8_t *data,
+				 uint16_t data_len, bool last_block,
+				 size_t total_size)
+{
+	int i;
+
+	for (i = 0; i < MAX_INSTANCE_COUNT; i++) {
+		if (inst[i].obj && inst[i].obj_inst_id == obj_inst_id) {
+			/* update min / max */
+			if (sensor_value[i] < min_measured_value[i]) {
+				update_min_measured(obj_inst_id, i);
+			}
+
+			if (sensor_value[i] > max_measured_value[i]) {
+				update_max_measured(obj_inst_id, i);
+			}
+
+			break;
+		}
+	}
+
+	return 0;
+}
+
+static struct lwm2m_engine_obj_inst *voltage_sensor_create(uint16_t obj_inst_id)
+{
+	int index, i = 0, j = 0;
+
+	/* Check that there is no other instance with this ID */
+	for (index = 0; index < MAX_INSTANCE_COUNT; index++) {
+		if (inst[index].obj && inst[index].obj_inst_id == obj_inst_id) {
+			LOG_ERR("Can not create instance - "
+				"already existing: %u",
+				obj_inst_id);
+			return NULL;
+		}
+	}
+
+	for (index = 0; index < MAX_INSTANCE_COUNT; index++) {
+		if (!inst[index].obj) {
+			break;
+		}
+	}
+
+	if (index >= MAX_INSTANCE_COUNT) {
+		LOG_ERR("Can not create instance - no more room: %u",
+			obj_inst_id);
+		return NULL;
+	}
+
+	/* Set default values (objects can be removed/recreated during runtime) */
+	units[index][0] = '\0';
+	min_measured_value[index] = INT32_MAX;
+	max_measured_value[index] = -INT32_MAX;
+	min_range_value[index] = 0;
+	max_range_value[index] = 0;
+	calibration_coefficient[index] = 1;
+	app_type[index][0] = '\0';
+
+	(void)memset(res[index], 0,
+		     sizeof(res[index][0]) * ARRAY_SIZE(res[index]));
+	init_res_instance(res_inst[index], ARRAY_SIZE(res_inst[index]));
+
+	/* initialize instance resource data */
+	INIT_OBJ_RES(SENSOR_VALUE_RID, res[index], i, res_inst[index], j, 1,
+		     false, true, &sensor_value[index], sizeof(*sensor_value),
+		     NULL, NULL, NULL, sensor_value_write_cb, NULL);
+	INIT_OBJ_RES_DATA(SENSOR_UNITS_RID, res[index], i, res_inst[index], j,
+			  units[index], UNIT_STR_MAX_SIZE);
+	INIT_OBJ_RES_DATA(MIN_MEASURED_VALUE_RID, res[index], i,
+			  res_inst[index], j, &min_measured_value[index],
+			  sizeof(*min_measured_value));
+	INIT_OBJ_RES_DATA(MAX_MEASURED_VALUE_RID, res[index], i,
+			  res_inst[index], j, &max_measured_value[index],
+			  sizeof(*max_measured_value));
+	INIT_OBJ_RES_DATA(MIN_RANGE_VALUE_RID, res[index], i, res_inst[index],
+			  j, &min_range_value[index], sizeof(*min_range_value));
+	INIT_OBJ_RES_DATA(MAX_RANGE_VALUE_RID, res[index], i, res_inst[index],
+			  j, &max_range_value[index], sizeof(*max_range_value));
+	INIT_OBJ_RES_EXECUTE(RESET_MIN_MAX_MEASURED_VALUES_RID, res[index], i,
+			     reset_min_max_measured_values_cb);
+	INIT_OBJ_RES_DATA(CURRENT_CALIBRATION_RID, res[index], i,
+			  res_inst[index], j, &calibration_coefficient[index],
+			  sizeof(*calibration_coefficient));
+	INIT_OBJ_RES_DATA(APPLICATION_TYPE_RID, res[index], i, res_inst[index],
+			  j, app_type[index], APP_TYPE_STR_MAX_SIZE);
+
+#if defined(CONFIG_LWM2M_IPSO_VOLTAGE_SENSOR_VERSION_1_1)
+	INIT_OBJ_RES_OPTDATA(TIMESTAMP_RID, res[index], i, res_inst[index], j);
+	INIT_OBJ_RES_OPTDATA(FRACTIONAL_TIMESTAMP_RID, res[index], i,
+			     res_inst[index], j);
+	INIT_OBJ_RES_OPTDATA(MEASUREMENT_QUALITY_INDICATOR_RID, res[index], i,
+			     res_inst[index], j);
+	INIT_OBJ_RES_OPTDATA(MEASUREMENT_QUALITY_LEVEL_RID, res[index], i,
+			     res_inst[index], j);
+#endif
+
+	inst[index].resources = res[index];
+	inst[index].resource_count = i;
+	LOG_DBG("Created IPSO Voltage Sensor instance: %d", obj_inst_id);
+	return &inst[index];
+}
+
+static int ipso_voltage_sensor_init(const struct device *dev)
+{
+	sensor.obj_id = IPSO_OBJECT_ID;
+	sensor.version_major = VOLTAGE_VERSION_MAJOR;
+	sensor.version_minor = VOLTAGE_VERSION_MINOR;
+	sensor.is_core = false;
+	sensor.fields = fields;
+	sensor.field_count = ARRAY_SIZE(fields);
+	sensor.max_instance_count = MAX_INSTANCE_COUNT;
+	sensor.create_cb = voltage_sensor_create;
+	lwm2m_register_obj(&sensor);
+
+	return 0;
+}
+
+SYS_INIT(ipso_voltage_sensor_init, APPLICATION,
+	 CONFIG_KERNEL_INIT_PRIORITY_DEFAULT);

tests/net/all/prj.conf

@@ -299,6 +299,7 @@ CONFIG_LWM2M_IPSO_TIMER=y
 CONFIG_LWM2M_IPSO_ONOFF_SWITCH=y
 CONFIG_LWM2M_IPSO_PUSH_BUTTON=y
 CONFIG_LWM2M_IPSO_CURRENT_SENSOR=y
+CONFIG_LWM2M_IPSO_VOLTAGE_SENSOR=y
 CONFIG_LWM2M_IPSO_FILLING_SENSOR=y
 CONFIG_LWM2M_RESOURCE_DATA_CACHE_SUPPORT=y
 CONFIG_LWM2M_UCIFI_SUPPORT=y