Delen via

Device class

  • Referentie
Pakket:
azure-iothub

Waarschuwing

Deze API is nu afgeschaft.

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 symmetricKey eigenschapsnaam (het was pascal-cased in plaats van camel-cased). De SDK houdt deze klasse bij om bestaande code niet te breken, maar deze wordt verwijderd in een toekomstige grote versie-update en klanten moeten in plaats daarvan gewone JSON-objecten gebruiken.

Constructors

Device(any)

Maak een instantie van een nieuw Device object.

Eigenschappen

authentication

Bevat de symmetrische sleutels die worden gebruikt om dit apparaat te verifiëren.
capabilities

Bevat de mogelijkheden van dit apparaat.
cloudToDeviceMessageCount

Aantal c2d-berichten dat wacht op door bezorgd op het apparaat.
connectionState

Of het apparaat is 'verbonden' of 'verbroken'. Het wordt echter niet aanbevolen om deze eigenschap te gebruiken om te bepalen of het apparaat nu daadwerkelijk is verbonden, omdat er mogelijk een time-out is opgetreden voor de apparaatverbinding en de IoT-hub deze mogelijk niet heeft gedetecteerd, of als het apparaat HTTPS gebruikt om verbinding te maken. Als u apparaatverbindingen wilt bewaken, wordt u aanbevolen om de functie voor het bewaken van bewerkingen van uw hub te gebruiken.
connectionStateUpdatedTime

Tijdstempel die de laatste keer connectionState wordt gewijzigd.
deviceId

De unieke apparaat-id zoals deze bestaat in het Apparaatregister van Azure IoT Hub.
etag

Zwakke entiteitstag die is toegewezen aan de beschrijving van deze apparaat-id
generationId

Wordt gebruikt om apparaten die zijn verwijderd of opnieuw gemaakt met dezelfde deviceId
lastActivityTime

Tijdstempel voor de laatste keer dat het apparaat is geverifieerd, een bericht heeft verzonden of een bericht heeft ontvangen.
status

'ingeschakeld' (apparaat geautoriseerd om verbinding te maken, kan berichten verzenden/ontvangen) of 'uitgeschakeld'.
statusReason

Tekenreeks van 128 tekens die wordt ingesteld wanneer het apparaat is uitgeschakeld.
statusUpdatedTime

Tijdstempel die de laatste keer status wordt gewijzigd.

Constructordetails

Device(any)

Maak een instantie van een nieuw Device object.

new Device(jsonData?: any)

Parameters

jsonData

any

Een optionele JSON-weergave van het apparaat, die wordt toegewezen aan eigenschappen in het -object. Als er geen argument wordt opgegeven, worden standaardwaarden toegewezen aan apparaateigenschappen.

Eigenschapdetails

authentication

Bevat de symmetrische sleutels die worden gebruikt om dit apparaat te verifiëren.

authentication?: Authentication

Waarde van eigenschap

Authentication

capabilities

Bevat de mogelijkheden van dit apparaat.

capabilities?: Capabilities

Waarde van eigenschap

Capabilities

cloudToDeviceMessageCount

Aantal c2d-berichten dat wacht op door bezorgd op het apparaat.

cloudToDeviceMessageCount?: string

Waarde van eigenschap

string

connectionState

Of het apparaat is 'verbonden' of 'verbroken'. Het wordt echter niet aanbevolen om deze eigenschap te gebruiken om te bepalen of het apparaat nu daadwerkelijk is verbonden, omdat er mogelijk een time-out is opgetreden voor de apparaatverbinding en de IoT-hub deze mogelijk niet heeft gedetecteerd, of als het apparaat HTTPS gebruikt om verbinding te maken. Als u apparaatverbindingen wilt bewaken, wordt u aanbevolen om de functie voor het bewaken van bewerkingen van uw hub te gebruiken.

connectionState?: ConnectionState

Waarde van eigenschap

ConnectionState

connectionStateUpdatedTime

Tijdstempel die de laatste keer connectionState wordt gewijzigd.

connectionStateUpdatedTime?: string

Waarde van eigenschap

string

deviceId

De unieke apparaat-id zoals deze bestaat in het Apparaatregister van Azure IoT Hub.

deviceId: string

Waarde van eigenschap

string

etag

Zwakke entiteitstag die is toegewezen aan de beschrijving van deze apparaat-id

etag?: string

Waarde van eigenschap

string

generationId

Wordt gebruikt om apparaten die zijn verwijderd of opnieuw gemaakt met dezelfde deviceId

generationId?: string

Waarde van eigenschap

string

lastActivityTime

Tijdstempel voor de laatste keer dat het apparaat is geverifieerd, een bericht heeft verzonden of een bericht heeft ontvangen.

lastActivityTime?: string

Waarde van eigenschap

string

status

'ingeschakeld' (apparaat geautoriseerd om verbinding te maken, kan berichten verzenden/ontvangen) of 'uitgeschakeld'.

status?: DeviceStatus

Waarde van eigenschap

DeviceStatus

statusReason

Tekenreeks van 128 tekens die wordt ingesteld wanneer het apparaat is uitgeschakeld.

statusReason?: string

Waarde van eigenschap

string

statusUpdatedTime

Tijdstempel die de laatste keer status wordt gewijzigd.

statusUpdatedTime?: string

Waarde van eigenschap

string