Arduino: MQTT

MQTT e Arduino

O suporte para MQTT para Arduíno é provido por uma biblioteca que pode ser obtida em: https://github.com/knolleary/pubsubclient .

Uma boa descrição do uso da biblioteca PubSubClient.h pode ser encontrada em:

Para interagir com a rede é necessário um shild Ethernet colocado sobre a placa Arduíno.

Limitações do MQTT para Arduíno

• Suporta somente publicações com QoS=0 e subscrições com QoS=0 ou QoS=1.
• Suporta somente CleanSessions devido a limitação de memória.
• Tamanho máximo de mensagem com 128 bytes por default.
• Intervalo de keep alive de 15 s por default.

  Os dois últimos parâmetros podem ser alterados na biblioteca PubSubClient.h:

  MQTT_MAX_PACKET_SIZE

  MQTT_KEEPALIVE

Hardware compatível

• Shield Ethernet
• Arduíno Ethernet
• Arduíno Yun
• Arduíno Wifi
• ESP8266
• ESP32

Experimento: MQTT e Arduino

Neste experimento foi utilizado um Arduino Leonardo com um Shield Ethernet, rodando a biblioteca PuSubClient.h para interagir um com brocker Mosquitto e clientes publicadores e subscritores através do protocolo MQTT.

A comunicação foi realizada através de uma rede local residencial e foram utilizados os seguintes endereços IP:

• brocker Mosquito: 192.168.0.13/24
• Arduino: 192.168.0.30/24
• Clientes (mosquitto_pub e mosquitto_sub): 192.168.0.21/24

O código Arduino abaixo descreve o cenário da aplicação e ilustra o uso das funções da biblioteca PuSubClient.h para implementar a comunicação MQTT.

/*            
 Baseado no exemplo da bilbioteca PubSubClient.h: Basic MQTT example

 Exemplo: MQTT com Arduíno/Shield Ethernet e Mosquitto: 
 Anunciar status do Arduino, receber comando para led e publicar status do led.

 Este sketch demonstra a comunicação de um Arduino com um brocker Mosquitto usando MQTT:
  - conecta ao brocker e informa lastWill para o tópico "status" com mensagem "off-line"
    (será publicada caso o Arduino seja desconectado involuntariamente);
  - publica para o tópico "status" a mensagem  "on-line" anunciando que está ativo;
  - subscreve o tópico "led" para receber comandos para um led;
  - caso receba mensagem para o tópico "led", aciona o led conforme comando recebido
    e publica para o tópico "ledStatus" o estado do led após o comando.
*/

#include <SPI.h>
#include <Ethernet.h>
#include <PubSubClient.h>

// Endereçamento IP utilizado para o cliente e servidor
byte mac[]    = { 0xDE, 0xED, 0xBA, 0xFE, 0xFE, 0xED };
IPAddress ip(192, 168, 0, 30);
IPAddress server(192, 168, 0, 13);

EthernetClient ethClient;
PubSubClient client(ethClient);

//Função callback chamada quando uma mensagem for recebida para subscrições:
void callback(char* topic, byte* payload, unsigned int length) {
  Serial.print("message arrived [");
  Serial.print(topic);
  Serial.print("] ");
  for (int i=0;i<length;i++) {
    Serial.print((char)payload[i]);
  }
  Serial.println();
  //comanda o "led" e publica "status"
  if (length == 2 and !strncmp((char*)payload, "on", length)) {
      digitalWrite(LED_BUILTIN, HIGH);
      client.publish("status", "ON_LINE: led ON");
  } else if (length == 3 and !strncmp((char*)payload, "off", length)) {
      digitalWrite(LED_BUILTIN, LOW);
      client.publish("status", "ON_LINE: led OFF");
  } else {
      client.publish("status", "ON_LINE: led UNCHANGED");
  }
}

void setup()
{
  Serial.begin(57600);

  client.setServer(server, 1883);
  client.setCallback(callback);

  Ethernet.begin(mac, ip);
  delay(5000); // Allow the hardware to sort itself out
  
  delay(10000);
}

void loop(){
  // Aguarda conexão    
  while (!client.connected()) {

    Serial.print("Attempting MQTT connection...");

    //Mensagem lastWill
    byte willQoS = 0;
    const char* willTopic = "status";
    const char* willMessage = "OFF_LINE";
    boolean willRetain = true;
    //Conexão
    if (client.connect("arduinoClient", willTopic, willQoS, willRetain, willMessage)) {
      Serial.println("connected");
      //Uma vez conectado publica status
      char* message = "ON_LINE";
      int length = strlen(message);
      boolean retained = true; //Retain message
      client.publish("status", (byte*)message, length, retained);
      // ... and resubscribe
      client.subscribe("led");
    } else {
      Serial.print("failed, rc=");
      Serial.print(client.state());
      Serial.println(" try again in 5 seconds");
      delay(5000);
    }
  }
  //Uma vez conectado client.loop() deve ser chamada periodicamente para manter conexão
  //e aguardar recebimento de mensagens
  client.loop();
}

Análise da troca de mensagens com Wireshark

Análise das mensagens trocadas

• Na marca de tempo 5.6... um cliente se conectou ao brocker e subscreveu o tópico "status".
• Na marca de tempo 36.3... o Arduíno se conectou ao brocker e informou tópico/mensagem lastWill ("status = OFF_LINE"), publicou o tópico "status = ON_LINE" e subscreveu o tópico "led". O brocker também publicou o tópico "status" para o cliente.
• Na marca de tempo 42.6... outro cliente se conectou ao brocker e publicou o tópico "led = ON". O brocker também publicou o tópico "led = ON" ao Arduino (que acionou um led) e publicou ao cliente o tópico "status = ON_LINE: led ON"
• Em seguida o Arduíno foi desligado.
• Na marca de tempo 65.6..., como o brocker não recebeu do Arduíno um PINGREC, ele supos que o Arduino foi desconectado involuntariamente e publicou ao cliente o tópico "status = OFF_LINE".

Obs: As mensagens em preto, com indicação de Spurious Retransmission e TCP ACKED unseen segment, não consegui diagnosticar. Creio que seja devido a alguma dificuldade da biblioteca PubSubClient.h no manuseio dos números de sequência e reconhecimento TCP.

Referências

Evandro.cantu (discussão) 10h27min de 16 de abril de 2020 (-03)