azure-iot-device package

O objeto Message é usado para telemetria (dispositivo para nuvem) e comandos (nuvem para dispositivo) mensagens assíncronas entre o dispositivo e o serviço Hub IoT. É independente do transporte, o que significa que funciona da mesma forma sobre AMQP, MQTT e HTTP.

Cliente de dispositivo do Hub IoT usado para conectar um dispositivo a um hub IoT do Azure.

Os usuários do SDK devem chamar um dos métodos de fábrica, fromConnectionString ou de SharedAccessSignature para criar um cliente de dispositivo do Hub IoT.

Representa os dados passados do serviço para o dispositivo quando um método de dispositivo é chamado da nuvem. Uma instância dessa classe é passada para o retorno de chamada registrado via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

Um objeto DeviceMethodResponse é fornecido ao usuário com cada DeviceMethodRequest permitindo que o usuário construa e envie uma resposta bem formatada de volta ao serviço para cada chamada de método de dispositivo. Uma instância dessa classe é passada como o segundo parâmetro para o retorno de chamada registrado via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

Fornece uma implementação AuthenticationProvider que delega a geração de tokens ao iotedged. Esta implementação destina-se a ser usada ao usar o cliente de módulo com o Azure IoT Edge.

Esse tipo herda de SharedAccessKeyAuthenticationProvider e é funcionalmente idêntico a esse tipo, exceto para a parte de geração de token que ele substitui implementando o método _sign.

Cliente de dispositivo do Hub IoT usado para conectar um dispositivo a um hub IoT do Azure.

Os usuários do SDK devem chamar um dos métodos de fábrica, fromConnectionString ou de SharedAccessSignature para criar um cliente de dispositivo do Hub IoT.

Fornece um objeto AuthenticationProvider que pode ser criado simplesmente com uma cadeia de conexão e, em seguida, é usado pelo cliente do dispositivo e transporta para autenticar com a instância do hub IoT do Azure.

O objeto SharedAccessKeyAuthenticationProvider cuida da criação de tokens de assinatura de acesso compartilhado em uma cadência regular e emite o evento newTokenAvailable para que os transportes renovem suas credenciais com a instância do hub IoT do Azure e permaneçam conectados.

Fornece um objeto AuthenticationProvider que pode ser criado simplesmente com uma assinatura de acesso compartilhado e, em seguida, é usado pelo cliente do dispositivo e transporta para autenticar com a instância do hub IoT do Azure.

O objeto SharedAccessSignatureAuthenticationProvider não renova o token de assinatura de acesso compartilhado automaticamente, portanto, o usuário precisa alimentar tokens de assinatura de acesso compartilhado não expirados para ele usando o método updateSharedAccessSignature. Para cada chamada para esse método, o SharedAccessSignatureAuthenticationProvider emitirá um evento newTokenAvailable que os transportes usarão para autenticar com a instância do hub IoT do Azure.

Um Gêmeo de Dispositivo é um documento que descreve o estado de um dispositivo armazenado por um hub IoT do Azure e está disponível mesmo se o dispositivo estiver offline. É construído em torno de 3 seções:

• Tags: pares chave/valor acessíveis apenas do lado do serviço
• Propriedades desejadas: atualizadas por um serviço e recebidas pelo dispositivo
• Propriedades relatadas: atualizadas pelo dispositivo e recebidas pelo serviço.

Observe que, embora seja uma possibilidade, as propriedades desejadas e relatadas não precisam corresponder e que a lógica para sincronizar essas duas coleções, se necessário, é deixada para o usuário do SDK.

Para obter mais informações, consulte Noções básicas sobre gêmeos de dispositivo.

Fornece um objeto AuthenticationProvider que pode ser criado simplesmente com um certificado e uma chave X509 e, em seguida, é usado pelo cliente do dispositivo e transporta para autenticar com a instância do hub IoT do Azure.

Ao contrário dos objetos SharedAccessSignatureAuthenticationProvider e SharedAccessKeyAuthenticationProvider, o X509AuthenticationProvider não emite um evento newTokenAvailable, uma vez que não há nenhum token envolvido na autenticação X509. Os transportes obterão as credenciais usando o método getDeviceCredentials.

Opções específicas para o transporte AMQP.

Isso é passado para setOptions como uma propriedade chamada http dentro de um objeto DeviceClientOptions.

Ver

Opções para o objeto Client. Passou para a função setOptions.

Exemplo

 var options = {
   cert: myX509Certificate,
   key: myX509Key,
   http: {
     receivePolicy: {
       interval: 10
     }
   }
 }
 client.setOptions(options, callback);

Estrutura de opções usada para configurar a frequência com que o recetor HTTP sonda mensagens. Cada uma dessas opções é mutuamente exclusiva, exceto para o drain booleano. Apenas um interval, at, cron ou manualPolling deve estar presente na estrutura das opções.

Isso é configurado chamando setOptions com isso como uma propriedade chamada receivePolicy dentro de um objeto HttpTransportOptions que está dentro de um objeto DeviceClientOptions.

Ver

Estrutura de opções para passar parâmetros de configuração opcionais para o Transporte Http.

Isso é passado para setOptions como uma propriedade chamada http dentro de um objeto DeviceClientOptions.

Ver

Opções específicas para o transporte MQTT

Isso é passado para setOptions como uma propriedade chamada mqtt dentro de um objeto DeviceClientOptions.

Contém as propriedades desejadas e relatadas para o gêmeo.