本頁面由 Cloud Translation API 翻譯而成。

nl::Weave::Profiles::DeviceDescription::WeaveDeviceDescriptor

#include <src/lib/profiles/device-description/DeviceDescription.h>

包含有關 Weave 裝置的描述性資訊。

摘要

建構函式和解構函式
`WeaveDeviceDescriptor(void)`

公開類型
`@180{ kMaxSerialNumberLength = 32, kMaxPairingCodeLength = 16, kMaxRendezvousWiFiESSID = 32, kMaxSoftwareVersionLength = WEAVE_CONFIG_MAX_SOFTWARE_VERSION_LENGTH }`	列舉定義部分屬性的長度上限。
`@181{ kFeature_HomeAlarmLinkCapable = 0x00000001, kFeature_LinePowered = 0x00000002 }`	列舉指出特定裝置功能的功能旗標。
`@182{ kFlag_IsRendezvousWiFiESSIDSuffix = 0x01 }`	列舉旗標欄位定義。

公開屬性
`Day`	`uint8_t` 裝置製造日期 (0 = 不存在)
`DeviceFeatures`	`uint32_t` 位元欄位，表示支援特定裝置功能。
`DeviceId`	`uint64_t` Weave 裝置 ID (0 = 不存在)
`FabricId`	`uint64_t` 裝置所屬的 Weave 布料 ID (0 = 不存在)
`Flags`	`uint8_t` 含有裝置額外資訊的位元欄位。
`ManufacturingDate`	`struct nl::Weave::Profiles::DeviceDescription::WeaveDeviceDescriptor::@183`
`Month`	`uint8_t` 裝置製造月份 (1 = 1 月)
`PairingCode[kMaxPairingCodeLength+1]`	`char` 裝置配對碼 (NUL 已終止，長度 0 = 未顯示)
`PairingCompatibilityVersionMajor`	`uint16_t` 主要裝置配對軟體相容性版本。
`PairingCompatibilityVersionMinor`	`uint16_t` 裝置配對軟體相容性的小型版本。
`Primary802154MACAddress[8]`	`uint8_t` 主要 802.15.4 介面的 MAC 位址 (大端序，所有零 = 不存在)
`PrimaryWiFiMACAddress[6]`	`uint8_t` 主要 Wi-Fi 介面的 MAC 位址 (大端序，所有零 = 不存在)
`ProductId`	`uint16_t` 裝置產品代碼 (0 = 不存在)
`ProductRevision`	`uint16_t` 裝置產品修訂版本 (0 = 沒有)
`RendezvousWiFiESSID[kMaxRendezvousWiFiESSID+1]`	`char` 裝置 Wi-Fi 路邊網路的 ESSID (NUL 已終止，0 個長度 = 不存在)
`SerialNumber[kMaxSerialNumberLength+1]`	`char` 裝置的序號 (NUL 已終止，0 個字元 = 不存在)
`SoftwareVersion[kMaxSoftwareVersionLength+1]`	`char` 使用中的軟體版本 (NUL 終止，0 個長度 = 不存在)
`VendorId`	`uint16_t` 裝置供應商代碼 (0 = 不存在)
`Year`	`uint16_t` 裝置製造年份 (有效範圍為 2001 至 2099 年)

公開函式
`Clear(void)`	`void` 清除裝置說明。

公開的靜態函式
`Decode(const uint8_t *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)`	`WEAVE_ERROR` 將所提供資料緩衝區的內容解碼為 Weave Device Descriptor 物件。
`DecodeTLV(const uint8_t *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)`	`WEAVE_ERROR` 將所提供 TLV 資料緩衝區的內容解碼為 Weave 裝置描述元物件。
`DecodeTLV(nl::Weave::TLV::TLVReader & reader, WeaveDeviceDescriptor & outDesc)`	`WEAVE_ERROR` 使用提供的預先初始化 TLVReader 解碼裝置說明。
`DecodeText(const char *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)`	`WEAVE_ERROR` 將所提供文字資料緩衝區的內容解碼為 Weave Device Descriptor 物件。
`EncodeTLV(const WeaveDeviceDescriptor & desc, uint8_t *buf, uint32_t bufLen, uint32_t & outEncodedLen)`	`WEAVE_ERROR` 將提供的裝置描述元進行編碼，做為寫入提供的緩衝區的 Weave TLV。
`EncodeTLV(const WeaveDeviceDescriptor & desc, nl::Weave::TLV::TLVWriter & writer)`	`WEAVE_ERROR` 使用提供的預先初始化 TLVWriter 物件，將提供的裝置描述元編碼為 Weave TLV。
`EncodeText(const WeaveDeviceDescriptor & desc, char *buf, uint32_t bufLen, uint32_t & outEncodedLen)`	`WEAVE_ERROR` 將提供的裝置描述元編碼為寫入提供的緩衝區的文字。
`IsZeroBytes(const uint8_t *buf, uint32_t len)`	`bool` 檢查指定的緩衝區是否只包含零。

公開類型

180 號星

 @180

定義部分屬性的長度上限。

屬性
`kMaxPairingCodeLength`	配對代碼長度上限。
`kMaxRendezvousWiFiESSID`	Rendezvous 的 Wi-Fi ESSID 長度上限。
`kMaxSerialNumberLength`	序號長度上限。
`kMaxSoftwareVersionLength`	軟體版本長度上限。

181 號星

 @181

指出特定裝置功能的功能旗標。

屬性
`kFeature_HomeAlarmLinkCapable`	表示支援與居家警報面板連線的 Nest Protect。
`kFeature_LinePowered`	表示需要接線的裝置。

182 次

 @182

旗標欄位定義。

屬性
`kFlag_IsRendezvousWiFiESSIDSuffix`	表示 RendezvousWiFiESSID 值是後置字串，會顯示在裝置的 Wi-Fi 路邊網路結尾。

公開屬性

天

uint8_t Day

裝置製造日期 (0 = 不存在)

DeviceFeatures

uint32_t DeviceFeatures

位元欄位，表示支援特定裝置功能。

DeviceId

uint64_t DeviceId

Weave 裝置 ID (0 = 不存在)

FabricId

uint64_t FabricId

裝置所屬的 Weave 布料 ID (0 = 不存在)

旗幟

uint8_t Flags

含有裝置額外資訊的位元欄位。

ManufacturingDate

struct nl::Weave::Profiles::DeviceDescription::WeaveDeviceDescriptor::@183 ManufacturingDate

月

uint8_t Month

裝置製造月份 (1 = 1 月)

PairingCode

char PairingCode[kMaxPairingCodeLength+1]

裝置配對碼 (NUL 已終止，長度 0 = 未顯示)

PairingCompatibilityVersionMajor

uint16_t PairingCompatibilityVersionMajor

主要裝置配對軟體相容性版本。

PairingCompatibilityVersionMinor

uint16_t PairingCompatibilityVersionMinor

裝置配對軟體相容性的小型版本。

主要 802154MACAddress

uint8_t Primary802154MACAddress[8]

主要 802.15.4 介面的 MAC 位址 (大端序，所有零 = 不存在)

PrimaryWiFiMACAddress

uint8_t PrimaryWiFiMACAddress[6]

主要 Wi-Fi 介面的 MAC 位址 (大端序，所有零 = 不存在)

ProductId

uint16_t ProductId

裝置產品代碼 (0 = 不存在)

ProductRevision

uint16_t ProductRevision

裝置產品修訂版本 (0 = 沒有)

RendezvousWiFiESSID

char RendezvousWiFiESSID[kMaxRendezvousWiFiESSID+1]

裝置 Wi-Fi 路邊網路的 ESSID (NUL 已終止，0 個長度 = 不存在)

SerialNumber

char SerialNumber[kMaxSerialNumberLength+1]

裝置的序號 (NUL 已終止，0 個字元 = 不存在)

SoftwareVersion

char SoftwareVersion[kMaxSoftwareVersionLength+1]

使用中的軟體版本 (NUL 終止，0 個長度 = 不存在)

VendorId

uint16_t VendorId

裝置供應商代碼 (0 = 不存在)

年

uint16_t Year

裝置製造年份 (有效範圍為 2001 至 2099 年)

公開函式

清除

void Clear(
  void
)

清除裝置說明。

WeaveDeviceDescriptor

 WeaveDeviceDescriptor(
  void
)

公開的靜態函式

Decode

WEAVE_ERROR Decode(
  const uint8_t *data,
  uint32_t dataLen,
  WeaveDeviceDescriptor & outDesc
)

將所提供資料緩衝區的內容解碼為 Weave Device Descriptor 物件。

詳細資料

參數

`[in] data`	指向內含文字或 TLV 編碼 Weave 裝置描述元資料的緩衝區。
`[in] dataLen`	提供的緩衝區長度。
`[out] outDesc`	要填入裝置描述元物件的參照。

傳回值

`WEAVE_ERROR_INVALID_DEVICE_DESCRIPTOR`	如果提供的緩衝區無效。
`WEAVE_NO_ERROR`	成功時。
`other`	其他 Weave 或平台專屬錯誤代碼，表示發生錯誤，導致 TLV 無法解碼。

DecodeTLV

WEAVE_ERROR DecodeTLV(
  const uint8_t *data,
  uint32_t dataLen,
  WeaveDeviceDescriptor & outDesc
)

將所提供 TLV 資料緩衝區的內容解碼為 Weave 裝置描述元物件。

詳細資料

參數

`[in] data`	指向包含文字編碼 Weave 裝置描述元資料的緩衝區指標。
`[in] dataLen`	提供的緩衝區長度。
`[out] outDesc`	要填入裝置描述元物件的參照。

傳回值

`WEAVE_ERROR_WRONG_TLV_TYPE`	如果這不是裝置說明TLV。
`WEAVE_ERROR_UNEXPECTED_TLV_ELEMENT`	如果「裝置說明」結束後出現更多 TLV 資料。
`WEAVE_NO_ERROR`	成功時。
`other`	其他 Weave 或平台專用錯誤代碼，表示發生錯誤，導致 TLV 無法編碼。

DecodeTLV

WEAVE_ERROR DecodeTLV(
  nl::Weave::TLV::TLVReader & reader,
  WeaveDeviceDescriptor & outDesc
)

使用提供的預先初始化 TLVReader 解碼裝置說明。

詳細資料

參數

`[in] reader`	預先初始化 TLVReader 的參照。
`[out] outDesc`	要填入裝置描述元物件的參照。

傳回值

`WEAVE_ERROR_INVALID_TLV_ELEMENT`	如果您在 TLV 資料中找到無效的裝置說明資訊。
`WEAVE_NO_ERROR`	成功時。
`other`	其他 Weave 或平台專屬錯誤代碼，表示發生錯誤，導致 TLV 無法解碼。

DecodeText

WEAVE_ERROR DecodeText(
  const char *data,
  uint32_t dataLen,
  WeaveDeviceDescriptor & outDesc
)

將所提供文字資料緩衝區的內容解碼為 Weave Device Descriptor 物件。

詳細資料

參數

`[in] data`	指向包含文字編碼 Weave 裝置描述元資料的緩衝區指標。
`[in] dataLen`	提供的緩衝區長度。
`[out] outDesc`	要填入裝置描述元物件的參照。

傳回值

`WEAVE_ERROR_UNSUPPORTED_DEVICE_DESCRIPTOR_VERSION`	系統不支援編碼的資料版本。
`WEAVE_ERROR_INVALID_DEVICE_DESCRIPTOR`	如果編碼資料的格式不正確。
`WEAVE_ERROR_INCORRECT_STATE`	如果解碼器發生不一致的狀態，
`WEAVE_ERROR_BUFFER_TOO_SMALL`	如果在解碼過程中達到緩衝區的結尾。
`WEAVE_NO_ERROR`	成功時。

EncodeTLV

WEAVE_ERROR EncodeTLV(
  const WeaveDeviceDescriptor & desc,
  uint8_t *buf,
  uint32_t bufLen,
  uint32_t & outEncodedLen
)

將提供的裝置描述元進行編碼，做為寫入提供的緩衝區的 Weave TLV。

詳細資料

參數

`[in] desc`	要進行編碼的 Weave Device Descriptor 參照。
`[out] buf`	指向要寫入編碼文字的緩衝區指標。
`[in] bufLen`	提供的緩衝區長度。
`[out] outEncodedLen`	長度變數的參照，系統會以寫入緩衝區的字元數覆寫。

傳回值

`WEAVE_NO_ERROR`	成功時。
`other`	其他 Weave 或平台專用錯誤代碼，表示發生錯誤，導致 TLV 無法編碼。

EncodeTLV

WEAVE_ERROR EncodeTLV(
  const WeaveDeviceDescriptor & desc,
  nl::Weave::TLV::TLVWriter & writer
)

使用提供的預先初始化 TLVWriter 物件，將提供的裝置描述元編碼為 Weave TLV。

這會用於將裝置說明新增至更大的 TLV 輸出內容。

詳細資料

參數

`[in] desc`	要進行編碼的 Weave Device Descriptor 參照。
`[in] writer`	要使用的預先初始化 TLVWriter 物件的參照。

傳回值

`WEAVE_NO_ERROR`	成功時。
`other`	其他 Weave 或平台專用錯誤代碼，表示發生錯誤，導致 TLV 無法編碼。

EncodeText

WEAVE_ERROR EncodeText(
  const WeaveDeviceDescriptor & desc,
  char *buf,
  uint32_t bufLen,
  uint32_t & outEncodedLen
)

將提供的裝置描述元編碼為寫入提供的緩衝區的文字。

詳細資料

參數

`[in] desc`	要進行編碼的 Weave Device Descriptor 參照。
`[out] buf`	指向要寫入編碼文字的緩衝區指標。
`[in] bufLen`	提供的緩衝區長度。
`[out] outEncodedLen`	長度變數的參照，系統會以寫入緩衝區的字元數覆寫。

傳回值

`WEAVE_ERROR_BUFFER_TOO_SMALL`	如果提供的緩衝區太小，無法生成文字說明。
`WEAVE_ERROR_INVALID_ARGUMENT`	如果描述元欄位無效，
`WEAVE_NO_ERROR`	成功時。

IsZeroBytes

bool IsZeroBytes(
  const uint8_t *buf,
  uint32_t len
)

檢查指定的緩衝區是否只包含零。

詳細資料

參數

`[in] buf`	指向緩衝區的指標。
`[in] len`	緩衝區長度。

傳回值

`TRUE`	如果緩衝區僅包含 0。
`FALSE`	如果緩衝區包含任何非零的值。

nl::Weave::Profiles::DeviceDescription::WeaveDeviceDescriptor

摘要

建構函式和解構函式

公開類型

公開屬性

公開函式

公開的靜態函式

公開類型

180 號星

181 號星

182 次

公開屬性

天

DeviceFeatures

DeviceId

FabricId

旗幟

ManufacturingDate

月

PairingCode

PairingCompatibilityVersionMajor

PairingCompatibilityVersionMinor

主要 802154MACAddress

PrimaryWiFiMACAddress

ProductId

ProductRevision

RendezvousWiFiESSID

SerialNumber

SoftwareVersion

VendorId

年

公開函式

清除

WeaveDeviceDescriptor

公開的靜態函式

Decode

DecodeTLV

DecodeTLV

DecodeText

EncodeTLV

EncodeTLV

EncodeText

IsZeroBytes