Control Remote Peripherals With MQTT

i recently covered the mqtt protocol and how it works , and we already know the iot mqtt is used to send data from remote sensors. just to recap briefly, mqtt is a lightweight protocol used in the telemetry. several iot platforms support mqtt to exchange data with remote iot boards and sensors. usually, iot boards use mqtt to connect to the iot platforms that acquire information.

project description

in this project, we use mqtt in a different way. we want to control an iot board (like the mkr1000) using mqtt. the target of this project is controlling an rgb led matrix remotely using mqtt. to build this project, we will use:

• arduino mkr1000
• 4×4 rgb led matrix

the mkr1000 will connect to the ubidots cloud platform using mqtt. this project is divided into two steps:

1. configure ubidots to handle the rgb color components using the web interface
2. develop an mqtt client to connect to ubidots and manage the led matrix

at the end of this project, we will control the rgb led matrix remotely using the ubidots web interface.

configure the iot board

in this first step, we will configure the ubidots interface to handle three color components. we will use sliders to control them. let us begin.

before continuing, you have to create a free account using this link . log into the application and click on the device to create a new device.

we used rgb controller as the device name. a device acts as a data container where we can group variables that hold the exchanged data. once the device is ready, we can start adding a new variable:

we will create three variables called:

• redcolor
• greencolor
• bluecolor

now it is time to create the dashboard that we will use to control these variable values. go to dashboard and click on "add". give a name to your dashboard and start adding controls. in this project, we add sliders, so click on "add new widget" and then on "slider":

select the device (aka the data source) previously configured:

select the rgb controller and you will see three variables:

select one of them and repeat the process for all three variables. at the end, you will have a dashboard that looks like this:

implementing a client to handle mqtt

once the iot platform is configured, we can focus our attention on the iot mqtt client. this client receives the data from the platform and manages the rgb led matrix. to create the client, we use the following libraries:

• adafruit neomatrix
• mqtt client (you can download it from the arduino library manager)

the first step is initialized the neomatrix, providing a set of information like the matrix width and height and the pin number. in our case, the rgb led matrix is connected using mkr pin 5.

adafruit_neomatrix matrix = adafruit_neomatrix(4, 4, 5,
                           neo_matrix_top     + neo_matrix_right +
                           neo_matrix_columns + neo_matrix_progressive,
                           neo_grb + neo_khz800);

notice the first three parameters represent the number of leds in a row and in a column. using the matrix instance, we can color the matrix.

let us implement the mqtt client. this project uses an mkr1000, so we'll use a wi-fi connection:

wificlient net;
mqttclient mqttclient;
 
void setup() {
      serial.begin(115000);  
      serial.println("configuring the net...");
      wifi.begin("your wifi sid", "your wifi password");
 
  while (wifi.status() != wl_connected) {
        serial.print(".");
        delay(1000);
    }
    serial.println("begin...");
    mqttclient.begin("mqtt://things.ubidots.com", net);
    matrix.begin();
    connect();
}

in the setup() method, we simply initialize the wi-fi connection and the mqttclient . to initialize the mqtt client, we have to set the mqtt server (ubidots server address) and the net .
the connect() method handles the connection and the mqtt topic subscription . according to the ubidots docs , each variable defined in the data source (aka device) has its own topic:

/v1.6/devices/_device_name/_variable_name/lv

notice that the lv at the end of the topic stands for last value . in other words, we are interested only in the last variable value to control the rgb led matrix. in this project, the application has to subscribe to the following topics:

/v1.6/devices/rgbcontroller/redcolor/lv
/v1.6/devices/rgbcontroller/greencolor/lv
/v1.6/devices/rgbcontroller/bluecolor/lv

so the connect() method is:

void connect() {
    serial.println("connecting to mqtt....");
    if (mqttclient.connect("your_unique_id", "your_ubidots_token", "")) {
        serial.println("mqtt client connected");
        int result = mqttclient.
        subscribe("/v1.6/devices/rgbcontroller/redcolor/lv");
        serial.println(result);
        serial.println("subscribed red topic.");
        int result1 = mqttclient.
        subscribe("/v1.6/devices/rgbcontroller/greencolor/lv");
        serial.println(result1);
        serial.println("subscribed green topic.");
        int result2 = mqttclient.
        subscribe("/v1.6/devices/rgbcontroller/bluecolor/lv");
        serial.println(result1);
        serial.println("subscribed blue topic.");
    } else {
        serial.println("######### client not connected ########");
    }
}

once the application is connected to the mqtt server and subscribed to the variable topics, we have to implement the method that listens to the values coming from the mqtt server. to this purpose, we have to implement a method named:

messagereceived(string topic, string payload, char * bytes, unsigned int length)

in this method, the application has to do the following tasks:

• identify the topic that holds the message.
• convert the message to the color component value.
• control the rgb led matrix, setting the new color.

this is the method implementation:

void messagereceived(string topic, string payload,
    char * bytes, unsigned int length) {

    if (topic.indexof("redcolor") >= 0) {
        red = atoi(bytes);
    } else if (topic.indexof("greencolor") >= 0) {
        green = atoi(bytes);
    } else if (topic.indexof("bluecolor") >= 0) {
        blue = atoi(bytes);
    }
    matrix.fillscreen(matrix.color(red, green, blue));
    matrix.show();
}

that’s all. in the last two lines of the method, we use the instance of matrix to fill the rgb led matrix with the color identified by the red, green, or blue component, and we show it.

now you can try to use the three sliders in the ubidots iot console to change the rgb led matrix color.

conclusion

at the end of this post, hopefully, you have gained knowledge about the mqtt protocol and how to use it to control remote peripherals.