Tutorial: Interactuar con Device Shadow mediante la aplicación de ejemplo y el cliente de pruebas MQTT

Abra el cliente de prueba MQTT

Abra el cliente de prueba de MQTT en la consola de AWS IoT en una ventana nueva para poder observar los mensajes recibidos por los temas MQTT sin perder la configuración de su cliente de prueba de MQTT. El cliente de prueba MQTT no conserva las suscripciones ni los registros de mensajes si lo abandona para ir a otra página de la consola. Para esta sección del tutorial, puede tener el documento Sombra de su cosa AWS IoT y el cliente de prueba MQTT abiertos en ventanas separadas para observar más fácilmente la interacción con las Sombras de dispositivos.

Suscribirse a los temas reservados de MQTT Shadow

Puede utilizar el cliente de pruebas de MQTT para introducir los nombres de los temas reservados de MQTT de Device Shadow y suscribirse a ellos para recibir actualizaciones cuando ejecute la aplicación de ejemplo shadow.py. Para suscribirse al tema:

1. En el cliente de prueba MQTT de la consola de AWS IoT, seleccione Suscribirse a un tema.

2. En la sección Filtrar temas, introduzca: $aws/things/thingname/shadow/update/#. Aquí thingname es el nombre del recurso que creó anteriormente (por ejemplo, My_light_bulb).

3. Mantenga los valores predeterminados para los ajustes de configuración adicionales y, a continuación, seleccione Suscribirse.

Si utiliza el comodín # en la suscripción al tema, podrá suscribirse a varios temas de MQTT al mismo tiempo y observar todos los mensajes que se intercambian entre el dispositivo y su Shadow en una sola ventana. Para obtener más información sobre los caracteres comodín y su uso, consulte Temas de MQTT.

Ejecute un programa de ejemplo shadow.py y observe los mensajes

En la ventana de la línea de comandos de la Raspberry Pi, si ha desconectado el programa, vuelva a ejecutar la aplicación de ejemplo y mire los mensajes en el cliente de pruebas MQTT de la consola de AWS IoT.

1. Ejecute la siguiente orden para reiniciar el programa de muestra. Sustituya your-iot-thing-name y your-iot-endpoint por los nombres de la cosa AWS IoT que creó anteriormente (por ejemplo, My_light_bulb), y el punto de conexión para interactuar con el dispositivo.

   cd ~/aws-iot-device-sdk-python-v2/samples
   python3 shadow.py --ca_file ~/certs/Amazon-root-CA-1.pem --cert ~/certs/device.pem.crt --key ~/certs/private.pem.key --endpoint your-iot-endpoint --thing_name your-iot-thing-name

   A continuación, la aplicación de ejemplo shadow.py se ejecuta y recupera el estado de sombra actual. Si ha eliminado la sombra o borrado los estados actuales, el programa fija el valor actual a off y luego le pide que introduzca un valor desired.

   Connecting to a3qEXAMPLEffp-ats.iot.us-west-2.amazonaws.com with client ID 'test-0c8ae2ff-cc87-49d2-a82a-ae7ba1d0ca5a'...
   Connected!
   Subscribing to Delta events...
   Subscribing to Update responses...
   Subscribing to Get responses...
   Requesting current shadow state...
   Launching thread to read user input...
   Finished getting initial shadow state.
   Shadow document lacks 'color' property. Setting defaults...
   Changed local shadow value to 'off'.
   Updating reported shadow value to 'off'...
   Update request published.
   Finished updating reported shadow value to 'off'...
   Enter desired value:

   Por otro lado, si el programa se estaba ejecutando y lo reiniciaste, verás el último valor de color registrado en la terminal. En el cliente de prueba MQTT, verá una actualización de los temas $aws/things/thingname/shadow/get y $aws/things/thingname/shadow/get/accepted.

   Supongamos que el último color registrado fue green. A continuación se muestra el contenido del archivo JSON $aws/things/thingname/shadow/get/accepted.

   {
   "state": {
     "desired": {
       "welcome": "aws-iot",
       "color": "green"
     },
     "reported": {
       "welcome": "aws-iot",
       "color": "green"
     }
   },
   "metadata": {
     "desired": {
       "welcome": {
         "timestamp": 1620156892
       },
       "color": {
         "timestamp": 1620161643
       }
     },
     "reported": {
       "welcome": {
         "timestamp": 1620156892
       },
       "color": {
         "timestamp": 1620161643
       }
     }
   },
   "version": 10,
   "timestamp": 1620173908
   }            
                 

2. Introduzca un valor desired en la terminal, por ejemplo yellow. La aplicación de ejemplo shadow.py responde y muestra los siguientes mensajes en el terminal que muestran el cambio en el valor reported a yellow.

   Enter desired value:
   yellow
   Changed local shadow value to 'yellow'.
   Updating reported shadow value to 'yellow'...
   Update request published.
   Finished updating reported shadow value to 'yellow'.

   En el cliente de prueba de MQTT de la consola de AWS IoT, en Suscripciones, verá que los siguientes temas han recibido un mensaje:

   • $aws/things/thingname/shadow/update: muestra que ambos valores desired y updated cambian al color yellow.

   • $aws/things/thingname/shadow/update/accepted: muestra los valores actuales de los estados desired y reported y sus metadatos e información sobre la versión.

   • $aws/things/thingname/shadow/update/documents: muestra los valores anteriores y actuales de los estados desired y reported y sus metadatos e información sobre la versión.

   Como el documento $aws/things/thingname/shadow/update/documents también contiene información contenida en los otros dos temas, podemos revisarlo para ver la información de estado. El estado anterior muestra el valor informado establecido en green, sus metadatos e información de versión, y el estado actual, que muestra el valor informado actualizado a yellow.

   {
   "previous": {
     "state": {
       "desired": {
         "welcome": "aws-iot",
         "color": "green"
       },
       "reported": {
         "welcome": "aws-iot",
         "color": "green"
       }
     },
     "metadata": {
       "desired": {
         "welcome": {
           "timestamp": 1617297888
         },
         "color": {
           "timestamp": 1617297898
         }
       },
       "reported": {
         "welcome": {
           "timestamp": 1617297888
         },
         "color": {
           "timestamp": 1617297898
         }
       }
     },
     "version": 10
   },
   "current": {
     "state": {
       "desired": {
         "welcome": "aws-iot",
         "color": "yellow"
       },
       "reported": {
         "welcome": "aws-iot",
         "color": "yellow"
       }
     },
     "metadata": {
       "desired": {
         "welcome": {
           "timestamp": 1617297888
         },
         "color": {
           "timestamp": 1617297904
         }
       },
       "reported": {
         "welcome": {
           "timestamp": 1617297888
         },
         "color": {
           "timestamp": 1617297904
         }
       }
     },
     "version": 11
   },
   "timestamp": 1617297904
   }

3. Ahora, si introduce otro valor desired, verá más cambios en los valores reported y en las actualizaciones de los mensajes que se reciben en estos temas. El número de versión también se incrementa en 1. Por ejemplo, si introduce el valor green, el estado anterior informa del valor yellow y el estado actual informa del valor green.

Editar el documento Shadow para observar los eventos delta

Para observar los cambios en el tema delta, edite el documento paralelo en la consola de AWS IoT. Por ejemplo, puede cambiar el valor desired por el color red. Para ello, en la consola de AWS IoT, seleccione Editar y, a continuación, establezca el valor desired en rojo en el JSON, manteniendo el valor establecido reported en green. Antes de guardar el cambio, mantenga el terminal abierto ya que verá el mensaje delta informado en el terminal.

{
"desired": {
  "welcome": "aws-iot",
  "color": "red"
},
"reported": {
  "welcome": "aws-iot",
  "color": "green"
}
}

La aplicación de ejemplo shadow.py responde a este cambio y muestra mensajes en el terminal que indican el delta. En el cliente de pruebas de MQTT, los temas update habrán recibido un mensaje que muestra los cambios en los valores desired y reported.

También verá que el tema $aws/things/thingname/shadow/update/delta recibió un mensaje. Para ver el mensaje, seleccione este tema, que aparece en Suscripciones.

{
"version": 13,
"timestamp": 1617318480,
"state": {
  "color": "red"
},
"metadata": {
  "color": {
    "timestamp": 1617318480
  }
}
}