Tutorial: interagindo com a Sombra do Dispositivo usando o aplicativo de amostra e o cliente de teste MQTT

Abra o cliente de teste MQTT

Abra o cliente de teste do MQTT no console AWS IoT em uma nova janela para que você possa observar as mensagens recebidas pelos tópicos do MQTT sem perder a configuração do seu cliente de teste do MQTT. O cliente de teste MQTT não retém assinaturas ou logs de mensagens se você deixá-lo para ir para outra página no console. Para esta seção do tutorial, você pode ter o documento de sombra do objeto AWS IoT e o cliente de teste MQTT abertos em janelas separadas para observar mais facilmente a interação com Sombras do Dispositivo.

Assine os tópicos Shadow reservados do MQTT

Você pode usar o cliente de teste MQTT para inserir os nomes dos tópicos reservados do MQTT da Sombra do Dispositivo e se inscrever neles para receber atualizações ao executar o aplicativo de amostra shadow.py. Para se inscrever nos tópicos:

1. No cliente de teste MQTT no AWS IoTconsole, escolha Subscribe to a topic (Se inscreva em um tópico).

2. Na seção Filtro de tópicos, digite: $aws/things/thingname /shadow/update/ #. Aqui, thingname é o nome do recurso de objeto que você criou anteriormente (por exemplo, My_light_bulb).

3. Mantenha os valores padrão para as configurações adicionais e escolha Inscrever-se.

Ao usar o caractere curinga # na assinatura do tópico, você pode se inscrever em vários tópicos do MQTT ao mesmo tempo e observar todas as mensagens trocadas entre o dispositivo e sua sombra em uma única janela. Para obter mais informações sobre os caracteres curinga e seu uso, consulteTópicos do MQTT.

Execute um programa de amostra shadow.py e observe as mensagens

Na janela de linha de comando do Raspberry Pi, se você desconectou o programa, execute o aplicativo de exemplo novamente e observe as mensagens no cliente de teste MQTT no console AWS IoT.

1. Execute o comando a seguir para reiniciar o programa de amostra. Substitua your-iot-thing-name e your-iot-endpoint pelos nomes do objeto AWS IoT que você criou anteriormente (por exemplo, My_light_bulb) e pelo endpoint para interagir com o 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

   Em seguida, o aplicativo de amostra shadow.py é executado e recupera o estado de sombra atual. Se você excluiu a sombra ou limpou os estados atuais, o programa define o valor atual como off e, em seguida, solicita que você insira um 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 outro lado, se o programa estava em execução e você o reiniciou, você verá o valor de cor mais recente relatado no terminal. No cliente de teste do MQTT, você verá uma atualização nos tópicos $aws/things/thingname/shadow/get e $aws/things/thingname/shadow/get/accepted.

   Suponha que a última cor relatada tenha sido green. A seguir mostra o conteúdo do arquivo 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. Insira um valor desired no terminal, como yellow. O aplicativo de amostra shadow.py responde e exibe as seguintes mensagens no terminal que mostram a alteração no valor reported para 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'.

   No cliente de teste do MQTT no AWS IoTconsole, em Assinaturas, você vê que os seguintes tópicos receberam uma mensagem:

   • $aws/things/thingname/shadow/update: mostra que os valores de desired e updated mudam para a cor yellow.

   • $aws/things/thingname/shadow/update/accepted: mostra os valores atuais dos estados desired e reported e seus metadados e informações de versão.

   • $aws/things/thingname/shadow/update/documents: mostra os valores anteriores e atuais dos estados desired e reported e seus metadados e informações de versão.

   Como o documento $aws/things/thingname/shadow/update/documents também contém informações contidas nos outros dois tópicos, podemos revisá-lo para ver as informações do estado. O estado anterior mostra o valor relatado definido como green, seus metadados e informações de versão e o estado atual que mostra o valor relatado atualizado para 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. Agora, se você inserir outro valor desired, verá mais alterações nos valores reported e nas atualizações de mensagens recebidas por esses tópicos. O número da versão também aumenta em 1. Por exemplo, se você inserir o valor green, o estado anterior reportará o valor yellow e o estado atual relatará o valor green.

Edite o documento de sombra para observar eventos delta

Para observar as alterações no tópico delta, edite o documento de sombra no console AWS IoT. Por exemplo, você pode alterar o valor desired para a cor red. Para fazer isso, no console AWS IoT, escolha Editar e defina o valor desired como vermelho no JSON, mantendo o valor reported definido como green. Antes de salvar a alteração, mantenha o terminal aberto, pois você verá a mensagem delta relatada no terminal.

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

O aplicativo de amostra shadow.py responde a essa alteração e exibe mensagens no terminal indicando o delta. No cliente de teste MQTT, os tópicos update receberão uma mensagem mostrando as alterações nos valores desired e reported.

Você também vê que o tópico $aws/things/ thingname /shadow/update/delta recebeu uma mensagem. Para ver a mensagem, escolha esse tópico, que está listado em Assinaturas.

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