From 92c9453abef96a3003d3c5958bf3834fb360fff7 Mon Sep 17 00:00:00 2001 From: mpetrov Date: Tue, 3 Dec 2024 16:05:03 +0200 Subject: [PATCH] Added show helps for bacnet connector basic config --- .../bacnet-device-name-field-expression_fn.md | 21 +++++++++++++++++++ ...acnet-device-profile-name-expression_fn.md | 21 +++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 ui-ngx/src/assets/help/en_US/widget/lib/gateway/bacnet-device-name-field-expression_fn.md create mode 100644 ui-ngx/src/assets/help/en_US/widget/lib/gateway/bacnet-device-profile-name-expression_fn.md diff --git a/ui-ngx/src/assets/help/en_US/widget/lib/gateway/bacnet-device-name-field-expression_fn.md b/ui-ngx/src/assets/help/en_US/widget/lib/gateway/bacnet-device-name-field-expression_fn.md new file mode 100644 index 0000000000..3a97cc4376 --- /dev/null +++ b/ui-ngx/src/assets/help/en_US/widget/lib/gateway/bacnet-device-name-field-expression_fn.md @@ -0,0 +1,21 @@ +## Expressions + +This field allows dynamically constructing a formatted device name using values extracted from a JSON object. You can specify variables to access the relevant fields in the JSON. + +# Available Variables + +You can use the following variables to extract specific device information: + +* `objectName`: Extracts the device's object name (e.g., `"Main Controller"`). +* `vendorId`: Extracts the device's vendor ID, typically a numeric identifier representing the manufacturer (e.g., `"1234"`). +* `objectId`: Extracts the device's unique object identifier (e.g., `"999"`). +* `address`: Extracts the device's network address (e.g., `"192.168.1.1"`). + +# Examples + +* `"Device ${objectName}"` + If the objectName variable exist and contains `"objectName": "Main Controller"`, the device on platform will have the following name: `Device Main Controller`. +* `"Vendor: ${vendorId}"` + If the vendorId variable exist and contains `"vendorId": 1234`, the device on platform will have the following name: `Vendor: 1234`. +* `"Device ID: ${objectId} at ${address}"` + If the objectId variable exist and contains `"vendorId": 999 `and address variable exist and contains `"address": "192.168.1.1"` , the device on platform will have the following name: `Device ID: 999 at 192.168.1.1`. diff --git a/ui-ngx/src/assets/help/en_US/widget/lib/gateway/bacnet-device-profile-name-expression_fn.md b/ui-ngx/src/assets/help/en_US/widget/lib/gateway/bacnet-device-profile-name-expression_fn.md new file mode 100644 index 0000000000..1b84c4d6ff --- /dev/null +++ b/ui-ngx/src/assets/help/en_US/widget/lib/gateway/bacnet-device-profile-name-expression_fn.md @@ -0,0 +1,21 @@ +## Expressions + +This field allows dynamically constructing a formatted profile name using values extracted from a JSON object. You can specify variables to access the relevant fields in the JSON. + +# Available Variables + +You can use the following variables to extract specific device information: + +* `objectName`: Extracts the device's object name (e.g., `"Main Controller"`). +* `vendorId`: Extracts the device's vendor ID, typically a numeric identifier representing the manufacturer (e.g., `"1234"`). +* `objectId`: Extracts the device's unique object identifier (e.g., `"999"`). +* `address`: Extracts the device's network address (e.g., `"192.168.1.1"`). + +# Examples + +* `"Device ${objectName}"` + If the objectName variable exist and contains `"objectName": "Main Controller"`, the device on platform will have the following name: `Device Main Controller`. +* `"Vendor: ${vendorId}"` + If the vendorId variable exist and contains `"vendorId": 1234`, the device on platform will have the following name: `Vendor: 1234`. +* `"Device ID: ${objectId} at ${address}"` + If the objectId variable exist and contains `"vendorId": 999 `and address variable exist and contains `"address": "192.168.1.1"` , the device on platform will have the following name: `Device ID: 999 at 192.168.1.1`.