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::IdentifyDeviceCriteria

代表在 LearnDevice 通訊協定中用來選取裝置的條件。

nl::Weave::Profiles::DeviceDescription::IdentifyRequestMessage

MarkRequest 訊息的剖析形式。

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

[ boolean ] 表示支援連線到居家警報面板的 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 string, 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 string, len 1-32 ] 用於裝置 Wi-Fi 網路的 ESSID。

內容專屬代碼

kTag_RendezvousWiFiESSIDSuffix

[ UTF-8 string, len 1-32 ] 裝置 Wi-Fi 網路的 ESSID 後置字串。

內容專屬代碼

kTag_SerialNumber

[ UTF-8 string, len 1-32 ] 裝置序號。

內容專屬標記

kTag_SoftwareVersion

[ UTF-8 string, len 1-32 ] 裝置上的軟體版本。

內容專屬標記

kTag_VendorId

[ uint, range 1-65535 ] 識別產品供應商的程式碼。

內容專屬標記

kTag_WeaveDeviceDescriptor

包含 Weave 裝置相關資訊的結構。

頂層標記

TargetDeviceModes

 TargetDeviceModes

位元欄位 (上限為 32 位元),可依據目前模式找出哪些裝置應回應 FindRequest Message。

請注意,此處定義的模式僅為一般性,適用於各種裝置類型。

屬性
kTargetDeviceMode_Any

尋找所有裝置 (無論模式為何)。

kTargetDeviceMode_UserSelectedMode

尋找「使用者所選」中的所有裝置模式,也就是按下按鈕 (或類似功能) 直接識別裝置的位置。

TargetFabricIds

 TargetFabricIds

特殊目標織品 ID。

屬性
kTargetFabricId_Any

指定無論織布成員為何,所有裝置都應回應。

kTargetFabricId_AnyFabric

指定只有「{0}_」_布料人員的裝置應回應。

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 不相符。