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

azure-iot-device package

Классы

Message

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

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

Пользователи пакета SDK должны вызывать один из методов фабрики, fromConnectionString или 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 должны вызывать один из методов фабрики, fromConnectionString или fromSharedAccessSignature для создания клиента устройства Центра Интернета вещей.
SharedAccessKeyAuthenticationProvider

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

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

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

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

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

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

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

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

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

В отличие от объектов SharedAccessSignatureAuthenticationProvider и SharedAccessKeyAuthenticationProvider, X509AuthenticationProvider не выдает событие newTokenAvailable, так как в проверке подлинности 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.

Он передается в 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>