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 位),根据当前模式识别哪些设备应该响应 FindRequest Message。
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::标识设备标准

表示在标识设备协议中选择设备时使用的条件。

nl::Weave::Profiles::DeviceDescription::RecognizeRequestMessage

标识请求消息的解析形式。

nl::Weave::Profiles::DeviceDescription::RecognizeResponseMessage

标识的 Message 消息的解析形式。

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 device ID.

上下文关联标记

kTag_FabricId

[ uint, 2^64 max ] 设备所属的 Weave 面料的 ID。

上下文关联标记

kTag_ManufacturingDate

[ uint, range 1-65535 ] 制造日期的编码形式。

上下文关联标记

kTag_PairingCode

[UTF-8 字符串, len 6-16 ] 设备的配对码。

上下文关联标记

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 字符串, len 1-32 ] 设备 Wi-Fi 配对网络的 ESSID。

上下文相关标记。

kTag_RendezvousWiFiESSIDSuffix

[UTF-8 字符串, len 1-32 ] 设备 Wi-Fi 配对网络的 ESSID 后缀。

上下文相关标记。

kTag_SerialNumber

[UTF-8 字符串, len 1-32 ] 设备序列号。

上下文关联标记

kTag_SoftwareVersion

[UTF-8 字符串, len 1-32 ] 设备上的软件版本。

上下文关联标记

kTag_VendorId

[ uint, range 1-65535 ] 用于标识商品供应商的代码。

上下文关联标记

kTag_WeaveDeviceDescriptor

包含描述 Weave 设备的信息的结构。

顶级代码

目标设备模式

 TargetDeviceModes

位字段(最多 32 位),根据当前模式识别哪些设备应该响应 FindRequest Message。

请注意,此处定义的模式旨在实现通用性,以便可应用到各种设备类型。

属性
kTargetDeviceMode_Any

可定位所有设备(无论模式如何)。

kTargetDeviceMode_UserSelectedMode

找到处于用户选择模式(即已通过按下按钮(或等效按钮)直接识别设备)的所有设备。

TargetFabricId

 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 不匹配。