azure-iot-device package

  • Referência

Classes

Message

O Message objeto é utilizado para mensagens assíncronas de telemetria (dispositivo para cloud) e comandos (cloud a dispositivo) entre o dispositivo e o serviço Hub IoT. É transport-agnostic, o que significa que funciona da mesma forma através de AMQP, MQTT e HTTP.
Client

Hub IoT cliente de dispositivo utilizado para ligar um dispositivo a um hub IoT do Azure.

Os utilizadores do SDK devem chamar um dos métodos de fábrica, deConnectionString ou deSharedAccessSignature para criar um cliente de dispositivo Hub IoT.
DeviceMethodRequest

Representa os dados transmitidos do serviço para o dispositivo quando um método de dispositivo é chamado a partir da cloud. Uma instância desta classe é transmitida para a chamada de retorno registada através de onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse

um DeviceMethodResponse objeto é fornecido ao utilizador, permitindo que o DeviceMethodRequest utilizador construa e envie uma resposta bem formatada de volta para o serviço para cada chamada de método de dispositivo. Uma instância desta classe é transmitida como o segundo parâmetro para a chamada de retorno registada através de onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
IotEdgeAuthenticationProvider

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

Este tipo herda SharedAccessKeyAuthenticationProvider e é funcionalmente idêntico a esse tipo, exceto a parte de geração de tokens que substitui ao implementar o _sign método.
ModuleClient

Hub IoT cliente de dispositivo utilizado para ligar um dispositivo a um hub IoT do Azure.

Os utilizadores do SDK devem chamar um dos métodos de fábrica, deConnectionString ou deSharedAccessSignature para criar um cliente de dispositivo Hub IoT.
SharedAccessKeyAuthenticationProvider

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

O SharedAccessKeyAuthenticationProvider objeto trata de criar tokens de assinatura de acesso partilhado numa cadência regular e emite o newTokenAvailable evento para que os transportes renovem as respetivas credenciais com a instância do hub IoT do Azure e se mantenham ligados.
SharedAccessSignatureAuthenticationProvider

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

O SharedAccessSignatureAuthenticationProvider objeto não renova automaticamente o token de assinatura de acesso partilhado, pelo que o utilizador tem de alimentar tokens de assinatura de acesso partilhado não expirados através do updateSharedAccessSignature método . Para cada chamada para este método, o SharedAccessSignatureAuthenticationProvider irá emitir um newTokenAvailable evento que os transportes utilizarão para autenticar com a instância do hub IoT do Azure.
Twin

Um Dispositivo Duplo é 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. É criado em torno de 3 secções:

  • Etiquetas: pares chave/valor apenas acessíveis a partir do lado do serviço
  • Propriedades Pretendidas: atualizadas por um serviço e recebidas pelo dispositivo
  • Propriedades Comunicadas: atualizadas pelo dispositivo e recebidas pelo serviço.

Tenha em atenção que, embora seja uma possibilidade, as propriedades pretendidas e comunicadas não têm de corresponder e que a lógica para sincronizar estas duas coleções, se necessário, é deixada ao utilizador do SDK.

Para obter mais informações, veja Understanding Device Twins (Compreender os Dispositivos Duplos).
X509AuthenticationProvider

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

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

Interfaces

AmqpTransportOptions

Opções específicas do transporte AMQP.

Isto é transmitido para setOptions como uma propriedade denominada http dentro de um objeto DeviceClientOptions .

Consulte
DeviceClientOptions

Opções para o objeto Cliente. Transmitido 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 utilizada para configurar a frequência com que o recetor HTTP consulta as mensagens. Cada uma destas opções é mutuamente exclusiva, exceto a drain booleana. Apenas um interval, atou cronmanualPolling deve estar presente na estrutura de opções.

Isto é configurado ao chamar setOptions com isto como uma propriedade denominada receivePolicy dentro de um objeto HttpTransportOptions que se encontra dentro de um objeto DeviceClientOptions .

Consulte
HttpTransportOptions

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

Isto é transmitido para setOptions como uma propriedade denominada http dentro de um objeto DeviceClientOptions .

Consulte
MqttTransportOptions

Opções específicas do transporte MQTT

Isto é transmitido para setOptions como uma propriedade denominada mqtt dentro de um objeto DeviceClientOptions .
TwinProperties

Contém as propriedades pretendidas e comunicadas do Duplo.

Aliases de Tipo

BufferConvertible

Funções

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

Detalhes de Função

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

Parâmetros

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

Devoluções

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

Devoluções

Promise<string>