1 of 14

MQTT

Qubitro provides a scalable, distributed, and fully-featured MQTT broker and does support all the behaviors specified in the MQTT v5.0, v3.1.1, and v.3.1 standards.

You can jump to client libraries and examples below if you are familiar with the MQTT libraries.

Conventions

We strongly recommend using the 8883 port for MQTT over TLS connectivity.

Description

Value

Host

broker.qubitro.com

Secure port

8883

Insecure port (for test purpose)

1883

Depending on the client library, a URL format may vary. Check our examples or contact us if you need help with the URL naming convention.

Example: tcp://broker.qubitro.com - tls://broker.qubitro.com or broker.qubitro.com

Authentication

Any MQTT client library that supports username-password authentication can be used to connect Qubitro.

Device ID and Device Token are both unique, generated automatically, and located under the device settings tab in Qubitro Portal.

Value Name

Qubitro Equivalent

Username

Device ID

Password

Device Token

Qubitro offers customized MQTT libraries for some languages and platforms in which username and password methods are replaced with proper method names. Example: See Ruby client.

Client ID

The client identifier (Client ID) identifies each MQTT client that connects to an MQTT broker.

Qubitro does not manage client IDs internally therefore client ID must be set with the same value as the device ID.

Value Name

Qubitro Equivalent

Client ID

Device ID

Quality of Service (QoS)

The MQTT specification describes three Quality of Service (QoS) levels. Qubitro has support for all QoS options ,but the default options are always 0 unless specified during the connection.

Value Name

Description

QoS 0

Delivered at most once

QoS 1

Delivered at least once

QoS 2

Delivered exactly once

Data Structure

Qubitro currently has support for key-value paired JSON objects as the data type. Nested values are not supported yet.

{
  "Key1" : "Value1",
  "Key2" : true,
  "Key3" : 90
  ...
}

Toit MQTT Connector

The Toit Qubitro MQTT connector package.

The offers built-in security and an enhanced MQTT connectivity experience.

Configure Source

Get Credentials

1. Select a project from the left navigation menu and click New source at the top right of the toolbar.

2. Select Toit in the MQTT section and click Continue.

3. Enter the information of your choice and click Continue.

4. This is where you get the required credentials. You can use the provided sample code or pass the credentials to your custom code.

Toit Quick start guide

Getting started

Installing Qubitro package

Run the following CLI command to install the Toit Qubitro connector.

jag pkg install github.com/kasperl/toit-qubitro

Publishing data

Qubitro expects key-value JSON formatted data for this source.

Client Examples

Various libraries for MQTT installation.

MQTT client libraries from various programming languages for introduction and description and provides basic function code examples for connecting, publishing, and subscribing.

We have libraries for the following languages:

Support and Feedback

If you have further questions or suggestions, feel free to join -> Qubitro Community Discord via this .

Arduino

Arduino is an open-source electronics platform based on easy-to-use hardware and software. Connect Arduino-based boards with the Qubitro MQTT package.

Nano 33 IoT

The Arduino Nano 33 IoT is Arduino's smallest board to get started with Internet of Things (IoT). Using the popular Arm® Cortex®-M0 32-bit SAMD21 processor, it also features the powerful u-blox NINA-W102 Wi-Fi module and the ECC608A crypto-chip for security.

MKR WiFi 1010

The MKR WiFi 1010 is a great choice for any beginner, maker or professional to get started with Internet of Things (IoT).Using the popular Arm® Cortex®-M0 32-bit SAMD21 processor, it also features the and the ECC508 crypto-chip for security.

MKR 1000 WiFi

The MKR 1000 WiFi is a great choice for any beginner, maker or professional to get started with Internet of Things (IoT). Using the popular Arm® Cortex®-M0 32-bit SAMD21 processor, it also features the and the ECC508 crypto-chip for security.

Support and Feedback

If you have further questions or suggestions, feel free to join -> Qubitro Community Discord via this .

Nano 33 IoT

Getting Started

Before getting started, make sure that required libraries are installed by visiting the setup page

Libraries

Include the required libraries and define objects on top of the page.

#include <QubitroMqttClient.h>
#include <WiFiNINA.h> 

WiFiClient wifiClient;
QubitroMqttClient mqttClient(wifiClient);

Variables

Define the required variables.

char deviceID[] = "PASTE_DEVICE_ID_HERE";
char deviceToken[] = "PASTE_DEVICE_TOKEN_HERE";
char host[] = "_IP_";
int port = 1883;

Data Structure

Qubitro currently has support for key-value paired JSON objects as a data type. Nested values are not supported yet.

{
  "Key1" : "Value1",
  "Key2" : true,
  "Key3" : 90
  ...
}

An example : "{\"Temp\":33}"

Setup method

Set client id for identification
Set device id and token for authentication
Connect to the Qubitro broker
Subscribe to the topic
Set onMessage method to listen subscribed topic

void setup() 
{
  
  mqttClient.setId(deviceID);
   
  mqttClient.setDeviceIdToken(deviceID, deviceToken);

  Serial.println("Connecting to Qubitro...");

  if (!mqttClient.connect(host, port)) 
  {
    Serial.println("Connection failed! Error code = ");
    Serial.println(mqttClient.connectError());
    Serial.println("Visit docs.qubitro.com or create a new issue on github.com/qubitro");
    while (1);
  }
  
  Serial.println("Connected to the Qubitro !");

  mqttClient.subscribe(deviceID);

  mqttClient.onMessage(receivedMessage);    
                                      
}

loop method

Publish data to the subscribed topic

void loop() 
{
   mqttClient.poll();   
   mqttClient.beginMessage(deviceID);   
   mqttClient.print("{\"Temp\":33}");
   mqttClient.endMessage();                
   delay(2000);   //wait 2 seconds
}

receivedMessage method

Print whenever message received

void receivedMessage(int messageSize) 
{
  Serial.print("New message received:");
  while (mqttClient.available()) 
  {
    Serial.print((char)mqttClient.read());
  }
  Serial.println();
}

Example

The following example :

Connects to the broker
Subscribes to the topic (the device itself in this example)
Publishes data in a loop with a delay of 2 seconds.
Prints message and subscribed topic (the device itself in this example)

Example output:

Connecting to WiFi...
Connected to the WiFi
Connecting to Qubitro...
Connected to the Qubitro !
New message received:{"Temp":33}
New message received:{"Temp":33}
New message received:{"Temp":33}

MKR WiFi 1010

Getting Started

Before getting started, make sure that required libraries are installed by visiting the setup page

Libraries

Include the required libraries and define objects on top of the page.

#include <QubitroMqttClient.h>
#include <WiFiNINA.h> 

WiFiClient wifiClient;
QubitroMqttClient mqttClient(wifiClient);

Variables

Define the required variables.

char deviceID[] = "PASTE_DEVICE_ID_HERE";
char deviceToken[] = "PASTE_DEVICE_TOKEN_HERE";
char host[] = "_IP_";
int port = 1883;

Data Structure

Qubitro currently has support for key-value paired JSON objects as a data type. Nested values are not supported yet.

{
  "Key1" : "Value1",
  "Key2" : true,
  "Key3" : 90
  ...
}

An example : "{\"Temp\":33}"

Setup method

Set client id for identification
Set device id and token for authentication
Connect to the Qubitro broker
Subscribe to the topic
Set onMessage method to listen subscribed topic

void setup() 
{
  
  mqttClient.setId(deviceID);
   
  mqttClient.setDeviceIdToken(deviceID, deviceToken);

  Serial.println("Connecting to Qubitro...");

  if (!mqttClient.connect(host, port)) 
  {
    Serial.println("Connection failed! Error code = ");
    Serial.println(mqttClient.connectError());
    Serial.println("Visit docs.qubitro.com or create a new issue on github.com/qubitro");
    while (1);
  }
  
  Serial.println("Connected to the Qubitro !");

  mqttClient.subscribe(deviceID);

  mqttClient.onMessage(receivedMessage);    
                                      
}

loop method

Publish data to the subscribed topic

void loop() 
{
   mqttClient.poll();   
   mqttClient.beginMessage(deviceID);   
   mqttClient.print("{\"Temp\":33}");
   mqttClient.endMessage();                
   delay(2000);   //wait 2 seconds
}

receivedMessage method

Print whenever message received

void receivedMessage(int messageSize) 
{
  Serial.print("New message received:");
  while (mqttClient.available()) 
  {
    Serial.print((char)mqttClient.read());
  }
  Serial.println();
}

Example

The following example :

Connects to the broker
Subscribes to the topic (the device itself in this example)
Publishes data in a loop with a delay of 2 seconds.
Prints message and subscribed topic (the device itself in this example)

Example output:

Connecting to WiFi...
Connected to the WiFi
Connecting to Qubitro...
Connected to the Qubitro !
New message received:{"Temp":33}
New message received:{"Temp":33}
New message received:{"Temp":33}

MKR 1000 WiFi

Getting Started

Before getting started, make sure that required libraries are installed by visiting the setup page

Libraries

Include the required libraries and define objects on top of the page.

#include <QubitroMqttClient.h>
#include <WiFi101.h>

WiFiClient wifiClient;
QubitroMqttClient mqttClient(wifiClient);

Variables

Define the required variables.

char deviceID[] = "PASTE_DEVICE_ID_HERE";
char deviceToken[] = "PASTE_DEVICE_TOKEN_HERE";
char host[] = "_IP_";
int port = 1883;

Data Structure

Qubitro currently has support for key-value paired JSON objects as a data type. Nested values are not supported yet.

{
  "Key1" : "Value1",
  "Key2" : true,
  "Key3" : 90
  ...
}

An example : "{\"Temp\":33}"

Setup method

Set client id for identification
Set device id and token for authentication
Connect to the Qubitro broker
Subscribe to the topic
Set onMessage method to listen subscribed topic

void setup() 
{
  
  mqttClient.setId(deviceID);
   
  mqttClient.setDeviceIdToken(deviceID, deviceToken);

  Serial.println("Connecting to Qubitro...");

  if (!mqttClient.connect(host, port)) 
  {
    Serial.println("Connection failed! Error code = ");
    Serial.println(mqttClient.connectError());
    Serial.println("Visit docs.qubitro.com or create a new issue on github.com/qubitro");
    while (1);
  }
  
  Serial.println("Connected to the Qubitro !");

  mqttClient.subscribe(deviceID);

  mqttClient.onMessage(receivedMessage);    
                                      
}

The loop method

Publish data to the subscribed topic

void loop() 
{
   mqttClient.poll();   
   mqttClient.beginMessage(deviceID);   
   mqttClient.print("{\"Temp\":33}");
   mqttClient.endMessage();                
   delay(2000);   //wait 2 seconds
}

receivedMessage method

Print whenever message received

void receivedMessage(int messageSize) 
{
  Serial.print("New message received:");
  while (mqttClient.available()) 
  {
    Serial.print((char)mqttClient.read());
  }
  Serial.println();
}

Example

The following example :

Connects to the broker
Subscribes to the topic (the device itself in this example)
Publishes data in a loop with a delay of 2 seconds.
Prints message and subscribed topic (the device itself in this example)

Example output:

Connecting to WiFi...
Connected to the WiFi
Connecting to Qubitro...
Connected to the Qubitro !
New message received:{"Temp":33}
New message received:{"Temp":33}
New message received:{"Temp":33}

C

Quick guide for C library.

Getting Started

Visit the MQTT overview page for conventions, authentication, and more information.

This documentation uses the Paho MQTT library. This library is open-source, so you can check it out on GitHub.

Install the packages

// Clone the library source
git clone https://github.com/eclipse/paho.mqtt.c.git
cd paho.mqtt.c

// Build the library
make

// Install to the system
sudo make install

Include libraries

#include "stdio.h"
#include "stdlib.h"
#include "string.h"
#include "MQTTClient.h"

Define variables

#define ADDRESS     "tcp://__broker_ip__"
#define CLIENTID    "__device_id__"
#define TOPIC       "__device_id__"
#define PAYLOAD     "{\"Key1\":Value1,\"Key2\":Value2}"
#define QOS         1
#define TIMEOUT     10000L

Set MQTT client options

Set client options and connect to the broker.

MQTTClient client;
MQTTClient_connectOptions options = MQTTClient_connectOptions_initializer;

options.username = "__device_id__";
options.password = "__device_token__";

MQTTClient_message pubmsg = MQTTClient_message_initializer;
MQTTClient_deliveryToken token;
int rc;

MQTTClient_create(&client, ADDRESS, CLIENTID,MQTTCLIENT_PERSISTENCE_NONE, NULL);
options.keepAliveInterval = 20;
options.cleansession = 1;

 if ((rc = MQTTClient_connect(client, &options)) != MQTTCLIENT_SUCCESS)
    {
        printf("Failed to connect, return code %d\n", rc);
        exit(-1);
    }
pubmsg.payload = PAYLOAD;
pubmsg.payloadlen = strlen(PAYLOAD);
pubmsg.qos = QOS;
pubmsg.retained = 0;

Publish data:

MQTTClient_publishMessage(client, TOPIC, &pubmsg, &token);

Optional: Close the connection to the broker:

MQTTClient_disconnect(client, 10000);
MQTTClient_destroy(&client);

Example

We strongly recommend using the 8883 port for MQTT over TLS connectivity.

ESP32

Connect ESP32-based boards with the Qubitro MQTT package.

Introduction

This example uses that offers a custom naming convention for easier development. It is possible to use any 3rd party MQTT Client with the following requirements.

For example, it is possible to use the library to connect MQTT over TLS with 8883 port.

Conventions

The helpful naming conventions for 3rd party MQTT libraries.

Examples

The following code connects to your wireless network, generates simulated sensor values, and publishes them to the Qubitro.

Example output:

Connecting to WiFi...
WiFi Connected.
Local IP: 192.168.1.100
RSSI: -50
Connecting to Qubitro...
Connected to Qubitro.
Sensor value 1: 20
Sensor value 2: 40

WifiClientSecure Example

Go

Quick guide for Go library.

Getting Started

Visit the MQTT overview page for conventions, authentication, and more information.

This documentation uses the Paho MQTT library. This library is open-source, so you can check it on GitHub.

Installing the packages

go get github.com/eclipse/paho.mqtt.golang

Import libraries

Then import it and initialize it with the required packages. Of course, you’ll want to replace DEVICE_ID and DEVICE_TOKENwith your actual device credentials which you can find under your device settings on Qubitro Portal.

Add the following code to the top of your page

package main

import (
	"encoding/json"
	"fmt"
	"time"

	mqtt "github.com/eclipse/paho.mqtt.golang"
)

Define Variables

var jsonData []byte
var deviceId string = "PASTE_DEVICE_ID_HERE"
var deviceToken string = "PASTE_DEVICE_TOKEN_HERE"
var brokerHost string = "tls://broker.qubitro.com:8883"

Setup MQTT Client

options := mqtt.NewClientOptions().AddBroker(brokerHost)
options.SetClientID(deviceId)
options.SetUsername(deviceId)
options.SetPassword(deviceToken)
options.AutoReconnect = true
	
client := mqtt.NewClient(options)

Define Callbacks

Define callbacks depending on your scenario.

See the examples below or visit the package documentation.

options.OnConnect = func(c mqtt.Client) {
		fmt.Println("Connected to Qubitro")
}

options.SetConnectionLostHandler(func(lost mqtt.Client, err error) {
		fmt.Println(err.Error())
})

Prepare Data

type Data struct {
	Temperature float64
	CpuUsage    float64
}

data := &Data{
		Temperature: 40.5,
		CpuUsage:    78,
}

Examples

We strongly recommend using the 8883 port for MQTT over TLS connectivity.

Publish

Message

Disconnect

client.Disconnect(250)

Javascript

Quick guide for JavaScript library.

Getting Started

Visit the MQTT overview page for conventions, authentication, and more information.

This documentation uses npm MQTT library. This library is open-source, so you can check it out on GitHub.

Install the packages

npm install mqtt --save

Import libraries

var mqtt = require('mqtt')

Define variables

var broker = 'PASTE_HOST_HERE'
var deviceToken  = 'PASTE_DEVICE_TOKEN_HERE'
var deviceId  = 'PASTE_DEVICE_ID_HERE'

Setup MQTT Client

var options = {
    port: 8883,
    keepalive: 60,
    secureProtocol: 'TLSv1_method'
    clientId: deviceId,
    username: deviceId,
    password: deviceToken,
};

var client = mqtt.connect(broker,options)

Prepare Data

const data = {
  key1: 'value1',
  key2: 'value2',
  key3: 'value3'
}

var sdata = JSON.stringclearify(data)

Examples

We strongly recommend using the 8883 port for MQTT over TLS connectivity.

Publish

An example of publishing data.

Python

Quick guide for Pyhton library.

Getting Started

Visit the MQTT overview page for conventions, authentication, and more information.

This documentation uses the Paho MQTT library. This library is open-source, so that you can check it out on GitHub.

Install the packages

pip3 install paho-mqtt

import paho.mqtt.client as mqtt
import json
import ssl

Examples

We strongly recommend using the 8883 port for MQTT over TLS connectivity.

QoS Options

client.subscribe(device_id, 0)

client.subscribe(device_id, 1)

client.subscribe(device_id, 2)

Publish

An example of publishing data.

An example of subscribing to a topic and receiving the message.

Log

Disconnect

Ruby

Quick guide for Ruby library.

Getting Started

Visit the MQTT overview page for conventions, authentication, and more information.

This library is open-source so you can check it out on GitHub.

Install the packages

gem install qubitro-mqtt

Import Libraries

require 'qubitro-mqtt'

Define Variables

deviceID = "PASTE_DEVICE_ID_HERE"
deviceToken = "PASTE_DEVICE_TOKEN_HERE"
host = "PASTE_DOMAIN_HERE"

Setup MQTT Client

Minimum configuration required to connect to the broker.

MQTT::Client.connect(
  :host => host,
  :port => 8883,
  :ssl => true,
  :client_id => deviceID,
  :device_id => deviceID,
  :device_token => deviceToken,
  :ack_timeout => 15,
  :will_topic => deviceID,
  :will_payload => payload,
)

Advanced configuration

MQTT::Client.connect(
:host => host,
:port => port,
:ssl => true | false,
:client_id => deviceID,
:device_id => deviceID,
:device_token => deviceToken,
:keep_alive => 15,
:clean_session => true | false,
:ack_timeout => 15,
:will_topic => deviceID,
:will_payload => payload,
:will_qos => 0 | 1, #QoS 2 not supported
:will_retain => false,
)

Prepare Data

payload = '{"Key1":1,"Key2":2}'

Examples

We strongly recommend using the 8883 port for MQTT over TLS connectivity.

Publish

Rust

Quick guide for Rust library.

Getting Started

Visit the MQTT overview page for conventions, authentication, and more information.

This documentation uses the Paho MQTT library. This library is open-source, so you can check it out on GitHub.

Install the packages

[dependencies]
paho-mqtt = {git = "https://github.com/eclipse/paho.mqtt.rust", branch = "master"}
futures = { version = "0.3", features = ["compat"] }

Import Dependencies

use std::{
    env,
    process,
    time::Duration,
    thread
};
use futures::{
    executor::block_on,
    stream::StreamExt,
};
use paho_mqtt as mqtt;

Define Variables

let host = "ssl://broker.qubitro.com:8883";
let dev_id = "PASTE_DEVICE_ID_HERE";
let dev_token = "PASTE_DEVICE_TOKEN_HERE";

Setup MQTT Client

Client Options:

let create_opts = mqtt::CreateOptionsBuilder::new()
    .server_uri(host)
    .persistence(mqtt::PersistenceType::None)
    .client_id(dev_id)
    .finalize();

MQTT Client:

let cli = mqtt::AsyncClient::new(create_opts).unwrap_or_else(|err| {
         println!("Error creating the client: {}", err);
         process::exit(1);
 });

Examples

We strongly recommend using the 8883 port for MQTT over TLS connectivity.

MQTT

Conventions

Authentication

Client ID

Quality of Service (QoS)

Data Structure

Toit MQTT Connector

Configure Source

Get Credentials

Toit Quick start guide

Getting started

Installing Qubitro package

Publishing data

Client Examples

Support and Feedback

Arduino

Nano 33 IoT

MKR WiFi 1010

MKR 1000 WiFi

Support and Feedback

Nano 33 IoT

Getting Started

Libraries

Variables

Data Structure

Setup method

loop method

receivedMessage method

Example

MKR WiFi 1010

Getting Started

Libraries

Variables

Data Structure

Setup method

loop method

receivedMessage method

Example

MKR 1000 WiFi

Getting Started

Libraries

Variables

Data Structure

Setup method

The loop method

receivedMessage method

Example

C

Getting Started

Include libraries

Define variables

Set MQTT client options

Example

ESP32

Introduction

Conventions

Examples

Subscribe and Publish Example

WifiClientSecure Example

Go

Getting Started

Import libraries

Define Variables

Setup MQTT Client

Define Callbacks

Prepare Data

Examples

Publish

Subscribe

Message

Disconnect

Javascript

Getting Started

Define variables

Setup MQTT Client

Prepare Data

Examples

Publish

Subscribe

Python