AWS IoT SiteWise Edge

6 min

The AWS IoT SiteWise Edge Integration enables Litmus Edge (LE) to connect to the MQTT broker in an AWS IoT SiteWise Edge Gateway. This allows the SiteWise Edge Data Processor and Publisher to publish data into AWS IoT SiteWise.

Supported communication

Outbound (Publish data from Edge to MQTT Broker) - Yes

Inbound (Subscribe data from MQTT Broker to Edge) - Yes

Configurations

Field	Details	Required
Instance Name	Connector instance name.	Yes
Hostname	DNS name of MQTT host.	Yes
Port	Port of MQTT host.	Yes
Client ID	Client ID is required by MQTT server.	Yes
Property Alias	AWS IoT SiteWise Asset Property Alias.	Yes
Integration Topic	MQTT topic path used by the AWS IoT SiteWise Edge gateway for data ingestion. Must match the topic configured in the SiteWise Edge gateway settings.	Yes
Additional Alias Definition	Optional string to further define dynamic propertyAlias and Integration Topic.	No
QoS	Quality of Service delivery guarantee: 0 = at most once (fire-and-forget), 1 = at least once, 2 = exactly once.	No
Throttling limit	Set a limit on the number of outbound messages per second. If sending data to a server that has restrictions on the rate of incoming messages, this ensures that no messages are lost.	No

Advanced configurations

Field	Details	Required
Parallel Publish Count	Number of messages published in parallel. Higher values increase throughput and resource usage.	No
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. Typically a status or alert string.	No
LWT payload type	Encoding of the LWT payload: string for plain text, base64 for binary data.	No
LWT QoS	QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.	No

Persistent storage configurations

Field	Details	Required
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 eventually sent when the connection is restored.	No
Persistent storage size limit	Set the size limit for storing persisted data in GB.	No
Queue mode	Select the sequence of data transfer: FIFO or LIFO. Selecting FIFO (First In First Out) sends the earliest message first. Selecting LIFO (Last In First Out) sends the latest message first.	No

Format directives

Symbol	Definition	Context
$	Special character indicates a variable character follows. A variable represents some dynamic string value. Supported variables defined as follows:	-
$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
%	Special character indicating a function character follows. A function represents some action to be taken on the next variable. Supported functions defined as follows:	-
%L	Lowercase()	apply to next variable
%U	Uppercase()	apply to next variable

Format directives notes

To use a special character in its literal form, enter symbol twice ($$ -> $, %% -> %) Example "$$$D.%%$N" -> "$deviceABC.%tagXYZ"

Add a Connector

Manage Connectors