azure-iot-device package
Klassen
Message |
Het Message object wordt gebruikt voor telemetrie (apparaat-naar-cloud) en opdrachten (cloud-naar-apparaat) asynchrone berichten tussen het apparaat en de IoT Hub-service. Het is transportagnostisch, wat betekent dat het op dezelfde manier werkt via AMQP, MQTT en HTTP. |
Client |
IoT Hub apparaatclient die wordt gebruikt om een apparaat te verbinden met een Azure IoT-hub. Gebruikers van de SDK moeten een van de factorymethoden aanroepen, fromConnectionString of fromSharedAccessSignature om een IoT Hub-apparaatclient te maken. |
DeviceMethodRequest |
Vertegenwoordigt de gegevens die worden doorgegeven van de service aan het apparaat wanneer een apparaatmethode wordt aangeroepen vanuit de cloud. Een exemplaar van deze klasse wordt doorgegeven aan de callback die is geregistreerd via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void). |
DeviceMethodResponse |
een DeviceMethodResponse -object wordt aan de gebruiker verstrekt met elke DeviceMethodRequest mogelijkheid om een goed opgemaakt antwoord te maken en terug te sturen naar de service voor elke apparaatmethodeaanroep. Een exemplaar van deze klasse wordt als de tweede parameter doorgegeven aan de callback die is geregistreerd via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void). |
IotEdgeAuthenticationProvider |
Biedt een Dit type neemt het over van |
ModuleClient |
IoT Hub apparaatclient die wordt gebruikt om een apparaat te verbinden met een Azure IoT-hub. Gebruikers van de SDK moeten een van de factorymethoden aanroepen, fromConnectionString of fromSharedAccessSignature om een IoT Hub-apparaatclient te maken. |
SharedAccessKeyAuthenticationProvider |
Biedt een Het |
SharedAccessSignatureAuthenticationProvider |
Biedt een Het |
Twin |
Een apparaatdubbel is een document waarin de status wordt beschreven van een apparaat dat is opgeslagen door een Azure IoT-hub en beschikbaar is, zelfs als het apparaat offline is. Het is gebouwd rond 3 secties:
Hoewel dit een mogelijkheid is, hoeven de gewenste en gerapporteerde eigenschappen niet overeen te komen en dat de logica voor het synchroniseren van deze twee verzamelingen, indien nodig, wordt overgelaten aan de gebruiker van de SDK. Zie Understanding Device Twins (Apparaatdubbels begrijpen) voor meer informatie. |
X509AuthenticationProvider |
Biedt een In tegenstelling tot de |
Interfaces
AmqpTransportOptions |
Opties die specifiek zijn voor het AMQP-transport. Dit wordt doorgegeven aan setOptions als een eigenschap met de naam Raadpleeg |
DeviceClientOptions |
Opties voor het clientobject. Doorgegeven aan de functie setOptions . Voorbeeld
|
DeviceTransport | |
HttpReceiverOptions |
De structuur van opties die wordt gebruikt om te configureren hoe vaak de HTTP-ontvanger berichten peilt.
Elk van deze opties sluiten elkaar uit, met uitzondering van de Dit wordt geconfigureerd door setOptions aan te roepen met deze eigenschap met de naam Raadpleeg |
HttpTransportOptions |
Optiesstructuur voor het doorgeven van optionele configuratieparameters aan http-transport. Dit wordt doorgegeven aan setOptions als een eigenschap met de naam Raadpleeg |
MqttTransportOptions |
Opties die specifiek zijn voor het MQTT-transport Dit wordt doorgegeven aan setOptions als een eigenschap met de naam |
TwinProperties |
Bevat de gewenste en gerapporteerde eigenschappen voor de dubbel. |
Type-aliassen
BufferConvertible |
Functies
get |
|
get |
|
get |
|
get |
Functiedetails
getUserAgentString(NoErrorCallback<string>)
function getUserAgentString(done: NoErrorCallback<string>)
Parameters
- done
-
NoErrorCallback<string>
getUserAgentString()
function getUserAgentString(): Promise<string>
Retouren
Promise<string>
getUserAgentString(string, NoErrorCallback<string>)
function getUserAgentString(productInfo: string, done: NoErrorCallback<string>)
Parameters
- productInfo
-
string
- done
-
NoErrorCallback<string>
getUserAgentString(string)
function getUserAgentString(productInfo: string): Promise<string>
Parameters
- productInfo
-
string
Retouren
Promise<string>