azure-iot-device package
Osztályok
Message |
Az Message objektumot telemetria (eszközről felhőre) és parancsok (felhőből eszközre) aszinkron üzenetküldéshez használják az eszköz és a IoT Hub szolgáltatás között. Ez transport-agnostic, ami azt jelenti, hogy ugyanúgy működik amqp, MQTT és HTTP. |
Client |
IoT Hub eszközügyfél, amellyel egy eszközt csatlakoztathat egy Azure IoT Hubhoz. Az SDK felhasználóinak meg kell hívniuk az egyik gyári metódust aConnectionString vagya FromSharedAccessSignature metódusból egy IoT Hub eszközügyfél létrehozásához. |
DeviceMethodRequest |
A szolgáltatásból az eszközre küldött adatokat jelöli, amikor a felhőből meghívnak egy eszközmetódust. Ennek az osztálynak egy példánya a használatával onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)regisztrált visszahívásnak lesz átadva. |
DeviceMethodResponse |
a rendszer egy DeviceMethodResponse objektumot biztosít a felhasználónak, DeviceMethodRequest amely lehetővé teszi a felhasználó számára, hogy jól formázott választ hozzon létre és küldjön vissza a szolgáltatásnak minden egyes eszközmetódus-híváshoz. A osztály egy példánya a második paraméterként lesz átadva a használatával onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)regisztrált visszahívásnak. |
IotEdgeAuthenticationProvider |
Olyan implementációt Ez a típus örökli a típust |
ModuleClient |
IoT Hub eszközügyfél, amellyel egy eszközt csatlakoztathat egy Azure IoT Hubhoz. Az SDK felhasználóinak meg kell hívniuk az egyik gyári metódust aConnectionString vagya FromSharedAccessSignature metódusból egy IoT Hub eszközügyfél létrehozásához. |
SharedAccessKeyAuthenticationProvider |
Olyan objektumot Az |
SharedAccessSignatureAuthenticationProvider |
Olyan objektumot Az |
Twin |
Az ikereszközök olyan dokumentumok, amelyek egy Azure IoT Hub által tárolt eszköz állapotát írják le, és akkor is elérhetők, ha az eszköz offline állapotban van. 3 szakasz köré épül:
Vegye figyelembe, hogy bár lehetséges, a kívánt és jelentett tulajdonságoknak nem kell egyezniük, és hogy a két gyűjtemény szinkronizálásának logikája szükség esetén az SDK felhasználójára marad. További információ: Az ikereszközök ismertetése. |
X509AuthenticationProvider |
Olyan objektumot A és az |
Interfészek
AmqpTransportOptions |
Az AMQP-átvitelre vonatkozó beállítások. Ezt a rendszer a DeviceClientOptions objektumon belül elnevezett Lásd: |
DeviceClientOptions |
Az Ügyfél objektum beállításai. Átadva a setOptions függvénynek . Példa
|
DeviceTransport | |
HttpReceiverOptions |
A beállítási struktúra annak konfigurálására szolgál, hogy a HTTP-fogadó milyen gyakran kérdez le üzeneteket.
Ezek a lehetőségek kölcsönösen kizárják egymást, kivéve a Ez úgy van konfigurálva, hogy meghívja a setOptions metódust egy, a DeviceClientOptions objektumon belül található HttpTransportOptions objektumban elnevezett Lásd: |
HttpTransportOptions |
A választható konfigurációs paraméterek HTTP-átvitelbe való átadásának beállítási struktúrája. Ezt a rendszer a DeviceClientOptions objektumon belül elnevezett Lásd: |
MqttTransportOptions |
Az MQTT-átvitelre vonatkozó beállítások Ezt a rendszer a DeviceClientOptions objektumon belül elnevezett |
TwinProperties |
Az ikerpéldány kívánt és jelentett tulajdonságait tartalmazza. |
Típusaliasok
BufferConvertible |
Függvények
get |
|
get |
|
get |
|
get |
Függvény adatai
getUserAgentString(NoErrorCallback<string>)
function getUserAgentString(done: NoErrorCallback<string>)
Paraméterek
- done
-
NoErrorCallback<string>
getUserAgentString()
function getUserAgentString(): Promise<string>
Válaszok
Promise<string>
getUserAgentString(string, NoErrorCallback<string>)
function getUserAgentString(productInfo: string, done: NoErrorCallback<string>)
Paraméterek
- productInfo
-
string
- done
-
NoErrorCallback<string>
getUserAgentString(string)
function getUserAgentString(productInfo: string): Promise<string>
Paraméterek
- productInfo
-
string
Válaszok
Promise<string>