Star

ThingsBoard Documentation

Documentation for using ThingsBoard IoT Platform.

External Nodes

External Nodes used are used to interact with external systems.

AWS SNS Node

image

Node publish messages to AWS SNS (Amazon Simple Notification Service).

Configuration:

image

In the following example, topic name depends on Device Type and there is a Message that contains deviceType field in Metadata:

{
    deviceType: controller
}

For publishing message in controller’s topic, we will set this pattern in Topic ARN pattern:

arn:aws:sns:us-east-1:123456789012:${deviceType}

In runtime, pattern will be resolved to arn:aws:sns:us-east-1:123456789012:controller

Published payload - Node will publish full Message payload to the SNS. If required, Rule Chain can be configured to use chain of Transformation Nodes for sending correct Payload to the SNS.

Outbound message from this node will contain response messageId and requestId in Message metadata. Original Message payload, type and originator will not be changed.


AWS SQS Node

image

Node publish messages to the AWS SQS (Amazon Simple Queue Service).

Configuration:

image

In the following example, Queue URL depends on Device Type and there is a Message that contains deviceType field in Metadata:

{
    deviceType: controller
}

For publishing message in controller’s Queue, we will set this pattern in Queue URL pattern:

https://sqs.us-east-1.amazonaws.com/123456789012/${deviceType}

In runtime, pattern will be resolved to https://sqs.us-east-1.amazonaws.com/123456789012/controller

Published body - Node will publish full Message payload to the SQS. If required, Rule Chain can be configured to use chain of Transformation Nodes for sending correct Payload to the SQS.

Published attributes - optional list of attributes can be added for publishing message in SQS. It is a collection of - pairs. Both, NAME and VALUE, could be a static values or patterns that will be resolved using Message metadata.

If FIFO queue is selected, then Message ID will be used as deduplication ID and Message originator as group ID.

Outbound message from this node will contain response messageId, requestId, messageBodyMd5, messageAttributesMd5 and sequenceNumber in Message metadata. Original Message payload, type and originator will not be changed.


Kafka Node

image

Kafka Node sends messages to Kafka brokers. Expects messages with any message type. Will send record via Kafka producer to Kafka server.

Configuration:

image

Published body - Node will send full Message payload to the Kafka topic. If required, Rule Chain can be configured to use chain of Transformation Nodes for sending correct Payload to the Kafka.

Outbound message from this node will contain response offset, partition and topic properties in the Message metadata. Original Message payload, type and originator will not be changed.


MQTT Node

image

Publish incoming message payload to the topic of the configured MQTT broker with QoS AT_LEAST_ONCE.

Configuration:

image

Different Authentication credentials are supported for external MQTT broker:

If PEM credentials type is selected, the following configuration should be provided:


Published body - Node will send full Message payload to the MQTT topic. If required, Rule Chain can be configured to use chain of Transformation Nodes for sending correct Payload to the MQTT broker.

In case of successful message publishing, original Message will be passed to the next nodes via Success chain, otherwise Failure chain is used.


RabbitMQ Node

image

Publish incoming message payload to the RabbitMQ.

Configuration:

image

Published body - Node will send full Message payload to the RabbitMQ. If required, Rule Chain can be configured to use chain of Transformation Nodes for sending correct Payload.

In case of successful message publishing, original Message will be passed to the next nodes via Success chain, otherwise Failure chain is used.


REST API Call Node

image

Invoke REST API calls to the external REST server.

Configuration:

image

Endpoint URL

URL can be a static string or a pattern. Only Message metadata is used for resolving patterns. So property names that are used in the patterns must exist in the Message Metadata, otherwise raw pattern will be added into URL.

For example, if Message payload contains property deviceType with value container, then this pattern:

http://localhost/api/${deviceType}/update

will be resolved to

http://localhost/api/container/update

Headers

Collection of header name/value can be configured. Those headers will be added into Rest request. Pattern should be used for configured both header name and header value. For example ${deviceType}. Only Message metadata is used for resolving patterns. So property names that are used in the pattern must exist in the Message Metadata, otherwise raw pattern will be added into header.

Request body - Node will send full Message payload to the configured REST endpoint. If required, Rule Chain can be configured to use chain of Transformation Nodes for sending correct Payload.

Outbound message from this node will contain response status, statusCode, statusReason and responce headers in the Message metadata. Outbound Message payload will be the same as response body. Original Message type and originator will not be changed.

In case of successful request, outbound message will be passed to the next nodes via Success chain, otherwise Failure chain is used.


Send Email Node

image

Node sends incoming message using configured Mail Server. This Node works only with messages that where created using To Email transformation Node, please connect this Node with To Email Node using Success chain.

Configuration:

image

This Node can work with default Mail Server configured on System level. Please find more details about how to configure default System SMTP Settings.

If specific Mail Server is required for this node - disable Use system SMTP settings checkbox and configure Mail Server manually.


Additionally this node can create email attachments if incoming message has prepared attachments field with reference to files stored in DataBase.

NOTE: This is part of File Storage feature supported by ThingsBoard Professional Edition.


In case of successful mail sending, original Message will be passed to the next nodes via Success chain, otherwise Failure chain is used.

You can see the real life example, where this node is used, in the next tutorial:


Twilio SMS Node


Professional Rule Node


Only ThingsBoard Professional Edition supports Twilio SMS Rule Node.

See Get ThingsBoard PE to install ThingsBoard PE.

image

Sends incoming message payload as SMS message via Twilio service.

Configuration:

image

SMS message will be sent to all recipients taken from Phone Numbers To list.

If SMS message will be sent to all recipients successfully, original Message will be passed to the next nodes via Success chain, otherwise Failure chain is used.