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
} 		enum
一部の属性の最大長を定義します。
@181{
  kFeature_HomeAlarmLinkCapable = 0x00000001,
  kFeature_LinePowered = 0x00000002
} 		enum
特定のデバイスの機能を示す機能フラグ。
@182{
  kFlag_IsRendezvousWiFiESSIDSuffix = 0x01
} 		enum
フラグ フィールドの定義。

パブリック属性
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 デバイス記述子オブジェクトにデコードします。
DecodeTLV(const uint8_t *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)
指定された TLV データバッファの内容を Weave デバイス記述子オブジェクトにデコードします。
DecodeTLV(nl::Weave::TLV::TLVReader & reader, WeaveDeviceDescriptor & outDesc)
提供されている事前初期化済み TLVReader を使用して、デバイスの説明をデコードします。
DecodeText(const char *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)
提供されたテキストデータ バッファの内容を Weave デバイス記述子オブジェクトにデコードします。
EncodeTLV(const WeaveDeviceDescriptor & desc, uint8_t *buf, uint32_t bufLen, uint32_t & outEncodedLen)
提供されたデバイス記述子を、提供されたバッファに書き込まれる Weave TLV としてエンコードします。
EncodeTLV(const WeaveDeviceDescriptor & desc, nl::Weave::TLV::TLVWriter & writer)
提供されたデバイス記述子を、提供された事前初期化済み TLVWriter オブジェクトを使用して記述された Weave TLV としてエンコードします。
EncodeText(const WeaveDeviceDescriptor & desc, char *buf, uint32_t bufLen, uint32_t & outEncodedLen)
指定されたデバイス記述子を、指定されたバッファに書き込まれたテキストとしてエンコードします。
IsZeroBytes(const uint8_t *buf, uint32_t len)
bool
指定されたバッファにゼロのみが含まれているかどうかを確認します。

パブリック タイプ

@180

 @180

一部の属性の最大長を定義します。

プロパティ
kMaxPairingCodeLength

ペア設定コードの最大長。
kMaxRendezvousWiFiESSID

ランデブの長さの Wi-Fi 最大 ESSID。
kMaxSerialNumberLength

シリアル番号の最大長。
kMaxSoftwareVersionLength

ソフトウェア バージョンの最大長。

@181

 @181

特定のデバイスの機能を示す機能フラグ。

プロパティ
kFeature_HomeAlarmLinkCapable

ホーム アラームパネルへの接続をサポートする Google Nest Protect を示します。
kFeature_LinePowered

ライン電源を必要とするデバイスを示します。

@182

 @182

フラグ フィールドの定義。

プロパティ
kFlag_IsRendezvousWiFiESSIDSuffix

RendezvousWiFiESSID の値が、デバイスの Wi-Fi ランデブ ネットワークの ESSID の末尾に表示されるサフィックス文字列であることを示します。

パブリック属性

日

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

マイナー デバイスのペア設定のソフトウェア互換性バージョン。

Primary802154MACAddress

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 デバイス記述子オブジェクトにデコードします。

詳細
パラメータ
[in] data
テキストまたは TLV でエンコードされた Weave デバイス記述子データを含むバッファへのポインタ。
[in] dataLen
指定されたバッファの長さ。
[out] outDesc
データが入力されるデバイス記述子オブジェクトへの参照。
戻り値
WEAVE_ERROR_INVALID_DEVICE_DESCRIPTOR
指定されたバッファが無効な場合。
WEAVE_NO_ERROR
成功時。
other
エラーが発生し TLV をデコードできないことを示すその他の Weave またはプラットフォーム固有のエラーコード。

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
[Device Description] の [TLV] ではない場合。
WEAVE_ERROR_UNEXPECTED_TLV_ELEMENT
デバイスの説明の後にさらに TLV データが見つかった場合。
WEAVE_NO_ERROR
成功時。
other
エラーが発生し TLV のエンコードが妨げられたことを示すその他の Weave またはプラットフォーム固有のエラーコード。

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
TLV のデコードを妨げるエラーが発生したことを示すその他の Weave またはプラットフォーム固有のエラーコード。

DecodeText

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

提供されたテキストデータ バッファの内容を Weave デバイス記述子オブジェクトにデコードします。

詳細
パラメータ
[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 デバイス記述子への参照。
[out] buf
エンコードされたテキストが書き込まれるバッファへのポインタ。
[in] bufLen
提供されたバッファの長さ。
[out] outEncodedLen
バッファに書き込まれた文字数で上書きされる長さ変数の参照。
戻り値
WEAVE_NO_ERROR
成功時。
other
エラーが発生し TLV のエンコードが妨げられたことを示すその他の Weave またはプラットフォーム固有のエラーコード。

EncodeTLV

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

提供されたデバイス記述子を、提供された事前初期化済み TLVWriter オブジェクトを使用して記述された Weave TLV としてエンコードします。

より大きな TLV 出力にデバイスの説明を追加する場合に使用します。

詳細
パラメータ
[in] desc
エンコードする Weave デバイス記述子への参照。
[in] writer
使用する事前初期化済み TLVWriter オブジェクトへの参照。
戻り値
WEAVE_NO_ERROR
成功時。
other
エラーが発生し TLV のエンコードが妨げられたことを示すその他の Weave またはプラットフォーム固有のエラーコード。

EncodeText

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

指定されたデバイス記述子を、指定されたバッファに書き込まれたテキストとしてエンコードします。

詳細
パラメータ
[in] desc
エンコードする Weave デバイス記述子への参照。
[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
バッファにゼロのみが含まれている場合。
FALSE
バッファにゼロ以外の値が含まれている場合。