azure-iot-device package

  • Ссылка

Классы

Message

Объект Message используется для асинхронного обмена сообщениями между устройством и службой Центр Интернета вещей телеметрии (с устройства в облако) и команд (из облака в устройство). Он не зависит от транспорта, то есть работает одинаково по amQP, MQTT и HTTP.
Client

Центр Интернета вещей клиент устройства, используемый для подключения устройства к Центру Интернета вещей Azure.

Пользователи пакета SDK должны вызвать один из методов фабрики, изConnectionString или fromSharedAccessSignature, чтобы создать клиент устройства Центр Интернета вещей.
DeviceMethodRequest

Представляет данные, передаваемые из службы на устройство при вызове метода устройства из облака. Экземпляр этого класса передается в обратный вызов, зарегистрированный через onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse

DeviceMethodResponse пользователю предоставляется объект , каждый из которых DeviceMethodRequest позволяет пользователю создать и отправить хорошо отформатированный ответ в службу для каждого вызова метода устройства. Экземпляр этого класса передается в качестве второго параметра в обратный вызов, зарегистрированный через onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
IotEdgeAuthenticationProvider

Предоставляет реализацию AuthenticationProvider , которая делегирует создание маркеров iotedged. Эта реализация предназначена для использования клиента модуля с azure IoT Edge.

Этот тип наследуется от SharedAccessKeyAuthenticationProvider и функционально идентичен этому типу, за исключением части создания маркера, которую он переопределяет путем реализации _sign метода .
ModuleClient

Центр Интернета вещей клиент устройства, используемый для подключения устройства к Центру Интернета вещей Azure.

Пользователи пакета SDK должны вызвать один из методов фабрики, изConnectionString или fromSharedAccessSignature, чтобы создать клиент устройства Центр Интернета вещей.
SharedAccessKeyAuthenticationProvider

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

Объект SharedAccessKeyAuthenticationProvider регулярно создает маркеры подписанного URL-адреса и выдает newTokenAvailable событие для транспорта, чтобы обновить свои учетные данные с помощью экземпляра Центра Интернета вещей Azure и оставаться на связи.
SharedAccessSignatureAuthenticationProvider

AuthenticationProvider Предоставляет объект, который может быть создан просто с подписанным URL-адресом и затем используется клиентом устройства и транспортом для проверки подлинности в экземпляре Центра Интернета вещей Azure.

Объект SharedAccessSignatureAuthenticationProvider не обновляет маркер подписанного URL-адреса автоматически, поэтому пользователю необходимо передать ему маркеры подписанных URL-адресов без истечения срока действия с помощью updateSharedAccessSignature метода . Для каждого вызова этого метода будет выдавать newTokenAvailable событие, SharedAccessSignatureAuthenticationProvider которое транспорты будут использовать для проверки подлинности в экземпляре Центра Интернета вещей Azure.
Twin

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

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

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

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

AuthenticationProvider Предоставляет объект, который может быть создан просто с сертификатом X509 и ключом, а затем используется клиентом устройства и транспортом для проверки подлинности в экземпляре Центра Интернета вещей Azure.

SharedAccessSignatureAuthenticationProvider В отличие от объектов и SharedAccessKeyAuthenticationProvider , объект не выдает newTokenAvailable событие, X509AuthenticationProvider так как маркеры не участвуют в проверке подлинности X509. Транспорты получат учетные данные с помощью getDeviceCredentials метода .

Интерфейсы

AmqpTransportOptions

Параметры, относящиеся к транспорту AMQP.

Он передается в setOptions как свойство с именем http внутри объекта DeviceClientOptions .

См.
DeviceClientOptions

Параметры для объекта Client. Передается в функцию setOptions .

Пример

 var options = {
   cert: myX509Certificate,
   key: myX509Key,
   http: {
     receivePolicy: {
       interval: 10
     }
   }
 }
 client.setOptions(options, callback);
DeviceTransport
HttpReceiverOptions

Структура параметров, используемая для настройки частоты опроса сообщений получателем HTTP. Каждый из этих вариантов является взаимоисключающим, за drain исключением логического. В структуре параметров должен присутствовать только один interval, atcron или manualPolling .

Это настраивается путем вызова метода setOptions в качестве свойства с именем receivePolicy внутри объекта HttpTransportOptions , который находится внутри объекта DeviceClientOptions .

См.
HttpTransportOptions

Структура параметров для передачи необязательных параметров конфигурации в http Transport.

Он передается в setOptions как свойство с именем http внутри объекта DeviceClientOptions .

См.
MqttTransportOptions

Параметры, относящиеся к транспорту MQTT

Он передается в setOptions как свойство с именем mqtt внутри объекта DeviceClientOptions .
TwinProperties

Содержит требуемые и сообщаемые свойства двойника.

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

BufferConvertible

Функции

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

Сведения о функции

getUserAgentString(NoErrorCallback<string>) 

function getUserAgentString(done: NoErrorCallback<string>)

Параметры

done

NoErrorCallback<string>

getUserAgentString() 

function getUserAgentString(): Promise<string>

Возвращаемое значение

Promise<string>

getUserAgentString(string, NoErrorCallback<string>) 

function getUserAgentString(productInfo: string, done: NoErrorCallback<string>)

Параметры

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string) 

function getUserAgentString(productInfo: string): Promise<string>

Параметры

productInfo

string

Возвращаемое значение

Promise<string>