azure-iot-device package

  • Referencia

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

Ez a típus örökli a típust SharedAccessKeyAuthenticationProvider , é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.
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 AuthenticationProvider biztosít, amely egyszerűen létrehozható egy kapcsolati sztring, amelyet aztán az eszközügyfél használ, és az Azure IoT Hub-példánnyal való hitelesítéshez átvitelt biztosít.

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

Olyan objektumot AuthenticationProvider biztosít, amely egyszerűen létrehozható egy közös hozzáférésű jogosultságkóddal, amelyet aztán az eszközügyfél használ, és az Azure IoT Hub-példánnyal való hitelesítéshez végzi a hitelesítést.

Az 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 a metódussal updateSharedAccessSignature be kell írnia a nem lejárt közös hozzáférésű jogosultságkód-jogkivonatokat. A metódus minden hívásához a SharedAccessSignatureAuthenticationProvider rendszer egy eseményt newTokenAvailable bocsát ki, amelyet az átvitel az Azure IoT Hub-példánnyal való hitelesítéshez használ.
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:

  • Címkék: a 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ítve, és az eszköz fogadja
  • 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 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 AuthenticationProvider biztosít, amely egyszerűen létrehozható egy X509-tanúsítvánnyal és kulccsal, majd az eszközügyfél és az átvitelek használatával hitelesíthető az Azure IoT Hub-példánnyal.

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

Interfészek

AmqpTransportOptions

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

Ezt a rendszer a DeviceClientOptions objektumon belül elnevezett http tulajdonságként adja át a setOptionsnak .

Lásd:
DeviceClientOptions

Az Ügyfél objektum beállításai. Átadva a setOptions függvénynek .

Példa

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

Ez úgy van konfigurálva, hogy meghívja a setOptions metódust egy, a DeviceClientOptions objektumon belül található HttpTransportOptions objektumban elnevezett receivePolicy tulajdonságként.

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 http tulajdonságként adja át a setOptionsnak .

Lásd:
MqttTransportOptions

Az MQTT-átvitelre vonatkozó beállítások

Ezt a rendszer a DeviceClientOptions objektumon belül elnevezett mqtt tulajdonságként adja át a setOptionsnak .
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>