GIRNI

Grupo de Investigación de Redes de iNformación Inalámbricas

Etiqueta: IoT

  • IoT LoRa - Integración con broker MQTT-HA

    La cobertura de los dispositivos IOT con un rango mayor al alcance con WiFi se logra al cambiar o incorporar otra red inalámbrica para implementación, por ejemplo LoRa.

    diagrama ancho banda wifi ble, lora, celularhttps://www.semtech.com/lora/why-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.

    diagrama bloques con home assistant

    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-

    Referencia: https://lora-developers.semtech.com/

  • 5. MQTT - Registro de mensajes en archivo.txt con Python

    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 texto
    import 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.
    def on_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ón
    def on_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

    Referencia: https://www.raspberrypi.org/documentation/remote-access/ssh/scp.md

  • 4. MQTT - Conexión desde Python

    La librería Paho-Mqtt de Python usada que permite conectarse como cliente a MQTT. Pypi.org

    Esto permite analizar los valores en los mensajes MQTT de los dispositivos para procesar, o activar algún proceso o evento con Python.

    La conexión requiere los parámetros de dirección IP del servidor, puerto, datos de usuario, contraseña y el tópico.

    # Parametros para la conexión
    servidormqtt = "192.168.xx.xx"
    usuario = "usuarioprueba"
    contrasena = "usuarioclave"
    topicolee = "#"
    

    La instalación de la librería en Python se puede realizar con pip, tal como otras librerias en Python.

    pip install paho-mqtt

    Instrucciones en Python

    # Conectando a MQTT-Mosquitto
    import paho.mqtt.client as mqtt
    
    # INGRESO
    # Parametros para la conexión
    servidormqtt = "192.168.xx.xx"
    usuario = "usuarioprueba"
    contrasena = "usuarioclave"
    topicolee = "#"
    
    # Funciones de conexión y mensaje
    # Al recibir CONNACK desde el servidor
    def on_connect(client, userdata, flags, rc):
        print("Conexión/código de resultado: "+str(rc))
        # Inicio o renovación de subscripción
        client.subscribe(topicolee)
    
    # el tópico tiene una publicación
    def on_message(client, userdata, msg):
        print(msg.topic+" "+str(msg.payload))
        unmensaje = msg.topic+" "+str(msg.payload)
        return()
    
    client = mqtt.Client()
    client.on_connect = on_connect
    client.on_message = on_message
    client.username_pw_set(username=usuario,password=contrasena)
    client.connect(servidormqtt, 1883, 60)
    client.loop_forever()
    

    Referencia: paho-mqtt, https://pypi.org/project/paho-mqtt/#usage-and-apihttps://pypi.org/project/paho-mqtt/#connect-reconnect-disconnect

  • 3. MQTT - Mosquitto TLS

    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.

    sudo openssl req -new -x509 -days 3650 -extensions v3_ca \
    -subj '/C=EC/L=Gye/CN=192.168.10.40' \
    -key mqtt-ca.key -out mqtt-ca.crt
    

    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.

    sudo openssl req -new -out mqtt-srv.csr -key mqtt-srv.key \
    -subj '/C=EC/L=Gye/CN=192.168.10.40'  
    

    El siguiente paso es firmar el certificado usando CA:

    sudo openssl x509 -req -days 3650 \
    -CA    /etc/mosquitto/ca_certificates/mqtt-ca.crt \
    -CAkey /etc/mosquitto/ca_certificates/mqtt-ca.key \
    -CAcreateserial -in mqtt-srv.csr -out mqtt-srv.crt
    

    1.3 Huella del certificado: fingerprint

    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.

    sudo netstat -lnpt
    sudo systemctl status mosquitto
    sudo journalctl -u mosquitto
    

    3. TLS para los clientes

    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"

    sudo openssl req -new -out sensor00-client.csr \
    -key sensor00-client.key \
    -subj '/C=EC/L=Gye/CN=192.168.10.40'

    creada la solicitud, se usa  para firmarla usando CA, se pedirá la frase de la primera sección:

    sudo openssl x509 -req  -days 3650 \
    -CA /etc/mosquitto/ca_certificates/mqtt-ca.crt \
    -CAkey /etc/mosquitto/ca_certificates/mqtt-ca.key \
    -CAcreateserial \
    -in sensor00-client.csr -out sensor00-client.crt
    

    Para usar en la programación del archivo.ino del dispositivo.

    openssl x509 -noout -in sensor00-client.crt -fingerprint
    

    Recuerde revisar los permisos de lectura de los certificados, y modificar los que sean necesarios.

    Se procede de forma semejante para los otros sensores "sensor##" o el nombre que se prefiera y se repite solo ésta sección.

    Repita el ejercicio para el certificado a usar por homeassistant con identificador 'HA-broker'.


    4. Prueba de funcionamiento

    4.1 Desde la consola ssh

    con los parámetros, utilice los parámetros con los que generó los certificados.

    mosquitto_sub -v -h 192.168.10.40 -p 8883 \
    -u 'usuarioprueba' -P 'usuarioclave' \
    --key /etc/mosquitto/certs/sensor00-client.key \
    --cert /etc/mosquitto/certs/sensor00-client.crt \
    --cafile /etc/mosquitto/certs/mqtt-srv.crt \
    -t 'oficina/mensaje' \
    --tls-version tlsv1.2 -i sensor00

    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.

    mosquitto_pub -h 192.168.10.40 \
    -u 'usuarioprueba' -P 'usuarioclave' \
    --key    /etc/mosquitto/certs/sensor01-client.key \
    --cert   /etc/mosquitto/certs/sensor01-client.crt \
    --cafile /etc/mosquitto/certs/mqtt-srv.crt \
    -t 'oficina/mensaje' \
    -p 8883 \
    --tls-version tlsv1.2 -i sensor01 \
    -m 'mensajePorTLS..!'
    

    con el siguiente resultado:

    Enter PEM pass phrase:
    Client mosqpub|1607-raspberry sending CONNECT
    Client mosqpub|1607-raspberry received CONNACK (0)
    Client mosqpub|1607-raspberry sending PUBLISH (d0, q0, r0, m1, 'home/garden/fountain', ... (2 bytes))
    Client mosqpub|1607-raspberry sending DISCONNECT

    4.2 Con el programa MQTT.fx

    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.

    openssl s_client --connect IP_ADDRESS:8883

    Referencias:

    https://www.raspberrypi.org/forums/viewtopic.php?t=287326

    https://mosquitto.org/man/mosquitto-tls-7.html

    https://mcuoneclipse.com/2017/04/14/enable-secure-communication-with-tls-and-the-mosquitto-broker/

    http://www.steves-internet-guide.com/mosquitto-tls/

    https://www.hivemq.com/blog/mqtt-security-fundamentals-tls-ssl/

    https://www.home-assistant.io/docs/mqtt/broker/

  • 2. MQTT - Mosquitto usuario y contraseña

    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 instrucción para generar un archivo de contraseñas: mosquitto_passwd. La instrucción para crear el usuario requiere escribir una contraseña a ser usada solo para el servicio MQTT:

    sudo mosquitto_passwd -c /etc/mosquitto/passwd usuarioprueba

    Para cada usuario se validan las contraseñas, se solicita escribirlas dos veces:

    Nota puede usar para el ejemplo : "usuarioprueba" , "usuarioclave", al ejercutar la instrucción anterior tendrá lo siguiente, teniendo que digitar la clave seleccionada.

    pi@raspberrypi:~ $ sudo mosquitto_passwd -c /etc/mosquitto/passwd usuarioprueba
    Password:
    Reenter password:

    2. Añadir control de usuarios a la configuración

    Añadir el control de usuarios requiere modificar el archivo de configuración para indicar la ubicación del archivo de contraseñas de cada usuario registrado.

    sudo nano /etc/mosquitto/conf.d/default.conf

    Y escribir en el archivo:

    password_file /etc/mosquitto/passwd
    allow_anonymous false

    La última instrucción, no permitirá que se den servicio a mensajes sin autenticación de usuario.

    Se guarda el archivo (^O) y sale de la aplicación (^X).

    Una vez completada la acción anterior, se debe reiniciar mosquitto:

    sudo systemctl restart mosquitto

    3. Pruebas de operación

    Realice nuevamente las pruebas de mensajes MQTT. Ahora se requiere indicar detalles del usuario que usa el servicio de suscripción y publicación:

    mosquitto_sub -d -t "oficina/mensaje" -u "usuarioprueba" -P "usuarioclave"
    
    mosquitto_pub -d -t "oficina/mensaje" -m "controlando usuario" -u "usuarioprueba" -P "usuarioclave"

    Los resultados se muestran incluso con mayor detalle:

    pi@raspberrypi:~ $ mosquitto_sub -d -t "oficina/mensaje" -u "usuarioprueba" -P "usuarioclave"
    Client mosqsub|754-raspberrypi sending CONNECT
    Client mosqsub|754-raspberrypi received CONNACK (0)
    Client mosqsub|754-raspberrypi sending SUBSCRIBE (Mid: 1, Topic: oficina/mensaje, QoS: 0)
    Client mosqsub|754-raspberrypi received SUBACK
    Subscribed (mid: 1): 0
    Client mosqsub|754-raspberrypi received PUBLISH (d0, q0, r0, m0, 'oficina/mensaje', ... (19 bytes))
    controlando usuario

    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 servidor, se aceptan todos los mensajes sin restricción 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

    https://mqttfx.jensd.de/

    3.1 Subscribirse a todos los tópicos

    Se puede usar el comodín '#':

    mosquitto_sub -v -h broker_ip -p 1883 -t '#'

    3.2 Añadir usuarios

    Para añadir usuarios a mosquitto, use la instrucción con el parámetro -b, añadiendo el usuario y la clave.

    sudo mosquitto_passwd -b /etc/mosquitto/passwd usuarionuevo clavenueva

    al terminar de agregar los usuarios, para activar los nuevos usuarios puede reiniciar el proceso como:

    sudo systemctl restart mosquitto

    4. Mosquitto en Home Assistant

    Para conectar Home-Assistant al broker Mosquitto, se requiere configurar los parámetros de conexión.

    La configuración se puede realizar usando la página web en el menú de:

    "Ajustes/Dispositivos y servicios/Integraciones"

    En el botón de "agregar integración", seleccione entre las opciones "MQTT".

    MQTT Config 02

    En otro caso, la forma mas tradicional es:

    Actualizar el inicio del servicio:

    sudo nano /etc/systemd/system/home-assistant@homeassistant.service
    

    En la línea correspondiente a After=

    [Unit]
    Description=Home Assistant
    After=network-online.target mosquitto.service
    

    Se actualiza el archivo configuration.yaml con la instrucción:

    sudo nano /home/homeassistant/.homeassistant/configuration.yaml
    

    añadiendo las instrucciones con los datos propuestos en el ejemplo que precede:

    mqtt:
      broker: localhost
      port: 1883 
      client_id: 'HA-broker'
      username: 'usuarioprueba'
      password: 'usuarioclave'
    

    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 siguiente página de publicación.


    Referencias:

    https://mcuoneclipse.com/2017/04/14/enable-secure-communication-with-tls-and-the-mosquitto-broker/

    https://aprendiendoarduino.wordpress.com/tag/configurar-mosquitto/

    http://www.steves-internet-guide.com/mosquitto-tls/

    https://www.hivemq.com/blog/mqtt-security-fundamentals-tls-ssl/

  • 1. MQTT - Mosquitto instalar

    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.

    sudo apt-get install mosquitto mosquitto
    sudo apt-get install mosquitto mosquitto-clients
    

    Más información sobre la instalación se pueden encontrar en:

    https://mosquitto.org/

    Si se completaron las instrucciones anteriores, Mosquitto se inicia al terminar el proceso, por lo que se puede continuar con las pruebas.

    Versiones actualizadas se pueden instalar con las instrucciones detalladas en:

    https://mosquitto.org/blog/2013/01/mosquitto-debian-repository/

    2. Pruebas de Mosquitto

    Para probar si la instalación se completó, se puede usar las instrucciones en dos ventanas separadas de comando (local o remota ssh):

    2.1 Para comprobar que se encuentra funcionando Mosquitto, use:

    systemctl status mosquitto

    obtendrá una respuesta semejante 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 Sat 2019-07-27 23:13:10 -05; 6min ago

    En caso que no esté iniciado el proceso, escriba la instrucción:

    mosquitto

    2.2 en una ventana de comando, se suscribirse a un tópico ejemplo, para recibir los mensajes:

    mosquitto_sub -v -t "oficina/mensaje"

    2.3. en otra ventana publicar un nuevo estado en el tópico:

    mosquitto_pub -t "oficina/mensaje" -m "mensaje mqtt"

    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

    sudo nano /etc/mosquitto/mosquitto.conf

    con la instrucción:

    listener 1883

    Referencia: https://mosquitto.org/man/mosquitto-conf-5.html

    4. Mosquitto en Home Assistant

    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:

    https://www.home-assistant.io/integrations/mqtt/


    Otra forma de configurar mediante la forma antigua al editar los archivos de configuración.

    Actualizar el inicio del servicio:

    sudo nano /etc/systemd/system/home-assistant@homeassistant.service
    

    En la línea correspondiente a After=

    [Unit]
    Description=Home Assistant
    After=network-online.target
    
    [Service]
    Type=simple
    User=%i
    ExecStart=/srv/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant"
    
    [Install]
    WantedBy=multi-user.target
    
    

    Se actualiza el archivo configuration.yaml con la instrucción:

    sudo nano /home/homeassistant/.homeassistant/configuration.yaml
    

    añadiendo las instrucciones con los datos propuestos en el ejemplo que precede:

    mqtt:
      broker: localhost
      port: 1883
      client_id: 'HA-broker'
    

    Al reiniciar Home-Assistant, debería iniciar con la configuración propuesta.


    Referencia:

    https://aprendiendoarduino.wordpress.com/tag/configurar-mosquitto/

  • 1. IoT Esquema abierto (Open) por capas



    Como una introducción para desarrollo IoT, Internet of Things,  se usa un esquema que agrupa los componentes en secciones y capas. Cada una de las secciones se encarga de una parte de todo el proceso, simplificando los pasos para tener componentes funcionales que interactúen como un todo.

    Esquema Capas 01

    El esquema básico presentado empieza con lo más tangible, las "cosas" ("Things" en inglés) presentado en el bloque inferior en color gris.

    El "usuario" observa, controla y se beneficia del estado de las cosas representando una sección importante en el esquema en los bloques en azul.


    1. Las cosas (Things)

    Cosas Estado 01

    Las "cosas" representan el artefacto que se desea conocer o controlar su estado.

    Para conocer el estado  por ejemplo abierto/cerrado, 0/1, se usan sensores.

    Para controlar el estado de las cosas, por ejemplo un foco, se usan actuadores.


    2. Usuario
    Teletrabajo 01

    El "usuario" observa, controla, se beneficia del estado de las cosas y accede a ellas en forma "presencial" o "virtual".

    Para que usuario llegue hasta las cosas, se crea un camino con algunos componentes tecnológicos intermedios que son los que se tratan en cada página del blog.


    3. Componentes o Capas

    FIEC03236 textmsg

    Cada componente añade una función específica a la infraestructura IoT.

    Algunos componentes son de uso cotidiano y los dispone en el hogar, la oficina, el aula.

    Por ejemplo, un teléfono móvil, tablets, PC, un «router Wifi», son componentes que se actualmente se encuentran muy difundidos.

    La extensa adopción de estos componentes facilita el despliegue del Internet de las cosas (IoT).


    4. Esquemas Abiertos de Hardware y Software

    La infraestructura IoT se conforma de  Hardware y Software, ambos se pueden desarrollar e implementar con herramientas de esquema abierto conocidos como,

    • Open Hardware
    • Open Software
    Open Hw Sw 01

    Para lo presentado en Girni IoT, se tiene preferencia en los esquemas abiertos.



    5. Explorando un poco de IoT

    Para explorar el esquema abierto IOT se revisa un ejemplo base, simplificado para incorporar un dispositivo sensor/actuador. El primer ejemplo a desarrollar es un  sensor de estado de Puerta-Ventana.

    D01 Puerta Ventana 01

    El estado de la "cosa", puerta o ventana es cerrado o abierto. El estado se representa por un 1 o 0, ON/OFF, es también conocido como un estado binario.

    Se usa un sensor tipo "interruptor magnético" con estados: abierto o cerrado, que permite determinar el estado de la puerta.

    Un dispositivo registra el estado o lectura del sensor magnético, y genera un mensaje  de estado de "ON/OFF" para enviarlo a un punto central de gestión de la información (servidor o broker).

    El dispositivo realiza las operaciones de revisión de sensor y envío de mensajes usando un "microcontrolador", como Arduino, ESP8266, ESP32, etc.

    El dispositivo usa una red de datos alámbrica o inalámbrica para enviar el mensaje al broker, por ejemplo WiFi.

    El broker registra, gestiona y muestra el estado de la "puerta" al usuario. El broker realiza las funciones de servidor de mensajes y de página web, semejante a Twitter, facebook, etc.

    El broker puede ser un servidor en la nube, o puede ser implementado  de forma local con una PC o Raspberry Pi, lo que se tenga disponible.

    Sensor Puerta 03 Abierta HA

    Para que el mensaje del estado de la puerta se gestione en el broker, es necesario enviarlo por medio de una red de datos disponible.

    La red de datos en la actualidad es muy común en su forma inalámbrica WiFi o cableada Ethernet, el uso de estas redes genera un escenario donde se facilita la implementación del internet de las cosas IoT.

    El usuario puede revisar el estado de la "puerta" desde una página web, como un texto o símbolo, mostrado en la figura anterior.


    Esquema por componentes y proceso por Bloques

    La implementación e integración de éstos componentes se desarrolla paso a paso, empezando por los componentes más elementales y luego incorporando otros elementos que hacen de IoT un tema fascinante.

    D01 Puerta Ventana 02

    Un dispositivo IoT con Wifi  puede ser implementado con una placa de desarrollo con ESP8266/ESP32, inicialmente el proceso varía en detalles con la placa de desarrollo que tenga disponible. Las placas en la actualidad ya no presentan una diferencia muy grande en costos, por lo que el modelo depende más de la placa que tenga disponible para un primer ejercicio.

    El proceso general para conectar un dispositivo IoT tiene varias fases o bloques:

    1. Conexión al router de una red WiFi.
    2. Envío de un mensaje de estado/acción de un sensor o actuador a un Gestor de mensajes (Broker) MQTT, por ejemplo Mosquitto.
    3. Registro el estado/acción de un sensor o actuador con un Gestor de dispositivos, entre ellos Home Assistant.

    Las siguientes secciones desarrollan estos pasos



  • 2. Home Assistant - Configurar MQTT

    La configuración de MQTT se realiza para: la conexión a MQTT y la revisión de mensajes de los dispositivos.

    Mosquitto en Home Assistant

    Para conectar Home-Assistant al broker Mosquitto, se requiere configurar los parámetros de conexión.

    3. Mosquitto en Home Assistant

    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ágine web en el menu 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:

    https://www.home-assistant.io/integrations/mqtt/


    Otra forma de configurar mediante la forma antigua al editar los archivos de configuración.

    Actualizar el inicio del servicio:

    sudo nano /etc/systemd/system/home-assistant@homeassistant.service
    

    En la línea correspondiente a After=

    [Unit]
    Description=Home Assistant
    After=network.target mosquitto.service
    

    Se actualiza el archivo configuration.yaml con la instrucción:

    sudo nano /home/homeassistant/.homeassistant/configuration.yaml
    

    añadiendo las instrucciones con los datos propuestos en el ejemplo que precede:

    mqtt:
      broker: localhost
      port: 8883 #1883
      client_id: 'Raspi01'
      username: 'usuarioprueba'
      password: 'usuarioclave'
    

    Al reiniciar Home-Assistant, debería iniciar con la configuración propuesta.

    El reinicio se puede realizar desde la página en el menú Configuración/Controles del Servidor. Recuerde siempre validar el cambio de configuración antes de reiniciar Home-Assistant.

    Referencia: https://www.home-assistant.io/docs/mqtt/

     

  • 1. Home Assistant - Instalar/Actualizar

    Revisado: 2021-07-27

    Home Assistant es una aplicación abierta, tipo local con la gestión básica para iniciar un proyecto de IOT para el hogar u oficina.

    Permite acceder a la información y control de los dispositivos mediante una página web de configuración simplificada, personalizada, facilitando la instalación básica para iniciar con los conceptos básicos.

    Ésta sección muestra notas tomadas como documentación simplificada al realizar un proyecto básico de IOT.

    La forma de implementarla para este proyecto es un Raspberry Pi, por tener un servidor dedicado y de bajo consumo energético, aunque puede inslalarse en otras plataformas.

    Referencia: https://www.home-assistant.io/installation/


    1. Instalación manual en Raspberry Pi

    Para la implementación de un broker simplificado que gestione las conexiones con cada dispositivo se usa un Raspberry Pi con su sistema operativo "Raspberry pi OS"  a partir del año 2020, antes conocido como"Raspbian". Dado que la documentación se inició en el 2018, se mantienen ambos nombres para la documentación.

    En adelante, se considera que el Raspbian ya se encuentra instalado, actualizado, operativo y con dirección IP fija, de no ser así puede seguir las instrucciones de la sección Raspberry Pi OS-Instalar

    A partir de aquí se resumen los pasos para la instalación de Home Assistant

    Para la instalación se recomienda actualizar Rasbian a la fecha, puede usar las indicaciones en la sección correspondiente Raspbian-Actualizar

    algunos componentes adicionales para actualizar

    sudo apt-get install -y python3 python3-dev python3-venv
    sudo apt-get install -y python3-pip libffi-dev libssl-dev libjpeg-dev zlib1g-dev
    sudo apt-get install -y autoconf build-essential libopenjp2-7 libtiff5 tzdata

    Luego se continua con el proceso de instalación en entorno virtual.

    Referencia: https://www.home-assistant.io/docs/installation/raspberry-pi/


    2. Crea un Entorno virtual en Python

    Crear un usuario para homeassistant
    
    sudo useradd -rm homeassistant -G dialout,gpio,i2c

    Crear un directorio de trabajo

    cd /srv
    sudo mkdir homeassistant
    sudo chown homeassistant:homeassistant homeassistant

    Configurar un entorno virtual, ajustar la versión de Python acorde a la disponible y que se encuentre probada. El resto de instrucciones se mantienen iguales.

    sudo -u homeassistant -H -s
    cd /srv/homeassistant
    python3 -m venv .
    source bin/activate

    Añadir los componentes Python

    hasta el momento,  la linea de shell debe tener la forma de:
    (homeassistant) homeassistant@raspberrypi:/srv/homeassistant $

    donde se puede escribir la instrucción:

    python3 -m pip install wheel

    3. Instala en entorno virtual

    Iniciar el proceso de instalación, en la línea de shell mostrada en el estado anterior, se escribe:

    pip3 install homeassistant

    donde se puede observar el progreso de instalación de la siguiente forma:

    (homeassistant) homeassistant@raspberry:/srv/homeassistant $ pip3 install homeassistant
    Looking in indexes: https://pypi.org/simple, https://www.piwheels.org/simple
    Collecting homeassistant
      Downloading https://files.pythonhosted.org/packages/87/c9/f41fcf931501f07ef9ca12365fd09eb879f6755618f375b058a229d9c94b/homeassistant-0.103.6-py3-none-any.whl (6.0MB)
        100% |████████████████████████████████| 6.0MB 53kB/s
    Collecting cryptography==2.8 (from homeassistant)
      Downloading https://files.pythonhosted.org/packages/be/60/da377e1bed002716fb2d5d1d1cab720f298cb33ecff7bf7adea72788e4e4/cryptography-2.8.tar.gz (504kB)
        100% |████████████████████████████████| 512kB 343kB/s
      Installing build dependencies ... done
    ...

    El programa se puede iniciar usando la instrucción. Esperar con paciencia, toma tiempo la primera ejecución.

    hass

    Durante el proceso de instalación, (o esperado al menos 5 minutos) una vez que se ha llegado al proceso de:

    [homeassistant.bootstrap] Home Assistant initialized in 525.83s
    [homeassistant.core] Starting Home Assistant
    (MainThread) [homeassistant.core] Timer:starting

    o en otro caso, observe los tiempos:

    2021-07-23 06:06:09 WARNING (Recorder) [homeassistant.components.recorder.util] The system could not validate that the sqlite3 database at //home/homeassistant/.homeassistant/home-assistant_v2.db was shutdown cleanly
    2021-07-23 06:08:15 WARNING (MainThread) [homeassistant.bootstrap] Waiting on integrations to complete setup: cloud
    2021-07-23 06:11:38 WARNING (MainThread) [homeassistant.bootstrap] Waiting on integrations to complete setup: zeroconf

    se debe ingresar vía web para ingresar los datos de usuario, palabra clave, ubicación geográfica y así completar la instalación.

    Para el ejemplo mostrado debería ingresar desde un navegador de internet a la dirección asignada en el proceso de instalación:

    192.168.10.100:8123

    Cuando se termine el proceso de instalación en la página web, será necesario configurar el inicio automático, así al reiniciar el Raspberry Pi, todo continúe funcionando normalmente.

    - se debe salir del proceso de la consola con las teclas Ctrl-C

    - regresar al usuario básico con la instrucción:  exit


    4. Configura el inicio automático

    Crear un archivo de servicio con nombre semejante al mostrado en la instrucción:

    sudo nano -w /etc/systemd/system/home-assistant@homeassistant.service

    El contenido del archivo siguen las siguientes instrucciones:

    [Unit]
    Description=Home Assistant
    After=network-online.target 
    
    [Service]
    Type=simple
    User=%i
    ExecStart=/srv/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant"
    
    [Install]
    WantedBy=multi-user.target

    Configure el autoinicio de Home Assistant con la instrucción:

    sudo systemctl enable home-assistant@homeassistant

    Para probar que todo funciona bién se reinicia el Raspberry Pi con la instruccion sudo reboot


    5. Modo avanzado para administrador

    Para comprobar que las configuraciones sean las correctas u otras opciones de administrador, se puede activar las opciones de modo avanzado para el usuario administrador desde la sección "administrador/modo avanzado"

    Se activan y muestran los botones en "configuración/controles de servidor"


    Referencia: Python Virtual enviroment

    https://www.home-assistant.io/docs/autostart/systemd

    6. Home Assistant – Actualizar

    Periódicamente se publican actualizaciones para Home Asssistant en el sitio web. La versión instalada se puede revisar en el sitio web local, sección de "Configuración/información".

    Las instrucciones para actualizar Home Assistant se realizan mediante una conexión terminal ssh que consiste en:

    • cambiar al usuario homeassistant
    • activar el directorio de trabajo
    • actualizar usando pip
    sudo -u homeassistant -H -s
    source /srv/homeassistant/bin/activate
    pip3 install --upgrade homeassistant

    La actualización se realiza usando pip dado que la base del programa es Python.

    La respuesta obtenida desde un terminal es semejante a lo mostrado:

    homeassistant@GirniLab01:/home/pi $ source /srv/homeassistant/bin/activate
    (homeassistant) homeassistant@GirniLab01:/home/pi $ pip3 install --upgrade homeassistant
    Looking in indexes: https://pypi.org/simple, https://www.piwheels.org/simple
    Collecting homeassistant
      Downloading homeassistant-2021.12.7-py3-none-any.whl (15.4 MB)
         |████████████████████████████████| 15.4 MB 21 kB/s
    Collecting httpx==0.21.0
      Downloading httpx-0.21.0-py3-none-any.whl (83 kB)
         |████████████████████████████████| 83 kB 283 kB/s
    ....
    

    Referencia: https://www.home-assistant.io/docs/installation/raspberry-pi/

    7. Actualizar con Docker

    Si la instalación fue realizada con Docker, se usan las siguientes instrucciones:

    # if this returns "Image is up to date" then you can stop here
    docker pull ghcr.io/home-assistant/home-assistant:stable
    
    # stop the running container
    docker stop homeassistant
    
    # remove it from Docker's list of containers
    docker rm homeassistant
    
    sudo docker run -d \
      --name homeassistant \
      --restart=unless-stopped \
      --privileged \
      -e TZ=Americas/Guayaquil \
      -v /home/girni/homeassistant:/config \
      --network=host \
      ghcr.io/home-assistant/home-assistant:stable
    

    Referencia: https://www.home-assistant.io/installation/raspberrypi-other