nl::Weave::Profiles::DeviceDescription

この名前空間には、Weave デバイス説明プロファイルの Weave 内のすべてのインターフェースが含まれます。

概要

列挙型
`@177`	enum
`@178`	enum Device Description Profile のメッセージタイプ。
@179{ kTag_WeaveDeviceDescriptor = 1, kTag_VendorId = 0, kTag_ProductId = 1, kTag_ProductRevision = 2, kTag_ManufacturingDate = 3, kTag_SerialNumber = 4, kTag_Primary802154MACAddress = 5, kTag_PrimaryWiFiMACAddress = 6, kTag_RendezvousWiFiESSID = 7, kTag_PairingCode = 8, kTag_SoftwareVersion = 9, kTag_DeviceId = 10, kTag_FabricId = 11, kTag_PairingCompatibilityVersionMajor = 12, kTag_PairingCompatibilityVersionMinor = 13, kTag_RendezvousWiFiESSIDSuffix = 14, kTag_DeviceFeature_HomeAlarmLinkCapable = 100, kTag_DeviceFeature_LinePowered = 101 }	enum デバイス説明プロファイルのデータ要素タグ
`TargetDeviceModes{ kTargetDeviceMode_Any = 0x00000000, kTargetDeviceMode_UserSelectedMode = 0x00000001 }`	enum 現在のモードに基づいて LocationsRequest メッセージに応答する必要があるデバイスを識別するビットフィールド（最大 32 ビット）。
`TargetFabricIds{ kTargetFabricId_NotInFabric = kFabricIdNotSpecified, kTargetFabricId_AnyFabric = kReservedFabricIdStart, kTargetFabricId_Any = kMaxFabricId }`	enum 特別なターゲットファブリック ID。

関数
`MatchTargetFabricId(uint64_t fabricId, uint64_t targetFabricId)`	`NL_DLL_EXPORT bool` 2 つのファブリック ID を比較して、一致するかどうかを判断します（ワイルドカード値を考慮）。

クラス
nl::Weave::Profiles::DeviceDescription::DeviceDescriptionClient	デバイス説明リクエストを発行するためのクライアントオブジェクト。
nl::Weave::Profiles::DeviceDescription::DeviceDescriptionServer	デバイス説明リクエストに応答するためのサーバーオブジェクト。
nl::Weave::Profiles::DeviceDescription::IdentifyDeviceCriteria	IdentityDevice プロトコルでデバイスを選択するために使用する条件を表します。
nl::Weave::Profiles::DeviceDescription::IdentifyRequestMessage	IdentityRequest メッセージの解析された形式。
nl::Weave::Profiles::DeviceDescription::IdentifyResponseMessage	IdentityResponse メッセージの解析された形式。
nl::Weave::Profiles::DeviceDescription::TextDescriptorReader
nl::Weave::Profiles::DeviceDescription::TextDescriptorWriter
nl::Weave::Profiles::DeviceDescription::WeaveDeviceDescriptor	Weave デバイスに関する記述情報が含まれています。

列挙型

@177

 @177

@178

 @178

Device Description Profile のメッセージタイプ。

@179

 @179

デバイス説明プロファイルのデータ要素タグ

プロパティ
`kTag_DeviceFeature_HomeAlarmLinkCapable`	[ boolean ] ホームアラームパネルへの接続をサポートする Google Nest Protect を示します。機能タグ
`kTag_DeviceFeature_LinePowered`	[ boolean ] ライン電源を必要とするデバイスを示します。機能タグ
`kTag_DeviceId`	[ uint, 2^64 max ] Weave デバイス ID。コンテキスト固有のタグ
`kTag_FabricId`	[ uint, 2^64 max ] デバイスが属する Weave ファブリックの ID。コンテキスト固有のタグ
`kTag_ManufacturingDate`	[ uint、範囲 1-65535 ] エンコードされた形式の製造日。コンテキスト固有のタグ
`kTag_PairingCode`	[ UTF-8 文字列、len 6-16 ] デバイスのペア設定コード。コンテキスト固有のタグ注: 重要: セキュリティ上の理由により、PairingCode フィールドをネットワーク経由で送信しないでください。これは WeaveDeviceDescriptor 構造内に存在し、デバイスに物理的に関連付けられたデータラベル（QR コードなど）にエンコードできます。
`kTag_PairingCompatibilityVersionMajor`	[ uint、範囲 1-65535 ] ペア設定ソフトウェアの互換性のメジャーバージョン。コンテキスト固有のタグ
`kTag_PairingCompatibilityVersionMinor`	[ uint、範囲 1-65535 ] ペア設定ソフトウェアの互換性のマイナーバージョン。コンテキスト固有のタグ
`kTag_Primary802154MACAddress`	[ バイト文字列、len = 8 ] デバイスのプライマリ 802.15.4 インターフェースの MAC アドレス。コンテキスト固有のタグ
`kTag_PrimaryWiFiMACAddress`	[ バイト文字列、len = 6 ] デバイスのプライマリ Wi-Fi インターフェースの MAC アドレス。コンテキスト固有のタグ
`kTag_ProductId`	[ uint、範囲 1-65535 ] 商品を識別するコード。コンテキスト固有のタグ
`kTag_ProductRevision`	[ uint、範囲 1-65535 ] プロダクトリビジョンを識別するコード。コンテキスト固有のタグ
`kTag_RendezvousWiFiESSID`	[ UTF-8 文字列、len 1-32 ] デバイスの Wi-Fi ランデブネットワークの ESSID。コンテキスト固有のタグ。注: このタグは RendezvousWiFiESSIDSuffix タグと相互に排他的です。
`kTag_RendezvousWiFiESSIDSuffix`	[ UTF-8 string, len 1-32 ] デバイスの Wi-Fi ランデブネットワークの ESSID 接尾辞。コンテキスト固有のタグ。注: このタグは RendezvousWiFiESSID タグと相互に排他的です。
`kTag_SerialNumber`	[ UTF-8 string, len 1-32 ] デバイスのシリアル番号。コンテキスト固有のタグ
`kTag_SoftwareVersion`	[ UTF-8 string, len 1-32 ] デバイス上のソフトウェアのバージョンです。コンテキスト固有のタグ
`kTag_VendorId`	[ uint, 範囲 1-65535 ] 製品ベンダーを識別するコード。コンテキスト固有のタグ
`kTag_WeaveDeviceDescriptor`	Weave デバイスを記述する情報を含む構造体。トップレベルタグ

TargetDeviceModes

 TargetDeviceModes

現在のモードに基づいて LocationsRequest メッセージに応答する必要があるデバイスを識別するビットフィールド（最大 32 ビット）。

なお、ここで定義するモードは、さまざまなデバイスタイプに適用できるように、一般的なモードを使用することを意図しています。

プロパティ
`kTargetDeviceMode_Any`	モードに関係なくすべてのデバイスの位置を特定します。
`kTargetDeviceMode_UserSelectedMode`	「ユーザー選択」モード（ユーザーがボタン（または同等の機能）を押してデバイスを直接特定したモード）で、すべてのデバイスを探します。

TargetFabricIds

 TargetFabricIds

特別なターゲットファブリック ID。

プロパティ
`kTargetFabricId_Any`	ファブリックメンバーシップに関係なく、すべてのデバイスが応答するように指定します。
`kTargetFabricId_AnyFabric`	ファブリックのメンバーであるデバイスのみが応答するように指定します。
`kTargetFabricId_NotInFabric`	ファブリックのメンバーではないデバイスのみが応答するように指定します。

関数

MatchTargetFabricId

NL_DLL_EXPORT bool MatchTargetFabricId(
  uint64_t fabricId,
  uint64_t targetFabricId
)

2 つのファブリック ID を比較して、一致するかどうかを判断します（ワイルドカード値を考慮）。

詳細

パラメータ

`[in] fabricId`	テストするファブリック ID。
`[in] targetFabricId`	テストするファブリック ID。

戻り値

`TRUE`	ファブリック ID が一致する場合。
`FALSE`	ファブリック ID が一致しない場合。