Common Settings for all Protocols
There are some settings which are available for any connection type.
General
On this tab, some general settings about the connection are made:
- ID: Enter a unique ID for this connection. It should only contain
lower case letters, numbers and or the
-
sign. - Description: An optional description.
- Location: Entering a value (or choose one from the list) will let you group the connections by location in the application main window (small tabs below the connection list).
- Group: Similar to location; enter a value here to establish logical connection groups, which can be viewed by toggling the tabs below the connection list in the main windows.
- Enable extended debug logging: If enabled, some connection types will output extended debug information to the log.
- Enable status parameters: If enabled, an additional write-only boolean
parameter
_status/connected
will appear that indicates whether the connection to the target device has been established successfully.
Note
The connection ID will be used throughout the application to identify a connection and its parameters.
Changing the ID of an existing connection will recreate the connection object in the BTConnect engine.
To avoid breaking your configuration, it is advised that you do not change the ID once you have used parameters from this connection in the converter rules etc.
MQTT Bridge
Check Enable MQTT Bridge in order to connect to the MQTT broker defined in the global configuration. Each connection object will establish a separate MQTT client connection to the broker.
- Client ID: In MQTT, each client has a unique “client ID” that is used to identify the client, and possibly catch up with messages missed during an outage. The Client ID defaults to the connection ID set on the General Tab, but you can enter a different value here if you like.
- Topic Prefix: If set, all topics will be prefix with this string,
in addition to the global topic prefix set in the application settings:
<global topic prefix>/<topic prefix>/<connection ID>/val/...
Last modified December 19, 2021