azure-iot-device package
Osztályok
Message |
A Message objektum telemetriára (eszközről felhőre) és parancsokra (felhőről eszközre) használható aszinkron üzenetküldésre az eszköz és az IoT Hub szolgáltatás között. Ez transport-agnostic, vagyis ugyanúgy működik az AMQP, az MQTT és a HTTP felett. |
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 vagy a fromSharedAccessSignature egy IoT Hub-eszközügyfél létrehozásához. |
DeviceMethodRequest |
A szolgáltatásból az eszközre továbbított adatokat jelöli, amikor a rendszer meghív egy eszközmetódust a felhőből. Az osztály egy példányát a rendszer a onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)keresztül regisztrált visszahívásnak továbbítja. |
DeviceMethodResponse |
a DeviceMethodResponse objektum minden egyes DeviceMethodRequest lehetővé teszi, hogy a felhasználó megfelelően formázott választ hozzon létre és küldjön vissza a szolgáltatásnak minden egyes eszközmetódus-híváshoz. Az osztály egy példánya a második paraméterként lesz átadva a onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)keresztül regisztrált visszahívásnak. |
IotEdgeAuthenticationProvider |
Egy Ez a típus a |
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 vagy a fromSharedAccessSignature egy IoT Hub-eszközügyfél létrehozásához. |
SharedAccessKeyAuthenticationProvider |
Egy A |
SharedAccessSignatureAuthenticationProvider |
Egy A |
Twin |
Az ikereszköz egy Azure IoT Hub által tárolt eszköz állapotát leíró dokumentum, amely akkor is elérhető, ha az eszköz offline állapotban van. 3 részből áll:
Vegye figyelembe, hogy bár lehetséges, a kívánt és a jelentett tulajdonságoknak nem kell egyezniük, és hogy a két gyűjtemény szinkronizálásának logikája, ha szükséges, az SDK felhasználójára marad. További információ: Device Twinsismertetése. |
X509AuthenticationProvider |
Egy A |
Interfészek
AmqpTransportOptions |
Az AMQP-átvitelre vonatkozó beállítások. Ez setOptionsDeviceClientOptions objektumon belül Lát |
DeviceClientOptions |
Az ügyfélobjektum beállításai. A setOptions függvény. példa
|
DeviceTransport | |
HttpReceiverOptions |
Az üzenetek HTTP-fogadójának lekérdezési gyakoriságának konfigurálásához használt beállítási struktúra.
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 setOptions egy HttpTransportOptions objektumon belül Lát |
HttpTransportOptions |
Az opcionális konfigurációs paraméterek http-átvitelbe való továbbításának beállítási struktúrája. Ez setOptionsDeviceClientOptions objektumon belül Lát |
MqttTransportOptions |
Az MQTT-átvitelre jellemző beállítások Ez setOptionsDeviceClientOptions objektumon belül |
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>