Compartilhar via

azure-iot-device package

  • Referência

Classes

Message

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

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

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

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 por meio de onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse

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 por meio de onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
IotEdgeAuthenticationProvider

Fornece uma implementação AuthenticationProvider que delega a geração de token a iotedged. Essa implementação deve ser usada ao usar o cliente do módulo com o Azure IoT Edge.

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

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

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

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

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 automaticamente o token de assinatura de acesso compartilhado, portanto, o usuário precisa alimentar tokens de assinatura de acesso compartilhado não expirados a ele usando o método updateSharedAccessSignature. Para cada chamada a 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.
Twin

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

  • Marcas: pares chave/valor acessíveis somente 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 dispositivos gêmeos.
X509AuthenticationProvider

Fornece um objeto AuthenticationProvider que pode ser criado simplesmente com um certificado X509 e uma chave 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, pois não há nenhum token envolvido na autenticação X509. Os transportes obterão as credenciais usando o método getDeviceCredentials.

Interfaces

AmqpTransportOptions

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

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

Ver
DeviceClientOptions

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

exemplo 

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

Estrutura de opções usada para configurar a frequência com que o receptor HTTP sonda mensagens. Cada uma dessas opções é mutuamente exclusiva, exceto pela drain booliana. Somente um interval, at, cron ou manualPolling estará presente na estrutura de 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
HttpTransportOptions

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
MqttTransportOptions

Opções específicas para o transporte MQTT

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

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

Aliases de tipo

BufferConvertible

Funções

getUserAgentString(NoErrorCallback<string>)
getUserAgentString()
getUserAgentString(string, NoErrorCallback<string>)
getUserAgentString(string)

Detalhes da função

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

Parâmetros

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

Retornos

Promise<string>

getUserAgentString(string, NoErrorCallback<string>) 

function getUserAgentString(productInfo: string, done: NoErrorCallback<string>)

Parâmetros

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string) 

function getUserAgentString(productInfo: string): Promise<string>

Parâmetros

productInfo

string

Retornos

Promise<string>