Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

このページは 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 }`	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_ERROR` 提供されたデータバッファの内容を Weave デバイス記述子オブジェクトにデコードします。
`DecodeTLV(const uint8_t *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)`	`WEAVE_ERROR` 指定された TLV データバッファの内容を Weave Device Descriptor オブジェクトにデコードします。
`DecodeTLV(nl::Weave::TLV::TLVReader & reader, WeaveDeviceDescriptor & outDesc)`	`WEAVE_ERROR` 提供された事前初期化済み TLVReader を使用して、デバイスの説明をデコードします。
`DecodeText(const char *data, uint32_t dataLen, WeaveDeviceDescriptor & outDesc)`	`WEAVE_ERROR` 提供されたテキストデータバッファの内容を Weave デバイス記述子オブジェクトにデコードします。
`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`	ランデブースの最大 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

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

プライマリ 802154MAC アドレス

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 Device Descriptor オブジェクトにデコードします。

詳細

パラメータ

`[in] data`	テキストでエンコードされた Weave デバイス記述子データを含むバッファへのポインタ。
`[in] dataLen`	指定されたバッファの長さ。
`[out] outDesc`	入力するデバイス記述子オブジェクトへの参照。

戻り値

`WEAVE_ERROR_WRONG_TLV_TYPE`	デバイスの説明 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`	バッファにゼロ以外の値が含まれているかどうか。

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

概要

コンストラクタとデストラクタ

公開タイプ

パブリック属性

パブリック関数

静的パブリック関数

公開タイプ

@180

@181

@182

パブリック属性

日

DeviceFeatures

DeviceId

FabricId

フラグ

ManufacturingDate

月

PairingCode

PairingCompatibilityVersionMajor

PairingCompatibilityVersionMinor

プライマリ 802154MAC アドレス

PrimaryWiFiMACAddress

ProductId

ProductRevision

RendezvousWiFiESSID

SerialNumber

SoftwareVersion

VendorId

年

パブリック関数

クリア

WeaveDeviceDescriptor

静的パブリック関数

Decode

DecodeTLV

DecodeTLV

DecodeText

EncodeTLV

EncodeTLV

EncodeText

IsZeroBytes