Partilhar via


azure-iothub package

Classes

Client

O cliente de serviço Hub IoT é utilizado para comunicar com dispositivos através de um hub IoT do Azure. Permite ao utilizador do SDK:

  • enviar cloud para dispositivo (também conhecido como comandos) para dispositivos: os comandos são colocados em fila no Hub IoT e entregues de forma assíncrona apenas quando o dispositivo está ligado. Apenas 50 comandos podem ser em fila por dispositivo.
  • invocar métodos diretos em dispositivos (que só funcionarão se o dispositivo estiver atualmente ligado: é uma forma síncrona de comunicar com o dispositivo)
  • escutar mensagens de feedback enviadas por dispositivos para comandos anteriores.
  • escutar notificações de carregamento de ficheiros a partir de dispositivos.

Os utilizadores devem criar novas Client instâncias ao chamar um dos métodos de fábrica, deConnectionString ou deSharedAccessSignature, para criar um Cliente de serviço Hub IoT.

Device

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

Esta classe foi preterida porque o registo 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, esta classe foi enviada com um erro de digitação no nome da symmetricKey propriedade (foi pascal-cased em vez de camel-cased). O SDK está a manter esta classe por perto para não quebrar o código existente, mas este será removido numa futura atualização de versão principal e os clientes devem, em vez disso, utilizar objetos JSON simples.

JobClient

Fornece métodos para criar, atualizar, monitorizar e cancelar tarefas de execução prolongada numa instância de Hub IoT, bem como consultar tarefas existentes. A API de Tarefas no Hub IoT do Azure permite agendar chamadas de método direto e atualizações de duplos em vários dispositivos.

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

Registry

A classe Registo fornece acesso ao serviço de identidade do dispositivo Hub IoT. Os utilizadores do SDK devem instanciar esta classe com um dos métodos de fábrica: deConnectionString ou deSharedAccessSignature.

O protocolo utilizado para operações de registo de identidade do dispositivo é HTTPS.

Amqp

Classe de transporte utilizada pelo cliente de serviço para ligar ao hub IoT do Azure com o protocolo AMQP através de um socket seguro (TLS). Esta classe não deve ser utilizada diretamente e, em vez disso, ser transmitida para um dos Client métodos de fábrica: deConnectionString ou deSharedAccessSignature.

AmqpWs

Classe de transporte utilizada pelo cliente de serviço para ligar ao hub IoT do Azure com o protocolo AMQP através de websockets seguros. Esta classe não deve ser utilizada diretamente e, em vez disso, ser transmitida para um dos Client métodos de fábrica: deConnectionString ou deSharedAccessSignature.

DigitalTwinClient
IoTHubTokenCredentials

Cria assinaturas de acesso partilhado com base na cadeia de ligação transmitida ao construtor. Esta classe é utilizada pela camada de protocolo do SDK para adicionar cabeçalhos de autenticação a cada pedido.

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

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

Interfaces

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

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

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

Descreve os parâmetros disponíveis para utilização com métodos diretos (também denominados métodos de dispositivo)

Module

Aliases de Tipo

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback