Input Connector Nodes
      Back to home
      1. Home
      2. 5: Workflow Toolkit
      3. Input Connector Nodes

      MQTT

      A lightweight messaging protocol designed for low-bandwidth, high-latency environments. MQTT is widely used in IoT for device-to-cloud and device-to-device communication, supporting efficient message transmission with bandwidth usage.

      Purpose: 

      The MQTT node:

      • Receives data from devices that are using the MQTT communication protocol.
      • A single MQTT node can receive data for all the devices configured within your solution.
      • The details of Rayven MQTT broker:
        • TCP: mqtt://broker.rayven.io:1883
        • TLS: mqtts://broker.rayven.io:8883
        • WebSockets: ws://broker.rayven.io:80
        • Secure WebSockets: wss://broker.rayven.io:443

      Outputs: The MQTT node will output each device’s payload in the order that they are received.


      How to Use:

      Implementation - In the Rayven Workflow:

      • Select Inputs
      • Drag the MQTT node to the canvas.
      • Double click on the MQTT node to open the configuration window

      Configuration

      Section: General

      This section contains basic configuration elements required for any MQTT node implementation

      Field

      Requirement

      Comments

      Node Name

      Mandatory

      Enter a name for this node.


      This provides a handle to which you and others can refer, so it should be simple but meaningful and explain the node’s purpose.

      Broker Address

      Mandatory

      Input the broker’s address.

      Example: broker.rayven.io or 53.169.16.32

      Username

      Mandatory

      Enter a username which will be used for authentication purposes.

      Topic

      Autofilled

      		  

      Port

      Mandatory

      Input the MQTT port number.MQTT node automatically generates a unique topic ID. 


      When configuring your gateway, please enter the topic ID in the following format:

      [[topicID]]/[[deviceID]]


      Where deviceID is the values configured in Device Management.


      Please contact your Rayven representative if you require a custom topic.

      Payload Format

      Mandatory

      Select the format of the payload that will be sent to the node. Format must be selected from the dropdown menu:

      • JSON
      • String
      • XML
      • CSV

      Client ID

      Optional

      Enter your MQTTs client ID.

      Password

      Optional

      Enter a unique password which will be used for authentication purposes.

      Payload Device ID Field Name

      Optional

      If the payload contains the unique device ID in the payload, please enter the JSON key that holds this information. All data packets will be tied to the device ID that is received from the payload, ignoring the device ID information provided within the Topic.


      Section: Take Date Field from JSON

      In the case that you would like the timestamp of the data to be based on the data coming from the device, and if the device is coordinated with a time zone, you will need to define the following three fields:

      Field

      Requirement

      Comments

      Date Field Name

      Optional

      Define the name of the date field coming in from your device

      Date Format

      Optional

      Define the format of how the data will be coming through, for example: dd/MM/yyyy HH:mm:ss. If the date is coming through in 24 hour format, the hours need to be in capital letters, (ie. HH:mm:ss)

      Timezone

      Optional

      Define from a drop down list, the time zone that the device is recording the data.

      Activation: Once the node has been configured, click the Activate button and then click Save. The node is ready to receive data into the workflow.