Merge d96336c into eb08bd4

Author: EchterAgo

NEWS.adoc

@@ -45,6 +45,11 @@ https://github.com/networkupstools/nut/milestone/13
  - Second-level bullet points listed in this file will now use 4 spaces
    (not 3 like before) for easier initial indentation of new entries.
 
+ - `apc_modbus` driver updates:
+    * Fixed string join not doing zero termination. [PR #3413]
+    * Decode `RunTimeCalibrationStatus_BF` into
+      `experimental.ups.calibration.result` [PR #3416]
+
  - NUT client libraries:
     * Complete support for actions documented in `docs/net-protocol.txt`
       was implemented in C++, Python and PERL bindings in-tree, and for Java

docs/nut.dict

@@ -1159,6 +1159,7 @@ Rodríguez
 Rouben
 Rozman
 Rucelf
+RunTimeCalibrationStatus
 RunAs
 RunUPSCommand
 RxD

drivers/apc_modbus.c

@@ -44,7 +44,7 @@
 #endif
 
 #define DRIVER_NAME	"NUT APC Modbus driver " DRIVER_NAME_NUT_MODBUS_HAS_USB_WITH_STR " USB support (libmodbus link type: " NUT_MODBUS_LINKTYPE_STR ")"
-#define DRIVER_VERSION	"0.19"
+#define DRIVER_VERSION	"0.20"
 
 #if defined NUT_MODBUS_HAS_USB
 
@@ -695,6 +695,7 @@ static int _apc_modbus_string_join(const char *values[], size_t values_len, cons
 	}
 
 	output_idx = 0;
+	output[0] = 0; /* Always zero terminate */
 
 	for (i = 0; i < values_len && output_idx < output_len; i++) {
 		if (values[i] == NULL)
@@ -771,6 +772,69 @@ static int _apc_modbus_battery_test_status_to_nut(const apc_modbus_value_t *valu
 
 static apc_modbus_converter_t _apc_modbus_battery_test_status_conversion = { _apc_modbus_battery_test_status_to_nut, NULL };
 
+static int _apc_modbus_runtime_calibration_status_to_nut(const apc_modbus_value_t *value, char *output, size_t output_len)
+{
+	const char *result, *source, *modifier;
+	const char *values[3];
+
+	if (value == NULL || output == NULL || output_len == 0) {
+		/* Invalid parameters */
+		return 0;
+	}
+
+	if (value->type != APC_VT_UINT) {
+		return 0;
+	}
+
+	result = NULL;
+	if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_PENDING)) {
+		result = "Pending";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_INPROGRESS)) {
+		result = "InProgress";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_PASSED)) {
+		result = "Passed";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_FAILED)) {
+		result = "Failed";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_REFUSED)) {
+		result = "Refused";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_ABORTED)) {
+		result = "Aborted";
+	}
+
+	source = NULL;
+	if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_SOURCE_PROTOCOL)) {
+		source = "Source: Protocol";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_SOURCE_LOCALUI)) {
+		source = "Source: LocalUI";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_SOURCE_INTERNAL)) {
+		source = "Source: Internal";
+	}
+
+	modifier = NULL;
+	if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_INVALIDSTATE)) {
+		modifier = "Modifier: InvalidState";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_INTERNALFAULT)) {
+		modifier = "Modifier: InternalFault";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_STATEOFCHARGENOTACCEPTABLE)) {
+		modifier = "Modifier: StateOfChargeNotAcceptable";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_LOADCHANGE)) {
+		modifier = "Modifier: LoadChange";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_ACINPUTNOTACCEPTABLE)) {
+		modifier = "Modifier: ACInputNotAcceptable";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_LOADTOOLOW)) {
+		modifier = "Modifier: LoadTooLow";
+	} else if ((value->data.uint_value & APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_OVERCHARGEINPROGRESS)) {
+		modifier = "Modifier: OverChargeInProgress";
+	}
+
+	values[0] = result;
+	values[1] = source;
+	values[2] = modifier;
+	return _apc_modbus_string_join(values, SIZEOF_ARRAY(values), ", ", output, output_len);
+}
+
+static apc_modbus_converter_t _apc_modbus_runtime_calibration_status_conversion = { _apc_modbus_runtime_calibration_status_to_nut, NULL };
+
 static const time_t apc_date_start_offset = 946684800; /* 2000-01-01 00:00 */
 
 static int _apc_modbus_date_to_nut(const apc_modbus_value_t *value, char *output, size_t output_len)
@@ -889,6 +953,7 @@ static apc_modbus_register_t apc_modbus_register_map_inventory[] = {
 static apc_modbus_register_t apc_modbus_register_map_status[] = {
 	{ "input.transfer.reason",          2,      1,  APC_VT_UINT,     APC_VF_NONE,         &_apc_modbus_status_change_cause_conversion,    NULL,       0,  NULL    },
 	{ "ups.test.result",                23,     1,  APC_VT_UINT,     APC_VF_NONE,         &_apc_modbus_battery_test_status_conversion,    NULL,       0,  NULL    },
+	{ "experimental.ups.calibration.result", 24, 1, APC_VT_UINT,     APC_VF_NONE,         &_apc_modbus_runtime_calibration_status_conversion,    NULL,       0,  NULL    },
 	{ NULL, 0, 0, APC_VT_INT, APC_VF_NONE, NULL, NULL, 0.0f, NULL }
 };
 

drivers/apc_modbus.h

@@ -48,6 +48,25 @@
 #define APC_MODBUS_REPLACEBATTERYTESTSTATUS_BF_MOD_INTERNALFAULT (1 << 10)
 #define APC_MODBUS_REPLACEBATTERYTESTSTATUS_BF_MOD_STATEOFCHARGENOTACCEPTABLE (1 << 11)
 
+/* RunTimeCalibrationStatus_BF register bits (register 24 in status block)
+ * See MPAO-98KJ7F_R1_EN Appendix B */
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_PENDING (1 << 0)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_INPROGRESS (1 << 1)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_PASSED (1 << 2)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_FAILED (1 << 3)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_REFUSED (1 << 4)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_ABORTED (1 << 5)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_SOURCE_PROTOCOL (1 << 6)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_SOURCE_LOCALUI (1 << 7)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_SOURCE_INTERNAL (1 << 8)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_INVALIDSTATE (1 << 9)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_INTERNALFAULT (1 << 10)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_STATEOFCHARGENOTACCEPTABLE (1 << 11)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_LOADCHANGE (1 << 12)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_ACINPUTNOTACCEPTABLE (1 << 13)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_LOADTOOLOW (1 << 14)
+#define APC_MODBUS_RUNTIMECALIBRATIONSTATUS_BF_MOD_OVERCHARGEINPROGRESS (1 << 15)
+
 #define APC_MODBUS_SOGRELAYCONFIGSETTING_BF_REG 590
 #define APC_MODBUS_SOGRELAYCONFIGSETTING_BF_MOG_PRESENT (1 << 0)
 #define APC_MODBUS_SOGRELAYCONFIGSETTING_BF_SOG_0_PRESENT (1 << 1)