Twin class

  • Reference
Balíček:
azure-iothub

Dvojče zařízení je dokument popisující stav zařízení, které je uložené ve službě Azure IoT Hub a je k dispozici, i když je zařízení offline. Je postaven na 3 sekcích:

  • Značky: Páry klíč/hodnota přístupné pouze ze strany služby
  • Požadované vlastnosti: aktualizovány službou a přijaty zařízením
  • Hlášené vlastnosti: aktualizováno zařízením a přijato službou.

Všimněte si, že i když se jedná o možnost, požadované a hlášené vlastnosti se nemusí shodovat a že logika synchronizace těchto dvou kolekcí je v případě potřeby ponechána uživateli sady SDK.

Další informace najdete v tématu Principy dvojčat zařízení.

Doporučeným způsobem, jak získat Twin pro konkrétní zařízení, je použít metodu getTwin(string, HttpResponseCallback<Twin>) .

Konstruktory

Twin(string | DeviceIdentity, Registry)

Vytvoří instanci nového Twinobjektu . Doporučeným způsobem, jak získat nový Twin objekt, je použít metodu getTwin(string, HttpResponseCallback<Twin>) .

Vlastnosti

deviceId

Jedinečný identifikátor identity zařízení přidružené k dvojčeti, protože existuje v registru identit zařízení.
etag

Značka použitá v optimistické souběžnosti, aby se zabránilo více paralelním edicí dvojčete zařízení.
modelId

ID modelu identity zařízení přidružené k dvojčeti, protože existuje v registru identit zařízení.
moduleId

Identifikátor modulu přidruženého k dvojčeti, protože existuje v registru identit zařízení.
properties

Slovníky požadovaných a hlášených vlastností (v properties.desiredproperties.reporteda ).
tags

Kolekce párů klíč/hodnota, která je dostupná jenom na straně služby a dá se použít v dotazech k vyhledání konkrétních zařízení.

Metody

get()
get(IncomingMessageCallback<Twin>)

Získá nejnovější verzi tohoto dvojčete zařízení ze služby IoT Hub.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)

Aktualizujte dvojče zařízení pomocí opravy poskytnuté jako argument.

Podrobnosti konstruktoru

Twin(string | DeviceIdentity, Registry)

Vytvoří instanci nového Twinobjektu . Doporučeným způsobem, jak získat nový Twin objekt, je použít metodu getTwin(string, HttpResponseCallback<Twin>) .

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

Parametry

device

string | DeviceIdentity

Řetězec identifikátoru zařízení nebo objekt popisující zařízení. Pokud objekt, musí obsahovat vlastnost deviceId.

registryClient
Registry

Klient registru HTTP, který slouží ke spouštění volání rozhraní REST API.

Podrobnosti vlastnosti

deviceId

Jedinečný identifikátor identity zařízení přidružené k dvojčeti, protože existuje v registru identit zařízení.

deviceId: string

Hodnota vlastnosti

string

etag

Značka použitá v optimistické souběžnosti, aby se zabránilo více paralelním edicí dvojčete zařízení.

etag: string

Hodnota vlastnosti

string

modelId

ID modelu identity zařízení přidružené k dvojčeti, protože existuje v registru identit zařízení.

modelId?: string

Hodnota vlastnosti

string

moduleId

Identifikátor modulu přidruženého k dvojčeti, protože existuje v registru identit zařízení.

moduleId?: string

Hodnota vlastnosti

string

properties

Slovníky požadovaných a hlášených vlastností (v properties.desiredproperties.reporteda ).

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

Hodnota vlastnosti

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

tags

Kolekce párů klíč/hodnota, která je dostupná jenom na straně služby a dá se použít v dotazech k vyhledání konkrétních zařízení.

tags: {[key: string]: string}

Hodnota vlastnosti

{[key: string]: string}

Podrobnosti metody

get() 

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

Návraty

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Získá nejnovější verzi tohoto dvojčete zařízení ze služby IoT Hub.

function get(done?: IncomingMessageCallback<Twin>)

Parametry

done

IncomingMessageCallback<Twin>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), objekt twin představující vytvořenou identitu zařízení a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.

toJSON() 

function toJSON(): object

Návraty

object

update(any) 

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

Parametry

patch

any

Návraty

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Aktualizujte dvojče zařízení pomocí opravy poskytnuté jako argument.

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

Parametry

patch

any

Objekt obsahující nové hodnoty, které se mají použít pro toto dvojče zařízení.

done

IncomingMessageCallback<Twin>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), objekt twin představující vytvořenou identitu zařízení a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.