Partilhar via


azure-iothub package

Classes

Client

O cliente de serviço do Hub IoT é usado para se comunicar com dispositivos por meio de um hub IoT do Azure. Ele permite que o usuário do SDK:

  • enviar da nuvem para o dispositivo (também conhecido como comandos) para dispositivos: os comandos são enfileirados no Hub IoT e entregues de forma assíncrona somente quando o dispositivo está conectado. Apenas 50 comandos podem ser enfileirados por dispositivo.
  • invocar métodos diretos em dispositivos (que funcionarão apenas se o dispositivo estiver conectado no momento: é uma maneira síncrona de se comunicar com o dispositivo)
  • Ouça as mensagens de feedback enviadas pelos dispositivos para comandos anteriores.
  • Ouça as notificações de upload de arquivos dos dispositivos.

Os usuários devem criar novas instâncias de Client chamando um dos métodos de fábrica, fromConnectionString ou de SharedAccessSignature, para criar um cliente de serviço do Hub IoT.

Device

Cria uma representação de um dispositivo para uso com o registro de identidade de dispositivo APIs.

Essa classe foi preterida porque o de registro de identidade de dispositivo pode trabalhar diretamente com objetos JSON contendo uma descrição parcial do dispositivo, não necessariamente o objeto completo. Além disso, inicialmente, esta classe foi enviada com um erro de digitação no nome da propriedade symmetricKey (era com caixa de pascal em vez de caixa de camelo). O SDK está mantendo essa classe para não quebrar o código existente, mas isso será removido em uma futura atualização de versão principal e os clientes devem, em vez disso, usar objetos JSON simples.

JobClient

Fornece métodos para criar, atualizar, monitorar e cancelar trabalhos de longa execução em uma instância do Hub IoT, bem como consultar trabalhos existentes. A API de Trabalhos no Hub IoT do Azure permite agendar chamadas diretas de método e atualizações gêmeas em vários dispositivos.

Espera-se que os usuários do SDK criem instâncias JobClient usando os métodos de fábrica fromConnectionString(string) e fromSharedAccessSignature(string).

Registry

A classe Registry fornece acesso ao serviço de identidade de dispositivo do Hub IoT. Os usuários do SDK devem instanciar essa classe com um dos métodos de fábrica: fromConnectionString ou fromSharedAccessSignature.

O protocolo usado para operações de registro de identidade de dispositivo é HTTPS.

Amqp

Classe de transporte usada pelo cliente de serviço para se conectar ao hub IoT do Azure usando o protocolo AMQP em um soquete seguro (TLS). Essa classe não deve ser usada diretamente e, em vez disso, ser passada para um dos Client métodos de fábrica: fromConnectionString ou fromSharedAccessSignature.

AmqpWs

Classe de transporte usada pelo cliente de serviço para se conectar ao hub IoT do Azure usando o protocolo AMQP em websockets seguros. Essa classe não deve ser usada diretamente e, em vez disso, ser passada para um dos Client métodos de fábrica: fromConnectionString ou fromSharedAccessSignature.

DigitalTwinClient
IoTHubTokenCredentials

Cria assinaturas de acesso compartilhado com base na cadeia de conexão passada para o construtor. Essa classe é usada pela camada de protocolo do SDK para adicionar cabeçalhos de autenticação a cada solicitação.

Twin

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.

A maneira recomendada de obter um Twin para um dispositivo específico é usar o método getTwin(string, HttpResponseCallback<Twin>).

Interfaces

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration

O objeto Configuration representa a configuração de um único dispositivo ou pode representar uma implantação que pode ser aplicada como uma configuração a dispositivos com base no targetCondition.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

Descreve os parâmetros que estão disponíveis para uso com métodos diretos (também chamados de métodos de dispositivo)

Module

Aliases de Tipo

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback