MQTT Retain on TagoIO Broker

MQTT Retain on TagoIO Broker

Alert
TagoIO MQTT Broker is available exclusively for Starter and Scale accounts in the US database region. Free accounts and European database region accounts may utilize third-party MQTT services with TagoIO via the MQTT Relay feature.

TagoIO's MQTT broker, while not designed to support the native retain feature found in standard MQTT protocol implementations, we offer a workaround to achieve similar functionality.

This approach involves utilizing Analysis and Actions features to store the last message published to a topic and then resend it when a new client subscribes.

Setting Up Message on Subscribing

To build an MQTT Retain workaround with TagoIO, you can either publish directly to a topic with an Action or use an Analysis script for more complex scenarios.

Using Actions to Publish a Message to a Subscriber

  1. Create an Action: Navigate to the Actions section in your TagoIO dashboard and create a new action. Choose the event that will trigger this action. It could be a variable update, a scheduled time, or another custom trigger.
  2. Configure MQTT Publish: In the action configuration, select "MQTT Publish" as the action type. You must specify the topic you wish to publish to and the message payload.

Using Analysis for Advanced Scenarios

For scenarios where is needed to publish for a large number of devices/topics and also you need more control over the publishing process, you can use an Analysis script.
  1. Create an Analysis: Go to the Analysis section and create a new Analysis. Choose Node.js as the environment.
  2. Implement MQTT Publish Script: Within your Analysis, implement a script that connects to the TagoIO MQTT broker and publishes your desired topic.
  3. Trigger Analysis: Configure an Action or another event to trigger the execution of your Analysis. This could be based on a device update, a scheduled time, or any other event in your TagoIO application.

See an Analysis Script to MQTT Publish:

  1. /*
  2. ** Analysis Example
  3. ** MQTT publish
  4. **
  5. * Snippet to push data to MQTT. Follow this pattern within your application
  6. * If you want more details about MQTT, search "MQTT" in TagoIO help center.
  7. * You can find plenty of documentation about this topic.
  8. * TagoIO Team.
  9. **
  10. ** How to use?
  11. ** In order to trigger this analysis you must setup an Action to trigger this analysis
  12. */

  14. const { Analysis, Services } = require("@tago-io/sdk");

  16. async function mqttPushExample(context, scope) {
  17.  // Create your data object to push to MQTT
  18.  // In this case we're sending a JSON object.
  19.  // You can send anything you want.
  20.  // Example:
  21.  // const myDataObject = 'This is a string';
  22.  const myDataObject = {
  23.    variable: "temperature_celsius",
  24.    value: (myData.value - 32) * (5 / 9),
  25.    unit: "C",
  26.  };

  28.  // Create a object with the options you chooses
  29.  const options = {
  30.    qos: 0,
  31.  };

  33.  // Publishing to MQTT
  34.  const MQTT = new Services({ token: context.token }).MQTT;
  35.  MQTT.publish({
  36.      bucket: myData.device, // for immutable/mutable devices
  37.      message: JSON.stringify(myDataObject),
  38.      topic: "tago/my_topic",
  39.      options,
  40.    }).then(context.log, context.log)
  41. }

  43. module.exports = new Analysis(mqttPushExample);

  45. // To run analysis on your machine (external)
  46. // module.exports = new Analysis(mqttPushExample, { token: "YOUR-TOKEN" });







    • Related Articles

    • Connecting your MQTT Broker to TagoIO

      TagoIO supports MQTT connections through our MQTT Relay command-line tool. This software acts as a bridge between your MQTT Broker and the TagoIO platform, facilitating seamless integration and data flow. Developed in Rust, the TagoIO MQTT Relay is ...

    • MQTT

      TagoIO MQTT Broker is available exclusively for Starter and Scale accounts in the US database region. European database region accounts cannot access this service due to new security requirements, but may utilize third-party MQTT services with TagoIO ...

    • MQTT - Publishing and Subscribing

      TagoIO MQTT Broker is available exclusively for Starter and Scale accounts in the US database region. European database region accounts cannot access this service due to new security requirements, but may utilize third-party MQTT services with TagoIO ...

    • Trigger by MQTT Topic

      The trigger type, Trigger by Variable, allows you to execute your Action when data is sent to an MQTT topic. TagoIO has its own MQTT broker that is responsible for pushing data to clients in case something new is published in the specific topics they ...

    • MQTT with Sensor Tag

      This is an example using the SensorTag Bluetooth module from Texas Instruments to send data to TagoIO. There is no code modification needed in the SensorTag side, and as it uses the MQTT protocol, only a configuration setup is needed. For the ...