Porovnávané verzie

Kľúč

  • Tento riadok sa pridal
  • Riadok je odstránený.
  • Formátovanie sa zmenilo.

...

KeywordFull name

Meaning

UnitDefault value

Kotva
ssa
ssa
SSA

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, 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/NONO

Kotva
swt
swt
SWT

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.



Kotva
swp
swp
SWP

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.



Kotva
fpt
fpt
FPT

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

Kotva
ftf
ftf
FTF

Time Field Name

If Payload Type = JSON, the name of the field with a timestamp - overriding the line parameter Time Field Name--

Kotva
ftm
ftm
FTM

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



Kotva
sr
sr
SR

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/NOYES

Kotva
sf
sf
SF

Store & Forward

The parameter allows you to change the Store & Forward functionality, which is defined for all stations on the line by the Store & Forward line parameter. The value Default means using the settings configured on the line.

Default
False
True
Default

Kotva
sfbs
sfbs
SFBS

Store & Forward Batch Size

If the Store & Forward functionality is active (see Store & Forward parameter), the parameter specifies the number of historical values ​​sent in one message (NDATA/DDATA) after communication is resumed.

1-100010

Kotva
sam
sam
SAM

Sparkplug Alias Mode

If Payload Type = Sparkplug Edge Node, the parameter specifies the alias usage mode. Aliases are numeric (integer - Int64) identifiers, used optionally in data and command messages (NDATA/DDATA/NCMD/DCMD) instead of text identifiers, due to the message size reduction. If used, they are listed in the NBIRTH/DBIRTH message together with text identifiers. Aliases must be unique within all I/O tags belonging to one station. 

  • Default (SAL=alias) - Aliases are used for those I/O tags that have them configured directly in the address as a SAL item (e.g. ST=UInt16;SAL=2;SA=Second).
  • Automatic (HOBJ) - Aliases are used for allI/O tags belonging to the station. The alias value is the HOBJ (ID) of the I/O tag. If an alias is configured in the I/O tag address, it is ignored.
  • Off - Aliases are not used. If they are configured directly in theI/O tag address, they are ignored.

Default (SAL=alias)

Automatic (HOBJ)

Off

Default (SAL=alias)

...