azure-iot-device package

Osztályok

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 AuthenticationProvider implementációt biztosít, amely a jogkivonatok létrehozását iotedgededre delegálja. Ezt az implementációt a modulügyfél Azure IoT Edge-lel való használatakor kell használni.

Ez a típus a SharedAccessKeyAuthenticationProvider öröklődik, és funkcionálisan megegyezik az adott típussal, kivéve azt a jogkivonat-létrehozási részt, amelyet felülbírál a _sign metódus implementálásával.
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.
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 AuthenticationProvider objektumot biztosít, amely egyszerűen egy kapcsolati sztringgel hozható létre, amelyet aztán az eszközügyfél használ, és az Azure IoT Hub-példánysal való hitelesítéshez.

A SharedAccessKeyAuthenticationProvider objektum gondoskodik a közös hozzáférésű jogosultságkód-jogkivonatok rendszeres létrehozásáról, és kibocsátja a newTokenAvailable eseményt, hogy az átvitelek megújíthassák hitelesítő adataikat az Azure IoT Hub-példánysal, és kapcsolatban maradjanak.
SharedAccessSignatureAuthenticationProvider

Egy AuthenticationProvider objektumot biztosít, amely egyszerűen egy közös hozzáférésű jogosultságkóddal hozható létre, majd az eszközügyfél használja, és az Azure IoT Hub-példányon történő hitelesítéshez használja.

A SharedAccessSignatureAuthenticationProvider objektum nem újítja meg automatikusan a közös hozzáférésű jogosultságkód-jogkivonatot, ezért a felhasználónak nem lejárt közös hozzáférésű jogosultságkód-jogkivonatokat kell a updateSharedAccessSignature metódussal táplálnia. A metódus minden egyes hívása esetén a SharedAccessSignatureAuthenticationProvider egy newTokenAvailable eseményt bocsát ki, amelyet a rendszer az Azure IoT Hub-példánysal való hitelesítéshez használ.
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:

  • Címkék: kulcs/érték párok csak a szolgáltatásoldalról érhetők el
  • Kívánt tulajdonságok: egy szolgáltatás által frissített és az eszköz által fogadott tulajdonságok
  • Jelentett tulajdonságok: az eszköz frissítette és a szolgáltatás fogadta.

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 AuthenticationProvider objektumot biztosít, amely egyszerűen egy X509-tanúsítvánnyal és kulccsal hozható létre, majd az eszközügyfél használja, és az Azure IoT Hub-példánysal való hitelesítéshez használja.

A SharedAccessSignatureAuthenticationProvider és SharedAccessKeyAuthenticationProvider objektumokkal ellentétben a X509AuthenticationProvider nem bocsát ki newTokenAvailable eseményt, mivel az X509-hitelesítésben nincs token. Az átvitelek a getDeviceCredentials metódus használatával kapják meg a hitelesítő adatokat.

Interfészek

AmqpTransportOptions

Az AMQP-átvitelre vonatkozó beállítások.

Ezt a Client.setOptions nevű tulajdonságként http továbbítják egy DeviceClientOptions objektumon belül.

Lát
DeviceClientOptions

Az ügyfélobjektum beállításai. Átadva a Client.setOptions funkcióba.

példa

 var options = {
   cert: myX509Certificate,
   key: myX509Key,
   http: {
     receivePolicy: {
       interval: 10
     }
   }
 }
 client.setOptions(options, callback);
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 drain logikai értéket. A választási lehetőségek struktúrájában csak egy interval, at, cron vagy manualPolling lehet jelen.

Ezt úgy konfigurálják, hogy hívják a Client.setOptions nevű tulajdonságot, receivePolicy amely egy HttpTransportOptions objektum belsejében található, amely egy DeviceClientOptions objektumon belül van.

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.

Ezt a Client.setOptions nevű tulajdonságként http továbbítják egy DeviceClientOptions objektumon belül.

Lát
MqttTransportOptions

Az MQTT-átvitelre jellemző beállítások

Ezt a Client.setOptions nevű tulajdonságként mqtt továbbítják egy DeviceClientOptions objektumon belül.
TwinProperties

Az ikerpéldány kívánt és jelentett tulajdonságait tartalmazza.

Típusaliasok

BufferConvertible

Függvények

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

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>