Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Tutorial: Instalación del SDK del dispositivo y ejecución de la aplicación de ejemplo para Device Shadows

Esta sección muestra cómo puede instalar el software necesario y el SDK del dispositivo AWS IoT para Python y ejecutar la aplicación de ejemplo shadow.py para editar el documento de la sombra y controlar su estado.

Antes de ejecutar este tutorial:

Debe haber configurado su Cuenta de AWS, configurado su dispositivo Raspberry Pi y creado una cosa AWS IoT y una política que otorgue al dispositivo permisos para publicar y suscribirse a los temas reservados MQTT del servicio Device Shadow. Para obtener más información, consulte Tutorial: Cómo preparar la Raspberry Pi para ejecutar la aplicación shadow.

También debe haber instalado Git, Python y el SDK del dispositivo AWS IoT para Python. Este tutorial se basa en los conceptos presentados en el tutorial Conexión de una Raspberry Pi u otro dispositivo. Si no ha probado ese tutorial, le recomendamos que siga los pasos descritos en él para instalar los archivos de certificado y el SDK del dispositivo y, a continuación, vuelva a este tutorial para ejecutar la aplicación de ejemplo shadow.py.

Para completar este tutorial se necesitan aproximadamente 20 minutos.

Paso 1: ejecutar la aplicación de ejemplo shadow.py

Antes de ejecutar la aplicación de ejemplo shadow.py, necesitará la siguiente información además de los nombres y la ubicación de los archivos de certificado que instaló.

Introduzca los valores y observe las actualizaciones en el documento Shadow

Puede introducir valores en el terminal para especificar el valor desired, lo que también actualiza el valor reported. Supongamos que introduce el color yellow en el terminal. El valor reported también se actualiza al color yellow. A continuación se muestran los mensajes que se muestran en el terminal:

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'.

Al publicar esta solicitud de actualización, AWS IoT crea una sombra clásica y predeterminada para el recurso de la cosa. Puede observar la solicitud de actualización que publicó a los valores reported ydesired en la consola de AWS IoT mirando el documento Shadow para el recurso cosa que creó (por ejemplo, My_light_bulb). Para ver la actualización en el documento Shadow, siga estos pasos:

El documento Shadow debería tener un aspecto similar al siguiente y mostrar los valores reported y desired establecidos en el color yellow. Puede ver estos valores en la sección Estado de sombra del documento.

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

También verá una sección de metadatos que contiene la información de la marca de tiempo y el número de versión de la solicitud.

Puede utilizar la versión del documento de estado para asegurarse de que actualiza la versión más reciente del documento de sombra de un dispositivo. Si envía otra solicitud de actualización, el número de versión aumentará en 1. Cuando se suministra una versión con una solicitud de actualización, el servicio rechaza la solicitud con un código de respuesta de conflicto HTTP 409 si la versión actual del documento de estado no coincide con la versión suministrada.

{
"metadata": {
  "desired": {
    "welcome": {
      "timestamp": 1620156892
    },
    "color": {
      "timestamp": 1620156893
    }
  },
  "reported": {
    "welcome": {
      "timestamp": 1620156892
    },
    "color": {
      "timestamp": 1620156893
    }
  }
},
"version": 10
}        

Para obtener más información sobre el documento alternativo y observar los cambios en la información de estado, continúe con el siguiente tutorial Tutorial: Interactuar con Device Shadow mediante la aplicación de ejemplo y el cliente de pruebas MQTT, tal como se describe en la sección Paso 4: Revisar los resultados y los siguientes pasos de este tutorial. Si lo desea, también puede obtener información sobre el código de ejemplo shadow.py y cómo utiliza el protocolo MQTT en la siguiente sección.

Paso 2: Revisar la aplicación de ejemplo del SDK de dispositivos shadow.py

En esta sección se revisa la aplicación de ejemplo shadow.py del SDK de dispositivos AWS IoT v2 para Python utilizada en este tutorial. A continuación, analizaremos cómo se conecta a AWS IoT Core mediante los protocolos MQTT y MQTT over WSS. La biblioteca de tiempo de ejecución común de AWS (AWS-CRT) proporciona el soporte de protocolo de comunicación de bajo nivel y se incluye con el SDK de dispositivos AWS IoT v2 para Python.

Si bien este tutorial utiliza MQTT y MQTT sobre WSS, AWS IoT es compatible con los dispositivos que publican solicitudes HTTPS. Para ver un ejemplo de un programa de Python que envía un mensaje HTTP desde un dispositivo, consulta el ejemplo de código HTTPS con la biblioteca requests de Python.

Para obtener información sobre cómo tomar una decisión fundamentada sobre qué protocolo utilizar para las comunicaciones de su dispositivo, consulte la Elegir un protocolo de aplicación para la comunicación de su dispositivo.

MQTT

Las llamadas de ejemplo shadow.py mtls_from_path (mostradas aquí) en el mqtt_connection_builder para establecer una conexión con AWS IoT Core mediante el protocolo MQTT. mtls_from_path utiliza certificados X.509 y TLS v1.2 para autenticar el dispositivo. La biblioteca AWS-CRT gestiona los detalles de nivel inferior de esa conexión.

mqtt_connection = mqtt_connection_builder.mtls_from_path(
  endpoint=args.endpoint,
  cert_filepath=args.cert,
  pri_key_filepath=args.key,
  ca_filepath=args.ca_file,
  client_bootstrap=client_bootstrap,
  on_connection_interrupted=on_connection_interrupted,
  on_connection_resumed=on_connection_resumed,
  client_id=args.client_id,
  clean_session=False,
  keep_alive_secs=6
)

La muestra shadow.py también llama a websockets_with_default_aws_signing en el mqtt_connection_builder para establecer una conexión con AWS IoT Core usando el protocolo MQTT sobre WSS. MQTT sobre WSS también utiliza los mismos parámetros que MQTT y toma estos parámetros adicionales:

Suscribirse a los temas y eventos de Sombra

El ejemplo shadow.py intenta establecer una conexión y espera a que esté completamente conectado. Si no está conectado, los comandos se ponen en cola. Una vez conectado, el ejemplo se suscribe a los eventos delta y actualiza y recibe mensajes, y publica los mensajes con un nivel de calidad de servicio (QoS) de 1 (mqtt.QoS.AT_LEAST_ONCE).

Cuando un dispositivo se suscribe a un mensaje con QoS de nivel 1, el agente de mensajes guarda los mensajes a los que está suscrito el dispositivo hasta que se puedan enviar al dispositivo. El agente de mensajes vuelve a enviar los mensajes hasta que recibe una respuesta PUBACK del dispositivo.

Para más información sobre el protocolo MQTT, consulte Revise el protocolo MQTT y MQTT.

Para obtener más información sobre cómo se utilizan MQTT, MQTT sobre WSS, las sesiones persistentes y los niveles de QoS que se utilizan en este tutorial, consulte Consulte la aplicación de ejemplo del SDK de dispositivo pubsub.py.

Paso 3: Solucionar problemas con la aplicación de ejemplo shadow.py

Cuando ejecute la aplicación de ejemplo shadow.py, debería ver algunos mensajes en el terminal y un aviso para introducir un valor desired. Si el programa arroja un error, para depurarlo puede empezar por comprobar si ha ejecutado el comando correcto para su sistema.

En algunos casos, el mensaje de error puede indicar problemas de conexión y tener un aspecto similar a: Host name was invalid for dns resolution o Connection was closed unexpectedly. En esos casos, puede comprobar lo siguiente:

Paso 4: Revisar los resultados y los siguientes pasos

Pasos siguientes

Ahora puede ejecutar la aplicación de ejemplo shadow.py y usar Device Shadows para controlar el estado. Puede observar las actualizaciones del documento sombra en la consola de AWS IoT y observar los eventos delta a los que responde la aplicación de muestra. Con el cliente de pruebas MQTT, puede suscribirse a los temas paralelos reservados y observar los mensajes que reciben los temas al ejecutar el programa de ejemplo. Para más información sobre cómo ejecutar este tutorial, consulte Tutorial: Interactuar con Device Shadow mediante la aplicación de ejemplo y el cliente de pruebas MQTT.