Deploying IoT Data Streams to Ubidots

This guide provides a step-by-step approach to integrating an edge device with Ubidots using MQTT in a containerized environment, enabling seamless real-time IoT data transmission and visualization.

Imagine being able to monitor your IoT device’s data from anywhere in the world, with just a few clicks. Ubidots Web Dashboard makes this possible by providing a user-friendly way to collect, visualize, and analyze data in real time. In this guide, we will walk through the process of connecting ALPON X4 to Ubidots using MQTT, ensuring seamless data transmission in a containerized environment.


Getting Started

Before we begin, let’s make sure we have everything we need:

Prerequisites

  1. Ubidots Account – If you don’t already have an account, sign up here to access your personalized dashboard.
  2. Ubidots Device – Create a virtual device in Ubidots to represent your ALPON X4. Step-by-step instructions can be found here.
  3. Device Token – You will need a device token to authenticate your connection. Retrieve it by following this guide.

Once these steps are complete, we’re ready to build our connection.


Step 1: Creating the Docker Image

To ensure that our script runs consistently across different environments, we will use Docker to package it. Follow these steps to create a Dockerfile:

  1. Open a terminal and create a new directory for your project.

  2. Inside the directory, create a new file called Dockerfile and add the following content:

    FROM python:3.11-slim
    
    RUN pip install --no-cache-dir paho-mqtt
    
    WORKDIR /app
    
    COPY send_to_ubidots.py .
    
    CMD ["python", "send_to_ubidots.py"]
    

This file tells Docker to:

  • Use a lightweight Python 3.11 image
  • Install the MQTT library (paho-mqtt)
  • Set up a working directory
  • Copy our Python script into the container
  • Run the script when the container starts


Step 2: Writing the MQTT Client Script

Now, let’s create the Python script that will send data to Ubidots.

  1. In the same directory as your Dockerfile, create a new file called send_to_ubidots.py.

  2. Copy and paste the following code into the file:

    import time
    import os
    from paho.mqtt import client as mqtt_client
    
    broker = 'industrial.api.ubidots.com'
    port = 1883
    topic = f"/v1.6/devices/{os.getenv('DEVICE_NAME', 'default_device_name')}"
    client_id = "alpon_x4_client"
    username = os.getenv('API_TOKEN', 'default_api_token')
    password = ""
    
    def connect_mqtt():
        def on_connect(client, userdata, flags, rc):
            if rc == 0:
                print("Connected to MQTT Broker!")
            else:
                print(f"Failed to connect, return code {rc}\n")
    
        client = mqtt_client.Client(client_id)
        client.username_pw_set(username, password)
        client.on_connect = on_connect
        client.connect(broker, port)
        return client
    
    def publish(client):
        while True:
            time.sleep(2)
            msg = '{"temperature": 25, "humidity": 60}'
            result = client.publish(topic, msg)
            status = result[0]
            if status == 0:
                print(f"Sent: `{msg}`")
            else:
                print(f"Failed to send message to topic {topic}")
    
    def run():
        client = connect_mqtt()
        client.loop_start()
        publish(client)
    
    if __name__ == '__main__':
        run()
    

This script will:

  • Connect to the Ubidots MQTT broker
  • Continuously send temperature and humidity data every 2 seconds
  • Print a message each time data is successfully sent


Step 3: Build and Push the Container to Sixfab Registry

After setting up the Dockerfile, use Docker’s build command to create the container image.

To deploy the container on ALPON X4, the image must be built on your personal computer for the ARM64 architecture.

docker buildx build --platform=linux/arm64 -t ubidots-mqtt-client:latest .

This will create an image named ubidots-mqtt-client, optimized for the ALPON X4’s ARM64 architecture.

Push to Sixfab Registry:

  • Log in to the Sixfab Connect platform, navigate to the Sixfab Registry page
  • Click on + Add Container and follow the prompts to push container to Sixfab registry.

    📘

    Manage and Deploy Applications

    Visit the Manage & Deploy Applications page for all the necessary details on pushing your container image to the Sixfab Registry.



Step 4: Deployment

Once the container image is uploaded to the Sixfab Connect registry, deploy it as follows:

  1. Go to the Application section of your asset on Sixfab Connect.

  2. Click the + Deploy button to configure and deploy the container.

  3. In the Deploy Container window, use the following settings:

    • Container Name: Enter the application name (e.g., "ubidots-mqtt-client").

    • Image: Select the Ubidots container image and tag pushed to the Sixfab Registry.

    • Environment: Click "+ Add More" in the environment section and add the following values:

      KeyValue
      API_TOKEN<your-token-here>
      DEVICE_NAME<your-device-name-here>

    • Click the "+ Deploy" button to start running the container on ALPON X4.



Step 5: Viewing Data on Ubidots

Now that everything is set up, it’s time to verify that our device is successfully sending data to Ubidots.

  1. Log in to your Ubidots account.
  2. Go to the Devices section.
  3. Select your device (e.g., ALPON_X4).
  4. Check if temperature and humidity data is appearing in real time.

If you see the data flowing in, congratulations! Your ALPON X4 is now successfully connected to Ubidots.