Para visualizar los resultados en el broker Home-assistant, usando los valores del servidor MQTT, se añaden las siguientes lineas en el archivo configuration.yaml.
el ejemplo describe la configuración para dos dispositivos D1 y D2, con los valores de «ON» y «OFF».
Para la presentación en home-assistant, se añade una tarjeta de «entidades», indicando los elementos de cada sensor. Especificarlos como luz, permite disponer del estado «ON» y «OFF» junto al boton de control para encender y apagar.
Para prueba del concepto, se implementa un dispositivo simplificado, un dispositivo que emite un «parpadeo» binario como estado de sensor.
Estado del sensor
El estado del sensor se indica con los valores "ON" encendido y "OFF" para apagado. El parpadeo se realiza a intervalos de tiempo de duración aleatoria entre 1 a 3 segundos.
Direccionamiento
El direccionamiento se realiza usando un numero hexadecimal almacenado en un byte. Por facilidad de identificación, se usa como dirección :
Dispositivo usa "D1" por la inicial, los otros dispositivos serán "D2","D3", etc.
gateway usa la dirección "C1" cuya inicial es de Concentrador o coordinador, nombre también usado en otras tecnologías.
El algoritmo esta realizado para una placa de desarrollo LoRa, la disponible es de marca Heltec LoRa ESP32 que ofrece librerías simplificadas. Un siguiente paso de desarrollo consiste en usar un módulo LoRa y un Arduino Uno por ejemplo, realizado con librerías más generales.
Instrucciones
Las instrucciones de dividen en el bloque principal, el procedimiento de sensor, y los procedimientos LoRa para envío y recepcion, separados en cada pestaña.
Bloque principal
Declara las librerias para el módulo o placa de desarrollo Heltec, se indica los parámetros LoRa como la Banda ISM que para Ecuador es US915, también se establecen las variables para el manejo de los mensajes de envío y recepción, tiempo de lecturas del sensor «simulado» para la prueba.
El bucle de configuración setup() inicializa el módulo y el de operación loop() revisa los tiempos en los que se debe realizar la lectura del sensor y el envío del mensaje LoRa. Luego revisa si se ha recibido un mensaje LoRa para mostrarlo en la ventana del «monitor serie».
/* Dispositivo Sensor Blink Parpadeo ON/OFF * http://blog.espol.edu.ec/girni/lora-multipunto-esquema/ * Referencia: Ejemplos de Aaron.Lee www.heltec.cn*/#include"heltec.h"// LoRa Banda ISM en Región 915Mhz#defineBAND915E6// 433E6,868E6,915E6bytespread_factor=8;// rango 6-12,default 7// Mensaje LoRa a enviar por direccionesbytedir_local=0xD1;// Dispositivo 1bytedir_destino=0xC1;// Dispositivo 2byteid_msjLoRa=0;// cuenta mensajeStringpaqueteEnv= ""; // mensaje
// Mensaje LoRa recibidobytedir_envio=0xD1;// receptorbytedir_remite=0xC1;// emisorStringpaqueteRcb="";// mensaje LoRabytepaqRcb_ID=0;bytepaqRcb_Estado=0;// 0:vacio, 1: nuevo, 2:incompleto// 3:otro destinatario, 4:Broadcast// Mensajes por Puerto Serial activabooleanserial_msj=true;// SENSOR ParpadeoStringsensorEstado="ON";// ON/OFF: 1/0// tiempo entre lecturaslongtiempo_antes=0;longtiempo_intervalo=6000;longtiempo_espera=tiempo_intervalo+random(3000);voidsetup(){Heltec.begin(false/*DisplayEnable Enable*/,true/*Heltec.Heltec.Heltec.LoRa Disable*/,serial_msj/*Serial Enable*/,true/*PABOOST Enable*/,BAND/*long BAND*/);LoRa.setSpreadingFactor(spread_factor);//LoRa.onReceive(cbk);LoRa.receive();}voidloop(){intrssi_lora=0;// nivel de señalintsnr_lora=0;// Enviar mensajes entre intervaloslongtiempo_ahora=millis();longt_transcurrido=tiempo_ahora-tiempo_antes;if(t_transcurrido>=tiempo_espera){sensor_revisa();//actualiza sensorpaqueteEnv=String(sensorEstado).c_str();envia_lora(dir_destino,dir_local,id_msjLoRa,paqueteEnv);id_msjLoRa=id_msjLoRa+1;// mensaje a serial monitorif(serial_msj==true){Serial.print("Enviado: ");Serial.print(String(dir_local,HEX));Serial.print(",");Serial.print(String(dir_destino,HEX));Serial.print(",");Serial.print(id_msjLoRa-1);Serial.print(",");Serial.println(paqueteEnv);}tiempo_antes=millis();tiempo_espera=tiempo_intervalo+random(3000);// LED parpadea. Envio LoRadigitalWrite(LED,HIGH);delay(100);digitalWrite(LED,LOW);delay(100);}// Revisar mensajes LoRa entrantesintmsjRcbLoRa=LoRa.parsePacket();if(msjRcbLoRa!=0){recibe_lora(msjRcbLoRa);rssi_lora=LoRa.packetRssi();snr_lora=LoRa.packetSnr();if(serial_msj==true){if(paqRcb_Estado==1){Serial.print("Recibido: ");Serial.print(String(dir_remite,HEX));Serial.print(",");Serial.print(String(dir_envio,HEX));Serial.print(",");Serial.print(paqRcb_ID);Serial.print(",");Serial.print(paqueteRcb);Serial.print(",");Serial.print(rssi_lora);Serial.print(",");Serial.print(snr_lora);Serial.print(",");Serial.println();}else{Serial.print("Paquete recibido Estado: ");Serial.println(paqRcb_Estado);}}// LED parpadea Rebibido LoradigitalWrite(LED,HIGH);delay(50);digitalWrite(LED,LOW);delay(50);digitalWrite(LED,HIGH);delay(50);digitalWrite(LED,LOW);}delay(100);}
Procedimiento de envío de paquete LoRa
Se toman los valores para destino, remitente, identificador de paquete y el mensaje o paquete a enviar, para realizar el paso de envio del mensaje con la instrucción LoRa.write().
voidenvia_lora(bytedestino,byteremite,bytepaqueteID,Stringpaquete){// espera radio para enviar un paquetewhile(LoRa.beginPacket()==0){if(serial_msj==true){Serial.println("Esperando radio disponible...");}delay(100);}// envio del mensaje LoRaLoRa.beginPacket();LoRa.write(destino);LoRa.write(remite);LoRa.write(paqueteID);LoRa.write(paquete.length());LoRa.print(paquete);LoRa.endPacket();}
Procedimiento de recepción de paquete LoRa
Para recibir un paquete LoRa se procede en el mismo orden realizado para el envío, es decir primero se recibe la dirección de envío, la dirección del remitente, el identificador del mensaje, tamaño del mensaje en bytes, todo lo que viene luego es el mensaje transmitido.
Luego se revisa el tamaño del paquete recibido y se compara con el valor de la variable de tamaño del mensaje. Esto permite validar si el mensaje se ha recibido completo o requiere alguna retransmisión.
voidrecibe_lora(inttamano){if(tamano==0){paqRcb_Estado=0;//vacioreturn;}// lectura de paquetepaqueteRcb="";dir_envio=LoRa.read();dir_remite=LoRa.read();paqRcb_ID=LoRa.read();bytepaqRcb_Tamano=LoRa.read();while(LoRa.available()){paqueteRcb+=(char)LoRa.read();}if(paqRcb_Tamano!=paqueteRcb.length()){paqRcb_Estado=2;// Tamaño incompletoreturn;}if(dir_envio!=dir_local){paqRcb_Estado=3;// otro destinoreturn;}if(dir_envio==0xFF){paqRcb_Estado=4;//Broadcast, difusionreturn;}paqRcb_Estado=1;// mensaje Nuevo}
Procedimiento para el sensor
En el ejercicio el procedimiento para el sensor consiste en altenar los valores entre encendido y apagado, el valor cambia cada vez que se use el procedimiento sensor_revisa()
Para realizar pruebas punto a punto, es necesario usar todas las instrucciones anteriores y cambiar solamente la dirección local y destino del mensaje y en el bloque principal siguiendo el esquema:
En el caso de recepción, los valores se actualizan en el procedimiento, dado que las direcciones son parte de la trama de datos, por lo que los valores declarados son solo referenciales.
Con lo que se pueden intercambiar mensajes entre dispositivos, modalidad punto a punto, obteniendo el siguiente resultado si están conectados las dos placas de desarrollo.
El esquema básico de comunicación de mensajes en los ejemplos es de punto a punto.
El siguiente nivel de comunicación es a varios dispositivos donde se requiere identificación o dirección del cada dispositivo.
En comunicación multipunto, la dirección (local y destino) permite identificar al emisor y receptor. Con las direcciones se pueden enviar mensajes entre dispositivos: uno a uno, uno a varios.
Se usa un esquema simple de direcciones en hexadecimal con la nomenclatura:
– «D#» para dispositivos y
– «C#» para concentradores o gateways en la red,
El símbolo «#» indica el número de dispositivo en la red. La dirección es numérica Hexadecimal donde se aprovecha los símbolos «D» y «C» para simplificar la asignación de direcciones en los prototipos, no es un limitante en la aplicación solo una forma didáctica de facilitar la identificación.
Una vez establecida la comunicación multipunto, el siguiente paso es conectar la red LoRa a otras redes, por lo que se designa un elemento de red como Gateway/Coordinador. La definición en este caso es semejante a otras redes inalámbricas como lo usado en Zigbee.
El dispositivo coordinador o gateway si es un módulo LoRa ESP32, permitirá enviar el mensaje por la red WiFi al broker. El formato del mensaje a emplear es MQTT aprovechando los conceptos descritos para dispositivos con WiFi.
El broker recibe los mensajes en MQTT y los gestiona con Home-Assistant. A partir de aquí, los datos se pueden visualizar en una página web (local o en nube).
El prototipo para un gateway simple se inicia con la función de recepción de mensajes que hay que procesar para enviarlos aun servidor MQTT. A partir de donde se gestionan los datos de los sensores.
Para el prototipo se usa placa de desarrollo que contiene: un módulo LoRa y un SoC ESP32. Si se reutiliza algunos componentes de algoritmos usados para los dispositivos con WiFi, la versión inicial se conecta un router IP via WiFi de donde se envia el mensaje MQTT.
El mensaje MQTT require la descripción de un tópico, por lo que en la conformación del tópico se usa la dirección de envío.
Los valores usados en el mensaje MQTT, son el estado del sensor u otro valor que se requiera. Para facilitar el seguimiento inicial de datos, se publica el identificador de mensaje, que es un contador ascendente que permite observar la secuencia del número de mensaje.
Gateway Multipunto – Recepción Lora y envío MQTT
Para el ejercicio se habilitan dos dispositivos «D1» y «D2», comprobando los mensajes recibidos de varias formas:
– mensajes por puerto serial
– mensajes MQTT en servidor
Instrucciones en Arduino
Los bloques se crean a partir del ejemplo de LoRa Mutipunto para dispositivos, aprovechando que el módulo Heltec LoRa-ESP32 tiene incorporado WiFi. Aunque no se encuentran todos los canales disponibles al mismo tiempo para recibir todas las señales, se aprovecha que si el canal está libre se puede realizar la transmisión del estado del sensor desde LoRa hacia WiFi para llegar hasta el broker MQTT.
El ejercicio es una prueba de concepto, pues un gateway completo debe estar atento a todos los canales de transmisión y tener la capacida de atención a cada uno de ellos simultaneamente.
Bloque principal
En el bloque principal se adjuntan los parámetros de conexión por WiFi, asi como las instrucciones de inicialización. Desde luego será necesario añadir los procedimientos de WiFi y MQTT.
/* Dispositivo Gateway: LoRa/WiFi/MQTT/Home-Assistant * http://blog.espol.edu.ec/girni/lora-multipunto-esquema/ * Referencia: Aaron.Lee www.heltec.cn, * https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series*/#include"heltec.h"#include<WiFi.h>#include<PubSubClient.h>// LoRa Banda ISM en Región 915Mhz#defineBAND915E6//433E6,868E6,915E6bytespread_factor=8;// rango 6-12,default 7// Mensaje LoRa a enviar por direccionesbytedir_local=0xC1;// Dispositivo 1bytedir_destino=0xD1;// Dispositivo 2byteid_msjLoRa=0;// cuenta mensajeStringpaqueteEnv="";// mensaje// Mensaje LoRa recibidobytedir_envio=0xC1;// receptorbytedir_remite=0xD1;// emisorStringpaqueteRcb="OFF";// mensaje LoRabytepaqRcb_ID=0;bytepaqRcb_Estado=0;// 0:vacio, 1: nuevo, 2:incompleto// 3:otro destinatario, 4:Broadcast// LED interno, ESP01-pin=1, ESP07-pin=2intLED_pin=LED;//LED interno Heltec// Mensajes por Puerto Serialbooleanserial_msj=true;// tiempo entre lecturaslongtiempo_antes=0;inttiempo_intervalo=6000;longtiempo_espera=tiempo_intervalo+random(3000);// WIFI: conexión a Routerchar*ssid="miRouter";char*password="miRouterclave";// MQTT: Servidorchar*MQTT_IP="192.168.10.50";uint16_tMQTT_puerto=1883;char*MQTT_usuario="usuarioprueba";char*MQTT_contrasena="usuarioclave";// MQTT: Dispositivo Sensorchar*MQTT_ID="LoraGatewayC1";Stringtopico_base="invernadero/lora";Stringtopico_valor="/valor";charMQTT_TOPIC[50]="";// construido en algoritmocharMQTT_SensorEstado[10]="OFF";booleanmqtt_desconectado=true;// MQTT: Dispositivo ActuadorStringtopico_accion="/cambia";charMQTT_COMMAND[50]="";charMQTT_ActuadorEstado[10]="OFF";booleanactuador_estado=false;booleanactuador_bandera=false;char*sensor_ON="ON";char*sensor_OFF="OFF";// Clientes WiFi y MQTTWiFiClientwificlient;PubSubClientmqttclient(wificlient);voidsetup(){Heltec.begin(false/*DisplayEnable Enable*/,true/*Heltec.LoRa Disable*/,serial_msj/*Serial Enable*/,true/*PABOOST Enable*/,BAND/*long BAND*/);LoRa.setSpreadingFactor(spread_factor);//LoRa.onReceive(cbk);LoRa.receive();inicia_wifi();// conexión WIFI y MQTTif(WiFi.status()==WL_CONNECTED){inicia_mqtt();}}voidloop(){// LoRa Revisa mensajes de dispositivosintmsjRcbLoRa=LoRa.parsePacket();if(msjRcbLoRa!=0){recibe_lora(msjRcbLoRa);intrssi_lora=LoRa.packetRssi();intsnr_lora=LoRa.packetSnr();if(serial_msj==true){if(paqRcb_Estado==1){Serial.print("Recibido: ");Serial.print(String(dir_remite,HEX));Serial.print(",");Serial.print(String(dir_envio,HEX));Serial.print(",");Serial.print(paqRcb_ID);Serial.print(",");Serial.print(paqueteRcb);Serial.print(",");Serial.print(rssi_lora);Serial.print(",");Serial.print(snr_lora);Serial.print(",");Serial.println();}else{Serial.print("Paquete recibido Estado: ");Serial.println(paqRcb_Estado);}}// LED parpadea. Rebibido LoRa digitalWrite(LED,HIGH);delay(50);digitalWrite(LED,LOW);delay(50);digitalWrite(LED,HIGH);delay(50);digitalWrite(LED,LOW);}// MQTT publica estado recibido desde LoRaif(msjRcbLoRa!=0&&paqRcb_Estado==1){if(mqttclient.connected()==true){publica_mqtt();}}// LoRa Reenvia a dispositivoif(actuador_bandera==true){id_msjLoRa=id_msjLoRa+1;envia_lora(dir_destino,dir_local,id_msjLoRa,paqueteEnv);actuador_bandera=false;}// Revisa estado WiFi y MQTTif(WiFi.status()!=WL_CONNECTED){inicia_wifi();}else{if(mqttclient.connected()==false){mqtt_desconectado=true;inicia_mqtt();// reintento}if(mqttclient.connected()==true){if(mqtt_desconectado==true){publica_mqtt();mqtt_desconectado=false;}mqttclient.loop();}}delay(100);}
LoRa – envío de mensajes
voidenvia_lora(bytedestino,byteremite,bytepaqueteID,Stringpaquete){// espera radio para enviar un paquetewhile(LoRa.beginPacket()==0){if(serial_msj==true){Serial.println("Esperando radio disponible...");}delay(100);}// envio del mensaje LoRaLoRa.beginPacket();LoRa.write(destino);LoRa.write(remite);LoRa.write(paqueteID);LoRa.write(paquete.length());LoRa.print(paquete);LoRa.endPacket();}
LoRa – Recibe mensajes
voidrecibe_lora(inttamano){if(tamano==0){paqRcb_Estado=0;//vacioreturn;}// lectura de paquetepaqueteRcb="";dir_envio=LoRa.read();dir_remite=LoRa.read();paqRcb_ID=LoRa.read();bytepaqrcbTamano=LoRa.read();while(LoRa.available()){paqueteRcb+=(char)LoRa.read();}if(paqrcbTamano!=paqueteRcb.length()){paqRcb_Estado=2;// tamaño incompletoreturn;}if(dir_envio!=dir_local){paqRcb_Estado=3;// otro destinoreturn;}if(dir_envio==0xFF){paqRcb_Estado=4;// Broadcast, difusionreturn;}paqRcb_Estado=1;// mensaje Nuevo}
MQTT- inicia
voidinicia_mqtt(void){intesperamqtt=5;intcuentamqtt=0;if(serial_msj){Serial.print(" MQTT Conectando a ");Serial.println(MQTT_IP);}mqttclient.setServer(MQTT_IP,MQTT_puerto);mqttclient.connect(MQTT_ID,MQTT_usuario,MQTT_contrasena);mqttclient.setCallback(recibe_mqtt);while(!mqttclient.connected()&&(cuentamqtt<=esperamqtt)){cuentamqtt=cuentamqtt+1;if(serial_msj){Serial.print(".");}// LED Monitor parpadeo MQTTdigitalWrite(LED_pin,HIGH);delay(200);digitalWrite(LED_pin,LOW);delay(200);}if(mqttclient.connected()){// publica_mqtt();// suscribe a todos los topicos base}if(serial_msj){//Fin de "...."Serial.print("\n MQTT Conectado: ");Serial.print(mqttclient.connected());Serial.print("\t Estado: ");Serial.println(mqttclient.state());}}
MQTT- publica mensaje
voidpublica_mqtt(){paqueteRcb.toCharArray(MQTT_SensorEstado,paqueteRcb.length()+1);// MQTT Construye tópico por remitenteStringremite=String(dir_remite,HEX);remite.toUpperCase();Stringtopico=topico_base+remite+topico_valor;topico.toCharArray(MQTT_TOPIC,topico.length()+1);if(serial_msj==true){Serial.print(" ");Serial.print(topico);Serial.print("/");Serial.println(MQTT_SensorEstado);}// MQTT Construye tópico por remitenteStringtopico_cmd="";topico_cmd+=topico_base+remite+"/cambia";topico_cmd.toCharArray(MQTT_COMMAND,topico_cmd.length()+1);if(serial_msj==true){Serial.print(" sucrito: ");Serial.println(MQTT_COMMAND);}if(mqttclient.connected()==true){mqttclient.publish(MQTT_TOPIC,MQTT_SensorEstado,true);mqttclient.subscribe(MQTT_COMMAND);}else{mqtt_desconectado=true;}}
MQTT- Recibe mensaje
// llega mensaje MQTT, callback mqtt sin confirmaciónvoidrecibe_mqtt(char*p_topic,byte*p_payload,unsignedintp_length){if(serial_msj){Serial.println("Recibe mensaje MQTT");Serial.println(p_topic);}// convierte a textoStringpayload;for(uint8_ti=0;i<p_length;i++){payload.concat((char)p_payload[i]);}paqueteEnv=payload;// direccion destinochardispositivo[3]="D0";intdesde=topico_base.length();dispositivo[0]=p_topic[desde];dispositivo[1]=p_topic[desde+1];dir_destino=(int)strtol(dispositivo,NULL,16);actuador_bandera=true;if(mqttclient.connected()==true){mqttclient.subscribe(MQTT_COMMAND);}else{mqtt_desconectado=true;}}
WiFi – inicio
voidinicia_wifi(void){intesperawifi=10;// >=10 para conectarintcuentawifi=0;if(serial_msj){Serial.print(" WiFi Conectando a ");Serial.println(ssid);}WiFi.disconnect(true);delay(1000);WiFi.mode(WIFI_STA);WiFi.setAutoConnect(true);WiFi.begin(ssid,password);delay(100);while(WiFi.status()!=WL_CONNECTED&&(cuentawifi<esperawifi)){cuentawifi=cuentawifi+1;if(serial_msj){Serial.print(".");}// Parpadeo de Monitor WifidigitalWrite(LED_pin,HIGH);delay(300);digitalWrite(LED_pin,LOW);delay(200);}if(serial_msj){// mensaje a serial, Fin de "..."Serial.println();if(WiFi.status()==WL_CONNECTED){Serial.print(" Estado: ");Serial.println(WiFi.status());Serial.print(" MAC: ");Serial.println(WiFi.macAddress());Serial.print(" IP: ");Serial.println(WiFi.localIP());Serial.print(" RSSI: ");Serial.println(WiFi.RSSI());Serial.println();}if(WiFi.status()!=WL_CONNECTED){WiFi.printDiag(Serial);Serial.println();}}}
La cobertura de los dispositivos IOT con un rango mayor al alcance con WiFi se logra al cambiar o incorporar otra red inalambrica para implementación, por ejemplo LoRa.
La selección de tecnología LoRa responde al esquema de trabajo de Hardware y Software Abierto, la disponibilidad de componentes, que son la base para plantear esquemas de prueba de concepto, entrenamiento y desarrollo DIY.
De tener en operación la gestión de datos con un servidor MQTT y Home-Assistant, la integración con esta plataforma abierta simplifica los pasos al considerarse una extensión de lo implementado con redes locales con cobertura WiFi.
El uso de una plataforma abierta permite personalizar los dispositivos a requerimientos nuevos.
En el caso de solo realizar la conexión con «pocos» dispositivos, se puede recurrir a una conexión multipunto con LoRa. El esquema de integración simplificado se muestra en al figura.
Esquema LoRa: Dispositivo y Gateway Básico
La comunicación entre dispositivos y broker se simplifica considerando que:
Dispone de módulos Lora y/o Placas de Desarrollo
Implementa prototipos para una etapa inicial, no dispone de un gateway comercial y no requiere acceso directo a internet
Simplifica el esquema de comunicación entre pocos dispositivos, basado en direccionamiento
Interactúa con el Broker mediante MQTT, usando la red Ethernet o Wifi
En las siguientes secciones se describe en detalle los componentes básicos que se van implementando.
Esquema LoRaWAN
En caso de requerir una cobertura mayor se amplia el esquema para usar LoRaWAN e incorporar un LoRa Mini Gateway también en esquema abierto con ChirpStack. como gestor de Gateways-
Para registrar los eventos de un determinado dispositivo para analizar su comportamiento y registrarlo en un archivo txt se puede usar la librería Paho en Python. El proceso de registro desde luego se puede realizar en un gestor de datos como Home Assistant, se supondrá en éste caso que no está disponible..
Se crea un archivo, al que se añade una linea por cada registros de mensajes MQTT.
Para el ejemplo los datos de guardan sin procesar.
# grabando mensajes MQTT# configurar los parámetros para la creacion de archivo de textoimport paho.mqtt.client as mqtt
# INGRESO# Parametros para la conexión
servidormqtt = "192.168.xx.xx"
topicolee = "oficina/+/dispositivo/#"# Para el archivo.txt
cuentamensaje = 0
nombrearchivo = 'unreporte.txt'
archivo = open(nombrearchivo,'w')
archivo.close() # Cierra el archivo# FUNCIONES, para conectar y recibir mensaje MQTT# Al recibir CONNACK desde el servidor.defon_connect(client, userdata, flags, rc):
print("Conexión/código de resultado: "+str(rc))
# Inicio o renovación de subscripción
client.subscribe(topicolee)
return()
# el tópico tiene una publicacióndefon_message(client, userdata, msg):
global cuentamensaje
print(msg.topic+" "+str(msg.payload))
unmensaje = msg.topic+" "+str(msg.payload)
# Archivo en modo añadir 'append'
archivo = open(nombrearchivo,'a')
unalinea = unmensaje + '\n'
archivo.write(unalinea)
cuentamensaje = cuentamensaje + 1
print('\n mensajes recibidos: ', cuentamensaje)
return()
client = mqtt.Client()
client.on_connect = on_connect
client.on_message = on_message
client.connect(servidormqtt, 1883, 60)
client.loop_forever()
Archivos py o txt desde PC a Raspberry Pi
Para transferir los archivos de Python o de texto generados se encuentra dispobible la instrucción scp. Luego de ejecutar la instrucción se pedirá la clave de acceso del usuario pi para copiar el archivo en el directorio proyecto/
scp archivo.py pi@192.168.xx.xx:projecto/
Para el caso contrario se usa una instrucción semejante pero con los parametros al contrario, observe que termina en un «.»
scp pi@192.168.xx.xx:projecto/archivo.txt .
En el enlace de la referencia se encuentran más instrucciones al respecto
Los mensajes MQTT que se transmiten como texto simple en la red (inalambrica) y podrían ser leidos con algún software de inspección de tráfico de red. Para añadir un nivel de seguridad con los mensajes MQTT se usa TLS.
Esta sección consta de dos partes:
– creación de los certificados para CA, broker y dispositivos
– configuración de Mosquitto
1. Creación de Certificados
Son archivos que contienen las «llaves» de encriptación que se deben crear o generar para poder realizar todo el proceso de validación. Esta sección considera que las llaves serán usadas de forma local, por lo que la certificación de las llaves se realiza en el mismo broker (self-signed certificate).
La generación de llaves se realiza con la aplicación «OpenSSL» que se incluye con Raspberry OS y para esta ocasión se ejecuta desde un terminal local o remoto (ssh).
Se requieren llaves y certificados para el broker y para cada cliente
1.1 CA – Certificate authority
Se require una «entidad» para crear los certificados y las llaves usadas en el proceso, concocida como CA. Los archivos creados de guardan en la carpeta:
cd /etc/mosquitto/ca_certificates/
primero se crea la llave, que require establecer una frase para generar el archivo, ejemplo: «mqttasegurado» o alguna que le permita establecer una contraseña para la generación de los todos los siguientes certificados y llaves. Anote la frase en algun lugar a su alcance para los próximos pasos.
sudo openssl genrsa -des3 -out mqtt-ca.key 2048
la instrucción genera la siguiente
Generating RSA private key, 2048 bit long modulus (2 primes)
...........................................+++++
.+++++
e is 65537 (0x010001)
Enter pass phrase for mqtt-ca.key:
Verifying - Enter pass phrase for mqtt-ca.key:
El certificado CA firmado con la llave creada en el paso anterior, requiere añadir información adicional como: país, provincia, ciudad e institución para asociar al certificado.
En CN (Common Name) use el nombre en la red o IP fijo del broker, ejemplo: 192.168.10.40
La información en la parte «-subj» permite disponer de un contacto en caso que sea necesario actualizar el archivo del certificado.
Recuerde revisar los permisos de lectura en el directorio de los archivos para los certificados con la instruccion ls -l. pues se requiere poder leerlos para generar las llaves de clientes. Por ejemplo:
pi@raspberry:/etc/mosquitto/ca_certificates $ ls -l
-rw-r--r-- 1 root root 1196 mar 26 22:46 mqtt-ca.crt
-rw-r--r-- 1 root root 1751 mar 26 22:40 mqtt-ca.key
-rw-r--r-- 1 root root 41 mar 26 23:05 mqtt-ca.srl
-rw-r--r-- 1 root root 73 nov 16 2019 README
pi@raspberry:/etc/mosquitto/certs $
si requiere cambiarlos usar la instrucción: sudo chown usuario archivo, o en otro caso cambiar los permisos de lectura para todos los demás.
sudo chmod g+r mqtt-ca*
1.2 TLS – broker Mqtt
Los certificados del broker y usuarios se crean en el directorio ‘certs’, por lo que se cambia de directorio con la instrucción:
cd /etc/mosquitto/certs/
se genera la llave para el broker
sudo openssl genrsa -out mqtt-srv.key 2048
Creación del certificado para el Broker usando la llave del paso anterior.
En CN (Common Name) use el nombre o IP del broker, ejemplo: 192.168.10.50. Este valor es el mismo nombre a usar en la conexión del cliente.
Para usar en la programación del archivo.ino del dispositivo.
openssl x509 -noout -in mqtt-srv.crt -fingerprint
Recuerde revisar los permisos de lectura de los certificados, y modifique los que sean necesarios.
Realizar lo mismo de los permisos que para el directorio /etc/mosquitto/ca_certificates
2. Configuración de Mosquitto
La configuración del broker debe contener cuáles son los certificados para la encriptación de los mensajes.
La configuración del broker mosquitto se encuentra en el archivo /etc/mosquitto/mosquitto.conf que se modifica para activar la encriptación con TLS.
El archivo de configuración se abre desde la consola con la instrucción:
sudo nano /etc/mosquitto/mosquitto.conf
Se añaden las instrucciones:
# Port to use for the default listener.
port 8883
# "c_rehash " each time you add/remove a certificate.
#capath
cafile /etc/mosquitto/ca_certificates/mqtt-ca.crt
# Path to the PEM encoded server certificate.
certfile /etc/mosquitto/certs/mqtt-srv.crt
# Path to the PEM encoded keyfile.
keyfile /etc/mosquitto/certs/mqtt-srv.key
# This option defines the version of the TLS protocol to use for this listener.
# The default value allows v1.2, v1.1 and v1.0, if they are all supported by
# the version of openssl that the broker was compiled against. For openssl >=
# 1.0.1 the valid values are tlsv1.2 tlsv1.1 and tlsv1. For openssl < 1.0.1 the
# valid values are tlsv1.
tls_version tlsv1.2
para activar los cambios, deber reiniciar mosquitto con la instrucción:
sudo systemctl restart mosquitto
Verifique el estado del servidor MQTT desde una consola remota con ssh:
systemctl status mosquitto
con lo que se obtiene mensajes semejantes a:
● mosquitto.service - Mosquitto MQTT v3.1/v3.1.1 Broker
Loaded: loaded (/lib/systemd/system/mosquitto.service; enabled; vendor preset: enabled)
Active: active (running) since Sun 2019-08-11 14:16:50 -05; 9min ago
Docs: man:mosquitto.conf(5)
man:mosquitto(8)
Main PID: 394 (mosquitto)
Tasks: 1 (limit: 2200)
Memory: 2.4M
CGroup: /system.slice/mosquitto.service
└─394 /usr/sbin/mosquitto -c /etc/mosquitto/mosquitto.conf
ago 11 14:16:50 raspberrypi mosquitto[394]: 1565551010: Config loaded from /etc/mosquitto/mosquitto.conf.
ago 11 14:16:50 raspberrypi mosquitto[394]: 1565551010: Opening ipv4 listen socket on port 8883.
revise que todo esté funcionando sin inconvenientes, que el puerto 8333 sea el que esté activo.
Para cada dispositivo que se use para enviar o recibir un mensaje Mqtt se define como un cliente. Cada cliente necesita su propia llave que debe ser firmada por la CA para que sea aceptada en las conexiones TLS.
para generar los certificados podemos regresar al directorio:
cd /etc/mosquitto/certs/
En adelante, llamaremos al dispositivo «sensor00» como identificador en cada proceso. Se genera la llave para «sensor00»
sudo openssl genrsa -out sensor00-client.key 2048
se crea una solicitud de forma para la llave. El valor de CN debe ser el nombre del dispositivo FQDN o una dirección IP fija.
Para las pruebas, se puede usar la consola remota o una laptop conectada a la misma red que el broker. Recuerde actualizar los datos en la sección «subj»
al ejecutar la instrucción, se pide la frase del certificado, la ingresa y obtiene:
Enter PEM pass phrase:
Client mosqsub|1557-raspberry sending CONNECT
Client mosqsub|1557-raspberry received CONNACK (0)
Client mosqsub|1557-raspberry sending SUBSCRIBE (Mid: 1, Topic: oficina/mensaje, QoS: 0)
Client mosqsub|1557-raspberry received SUBACK
Subscribed (mid: 1): 0
ON
Puede cambiar el estado con mosquitto_pub se escribe una instrucción semejante añadiendo el mensaje -m ‘ON’. Esta instrucción usa otro cliente: sendor01.
Otra opción para probar la conexión es usando un programa desde una PC y con el certificado de cliente, por ejemplo MQTT.FX que lo puede descargar de forma gratuita.
Realice una copia del certificado de cliente en la pc donde instala el programa MQTT.FC en un directorio de trabajo.
Use los parámetros requeridos para la conexión en la ventana del menú «extras/edit/connection profiles» para usuario y clave, TLS, etc
Se presiona conectar a MQTT, luego se suscribe al tópico de interés y se puede publicar en el mismo tópico.
5 Revisar conexión SSL
Sustituir IP_ADDRESS con la dirección IP antes de usar la instrucción.
Para crear un nivel de control de cuáles dispositivos operan con el servidor MQTT, se añaden usuarios y contraseñas.
1. Crear usuarios y contraseñas
Mosquitto dispone de una instruccion para generar un archivo de contraseñas: mosquitto_passwd. La instruccion para crear el usuario requiere escribir una contraseña a ser usada solo para el servicio MQTT:
Para cada usuario se validan las contraseñas, se solicita escribirlas dos veces:
Nota puede usar para el ejemplo : «usuarioprueba» , «usuarioclave», al ejercutar la instruccion anterior tendrá lo siguiente, teniendo que digitar la clave seleccionada.
Añadir el control de usuarios require modificar el archivo de configuración para indicar la ubicación del archivo de contraseñas de cada usuario registrado.
Como comprobación, intente enviar un mensaje con usuario cambiado con clave errada.
En las nuevas versiones, en modo «localhost» es decir desde un terminal del sevidor, se aceptan todos los mensajes sin restriccion como un modo de prueba de operación. Par comprobar otro tipo de conexión se debe realizar desde otro programa o computador. por ejemplo: mqtt.fx
el parámetro de broker puede ser también la dirección IP del servidor mosquitto.
Al reiniciar Home-Assistant, debería iniciar con la configuración propuesta.
5. MQTT con TLS
Para aumentar el nivel de seguridad de los mensajes MQTT, se añade encriptado TLS a los mensajes. El tema se desarrolla en la siguente página de publicación.
Como protocolo para comunicar el broker con los dispositivos será MQTT.
La versión seleccionada es Mosquitto, disponible en el enlace mostrado.
1. Instalar Mosquitto en Raspberry Pi
La forma simplificada de instalar mosquitto es desde una ventana de terminal, que instala e inicia el servicio. Recuerde actualizar Raspbian antes de éste proceso, notas en la sección de RaspberryPi-Actualizar.
Si aparece el estado en la ventana del numeral 2.2, MQTT se encuentra funcionando correctamente.
Para iniciar una prueba, también puede usar el programa cliente MQTT.fx, requiere descargar y configurar los parámetros de MQTT.
Esta es una instalación básica, procesa cualquier suscripción o publicación de mensajes. Tiene utilidad para probar los primeros mensajes de un dispositivo básico en construcción.
Para añadir un nivel de seguridad mediante usuario y contraseña, se requieren algunos pasos adicionales descritos en otra entrada del blog.
3. Puertos de conexión
A partir de la versión 2, la configuración predeterminada se restringe a los mensajes enviados desde la dirección»local» (127.0.0.1). Para abrir la recepción mensajes desde otras direcciones, se actualiza el archivo
Para conectar Home-Assistant al broker Mosquitto, se requiere configurar los parámetros de conexión.
La forma más simple de configurar MQTT es usando la página web en el menú de configuración/Integraciones.
Se usa el botón «+ añadir integración» para indicar los parámetros del servidor MQTT tal com «agente:» dirección ip o «localhost», el puerto es el mismo, se añade de ser el caso el usuario y la contraseña.
Al completar la configuración, deberá aparecer entre la lista de integraciones: