Sdílet prostřednictvím

azure-iot-device package

  • Reference

Třídy

Message

Objekt se Message používá pro telemetrii (zařízení-cloud) a příkazy (cloud-zařízení) a asynchronní 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ým způsobem jako AMQP, MQTT a HTTP.
Client

IoT Hub klienta zařízení použitého k připojení zařízení k centru Azure IoT.

Uživatelé sady SDK by měli zavolat jednu z metod z výroby zConnectionString nebo zSharedAccessSignature, aby vytvořili klienta IoT Hub zařízení.
DeviceMethodRequest

Představuje data předaná ze služby do zařízení při zavolání metody zařízení z cloudu. Instance této třídy je předána zpětnému volání registrovanému prostřednictvím onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
DeviceMethodResponse

DeviceMethodResponse uživateli je poskytován objekt, přičemž každý z nich DeviceMethodRequest umožňuje uživateli vytvořit a odeslat dobře formátovanou odpověď zpět službě pro každé volání metody zařízení. Instance této třídy je předána jako druhý parametr zpětnému volání registrovanému prostřednictvím onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
IotEdgeAuthenticationProvider

AuthenticationProvider Poskytuje implementaci, která deleguje generování tokenů na iotedged. Tato implementace se používá 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í _sign metody .
ModuleClient

IoT Hub klienta zařízení použitého k připojení zařízení k centru Azure IoT.

Uživatelé sady SDK by měli zavolat jednu z metod z výroby zConnectionString nebo zSharedAccessSignature, aby vytvořili klienta IoT Hub zařízení.
SharedAccessKeyAuthenticationProvider

AuthenticationProvider Poskytuje objekt, který se dá vytvořit jednoduše pomocí připojovacího řetězce a pak ho použije klient zařízení a přenosy k ověření v instanci služby Azure IoT Hub.

Objekt SharedAccessKeyAuthenticationProvider se pravidelně stará o vytváření tokenů sdíleného přístupového podpisu a generuje událost pro přenosy, aby obnovily své přihlašovací údaje pomocí instance služby Azure IoT Hub a zůstaly newTokenAvailable připojené.
SharedAccessSignatureAuthenticationProvider

AuthenticationProvider Poskytuje objekt, který se dá vytvořit jednoduše se sdíleným přístupovým podpisem a který pak použije klient zařízení a přenosy k ověření v instanci služby Azure IoT Hub.

Objekt SharedAccessSignatureAuthenticationProvider token sdíleného přístupového podpisu neobnovuje automaticky, takže uživatel do něj updateSharedAccessSignature musí pomocí metody předá tokeny sdíleného přístupového podpisu, které nevypršela platnost. Při každém volání této metody vygeneruje newTokenAvailable událost, SharedAccessSignatureAuthenticationProvider kterou transporty použijí 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é ve službě Azure IoT Hub a je dostupné, i když je zařízení offline. Je postaven kolem 3 sekcí:

  • Značky: Páry klíč-hodnota přístupné pouze ze strany služby
  • Požadované vlastnosti: aktualizovány službou a přijaty zařízením
  • Ohlášené vlastnosti: Aktualizováno zařízením a přijímá je služba.

Mějte na paměti, že i když je to možné, požadované a hlášené vlastnosti se nemusí shodovat a že logika synchronizace těchto dvou kolekcí je v případě potřeby ponechána na uživateli sady SDK.

Další informace najdete v tématu Principy dvojčat zařízení.
X509AuthenticationProvider

AuthenticationProvider Poskytuje objekt, který lze vytvořit jednoduše pomocí certifikátu a klíče X509 a který pak použije klient zařízení a přenosy k ověření v instanci služby Azure IoT Hub.

SharedAccessSignatureAuthenticationProvider Na rozdíl od objektů a SharedAccessKeyAuthenticationProvider negeneruje newTokenAvailable objekt událost, X509AuthenticationProvider protože ověřování X509 neobsahuje žádný token. Přenosy získají přihlašovací údaje pomocí getDeviceCredentials metody .

Rozhraní

AmqpTransportOptions

Možnosti specifické pro přenos AMQP.

To se předává do setOptions jako vlastnost s názvem http uvnitř objektu DeviceClientOptions .

Seznamte se s 
DeviceClientOptions

Možnosti pro objekt Client. 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žívaná ke konfiguraci, jak často se příjemce HTTP dotazuje na zprávy. Každá z těchto možností se vzájemně vylučuje, s výjimkou logické hodnoty drain . Ve struktuře možností musí být pouze jeden intervalat, cron nebo manualPolling .

To se konfiguruje voláním setOptions s touto vlastností s názvem receivePolicy uvnitř objektu HttpTransportOptions , který je uvnitř objektu DeviceClientOptions .

Seznamte se s 
HttpTransportOptions

Struktura možností pro předávání volitelných konfiguračních parametrů do přenosu HTTP.

To se předává do setOptions jako vlastnost s názvem http uvnitř objektu DeviceClientOptions .

Seznamte se s 
MqttTransportOptions

Možnosti specifické pro přenos MQTT

To se předává do 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>