nl::Weave::Profiles::DeviceDescription

此命名空间包含 Weave 中用于 Weave 设备描述配置文件的所有接口。

摘要

枚举
`@177`	枚举
`@178`	枚举设备说明配置文件的消息类型。
@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 }	枚举设备说明配置文件的数据元素标记。
`TargetDeviceModes{ kTargetDeviceMode_Any = 0x00000000, kTargetDeviceMode_UserSelectedMode = 0x00000001 }`	枚举位字段（最大 32 位），用于标识哪些设备应根据其当前模式响应 LocateRequest 消息。
`TargetFabricIds{ kTargetFabricId_NotInFabric = kFabricIdNotSpecified, kTargetFabricId_AnyFabric = kReservedFabricIdStart, kTargetFabricId_Any = kMaxFabricId }`	枚举特殊目标结构脉络 ID。

函数
`MatchTargetFabricId(uint64_t fabricId, uint64_t targetFabricId)`	`NL_DLL_EXPORT bool` 比较两个结构 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

设备说明配置文件的消息类型。

@179

 @179

设备说明配置文件的数据元素标记。

属性
`kTag_DeviceFeature_HomeAlarmLinkCapable`	[布尔值 ] 表示支持连接到住宅警报面板的 Nest Protect。功能标记
`kTag_DeviceFeature_LinePowered`	[布尔值 ] 表示需要电源线的设备。功能标记
`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 结构中，以便可以在与设备实际关联的数据标签（例如二维码）中进行编码。
`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 string, len 1-32 ] 设备的 Wi-Fi 聚会网络的 ESSID。特定于上下文的标记。注意：此标记与 RendezvousWiFiESSIDSuffix 标记互斥。
`kTag_RendezvousWiFiESSIDSuffix`	[UTF-8 string, 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, 范围 1-65535 ] 用于标识产品供应商的代码。上下文特定标记
`kTag_WeaveDeviceDescriptor`	包含描述 Weave 设备的信息的结构。顶级代码

TargetDeviceModes

 TargetDeviceModes

位字段（最大 32 位），用于标识哪些设备应根据其当前模式响应 LocateRequest 消息。

请注意，此处定义的模式是通用模式，可以应用于各种设备类型。

属性
`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
)

比较两个结构 ID 以确定它们是否匹配（考虑通配符值）。

详细信息

参数

`[in] fabricId`	要测试的结构 ID。
`[in] targetFabricId`	要用于测试的结构 ID。

返回值

`TRUE`	如果织物 ID 匹配。
`FALSE`	如果织物 ID 不匹配。