Sdílet prostřednictvím

DigitalTwinClient class

  • Reference
Balíček:
azure-iothub

Konstruktory

DigitalTwinClient(IoTHubTokenCredentials)

Konstruktor, který také vytvoří instanci klienta vrstvy protokolu používaného DigitalTwinClient.

Metody

getDigitalTwin(string)

Načtěte digitální dvojče daného zařízení.
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Vyvolání příkazu na komponentě konkrétního zařízení a získání jeho výsledku
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

Vyvolání příkazu na komponentě konkrétního zařízení a získání jeho výsledku
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)

Aktualizujte digital Twin daného zařízení pomocí objektu opravy.

Podrobnosti konstruktoru

DigitalTwinClient(IoTHubTokenCredentials)

Konstruktor, který také vytvoří instanci klienta vrstvy protokolu používaného DigitalTwinClient.

new DigitalTwinClient(creds: IoTHubTokenCredentials)

Parametry

creds
IoTHubTokenCredentials

Přihlašovací údaje tokenu IoTHubu použité k vytvoření klienta vrstvy protokolu

Podrobnosti metody

getDigitalTwin(string)

Načtěte digitální dvojče daného zařízení.

function getDigitalTwin(digitalTwinId: string): Promise<DigitalTwinResponse>

Parametry

digitalTwinId

string

ID digitálního dvojčete daného zařízení nebo modulu. Formát digitalTwinId je DeviceId[~ModuleId]. ModuleId je volitelné.

Návraty

Promise<DigitalTwinResponse>

DigitalTwinResponse Návratový objekt obsahující Digital Twin plus HttpResponse.

getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>) 

function getDigitalTwin(digitalTwinId: string, callback: TripleValueCallback<DigitalTwin, HttpOperationResponse>)

Parametry

digitalTwinId

string

callback

TripleValueCallback<DigitalTwin, HttpOperationResponse>

invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Vyvolání příkazu na komponentě konkrétního zařízení a získání jeho výsledku

function invokeCommand(digitalTwinId: string, commandName: string, argument: any, options?: DigitalTwinInvokeRootLevelCommandOptionalParams): Promise<DigitalTwinInvokeRootLevelCommandResponse>

Parametry

digitalTwinId

string

ID digitálního dvojčete daného zařízení.

commandName

string

argument

any

Argument příkazu.

options

DigitalTwinInvokeRootLevelCommandOptionalParams

Volitelný parametr pro nastavení možností, včetně connectionTimeoutInSeconds a responseTimeoutInSeconds. Hodnota responseTimeoutInSeconds musí být v rozsahu [5; 300].

Návraty

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse Výsledek vyvolaného příkazu, který obsahuje výsledek, stavový kód, ID požadavku a parsovanou hodnotu HttpResponse.

invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

Vyvolání příkazu na komponentě konkrétního zařízení a získání jeho výsledku

function invokeComponentCommand(digitalTwinId: string, componentName: string, commandName: string, argument: any, options?: DigitalTwinInvokeComponentCommandOptionalParams): Promise<DigitalTwinInvokeComponentCommandResponse>

Parametry

digitalTwinId

string

ID digitálního dvojčete daného zařízení.

componentName

string

Název komponenty.

commandName

string

Název příkazu.

argument

any

Argument příkazu.

options

DigitalTwinInvokeComponentCommandOptionalParams

Volitelný parametr pro nastavení možností, včetně connectionTimeoutInSeconds a responseTimeoutInSeconds. Hodnota responseTimeoutInSeconds musí být v rozsahu [5; 300].

Návraty

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse Výsledek vyvolaného příkazu obsahující výsledek, stavový kód, ID požadavku a parsovanou hodnotu HttpResponse.

updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>) 

function updateDigitalTwin(digitalTwinId: string, patch: any[], eTagOrCallback?: string | TripleValueCallback<void, HttpOperationResponse>, callback?: TripleValueCallback<void, HttpOperationResponse>)

Parametry

digitalTwinId

string

patch

any[]

eTagOrCallback

string | TripleValueCallback<void, HttpOperationResponse>

callback

TripleValueCallback<void, HttpOperationResponse>

updateDigitalTwin(string, any[], string)

Aktualizujte digital Twin daného zařízení pomocí objektu opravy.

function updateDigitalTwin(digitalTwinId: string, patch: any[], eTag?: string): Promise<DigitalTwinUpdateResponse>

Parametry

digitalTwinId

string

ID digitálního dvojčete daného zařízení.

patch

any[]

Oprava objet obsahuje aktualizační část digitálního dvojčete.

eTag

string

Značka eTag pro identifikaci opravy.

Návraty

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse The HTTPesponse.