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

このページは Cloud Translation API によって翻訳されました。

nl::Weave::DeviceLayer::Internal::NRF5Config

#include <src/adaptations/device-layer/include/Weave/DeviceLayer/nRF5/nRF5Config.h>

Nordic nRF5 SDK に基づくプラットフォームで、永続的なデバイス構成にアクセスするための関数と定義を提供します。

概要

この実装では、基盤となるストレージレイヤとして Nordic Flash Data Storage（FDS）ライブラリを使用します。

注: このクラスは、GenericConfigurationManagerImpl<>使用します。このように使用すると、クラスは当然、テンプレートクラスによって参照される委任メンバーの実装（ReadConfigValue() メソッドなど）を提供します。

継承

直系の既知のサブクラス:
nl::Weave::DeviceLayer::ConfigurationManagerImpl
nl::Weave::DeviceLayer::Internal::GroupKeyStoreImpl

公開タイプ
`Key`	使用 `uint32_t`

保護されているタイプ
`ForEachRecordFunct`	使用 `std::function< WEAVE_ERROR(const fds_flash_record_t &rec, bool &deleteRec)>`

公開静的属性
`kConfigKey_FabricId = NRF5ConfigKey(kFileId_WeaveConfig, 0x0007)`	`constexpr Key`
`kConfigKey_FabricSecret = NRF5ConfigKey(kFileId_WeaveConfig, 0x000B)`	`constexpr Key`
`kConfigKey_FailSafeArmed = NRF5ConfigKey(kFileId_WeaveConfig, 0x000D)`	`constexpr Key`
`kConfigKey_GroupKey = NRF5ConfigKey(kFileId_WeaveConfig, 0x000E)`	`constexpr Key`
`kConfigKey_LastUsedEpochKeyId = NRF5ConfigKey(kFileId_WeaveConfig, 0x000C)`	`constexpr Key`
`kConfigKey_ManufacturingDate = NRF5ConfigKey(kFileId_WeaveFactory, 0x0005)`	`constexpr Key`
`kConfigKey_MfrDeviceCert = NRF5ConfigKey(kFileId_WeaveFactory, 0x0003)`	`constexpr Key`
`kConfigKey_MfrDeviceICACerts = NRF5ConfigKey(kFileId_WeaveFactory, 0x0010)`	`constexpr Key`
`kConfigKey_MfrDeviceId = NRF5ConfigKey(kFileId_WeaveFactory, 0x0002)`	`constexpr Key`
`kConfigKey_MfrDevicePrivateKey = NRF5ConfigKey(kFileId_WeaveFactory, 0x0004)`	`constexpr Key`
`kConfigKey_OperationalDeviceCert = NRF5ConfigKey(kFileId_WeaveConfig, 0x0012)`	`constexpr Key`
`kConfigKey_OperationalDeviceICACerts = NRF5ConfigKey(kFileId_WeaveConfig, 0x0013)`	`constexpr Key`
`kConfigKey_OperationalDeviceId = NRF5ConfigKey(kFileId_WeaveConfig, 0x0011)`	`constexpr Key`
`kConfigKey_OperationalDevicePrivateKey = NRF5ConfigKey(kFileId_WeaveConfig, 0x0014)`	`constexpr Key`
`kConfigKey_PairedAccountId = NRF5ConfigKey(kFileId_WeaveConfig, 0x0009)`	`constexpr Key`
`kConfigKey_PairingCode = NRF5ConfigKey(kFileId_WeaveFactory, 0x0006)`	`constexpr Key`
`kConfigKey_ProductRevision = NRF5ConfigKey(kFileId_WeaveFactory, 0x000F)`	`constexpr Key`
`kConfigKey_SerialNum = NRF5ConfigKey(kFileId_WeaveFactory, 0x0001)`	`constexpr Key`
`kConfigKey_ServiceConfig = NRF5ConfigKey(kFileId_WeaveConfig, 0x0008)`	`constexpr Key`
`kConfigKey_ServiceId = NRF5ConfigKey(kFileId_WeaveConfig, 0x000A)`	`constexpr Key`
`kFDSFileIdMax = 0xBFFF`	`constexpr uint16_t` FDS ファイル ID に使用できる最大値（Nordic SDK ごと）
`kFDSFileIdMin = 0x0000`	`constexpr uint16_t` FDS ファイル ID に使用できる最小値（Nordic SDK ごと）
`kFDSRecordKeyMax = 0xBFFF`	`constexpr uint16_t` FDS レコードキーに使用できる最大値（北欧 SDK 単位）
`kFDSRecordKeyMin = 0x0001`	`constexpr uint16_t` FDS レコードキーに使用できる最小値（Nordic SDK ごと）
`kFileId_WeaveConfig = 0x235B`	`constexpr uint16_t` 実行時に設定される動的構成値を含む FDS ファイル。
`kFileId_WeaveCounter = 0x235C`	`constexpr uint16_t` 実行時に設定される動的カウンタ値を含む FDS ファイル。
`kFileId_WeaveFactory = 0x235A`	`constexpr uint16_t` 製造時に設定された永続的な構成値を含む FDS ファイル。
`kPersistedCounterRecordKeyBase = kFDSRecordKeyMin`	`constexpr uint16_t` Weave の永続的なカウンタ値を含むレコードの基本レコードキー。
`kPersistedCounterRecordKeyMax = kFDSRecordKeyMax`	`constexpr uint16_t` Weave の永続的なカウンタ値を含むレコードの最大レコードキー。

保護される静的属性
`kFDSWordSize = 4`	`constexpr uint16_t`
`sActiveAsyncOp`	`FDSAsyncOp *volatile`
`sAsyncOpCompletionSem`	`SemaphoreHandle_t`

静的パブリック関数
`ClearConfigValue(Key key)`	`WEAVE_ERROR`
`ConfigValueExists(Key key)`	`bool`
`FactoryResetConfig(void)`	`WEAVE_ERROR`
`Init(void)`	`WEAVE_ERROR`
`ReadConfigValue(Key key, bool & val)`	`WEAVE_ERROR`
`ReadConfigValue(Key key, uint32_t & val)`	`WEAVE_ERROR`
`ReadConfigValue(Key key, uint64_t & val)`	`WEAVE_ERROR`
`ReadConfigValueBin(Key key, uint8_t *buf, size_t bufSize, size_t & outLen)`	`WEAVE_ERROR`
`ReadConfigValueStr(Key key, char *buf, size_t bufSize, size_t & outLen)`	`WEAVE_ERROR`
`RunConfigUnitTest(void)`	`void`
`WriteConfigValue(Key key, bool val)`	`WEAVE_ERROR`
`WriteConfigValue(Key key, uint32_t val)`	`WEAVE_ERROR`
`WriteConfigValue(Key key, uint64_t val)`	`WEAVE_ERROR`
`WriteConfigValueBin(Key key, const uint8_t *data, size_t dataLen)`	`WEAVE_ERROR`
`WriteConfigValueStr(Key key, const char *str)`	`WEAVE_ERROR`
`WriteConfigValueStr(Key key, const char *str, size_t strLen)`	`WEAVE_ERROR`

保護された静的関数
`DoAsyncFDSOp(FDSAsyncOp & asyncOp)`	`WEAVE_ERROR`
`FDSWords(size_t s)`	`constexpr uint16_t` 指定されたサイズオブジェクトを保持するために必要な FDS ワードの数。
`ForEachRecord(uint16_t fileId, uint16_t recordKey, ForEachRecordFunct funct)`	`WEAVE_ERROR`
`GetFileId(uint32_t key)`	`constexpr uint16_t` キー値から FDS ファイル ID を抽出します。
`GetRecordKey(uint32_t key)`	`constexpr uint16_t` キー値から FDS レコードキーを抽出します。
`OpenRecord(NRF5Config::Key key, fds_record_desc_t & recDesc, fds_flash_record_t & rec)`	`WEAVE_ERROR`

公開タイプ

キー

uint32_t Key

保護されているタイプ

ForEachRecordFunct

std::function< WEAVE_ERROR(const fds_flash_record_t &rec, bool &deleteRec)> ForEachRecordFunct

公開静的属性

kConfigKey_FabricId

constexpr Key kConfigKey_FabricId = NRF5ConfigKey(kFileId_WeaveConfig,  0x0007)

kConfigKey_FabricSecret

constexpr Key kConfigKey_FabricSecret = NRF5ConfigKey(kFileId_WeaveConfig,  0x000B)

kConfigKey_FailSafeArmed

constexpr Key kConfigKey_FailSafeArmed = NRF5ConfigKey(kFileId_WeaveConfig,  0x000D)

kConfigKey_GroupKey

constexpr Key kConfigKey_GroupKey = NRF5ConfigKey(kFileId_WeaveConfig,  0x000E)

kConfigKey_LastUsedEpochKeyId

constexpr Key kConfigKey_LastUsedEpochKeyId = NRF5ConfigKey(kFileId_WeaveConfig,  0x000C)

kConfigKey_ManufacturingDate

constexpr Key kConfigKey_ManufacturingDate = NRF5ConfigKey(kFileId_WeaveFactory, 0x0005)

kConfigKey_MfrDeviceCert

constexpr Key kConfigKey_MfrDeviceCert = NRF5ConfigKey(kFileId_WeaveFactory, 0x0003)

kConfigKey_MfrDeviceICACerts

constexpr Key kConfigKey_MfrDeviceICACerts = NRF5ConfigKey(kFileId_WeaveFactory, 0x0010)

kConfigKey_MfrDeviceId

constexpr Key kConfigKey_MfrDeviceId = NRF5ConfigKey(kFileId_WeaveFactory, 0x0002)

kConfigKey_MfrDevicePrivateKey

constexpr Key kConfigKey_MfrDevicePrivateKey = NRF5ConfigKey(kFileId_WeaveFactory, 0x0004)

kConfigKey_OperationalDeviceCert

constexpr Key kConfigKey_OperationalDeviceCert = NRF5ConfigKey(kFileId_WeaveConfig,  0x0012)

kConfigKey_OperationalDeviceICACerts

constexpr Key kConfigKey_OperationalDeviceICACerts = NRF5ConfigKey(kFileId_WeaveConfig,  0x0013)

kConfigKey_OperationalDeviceId

constexpr Key kConfigKey_OperationalDeviceId = NRF5ConfigKey(kFileId_WeaveConfig,  0x0011)

kConfigKey_OperationalDevicePrivateKey

constexpr Key kConfigKey_OperationalDevicePrivateKey = NRF5ConfigKey(kFileId_WeaveConfig,  0x0014)

kConfigKey_PairedAccountId

constexpr Key kConfigKey_PairedAccountId = NRF5ConfigKey(kFileId_WeaveConfig,  0x0009)

kConfigKey_PairingCode

constexpr Key kConfigKey_PairingCode = NRF5ConfigKey(kFileId_WeaveFactory, 0x0006)

kConfigKey_ProductRevision

constexpr Key kConfigKey_ProductRevision = NRF5ConfigKey(kFileId_WeaveFactory, 0x000F)

kConfigKey_SerialNum

constexpr Key kConfigKey_SerialNum = NRF5ConfigKey(kFileId_WeaveFactory, 0x0001)

kConfigKey_ServiceConfig

constexpr Key kConfigKey_ServiceConfig = NRF5ConfigKey(kFileId_WeaveConfig,  0x0008)

kConfigKey_ServiceId

constexpr Key kConfigKey_ServiceId = NRF5ConfigKey(kFileId_WeaveConfig,  0x000A)

kFDSFileIdMax

constexpr uint16_t kFDSFileIdMax = 0xBFFF

FDS ファイル ID に使用できる最大値（Nordic SDK ごと）

kFDSFileIdMin

constexpr uint16_t kFDSFileIdMin = 0x0000

FDS ファイル ID に使用できる最小値（Nordic SDK ごと）

kFDSRecordKeyMax

constexpr uint16_t kFDSRecordKeyMax = 0xBFFF

FDS レコードキーに使用できる最大値（北欧 SDK 単位）

kFDSRecordKeyMin

constexpr uint16_t kFDSRecordKeyMin = 0x0001

FDS レコードキーに使用できる最小値（Nordic SDK ごと）

kFileId_WeaveConfig

constexpr uint16_t kFileId_WeaveConfig = 0x235B

実行時に設定される動的構成値を含む FDS ファイル。

出荷時設定へのリセット時に消去されます。

kFileId_WeaveCounter

constexpr uint16_t kFileId_WeaveCounter = 0x235C

実行時に設定される動的カウンタ値を含む FDS ファイル。

出荷時設定へのリセット時に保持されます。

kFileId_WeaveFactory

constexpr uint16_t kFileId_WeaveFactory = 0x235A

製造時に設定された永続的な構成値を含む FDS ファイル。

出荷時設定へのリセット時に保持されます。

kPersistedCounterRecordKeyBase

constexpr uint16_t kPersistedCounterRecordKeyBase = kFDSRecordKeyMin

Weave の永続的なカウンタ値を含むレコードの基本レコードキー。

この値に Weave カウンタ ID が追加され、FDS レコードキーが形成されます。

kPersistedCounterRecordKeyMax

constexpr uint16_t kPersistedCounterRecordKeyMax = kFDSRecordKeyMax

Weave の永続的なカウンタ値を含むレコードの最大レコードキー。

保護される静的属性

kFDSWordSize

constexpr uint16_t kFDSWordSize = 4

sActiveAsyncOp

FDSAsyncOp *volatile sActiveAsyncOp

sAsyncOpCompletionSem

SemaphoreHandle_t sAsyncOpCompletionSem

静的パブリック関数

ClearConfigValue

WEAVE_ERROR ClearConfigValue(
  Key key
)

ConfigValueExists

bool ConfigValueExists(
  Key key
)

FactoryResetConfig

WEAVE_ERROR FactoryResetConfig(
  void
)

init

WEAVE_ERROR Init(
  void
)

ReadConfigValue

WEAVE_ERROR ReadConfigValue(
  Key key,
  bool & val
)

ReadConfigValue

WEAVE_ERROR ReadConfigValue(
  Key key,
  uint32_t & val
)

ReadConfigValue

WEAVE_ERROR ReadConfigValue(
  Key key,
  uint64_t & val
)

ReadConfigValueBin

WEAVE_ERROR ReadConfigValueBin(
  Key key,
  uint8_t *buf,
  size_t bufSize,
  size_t & outLen
)

ReadConfigValueStr

WEAVE_ERROR ReadConfigValueStr(
  Key key,
  char *buf,
  size_t bufSize,
  size_t & outLen
)

RunConfigUnitTest

void RunConfigUnitTest(
  void
)

WriteConfigValue

WEAVE_ERROR WriteConfigValue(
  Key key,
  bool val
)

WriteConfigValue

WEAVE_ERROR WriteConfigValue(
  Key key,
  uint32_t val
)

WriteConfigValue

WEAVE_ERROR WriteConfigValue(
  Key key,
  uint64_t val
)

WriteConfigValueBin

WEAVE_ERROR WriteConfigValueBin(
  Key key,
  const uint8_t *data,
  size_t dataLen
)

WriteConfigValueStr

WEAVE_ERROR WriteConfigValueStr(
  Key key,
  const char *str
)

WriteConfigValueStr

WEAVE_ERROR WriteConfigValueStr(
  Key key,
  const char *str,
  size_t strLen
)

保護された静的関数

DoAsyncFDSOp

WEAVE_ERROR DoAsyncFDSOp(
  FDSAsyncOp & asyncOp
)

FDSWords

constexpr uint16_t FDSWords(
  size_t s
)

指定されたサイズオブジェクトを保持するために必要な FDS ワードの数。

ForEachRecord

WEAVE_ERROR ForEachRecord(
  uint16_t fileId,
  uint16_t recordKey,
  ForEachRecordFunct funct
)

GetFileId

constexpr uint16_t GetFileId(
  uint32_t key
)

キー値から FDS ファイル ID を抽出します。

GetRecordKey

constexpr uint16_t GetRecordKey(
  uint32_t key
)

キー値から FDS レコードキーを抽出します。

OpenRecord

WEAVE_ERROR OpenRecord(
  NRF5Config::Key key,
  fds_record_desc_t & recDesc,
  fds_flash_record_t & rec
)