| Keyword | Full name | Meaning | Unit | Default value |
|---|
| Subscribe Station Address | If this parameter has the value YES, the Topic related to the station address is also added to the SUBSCRIBE message: - If Payload Type = Sparkplug Host, an NDATA/DDATA topic is the following topics are created from the station address:
- NDATA/DDATA topic (e.g., spBv1.0/myGroup/NDATA/myEdgeNode or spBv1.0/myGroup/DDATA/myEdgeNode/myDevice1)
- NBIRTH/DBIRTH topic (e.g., spBv1.0/myGroup/NBIRTH/myEdgeNode or spBv1.0/myGroup/DBIRTH/myEdgeNode/myDevice1)
- NDEATH/DDEATH topic (e.g., spBv1.0/myGroup/NDEATH/myEdgeNode or spBv1.0/myGroup/DDEATH/myEdgeNode/myDevice1)
- If Payload Type = Sparkplug Edge Node, the parameter is ignored - NCMD/DCMD topic is always created (e.g. . , spBv1.0/myGroup/NCMD/myEdgeNode or spBv1.0/myGroup/DCMD/myEdgeNode/myDevice1)
- If Payload Type = Text only or JSON, the topic is the same as the station address (i.e., it makes no sense to set this parameter on stations that have addresses in the form of a regular expression, e.g., status/batt.*)
| YES/NO | NO |
| Station Will Topic | Will topic of the device. If this parameter is set and a message with the same topic is received, the station will go into a communication error (StHardErr) and the values of the I/O tags will be invalidated. In this way, it is possible to emulate the standard behavior that occurs when there is a communication error with the device (even if the communication between the D2000 Kom process and the MQTT broker is functional). If Payload Type = Sparkplug Host, it is not necessary to enter this parameter - if an NDEATH/DDEATH message arrives with a Topic that matches the station address, the station will go into a communication error. |
|
|
| Station Will Payload | Content of the Will message. If this parameter is set and a message with the same topic as defined by the Station Will Topic parameter is received, the Payload must also be the same. If this parameter is an empty string, matching the topic with the Station Will Topic parameter is sufficient. Note: This parameter was implemented because MQTT brokers send messages with the same Topic when connecting/disconnecting the device, the difference being only in the payload. |
|
|
| Payload Type | The setting of message parsing (overriding the line parameter Payload Type): - Default - the line parameter Payload Type is respected
- Text only - the message is not parsed, it is assigned to the I/O tag with the address IN_TOPIC
- JSON - the message is parsed as JSON data. If there is an I/O tag with the address IN_TOPIC, the whole message will be assigned to it.
If there are I/O tags with addresses JA=json_address, they will be populated with the appropriate data from the JSON message. If no such addresses exist in the message, the I/O tags will be invalidated. - Sparkplug - the message is parsed as Sparkplug B payload (binary coded). Based on the line parameter Payload Type, this is Sparkplug Host/Edge Node mode, Sparkplug Host by default.
| Default Text only JSON Sparkplug | Default |
| | If Payload Type = JSON, the name of the field with a timestamp - overriding the line parameter Time Field Name. | - | - |
| Time Mask | Mask for parsing a value in the field with a timestamp - overriding the line parameter Time Mask. Note: Whether the time is interpreted as local or UTC with a configured offset depends on the time station parameters settings. | - | - |
Sparkplug parameters |
|
|
| Send Node Control/Rebirth | If Payload Type = Sparkplug Host, when connecting to the MQTT server, a command (NCMD or DCMD) with the metric 'Node Control/Rebirth' is sent to the SparkPlug station. The response should be a message (NBIRTH/DBIRTH) with all current metrics. | YES/NO | YES |