MQTT - AWS IoT SiteWise Edge (Gen 1)

6 min

The MQTT - AWS IoT SiteWise Edge (Gen 1) connector enables Litmus Edge (LE) to connect to the MQTT broker in an AWS IoT SiteWise Edge gateway. The SiteWise Edge data processor and publisher can then publish the data into AWS IoT SiteWise.

Supported communication

Outbound (publish data from LE to the MQTT broker): Yes

Inbound (subscribe to data from the MQTT broker to LE): Yes

Configurations

Field	Details	Required	Default
Instance Name	Connector instance name.	Yes	-
Hostname	DNS name or IP address of the MQTT broker in the SiteWise Edge gateway. Maximum 255 characters.	Yes	-
Port	Port of the MQTT broker. Range is 1 to 65535.	Yes	8883
Client ID	Client ID that the connector uses with the MQTT broker.	Yes	-
Property Alias	AWS IoT SiteWise asset property alias. You can use format directives. See Format directives.	Yes	-
Integration Topic	MQTT topic that the SiteWise Edge gateway uses for data ingestion. Must match the topic configured in the gateway settings.	Yes	-
Additional Alias Definition	Optional string to further define a dynamic Property Alias and Integration Topic. Use it with the $S format directive.	No	-
QoS	Quality of Service delivery guarantee: 0 = at most once, 1 = at least once, 2 = exactly once.	No	1
Parallel Publish Count	Number of messages published in parallel. Higher values increase throughput and resource usage. Range is 1 to 4000.	No	100
LWT topic	MQTT topic the broker publishes the Last Will message to if this client disconnects unexpectedly.	No	-
LWT payload	Message content published to the LWT topic on unexpected disconnection. Maximum 255 characters.	No	-
LWT payload type	Encoding of the LWT payload: string for plain text, base64 for binary data.	No	string
LWT QoS	QoS level for the Last Will message: 0, 1, or 2.	No	1
Throttling limit	Maximum outbound messages per second. A value of 0 disables throttling.	No	0

Advanced configurations

Field	Details	Required	Default
Connection Timeout	Maximum time in seconds for one connection attempt to the broker. Range is 1 to 60.	No	30
Ping Timeout	Time in seconds to wait for the broker's keep-alive reply before the connection counts as lost. The connector checks every five seconds, so it rounds the value up to the next multiple of 5. Range is 5 to 60.	No	10
Reconnect Interval	Time in seconds to wait after a lost or failed connection before the next attempt. Range is 1 to 60.	No	5
Publish Wait Timeout	Maximum time in seconds for a single publish before the connector gives up on it. Range is 1 to 60.	No	10

Persistent storage configurations

Field	Details	Required	Default
Persistent storage	If enabled, messages in the outbound queue are stored on disk. If there are interruptions in connection or power loss, messages are retained and sent when the connection is restored.	No	Enabled
Persistent storage size limit	Size limit in GB for persisted data. Shown only when Persistent storage is enabled.	No	1
Queue Mode	Order in which buffered messages are sent: fifo (First In First Out) sends the earliest message first, and lifo (Last In First Out) sends the latest message first. Shown only when Persistent storage is enabled.	No	lifo
Enable Logging	Write connection and publish error messages to the connector log. Logging can increase CPU usage, so enable it only for debugging.	No	Disabled

Topic parameters

Each inbound and outbound topic has a Qos setting: default, 0, 1, or 2. The default is default.

Format directives

Use these directives in Property Alias and Integration Topic to build values from each message.

Symbol	Definition	Context
$	A variable follows. A variable represents a dynamic string value. The supported variables are:	-
$S	Additional Alias Definition	from connector settings
$D	Device Name	from DeviceHub tag
$N	Tag Name	from DeviceHub tag
$R	Raw Tag Type	from DeviceHub tag
$P	Tag Description	from DeviceHub tag
$H	Hostname	from OS
%	A function follows. A function acts on the next variable. The supported functions are:	-
%L	Lowercase()	apply to next variable
%U	Uppercase()	apply to next variable

To use a special character literally, enter it twice: $$ for $, and %% for %. For example, "$$$D.%%$N" becomes "$deviceABC.%tagXYZ".

AWS IoT SiteWise

Add a ConnectorAdd a Connector

Manage ConnectorsManage Connectors