Compartilhar via


azure-iothub package

Classes

Client

O cliente de serviço 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 nuvem para dispositivo (também conhecido como comandos) para dispositivos: os comandos são enfileirados em Hub IoT e entregues de forma assíncrona somente quando o dispositivo está conectado. Somente 50 comandos podem ser enfileirados por dispositivo.
  • invocar métodos diretos em dispositivos (que funcionarão somente se o dispositivo estiver conectado no momento: é uma maneira síncrona de se comunicar com o dispositivo)
  • ouça mensagens de comentários enviadas por dispositivos para comandos anteriores.
  • ouça as notificações de upload de arquivos de dispositivos.

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

Device

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

Essa classe foi preterida porque o registro de identidade do dispositivo pode funcionar diretamente com objetos JSON que contêm uma descrição parcial do dispositivo, não necessariamente o objeto completo. Além disso, inicialmente, essa classe foi enviada com um erro de digitação no nome da symmetricKey propriedade (foi caso pascal em vez de maiúsculas e minúsculas). O SDK está mantendo essa classe por perto para não interromper o código existente, mas isso será removido em uma atualização de versão principal futura e os clientes devem, em vez disso, usar objetos JSON simples.

JobClient

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

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

Registry

A classe Registry fornece acesso ao serviço de identidade do dispositivo 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 do 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 TLS seguro. Essa classe não deve ser usada diretamente e, em vez disso, ser passada para um dos métodos de Client 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 métodos de Client 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 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.

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

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 para dispositivos com base no targetCondition.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

Descreve os parâmetros 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