azure-iot-device package

Třídy

Message	Objekt Message slouží k telemetrii (zařízení-cloud) a příkazům (cloud-zařízení) asynchronního zasílání zpráv mezi zařízením a službou IoT Hub. Je nezávislá na přenosu, což znamená, že funguje stejně přes AMQP, MQTT a HTTP.
Client	Klient zařízení služby IoT Hub používaný k připojení zařízení k centru Azure IoT. Uživatelé sady SDK by měli volat jednu z metod továrny, zconnectionString nebo zesharedAccessSignature vytvořit klienta zařízení IoT Hubu.
DeviceMethodRequest	Představuje data předávaná ze služby do zařízení, když je volána metoda zařízení z cloudu. Instance této třídy se předává zpětnému volání registrovanému prostřednictvím onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse	Uživateli je k dispozici objekt DeviceMethodResponse s každou DeviceMethodRequest který uživateli umožňuje vytvořit a odeslat dobře naformátovanou odpověď zpět do služby pro každé volání metody zařízení. Instance této třídy se předává jako druhý parametr zpětnému volání registrovanému prostřednictvím onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
IotEdgeAuthenticationProvider	Poskytuje AuthenticationProvider implementaci, která deleguje generování tokenů na iotedged. Tato implementace je určená k použití při použití klienta modulu s Azure IoT Edge. Tento typ dědí z SharedAccessKeyAuthenticationProvider a je funkčně identický s tímto typem s výjimkou části generování tokenu, kterou přepíše implementací metody _sign.
ModuleClient	Klient zařízení služby IoT Hub používaný k připojení zařízení k centru Azure IoT. Uživatelé sady SDK by měli volat jednu z metod továrny, zconnectionString nebo zesharedAccessSignature vytvořit klienta zařízení IoT Hubu.
SharedAccessKeyAuthenticationProvider	Poskytuje AuthenticationProvider objekt, který lze vytvořit jednoduše pomocí připojovacího řetězce a pak ho použije klient zařízení a přenáší k ověření v instanci centra Azure IoT. Objekt SharedAccessKeyAuthenticationProvider se postará o vytvoření tokenů sdíleného přístupového podpisu v pravidelných intervalech a vygeneruje newTokenAvailable událost pro přenosy, aby se obnovily přihlašovací údaje pomocí instance služby Azure IoT Hub a zůstali připojení.
SharedAccessSignatureAuthenticationProvider	Poskytuje AuthenticationProvider objekt, který se dá vytvořit jednoduše pomocí sdíleného přístupového podpisu a pak ho použije klient zařízení a přenosy k ověření v instanci služby Azure IoT Hub. Objekt SharedAccessSignatureAuthenticationProvider neprodlouží token sdíleného přístupového podpisu automaticky, takže uživatel musí generovat tokeny sdíleného přístupového podpisu, kterým nevypršela platnost, pomocí metody updateSharedAccessSignature. Pro každé volání této metody SharedAccessSignatureAuthenticationProvider vygeneruje newTokenAvailable událost, která se použije k ověření v instanci služby Azure IoT Hub.
Twin	Dvojče zařízení je dokument popisující stav zařízení, které je uložené centrem Azure IoT, a je k dispozici i v případě, že je zařízení offline. Je postaven kolem 3 částí: Značky: Páry klíč/hodnota jsou přístupné pouze ze strany služby. Požadované vlastnosti: Aktualizováno službou a přijato zařízením Ohlášené vlastnosti: aktualizováno zařízením a přijatou službou. Mějte na paměti, že i když je to možnost, požadované a hlášené vlastnosti nemusí odpovídat a že logika synchronizace těchto dvou kolekcí je v případě potřeby ponechána uživateli sady SDK. Další informace naleznete v tématu Principy dvojčat zařízení.
X509AuthenticationProvider	Poskytuje AuthenticationProvider objekt, který lze vytvořit jednoduše pomocí certifikátu a klíče X509 a pak ho použije klient zařízení a přenáší k ověření v instanci azure IoT Hubu. Na rozdíl od objektů SharedAccessSignatureAuthenticationProvider a SharedAccessKeyAuthenticationProviderX509AuthenticationProvider nevysílají newTokenAvailable událost, protože ověřování X509 neobsahuje žádný token. Přenosy získají přihlašovací údaje pomocí metody getDeviceCredentials.

Rozhraní

AmqpTransportOptions	Možnosti specifické pro přenos AMQP Toto se předá setOptions jako vlastnost s názvem http uvnitř objektu DeviceClientOptions. Vidět
DeviceClientOptions	Možnosti objektu Klient. Předáno do funkce setOptions. příklad var options = { cert: myX509Certificate, key: myX509Key, http: { receivePolicy: { interval: 10 } } } client.setOptions(options, callback);
DeviceTransport
HttpReceiverOptions	Struktura možností použitá ke konfiguraci, jak často příjemce HTTP dotazuje zprávy. Každá z těchto možností se vzájemně vylučují, s výjimkou drain logické hodnoty. Ve struktuře možností se nachází pouze jeden interval, at, cron nebo manualPolling. To je nakonfigurováno voláním setOptions s tímto jako vlastnost s názvem receivePolicy uvnitř HttpTransportOptions objektu, který je uvnitř DeviceClientOptions objektu. Vidět
HttpTransportOptions	Struktura možností pro předávání volitelných parametrů konfigurace do přenosu HTTP Toto se předá setOptions jako vlastnost s názvem http uvnitř objektu DeviceClientOptions. Vidět
MqttTransportOptions	Možnosti specifické pro přenos MQTT Toto se předá setOptions jako vlastnost s názvem mqtt uvnitř objektu DeviceClientOptions.
TwinProperties	Obsahuje požadované a hlášené vlastnosti dvojčete.

Aliasy typu

BufferConvertible

Funkce

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

Podrobnosti funkce

getUserAgentString(NoErrorCallback<string>)

function getUserAgentString(done: NoErrorCallback<string>)

Parametry

done

NoErrorCallback<string>

getUserAgentString()

function getUserAgentString(): Promise<string>

Návraty

Promise<string>

getUserAgentString(string, NoErrorCallback<string>)

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

Parametry

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string)

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

Parametry

productInfo

string

Návraty

Promise<string>