BacnetMSTP
Review the following information for setting up and configuring the BACnet MS/TP driver.
Litmus Edge Compatible Series
Compatibility parameter | Compatible items |
|---|---|
Driver type | Serial |
Validated devices/series | BACnet MS/TP compatible devices (Building Management Systems, HVAC controllers, Air Handling Units) |
Replaces Gen 1 driver(s) | N/A |
To set up and configure this device in Litmus Edge, you must:
- Step 1: Set up and Configure the PLC Device
- Step 2: Set up the PLC Device in Litmus Edge DeviceHub
- Step 3: Configure the List of Registers
Step 1: Set up and Configure the PLC Device
Configure your BACnet MS/TP device with the appropriate serial communication parameters. Note the following settings from your device configuration:
- Serial port device file (for example, /dev/ttyS0)
- Baud rate
- Data bits
- Stop bits
- Parity settings
- Device MAC address on the MS/TP network
Ensure the device is properly wired to your Litmus Edge gateway's serial port following RS-485 wiring standards.
Step 2: Set up the PLC Device in Litmus Edge DeviceHub
Configure the following parameters when you Connect a Device with this driver. Update default values to the specific setup of your device.
Parameter | Value |
|---|---|
Type | BACnet |
Driver | BacnetMSTP |
Device File | /dev/ttyS0 |
Baud Rate | Select appropriate baud rate (e.g., 9600, 19200, 38400, 76800) |
Data Bits | 8 |
Stop Bits | 1 |
Parity | None |
Response Timeout | 5000 (ms) |
Step 3: Configure the List of Registers
When you Add a Tag to the connected device, refer to the following register table and tag parameters. Refer to the following additional resources:
Register Table
Name | Value Types | Access Types | Address Format | Min Address | Max Address | Description |
|---|---|---|---|---|---|---|
AI | float32, object | R/O | DDDDDDDD | 0 | 2147483647 | Analog input |
AO | float32, object | R/W | DDDDDDDD | 0 | 2147483647 | Analog output |
AV | float32, object | R/W | DDDDDDDD | 0 | 2147483647 | Analog value |
BI | uint32, bit, object | R/O | DDDDDDDD | 0 | 2147483647 | Binary input |
BO | uint32, bit, object | R/W | DDDDDDDD | 0 | 2147483647 | Binary output |
BV | uint32, bit, object | R/W | DDDDDDDD | 0 | 2147483647 | Binary value |
MSI | uint32, object | R/O | DDDDDDDD | 0 | 2147483647 | Multi state input |
MSO | uint32, object | R/W | DDDDDDDD | 0 | 2147483647 | Multi state output |
MSV | uint32, object | R/W | DDDDDDDD | 0 | 2147483647 | Multi state value |
SCH | uint32, float32, object | R/W | DDDDDDDD | 0 | 2147483647 | Schedule |
LFSP | uint32, object | R/W | DDDDDDDD | 0 | 2147483647 | Life safety point |
LOCTL | uint32, object | R/W | DDDDDDDD | 0 | 2147483647 | Load control |
OCTSTR | octet_string, object | R/W | DDDDDDDD | 0 | 2147483647 | Octet string |
PINT | uint32, object | R/W | DDDDDDDD | 0 | 2147483647 | Positive integer |
CHV | string, object | R/W | DDDDDDDD | 0 | 2147483647 | Character string value |
F | octet_string, object | R/W | DDDDDDDD | 0 | 2147483647 | File object |
PROPRIETARY | bit, int32, uint32, float32, float64, string, octet_string, object | R/W | DDDDDDDD | 0 | 2147483647 | Proprietary |
Tag Parameters
- Name: Select a register name from the drop-down list. The available options depend on the names in the register table.
- Value Type: Select a data type from the drop-down list. The available options depend on the register name selected.
- Polling Interval: Enter a value in milliseconds. This determines how often the tag should poll the register for data.
- Tag Name: Enter a name for the tag.
- Description (Optional): Enter a description for the tag.
- Address: Enter the BACnet object instance number in decimal format. The value must be within the allowed min/max range (0-2147483647).
- MAC: Enter the MAC address of the BACnet MS/TP device on the network.
- Count: Enter the number of register values to read. A count higher than 1 will generate an array of values from the address value configured and respective subsequent address values.
- Tag Formula: Enter a formula for the tag to process the generated data. Two variables are permitted: value (current tag value) and timestamp (current tag UNIX time in milliseconds). The following math functions are available:
- sin
- cos
- sqrt
- tan
- power: power (x) performs the operation 10^x.
- log: log (x) is the natural logarithm (the logarithm is in base e).
- exp: exp (x) performs the operation e^x.
- Only Publish on Change of Value: Select the checkbox to customize NATS messages to be published only when the value parameter changes to a new one. Change of Value only applies to boolean, numeric (such as int or float), and simple string data types. It does not apply to complex types, such as JSON or array. Poll-once topics will not be affected by Change of Value settings. These topics will still only see a single message.
- Meta Data: Metadata summarizes basic information about data. This feature allows you to define key-value pair data for the device output payload later on. It can then be used to find, use, and reuse particular instances of data.
Note: If you use special characters in meta data key names, the special characters are replaced with underscore characters in the payload. This can cause two key names to be combined into one. For example, configuring the key names a**b and a&&b will cause only one key name to be created (a__b).