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 transportneutraal, 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 factory-methoden aanroepen, fromConnectionString of fromSharedAccessSignature om een IoT Hub-apparaatclient te maken. |
DeviceMethodRequest |
Vertegenwoordigt de gegevens die van de service naar het apparaat worden doorgegeven wanneer een apparaatmethode vanuit de cloud wordt aangeroepen. Een exemplaar van deze klasse wordt via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)doorgegeven aan de callback die is geregistreerd. |
DeviceMethodResponse |
een DeviceMethodResponse-object wordt aan de gebruiker verstrekt met elke DeviceMethodRequest waarmee de gebruiker een goed opgemaakt antwoord naar de service kan maken en verzenden voor elke aanroep van de apparaatmethode. Een exemplaar van deze klasse wordt doorgegeven als de tweede parameter aan de callback geregistreerd via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void). |
IotEdgeAuthenticationProvider |
Biedt een Dit type neemt 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 factory-methoden 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 met een beschrijving van de status 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:
Houd er rekening mee dat hoewel het een mogelijkheid is dat gewenste en gerapporteerde eigenschappen niet overeenkomen en dat de logica voor het synchroniseren van deze twee verzamelingen, indien nodig, overblijft aan de gebruiker van de SDK. Zie Understanding Device Twinsvoor 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 Zien |
DeviceClientOptions |
Opties voor het clientobject. Doorgegeven aan de functie setOptions. voorbeeld van
|
DeviceTransport | |
HttpReceiverOptions |
Optiesstructuur die wordt gebruikt om te configureren hoe vaak de HTTP-ontvanger pollt voor berichten.
Elk van deze opties is wederzijds exclusief, met uitzondering van de Dit wordt geconfigureerd door setOptions- aan te roepen als een eigenschap met de naam Zien |
HttpTransportOptions |
Optiesstructuur voor het doorgeven van optionele configuratieparameters aan http-transport. Dit wordt doorgegeven aan setOptions- als een eigenschap met de naam Zien |
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 tweeling. |
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>