Commit f976fb10 authored by Micha Mueller's avatar Micha Mueller
Browse files

Minor improvements to readme

parent 6289312a
......@@ -394,7 +394,7 @@ Explanation of the values specific for the PDU plugin:
## BACnet
The BACnet plugin enables dcdbpusher to communicate and request data from devices which communicate via the BACnet protocol. A so called "read property" request is sent by the plugin to the BACnet devices as configured in the config file. The response value is then stored in the database. Usually one is only interested in collecting the current reading of a BACnet device (property PROP_PRESENT_VALUE, ID 85). However, also reading of other properties is supported.
> NOTE     On startup BACnet plugin does no device discovery. Instead it relies on the user providing an address_cache file with addresses of all required BACnet devices. One can generate such a address-file for example by using the bacwi demo tool provided by the BACnet-Stack.
> NOTE     On startup BACnet plugin does no device discovery. Instead it relies on the user providing an `address_cache` file with addresses of all required BACnet devices. One can generate such a address-file for example by using the `bacwi` demo tool provided by the BACnet-Stack.
### config file format
......@@ -453,13 +453,13 @@ Explanation of the values specific for the BACnet plugin:
| Value | Explanation |
|:----- |:----------- |
| interface | Network interface (IPv4) which to use by the plugin to send its "Read Property" requests.
| interface | Network interface (IPv4) which is to be used by the plugin to send its "Read Property" requests.
| port | Port to use on the interface
| apdu_timeout | Value of µ-seconds before sending a request times out.
| apdu_retries | How often should sending a request be retried.
| templates | One can define template properties in this section for convenience.
| devices | Starts the part in the config file where the actual BACnet devices are configured. A BACnet device consists of multiple nested parts: device > objects > properties.
| mqttPart | One can define a partial MQTT topic on each nesting level (device, object), which will be appended to the MQTT prefix. Together with the mqttsuffix of a property this will make up the whole MQTT topic of a property (aka sensor). MQTT topic = mqttPrefix + mqttPart (device) + mqttPart (object) + mqttsuffix.
| mqttPart | One can define a partial MQTT topic on each nesting level, which will be appended to the MQTT prefix. Together with the mqttsuffix of a property this will make up the whole MQTT topic of a property (aka sensor). MQTT topic = mqttPrefix + mqttPart (device) + mqttPart (object) + mqttsuffix.
| instance (device) | Instance of the BACnet-device.
| type | Type of the object within the device.
| instance (object) | Instance of the object within the device.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment