Поделиться через


azure-iothub package

Классы

Client

Клиент службы Центра Интернета вещей используется для взаимодействия с устройствами через Центр Интернета вещей Azure. Он позволяет пользователю ПАКЕТА SDK:

  • отправка облачных устройств (также известных как команды) на устройства: команды помещаются в Центр Интернета вещей и передаются асинхронно, только если устройство подключено. Только 50 команд могут быть помещены в очередь на каждое устройство.
  • вызов прямых методов на устройствах (которые будут работать только в том случае, если устройство подключено в данный момент: это синхронный способ взаимодействия с устройством).
  • прослушивание сообщений обратной связи, отправленных устройствами для предыдущих команд.
  • прослушивает уведомления о отправке файлов с устройств.

Пользователи должны создавать новые экземпляры Client путем вызова одного из методов фабрики, fromConnectionString или fromSharedAccessSignatureдля создания клиента службы Центра Интернета вещей.

Device

Создает представление устройства для использования с реестром удостоверений устройств API.

Этот класс не рекомендуется использовать, так как реестр удостоверений устройств может работать непосредственно с объектами JSON, содержащим частичное описание устройства, не обязательно полный объект. Поверх этого класса изначально этот класс был отправлен с опечаткой на имя свойства symmetricKey (он был паскал-регистр вместо верблюдьего регистра). Пакет SDK хранит этот класс вокруг, чтобы не нарушать существующий код, но это будет удалено в будущем обновлении основной версии, и клиенты должны вместо этого использовать обычные объекты JSON.

JobClient

Предоставляет методы для создания, обновления, мониторинга и отмены длительных заданий в экземпляре Центра Интернета вещей, а также запроса существующих заданий. API заданий в Центре Интернета вещей Azure позволяет планировать прямые вызовы методов и обновления двойников на нескольких устройствах.

Ожидается, что пользователи пакета SDK создают экземпляры JobClient с помощью методов фабрики fromConnectionString(string) и fromSharedAccessSignature(string).

Registry

Класс Registry предоставляет доступ к службе удостоверений устройств Центра Интернета вещей. Пользователи пакета SDK должны создать экземпляр этого класса одним из методов фабрики: fromConnectionString или fromSharedAccessSignature.

Протокол, используемый для операций реестра удостоверений устройств, — HTTPS.

Amqp

Класс транспорта, используемый клиентом службы для подключения к Центру Интернета вещей Azure с помощью протокола AMQP через безопасный сокет TLS. Этот класс не следует использовать напрямую и вместо этого передаваться одному из методов фабрики Client: fromConnectionString или fromSharedAccessSignature.

AmqpWs

Класс транспорта, используемый клиентом службы для подключения к Центру Интернета вещей Azure с помощью протокола AMQP через безопасные websockets. Этот класс не следует использовать напрямую и вместо этого передаваться одному из методов фабрики Client: fromConnectionString или fromSharedAccessSignature.

DigitalTwinClient
IoTHubTokenCredentials

Создает подписанные URL-адреса на основе строки подключения, переданной конструктору. Этот класс используется уровнем протокола пакета SDK для добавления заголовков проверки подлинности в каждый запрос.

Twin

Двойник устройства — это документ, описывающий состояние устройства, хранящегося центром Интернета вещей Azure, и доступен, даже если устройство находится в автономном режиме. Он построен около 3 разделов:

  • Теги: пары "ключ-значение", доступные только со стороны службы
  • Требуемые свойства: обновлена службой и получена устройством
  • Сообщаемые свойства: обновлено устройством и получено службой.

Обратите внимание, что хотя это возможность, требуемые и сообщаемые свойства не должны соответствовать, и что логика синхронизации этих двух коллекций, при необходимости, остается пользователю пакета SDK.

Дополнительные сведения см. в разделе Основные сведения обдвойников устройств.

Рекомендуемый способ получения Twin для конкретного устройства — использовать метод getTwin(string, HttpResponseCallback<Twin>).

Интерфейсы

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

Объект Configuration представляет конфигурацию одного устройства или может представлять развертывание, которое можно применить в качестве конфигурации к устройствам на основе targetCondition.

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

Описание параметров, доступных для использования с прямыми методами (также называемыми методами устройства).

Module

Псевдонимы типа

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback