Feature/add who am i and you are services (#1024)

* Added Who-Am-I-Request encoding, decoding, unit tests, and command line application bacwhoami. * Added You-Are-Request encoding, decoding, unit tests, and command line application bacyouare. * Added Who-Am-I with Who-Is and You-Are handling into the example server application when run as device 4194303.
2025-06-23 10:49:59 -05:00
parent 9e626e599b
commit 5072fb5913
34 changed files with 2411 additions and 80 deletions
@@ -0,0 +1,129 @@
+/**
+ * @file
+ * @brief A basic You-Are service handler
+ * @author Steve Karg <skarg@users.sourceforge.net>
+ * @date June 2025
+ * @copyright SPDX-License-Identifier: MIT
+ */
+#include <stddef.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include <stdio.h>
+/* BACnet Stack defines - first */
+#include "bacnet/bacdef.h"
+/* BACnet Stack API */
+#include "bacnet/bacdcode.h"
+#include "bacnet/bacapp.h"
+#include "bacnet/youare.h"
+#include "bacnet/basic/services.h"
+#include "bacnet/basic/sys/debug.h"
+#include "bacnet/basic/object/device.h"
+
+/**
+ * A basic handler for You-Are responses.
+ * @param service_request [in] The received message to be handled.
+ * @param service_len [in] Length of the service_request message.
+ * @param src [in] The BACNET_ADDRESS of the message's source.
+ */
+void handler_you_are_json_print(
+    uint8_t *service_request, uint16_t service_len, BACNET_ADDRESS *src)
+{
+    int len = 0;
+    uint32_t device_id = 0;
+    uint16_t vendor_id = 0;
+    BACNET_CHARACTER_STRING model_name = { 0 };
+    BACNET_CHARACTER_STRING serial_number = { 0 };
+    BACNET_OCTET_STRING mac_address = { 0 };
+    char *model_name_string = NULL;
+    char *serial_number_string = NULL;
+    char *mac_address_string = NULL;
+
+    (void)src;
+    len = you_are_request_decode(
+        service_request, service_len, &device_id, &vendor_id, &model_name,
+        &serial_number, &mac_address);
+    if (len > 0) {
+        debug_printf_stdout("{\n\"You-Are-Request\": {\n");
+        debug_printf_stdout(" \"vendor-id\" : %u,\n", (unsigned)vendor_id);
+        len = bacapp_snprintf_character_string(NULL, 0, &model_name);
+        if (len > 0) {
+            model_name_string = calloc(sizeof(char), len + 1);
+            if (model_name_string) {
+                bacapp_snprintf_character_string(
+                    model_name_string, len + 1, &model_name);
+            }
+        }
+        debug_printf_stdout(
+            " \"model-name\" : %s,\n",
+            model_name_string ? model_name_string : "");
+        len = bacapp_snprintf_character_string(NULL, 0, &serial_number);
+        if (len > 0) {
+            serial_number_string = calloc(sizeof(char), len + 1);
+            if (serial_number_string) {
+                bacapp_snprintf_character_string(
+                    serial_number_string, len + 1, &serial_number);
+            }
+        }
+        debug_printf_stdout(
+            " \"serial-number\" : %s",
+            serial_number_string ? serial_number_string : "");
+        if (device_id <= BACNET_MAX_INSTANCE) {
+            debug_printf_stdout(",\n");
+            debug_printf_stdout(
+                " \"device-identifier\" : %lu", (unsigned long)device_id);
+        }
+        if (mac_address.length > 0) {
+            debug_printf_stdout(",\n");
+            len = bacapp_snprintf_octet_string(NULL, 0, &mac_address);
+            if (len > 0) {
+                mac_address_string = calloc(sizeof(char), len + 1);
+                if (mac_address_string) {
+                    bacapp_snprintf_octet_string(
+                        mac_address_string, len + 1, &mac_address);
+                }
+            }
+            debug_printf_stdout(
+                " \"device-mac-address\" : \"%s\"",
+                mac_address_string ? mac_address_string : "");
+        }
+        debug_printf_stdout("\n }\n}\n");
+        free(model_name_string);
+        free(serial_number_string);
+        free(mac_address_string);
+    }
+
+    return;
+}
+
+/**
+ * A basic handler for You-Are-Request
+ * @param service_request [in] The received message to be handled.
+ * @param service_len [in] Length of the service_request message.
+ * @param src [in] The BACNET_ADDRESS of the message's source.
+ */
+void handler_you_are_device_id_set(
+    uint8_t *service_request, uint16_t service_len, BACNET_ADDRESS *src)
+{
+    int len = 0;
+    uint32_t device_id = 0;
+    uint16_t vendor_id = 0;
+    BACNET_CHARACTER_STRING model_name = { 0 }, device_model_name = { 0 };
+    BACNET_CHARACTER_STRING serial_number = { 0 }, device_serial_number = { 0 };
+
+    (void)src;
+    len = you_are_request_decode(
+        service_request, service_len, &device_id, &vendor_id, &model_name,
+        &serial_number, NULL);
+    if (len > 0) {
+        characterstring_init_ansi(&device_model_name, Device_Model_Name());
+        characterstring_init_ansi(
+            &device_serial_number, Device_Serial_Number());
+        if ((Device_Vendor_Identifier() == vendor_id) &&
+            characterstring_same(&device_model_name, &model_name) &&
+            characterstring_same(&device_serial_number, &serial_number)) {
+            Device_Set_Object_Instance_Number(device_id);
+        }
+    }
+
+    return;
+}