Configuration Details
The parameters in the configuration file are shown below:
Field | Type | Required | Default |
---|---|---|---|
listenTopic | String | Yes | |
publishTopic | String | Yes | |
tags | Object | Yes | |
log_level | String | No | off |
clientid | String | Yes | |
qos | Integer | No |
listenTopic
The listenTopic
field determines the MQTT topic on which this app listens for incoming data.
publishTopic
The publishTopic
field determines the MQTT topic on which this app publishes the filtered data.
tags
The
tags
field defines the variables on which deadband is to be applied. The tags is an object of the following structure.Field | Type | Required |
---|---|---|
<variable name 1> | String | Yes |
<variable name 2> | String | No |
... | String | No |
The fields <variable name 1>, <variable name 2>, etc. represent individual variable names for which the values are objects that have the deadband details below.
Field | Type | Required |
---|---|---|
type | String | Yes |
value | Any numeric | Yes |
timeoutInMS | Integer | Yes |
type
determines the type of deadband; possible values are absolute and percent
value
is the deadband value to be usedtimeoutInMS
is the timeout value (in milliseconds) to be used during deadband calculation
log_level
For details about the log_level
and log_name
fields, see the Generic CDP Blocks section of the Protocol Adapters documentation page.
clientid
The clientid
is used to specify the name of the client in the MQTT client options. It can be any unique string.
qos
The qos
field is used to specify the qos (quality of service) to the MQTT client during publishing.