Twin class
Device Twin は、Azure IoT ハブによって格納され、デバイスがオフラインの場合でも使用できるデバイスの状態を説明するドキュメントです。 次の 3 つのセクションを中心に構築されています。
- タグ: サービス側からのみアクセスできるキーと値のペア
- 必要なプロパティ: サービスによって更新され、デバイスによって受信されます
- 報告されるプロパティ: デバイスによって更新され、サービスによって受信されます。
可能性はありますが、必要なプロパティと報告されるプロパティは一致する必要はありません。また、必要に応じて、これら 2 つのコレクションを同期するロジックが SDK のユーザーに委ねられます。
詳細については、「デバイス ツインについて」を参照してください。
特定のデバイスの Twin を取得するには、getTwin(string, HttpResponseCallback<Twin>) メソッドを使用することをお勧めします。
コンストラクター
Twin(string | Device |
新しい Twinをインスタンス化します。 新しい Twin オブジェクトを取得するには、getTwin(string, HttpResponseCallback<Twin>) メソッドを使用することをお勧めします。 |
プロパティ
device |
ツインに関連付けられているデバイス ID の一意識別子 。デバイス ID レジストリに存在します。 |
etag | デバイス ツインの複数の並列エディションを回避するためにオプティミスティック コンカレンシーで使用されるタグ。 |
model |
ツインに関連付けられているデバイス ID のモデル ID 。デバイス ID レジストリに存在します。 |
module |
デバイス ID レジストリに存在するツインに関連付けられているモジュールのモジュール識別子。 |
properties | 必要なプロパティと報告されるプロパティの二項数 (それぞれ |
tags | サービス側でのみ使用でき、クエリで特定のデバイスを検索するために使用できるキーと値のペアのコレクション。 |
メソッド
get() | |
get(Incoming |
IoT Hub サービスからこのデバイス ツインの最新バージョンを取得します。 |
toJSON() | |
update(any) | |
update(any, Incoming |
引数として指定されたパッチでデバイス ツインを更新します。 |
コンストラクターの詳細
Twin(string | DeviceIdentity, Registry)
新しい Twinをインスタンス化します。 新しい Twin オブジェクトを取得するには、getTwin(string, HttpResponseCallback<Twin>) メソッドを使用することをお勧めします。
new Twin(device: string | DeviceIdentity, registryClient: Registry)
パラメーター
- device
-
string | DeviceIdentity
デバイス識別子文字列、またはデバイスを記述するオブジェクト。 オブジェクトの場合は、deviceId プロパティを含む必要があります。
- registryClient
- Registry
REST API 呼び出しの実行に使用される HTTP レジストリ クライアント。
プロパティの詳細
deviceId
ツインに関連付けられているデバイス ID の一意識別子 。デバイス ID レジストリに存在します。
deviceId: string
プロパティ値
string
etag
デバイス ツインの複数の並列エディションを回避するためにオプティミスティック コンカレンシーで使用されるタグ。
etag: string
プロパティ値
string
modelId
ツインに関連付けられているデバイス ID のモデル ID 。デバイス ID レジストリに存在します。
modelId?: string
プロパティ値
string
moduleId
デバイス ID レジストリに存在するツインに関連付けられているモジュールのモジュール識別子。
moduleId?: string
プロパティ値
string
properties
必要なプロパティと報告されるプロパティの二項数 (それぞれ properties.desired
および properties.reported
)。
properties: { desired: {[key: string]: any}, reported: {[key: string]: any} }
プロパティ値
{ desired: {[key: string]: any}, reported: {[key: string]: any} }
tags
サービス側でのみ使用でき、クエリで特定のデバイスを検索するために使用できるキーと値のペアのコレクション。
tags: {[key: string]: string}
プロパティ値
{[key: string]: string}
メソッドの詳細
get()
function get(): Promise<ResultWithIncomingMessage<Twin>>
戻り値
Promise<ResultWithIncomingMessage<Twin>>
get(IncomingMessageCallback<Twin>)
IoT Hub サービスからこのデバイス ツインの最新バージョンを取得します。
function get(done?: IncomingMessageCallback<Twin>)
パラメーター
toJSON()
function toJSON(): object
戻り値
object
update(any)
function update(patch: any): Promise<ResultWithIncomingMessage<Twin>>
パラメーター
- patch
-
any
戻り値
Promise<ResultWithIncomingMessage<Twin>>
update(any, IncomingMessageCallback<Twin>)
引数として指定されたパッチでデバイス ツインを更新します。
function update(patch: any, done?: IncomingMessageCallback<Twin>)
パラメーター
- patch
-
any
このデバイス ツインに適用する新しい値を含むオブジェクト。