Arduino: MQTT: mudanças entre as edições

De Wiki Cursos IFPR Foz
Ir para navegaçãoIr para pesquisar
 
(47 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
=MQTT e Arduino=
=Experimento: MQTT e Arduino=


O suporte para '''MQTT''' para '''Arduíno''' é provido por uma '''biblioteca''' que pode ser obtida em: https://github.com/knolleary/pubsubclient .
O suporte para '''MQTT''' para '''Arduíno''' é provido por uma '''biblioteca''' que pode ser obtida em: https://github.com/knolleary/pubsubclient .
Linha 7: Linha 7:
Para interagir com a '''rede''' é necessário um '''''shild'' Ethernet''' colocado sobre a placa Arduíno.
Para interagir com a '''rede''' é necessário um '''''shild'' Ethernet''' colocado sobre a placa Arduíno.


;Limitações do MQTT para Arduíno:
==Descrição do experimento==
*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:
Neste experimento foi utilizado um '''Arduino UNO''' com um '''''Shield'' Ethernet''', rodando a '''biblioteca PubSubClient.h''' para interagir um com '''brocker Mosquitto''' e '''clientes publicadores''' e '''subscritores''' através do '''protocolo MQTT'''.
*''Shield'' Ethernet
*Arduíno Ethernet
*Arduíno Yun
*Arduíno Wifi
*ESP8266
*ESP32


==Exemplo: MQTT e Arduino==
A comunicação foi realizada através de uma '''rede local''' residencial e foram utilizados os seguintes '''endereços IP''':
*brocker '''Mosquito''': 192.168.1.19/24
*'''Arduino''': 192.168.1.50/24
*Clientes ('''mosquitto_pub''' e '''mosquitto_sub'''): 192.168.1.19/24
 
===Código fonte Arduino===
 
O '''código''' Arduino abaixo descreve o cenário da aplicação e ilustra o uso das funções da '''biblioteca PubSubClient.h''' para implementar a comunicação MQTT.


<syntaxhighlight lang="c">
<syntaxhighlight lang="c">
Linha 34: Linha 28:


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


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


EthernetClient ethClient;
EthernetClient ethClient;
Linha 63: Linha 56:
   }
   }
   Serial.println();
   Serial.println();
   //comanda o "led" e publica "ledStatus"
   //comanda o LED
   if (length == 2 and !strncmp((char*)payload, "on", length)) {
   if ((char)payload[0] == '1') {
      digitalWrite(LED_BUILTIN, HIGH);
    digitalWrite(4, HIGH);
      client.publish("ledStatus", "ON");
   } else if ((char)payload[0] == '0') {
   } else if (length == 3 and !strncmp((char*)payload, "off", length)) {
    digitalWrite(4, LOW);
      digitalWrite(LED_BUILTIN, LOW);
   }  
      client.publish("ledStatus", "OFF");
  } else {
      client.publish("ledStatus", "NOT CHANGE");
   }
}
}


Linha 78: Linha 67:
{
{
   Serial.begin(57600);
   Serial.begin(57600);
  pinMode(4, OUTPUT);


   client.setServer(server, 1883);
   client.setServer(server, 1883);
Linha 96: Linha 87:
     //Mensagem lastWill
     //Mensagem lastWill
     byte willQoS = 0;
     byte willQoS = 0;
     const char* willTopic = "status";
     const char* willTopic = "arduino/status";
     const char* willMessage = "off-line";
     const char* willMessage = "OFF_LINE";
     boolean willRetain = true;
     boolean willRetain = true;
     //Conexão
     //Conexão
Linha 103: Linha 94:
       Serial.println("connected");
       Serial.println("connected");
       //Uma vez conectado publica status
       //Uma vez conectado publica status
       char* message = "on-line";
       char* message = "ON_LINE";
       int length = strlen(message);
       int length = strlen(message);
       boolean retained = true; //Retain message
       boolean retained = true; //Retain message
       client.publish("status", (byte*)message, length, retained);
       client.publish("arduino/status", (byte*)message, length, retained);
       // ... and resubscribe
       // ... and resubscribe
       client.subscribe("led");
       client.subscribe("arduino/led");
     } else {
     } else {
       Serial.print("failed, rc=");
       Serial.print("failed, rc=");
Linha 119: Linha 110:
   //e aguardar recebimento de mensagens
   //e aguardar recebimento de mensagens
   client.loop();
   client.loop();
}
}      
 
</syntaxhighlight>
</syntaxhighlight>
==Comandos nos terminais clientes MQTT==
;Cliente Subscritor:
mosquitto_sub -h 192.168.1.19 -t arduino/status
;Cliente Publicador:
mosquitto_pub -h 192.168.1.19 -t arduino/led -m 1
mosquitto_pub -h 192.168.1.19 -t arduino/led -m 0
==Análise da troca de mensagens com Wireshark==
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.18/24
[[Arquivo:brockerMQTT&Arduino.png]]
;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"'''.
;Observação: As '''mensagens em preto''', com indicação de ''TCP ACKED unseen segment'', como indicado em <ref>https://osqa-ask.wireshark.org/questions/46134/tcp-acked-unseen-segment</ref>, "se referem a pacotes que foram transferidos e reconhecidos, mas que não foram capturados pelo Wireshark. Usualmente isto acontece quando o dispositivo não é rápido o suficiente". O que pede ser o caso do Arduino.
<!--==Interação com Node-RED==
O mesmo exemplo pode ser utilizado para interação com '''[[Node-RED#Interação_do_Node_RED_e_ESP8266_via_brocker_Moquitto|Interação do Node_RED e ESP8266 via brocker Moquitto]] ''' utilizando o broker '''Mosquitto''' para intermediar a comunicação.-->
==Projeto: Arduíno e MQTT==
Construir um projeto utilizando dois '''Arduínos''' e comunicação utilizando o '''protocolo MQTT'''. Um dos Arduínos deve '''monitorar sensores''' (temperatura, luminosidade ou outros) e '''publicar''' periodicamente os dados lidos em um '''broker MQTT'''. O outro Arduío deve '''subscrever tópicos''' no '''broker''' e, a partir dos tópicos subscritos, '''comandar dispositivos''', como relés, leds ou motores.


==Referências==
==Referências==
Linha 127: Linha 152:
[[Categoria:IoT]]
[[Categoria:IoT]]
[[Categoria:Arduíno]]
[[Categoria:Arduíno]]
 
----
[[Usuário:Evandro.cantu|Evandro.cantu]] ([[Usuário Discussão:Evandro.cantu|discussão]]) 10h27min de 16 de abril de 2020 (-03)
[[Usuário:Evandro.cantu|Evandro.cantu]] ([[Usuário Discussão:Evandro.cantu|discussão]]) 17h21min de 27 de junho de 2023 (-03)

Edição atual tal como às 20h22min de 27 de junho de 2023

Experimento: 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: [1]

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

Descrição do experimento

Neste experimento foi utilizado um Arduino UNO com um Shield Ethernet, rodando a biblioteca PubSubClient.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.1.19/24
  • Arduino: 192.168.1.50/24
  • Clientes (mosquitto_pub e mosquitto_sub): 192.168.1.19/24

Código fonte Arduino

O código Arduino abaixo descreve o cenário da aplicação e ilustra o uso das funções da biblioteca PubSubClient.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 "arduino/status" com mensagem "off-line"
    (será publicada caso o Arduino seja desconectado involuntariamente);
  - publica para o tópico "arduino/status" a mensagem  "on-line" anunciando que está ativo;
  - subscreve o tópico "arduino/led" para receber comandos para um led;
  - caso receba mensagem para o tópico "arduino/led", aciona o led conforme comando recebido.
*/

#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, 1, 50);
IPAddress server(192, 168, 1, 19);

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
  if ((char)payload[0] == '1') {
    digitalWrite(4, HIGH);
  } else if  ((char)payload[0] == '0') {
    digitalWrite(4, LOW);
  } 
}

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

  pinMode(4, OUTPUT);

  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 = "arduino/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("arduino/status", (byte*)message, length, retained);
      // ... and resubscribe
      client.subscribe("arduino/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();
}

Comandos nos terminais clientes MQTT

Cliente Subscritor
mosquitto_sub -h 192.168.1.19 -t arduino/status
Cliente Publicador
mosquitto_pub -h 192.168.1.19 -t arduino/led -m 1
mosquitto_pub -h 192.168.1.19 -t arduino/led -m 0

Análise da troca de mensagens com Wireshark

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.18/24

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".
Observação
As mensagens em preto, com indicação de TCP ACKED unseen segment, como indicado em [2], "se referem a pacotes que foram transferidos e reconhecidos, mas que não foram capturados pelo Wireshark. Usualmente isto acontece quando o dispositivo não é rápido o suficiente". O que pede ser o caso do Arduino.

Projeto: Arduíno e MQTT

Construir um projeto utilizando dois Arduínos e comunicação utilizando o protocolo MQTT. Um dos Arduínos deve monitorar sensores (temperatura, luminosidade ou outros) e publicar periodicamente os dados lidos em um broker MQTT. O outro Arduío deve subscrever tópicos no broker e, a partir dos tópicos subscritos, comandar dispositivos, como relés, leds ou motores.

Referências


Evandro.cantu (discussão) 17h21min de 27 de junho de 2023 (-03)