azure-iothub package
Klassen
Client |
De IoT Hub-serviceclient wordt gebruikt om te communiceren met apparaten via een Azure IoT-hub. Hiermee kan de SDK-gebruiker het volgende doen:
Gebruikers moeten nieuwe Client exemplaren maken door een van de factorymethoden aan te roepen, fromConnectionString of fromSharedAccessSignature, om een IoT Hub-serviceclient te maken. |
Device |
Hiermee maakt u een weergave van een apparaat voor gebruik met de register-API's voor apparaat-id's . Deze klasse is afgeschaft omdat het register voor apparaat-id's rechtstreeks kan werken met JSON-objecten die een gedeeltelijke beschrijving van het apparaat bevatten, niet noodzakelijkerwijs het volledige object. Bovendien werd deze klasse in eerste instantie geleverd met een typfout op de |
JobClient |
Biedt methoden voor het maken, bijwerken, bewaken en annuleren van langlopende taken op een IoT Hub exemplaar, evenals het uitvoeren van query's op bestaande taken. Met de Taken-API in Azure IoT Hub kunt u directe methode-aanroepen en dubbelupdates plannen op meerdere apparaten. VAN SDK-gebruikers wordt verwacht dat ze exemplaren maken JobClient met behulp van de factory-methoden fromConnectionString(string) en fromSharedAccessSignature(string). |
Registry |
De klasse Registry biedt toegang tot de IoT Hub apparaat-id-service. Gebruikers van de SDK moeten deze klasse instantiëren met een van de factorymethoden: fromConnectionString of fromSharedAccessSignature. Het protocol dat wordt gebruikt voor registerbewerkingen voor apparaat-id's is HTTPS. |
Amqp |
Transportklasse die door de serviceclient wordt gebruikt om verbinding te maken met de Azure IoT-hub met behulp van het AMQP-protocol via een beveiligde (TLS)-socket. Deze klasse moet niet rechtstreeks worden gebruikt en in plaats daarvan worden doorgegeven aan een van de Client factory-methoden: fromConnectionString of fromSharedAccessSignature. |
AmqpWs |
Transportklasse die door de serviceclient wordt gebruikt om verbinding te maken met de Azure IoT-hub met behulp van het AMQP-protocol via beveiligde websockets. Deze klasse moet niet rechtstreeks worden gebruikt en in plaats daarvan worden doorgegeven aan een van de Client factory-methoden: fromConnectionString of fromSharedAccessSignature. |
DigitalTwinClient | |
IoTHubTokenCredentials |
Hiermee maakt u handtekeningen voor gedeelde toegang op basis van de connection string doorgegeven aan de constructor. Deze klasse wordt gebruikt door de protocollaag van de SDK om verificatieheaders toe te voegen aan elke aanvraag. |
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. De aanbevolen manier om een Twin voor een specifiek apparaat te verkrijgen, is door de getTwin(string, HttpResponseCallback<Twin>) methode te gebruiken. |
Interfaces
ServiceReceiver | |
Transport | |
TransportConfigOptions | |
Authentication | |
Capabilities | |
X509Thumbprints | |
BulkRegistryOperationResult | |
DeviceDescription | |
DeviceRegistryOperationError | |
JobStatus | |
QueryDescription | |
RegistryStatistics | |
TransportConfig | |
Configuration |
Het object Configuration vertegenwoordigt de configuratie van één apparaat of het kan een implementatie vertegenwoordigen die kan worden toegepast als een configuratie op apparaten op basis van de targetCondition. |
ConfigurationContent | |
ConfigurationMetrics | |
DeviceMethodParams |
Beschrijft de parameters die beschikbaar zijn voor gebruik met directe methoden (ook wel apparaatmethoden genoemd) |
Module |
Type-aliassen
TransportCtor | |
ConnectionState | |
DeviceStatus | |
JobCallback | |
BulkRegistryOperationType | |
JobCallback | |
ResponseCallback |