Udostępnij za pośrednictwem

Twin class

  • Odwołanie
Pakiet:
azure-iothub

Bliźniaczą reprezentacją urządzenia jest dokument opisujący stan urządzenia przechowywanego przez centrum Azure IoT Hub i jest dostępny nawet wtedy, gdy urządzenie jest w trybie offline. Jest on tworzony w około 3 sekcjach:

  • Tagi: pary klucz/wartość są dostępne tylko po stronie usługi
  • Żądane właściwości: zaktualizowane przez usługę i odebrane przez urządzenie
  • Zgłaszane właściwości: zaktualizowane przez urządzenie i odebrane przez usługę.

Należy pamiętać, że chociaż jest to możliwe, żądane i zgłoszone właściwości nie muszą być zgodne i że logika synchronizacji tych dwóch kolekcji, w razie potrzeby, jest pozostawiona użytkownikowi zestawu SDK.

Aby uzyskać więcej informacji, zobacz Understanding Device Twins (Opis bliźniaczych reprezentacji urządzeń).

Zalecanym sposobem uzyskania Twin dla określonego urządzenia jest użycie getTwin(string, HttpResponseCallback<Twin>) metody .

Konstruktory

Twin(string | DeviceIdentity, Registry)

Tworzy wystąpienie nowego Twinelementu . Zalecanym sposobem uzyskania nowego Twin obiektu jest użycie getTwin(string, HttpResponseCallback<Twin>) metody .

Właściwości

deviceId

Unikatowy identyfikator tożsamości urządzenia skojarzonej z bliźniaczą reprezentacją, ponieważ istnieje w rejestrze tożsamości urządzeń.
etag

Tag używany w optymistycznej współbieżności, aby uniknąć wielu równoległych edycji bliźniaczej reprezentacji urządzenia.
modelId

Identyfikator modelu tożsamości urządzenia skojarzonej z bliźniaczą reprezentacją, ponieważ istnieje w rejestrze tożsamości urządzeń.
moduleId

Identyfikator modułu dla modułu skojarzonego z bliźniaczą reprezentacją, ponieważ istnieje on w rejestrze tożsamości urządzeń.
properties

Żądane i zgłoszone słowniki właściwości (odpowiednio w i properties.desiredproperties.reported).
tags

Kolekcja par klucz/wartość, które są dostępne tylko po stronie usługi i mogą być używane w zapytaniach do znajdowania określonych urządzeń.

Metody

get()
get(IncomingMessageCallback<Twin>)

Pobiera najnowszą wersję tej bliźniaczej reprezentacji urządzenia z usługi IoT Hub.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)

Zaktualizuj bliźniaczą reprezentację urządzenia przy użyciu poprawki podanej jako argument.

Szczegóły konstruktora

Twin(string | DeviceIdentity, Registry)

Tworzy wystąpienie nowego Twinelementu . Zalecanym sposobem uzyskania nowego Twin obiektu jest użycie getTwin(string, HttpResponseCallback<Twin>) metody .

new Twin(device: string | DeviceIdentity, registryClient: Registry)

Parametry

device

string | DeviceIdentity

Ciąg identyfikatora urządzenia lub obiekt opisujący urządzenie. Jeśli obiekt, musi zawierać właściwość deviceId.

registryClient
Registry

Klient rejestru HTTP używany do wykonywania wywołań interfejsu API REST.

Szczegóły właściwości

deviceId

Unikatowy identyfikator tożsamości urządzenia skojarzonej z bliźniaczą reprezentacją, ponieważ istnieje w rejestrze tożsamości urządzeń.

deviceId: string

Wartość właściwości

string

etag

Tag używany w optymistycznej współbieżności, aby uniknąć wielu równoległych edycji bliźniaczej reprezentacji urządzenia.

etag: string

Wartość właściwości

string

modelId

Identyfikator modelu tożsamości urządzenia skojarzonej z bliźniaczą reprezentacją, ponieważ istnieje w rejestrze tożsamości urządzeń.

modelId?: string

Wartość właściwości

string

moduleId

Identyfikator modułu dla modułu skojarzonego z bliźniaczą reprezentacją, ponieważ istnieje on w rejestrze tożsamości urządzeń.

moduleId?: string

Wartość właściwości

string

properties

Żądane i zgłoszone słowniki właściwości (odpowiednio w i properties.desiredproperties.reported).

properties: { desired: {[key: string]: any}, reported: {[key: string]: any} }

Wartość właściwości

{ desired: {[key: string]: any}, reported: {[key: string]: any} }

tags

Kolekcja par klucz/wartość, które są dostępne tylko po stronie usługi i mogą być używane w zapytaniach do znajdowania określonych urządzeń.

tags: {[key: string]: string}

Wartość właściwości

{[key: string]: string}

Szczegóły metody

get() 

function get(): Promise<ResultWithIncomingMessage<Twin>>

Zwraca

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Pobiera najnowszą wersję tej bliźniaczej reprezentacji urządzenia z usługi IoT Hub.

function get(done?: IncomingMessageCallback<Twin>)

Parametry

done

IncomingMessageCallback<Twin>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done element zostanie wywołany z trzema argumentami: obiekt Error (może mieć wartość null), obiekt bliźniaczej reprezentacji reprezentujący utworzoną tożsamość urządzenia oraz obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.

toJSON() 

function toJSON(): object

Zwraca

object

update(any) 

function update(patch: any): Promise<ResultWithIncomingMessage<Twin>>

Parametry

patch

any

Zwraca

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Zaktualizuj bliźniaczą reprezentację urządzenia przy użyciu poprawki podanej jako argument.

function update(patch: any, done?: IncomingMessageCallback<Twin>)

Parametry

patch

any

Obiekt zawierający nowe wartości, które mają być stosowane do tej reprezentacji bliźniaczej urządzenia.

done

IncomingMessageCallback<Twin>

Opcjonalna funkcja wywoływana po zakończeniu operacji. done element zostanie wywołany z trzema argumentami: obiekt Error (może mieć wartość null), obiekt bliźniaczej reprezentacji reprezentujący utworzoną tożsamość urządzenia oraz obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.