nl::Weave::Profiles::DeviceDescription

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

概要

列挙型
`@177`	enum
`@178`	enum Device Description プロファイルのメッセージタイプ。
@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 Device Description プロファイルのデータ要素タグ。
`TargetDeviceModes{ kTargetDeviceMode_Any = 0x00000000, kTargetDeviceMode_UserSelectedMode = 0x00000001 }`	enum 現在のモードに基づいて、locale リクエストメッセージに応答するデバイスを指定するビットフィールド（最大 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 プロファイルのメッセージタイプ。

@179

 @179

Device Description プロファイルのデータ要素タグ。

をご覧ください。

プロパティ
`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, range 1-65535 ] エンコードされた形式の製造日。コンテキスト固有のタグ
`kTag_PairingCode`	[ UTF-8 文字列, len 6-16 ] デバイスのペアリングコード。コンテキスト固有のタグ注: 重要: セキュリティ上の理由から、PairingCode フィールドをネットワーク経由で送信しないでください。デバイスに物理的に関連付けられたデータラベル（QR コードなど）にエンコードできるように、WeaveDeviceDescriptor 構造に格納されています。
`kTag_PairingCompatibilityVersionMajor`	[ uint, range 1-65535 ] ペアリングソフトウェア互換性メジャーバージョン。コンテキスト固有のタグ
`kTag_PairingCompatibilityVersionMinor`	[ uint, range 1-65535 ] ペアリングソフトウェア互換性マイナーバージョン。コンテキスト固有のタグ
`kTag_Primary802154MACAddress`	[ byte string, len = 8 ] デバイスのプライマリ 802.15.4 インターフェースの MAC アドレス。コンテキスト固有のタグ
`kTag_PrimaryWiFiMACAddress`	[ byte string, len = 6 ] デバイスのプライマリ Wi-Fi インターフェースの MAC アドレス。コンテキスト固有のタグ
`kTag_ProductId`	[ uint, range 1-65535 ] 製品を識別するコード。コンテキスト固有のタグ
`kTag_ProductRevision`	[ uint, range 1-65535 ] 製品リビジョンを識別するコード。コンテキスト固有のタグ
`kTag_RendezvousWiFiESSID`	[ UTF-8 string, len 1-32 ] デバイスの Wi-Fi ランデブーネットワークの ESSID。コンテキスト固有のタグ注: このタグは RendezvousWiFiESSIDSuffix タグとは相互に排他的です。をご覧ください。
`kTag_RendezvousWiFiESSIDSuffix`	[ UTF-8 文字列、len 1-32 ] デバイスの Wi-Fi ランデブーネットワークの ESSID サフィックス。コンテキスト固有のタグ注: このタグは RendezvousWiFiESSID タグと相互に排他的です。をご覧ください。
`kTag_SerialNumber`	[ UTF-8 文字列, len 1-32 ] デバイスのシリアル番号。コンテキスト固有のタグ
`kTag_SoftwareVersion`	[ UTF-8 string, len 1-32 ] デバイス上のソフトウェアのバージョン。コンテキスト固有のタグ
`kTag_VendorId`	[ uint, range 1-65535 ] 製品ベンダーを識別するコード。コンテキスト固有のタグ
`kTag_WeaveDeviceDescriptor`	Weave デバイスを説明する情報を含む構造体。トップレベルタグ

TargetDeviceModes

 TargetDeviceModes

現在のモードに基づいて、locale リクエストメッセージに応答するデバイスを指定するビットフィールド（最大 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 が一致しない場合。