Merge pull request #12177 from maxunbearable/task/4981-bacnet-help-md-files

Added show helps for bacnet connector basic config
This commit is contained in:
Igor Kulikov 2024-12-03 17:25:00 +02:00 committed by GitHub
commit c59ac9e59e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 42 additions and 0 deletions

View File

@ -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`.

View File

@ -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`.