JSON Tag Publisher (Type B)
This object links to a Broker Connection to publish all data collected by Edge ACM (eACM) in a configurable JSON MQTT format.
Publishes with this JSON Tag Publisher are per tag. If publishes should be per device, the JSON Device Publisher can be used instead.
General
Property | Description |
|---|---|
Name | The name of this item |
Enabled | When enabled, data will be published |
Folder | The parent folder of this object |
MQTT
Property | Description |
|---|---|
Broker Connections | The Broker Connection objects used by this Sparkplug B Publisher object. Brokers will be connected to in a round robin fashion starting with highest priority and continuing to lowest priority. |
Assigned Schedules | The Publish Schedules that are associated with this publisher. AUTOSOL MQTT will only publish tags that match the publish group id’s assigned to these schedule objects |
Node ID | The unique identifier used by this publisher when publishing data |
Publish QoS | The Quality of Service for published messages
|
Subscribe QoS | The requested Quality of Service for subscribed messages (typically tag value writes from remote clients)
|
Default Publish Rate | The time between data update messages. Changing the units will dynamically change the numerical value This publish rate will only be used if there are no publish schedule objects assigned in 'Assigned Schedules' |
JSON Payload
Property | Description |
|---|---|
Value Key | The name assigned to the JSON field holding the tag value |
Include Timestamp | When enabled, the tag publish timestamp will be included in the JSON Payload |
Timestamp Key | The name assigned to the JSON field holding the timestamp value Only used when the ‘Include Timestamp’ option is enabled |
Timestamp Date Format | Use None when no date is desired, or you wish to use the default Timestamp Time Format of Epoch; otherwise, choose the desired date format consisting of a month, day and year. |
Timestamp Time Format | Choose Epoch which is the number of milliseconds since 1970, or one of the time formats which provide hours (HH), minutes (mm), seconds (ss), or milliseconds (000). |
Include Tag Quality | When enabled, the tag quality will be included in the JSON Payload |
Quality Key | The name assigned to the JSON field holding the tag quality Only used when the ‘Include Tag Quality’ option is enabled |
Include Tag Type | When enabled, the tag type will be included in the JSON Payload |
Type Key | The name assigned to the JSON filed holding the tag type Only used when the ‘Include Tag Type’ option is enabled |
Data Types
Property | Description |
|---|---|
Unknown | The custom data type used for Unknown tag types published |
Int8 | The custom data type used for signed 8 bit integer tag types published |
Int16 | The custom data type used for signed 16 bit integer tag types published |
Int32 | The custom data type used for signed 32 bit integer tag types published |
Int64 | The custom data type used for signed 64 bit integer tag types published |
UInt8 | The custom data type used for unsigned 8 bit integer tag types published |
UInt16 | The custom data type used for unsigned 16 bit integer tag types published |
UInt32 | The custom data type used for unsigned 32 bit integer tag types published |
UInt64 | The custom data type used for unsigned 64 bit integer tag types published |
Float | The custom data type used for float tag types published |
Double | The custom data type used for double tag types published |
Boolean | The custom data type used for boolean tag types published |
String | The custom data type used for string tag types published |
Datetime | The custom data type used for datetime tag types published |
Advanced MQTT
Property | Description |
|---|---|
Use Custom Write Topic | Enable option to set custom write topic |
Custom Write Topic | Topic to use when custom write topic is enabled |
Delay Between Publishes | The time between published messages. Changing the units will dynamically change the numerical value |
Publish backfill data when timestamp is included in messages | Enable the option |
Writes
In order to write to tags on this publisher your topic name must match the following format
{Node Name}/WRITE/{Device Name}/{Tag Name}The payload must contain a Value for the tag that is being written to, the key for Value must match the Value Key defined on the JSON Payload Tab. Below is an example of a write payload with the default key
{
"Value":15
}