透過集合功能整理內容 你可以依據偏好儲存及分類內容。

nl::Weave::DeviceLayer::內部::NRF5Config

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

提供用於在北歐 nRF5 SDK 平台上存取永久裝置設定的功能和定義。

總結

此實作會使用北歐 Flash 資料儲存 (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 的上限值 (每個北歐 SDK)
kFDSFileIdMin = 0x0000
constexpr uint16_t
可用於 FDS 檔案 ID 的最小值 (每個北歐 SDK)
kFDSRecordKeyMax = 0xBFFF
constexpr uint16_t
可用於 FDS 記錄鍵的最大值 (每個北歐 SDK)
kFDSRecordKeyMin = 0x0001
constexpr uint16_t
用於 FDS 記錄鍵的最小值 (每個北歐 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)
ConfigValueExists(Key key)
bool
FactoryResetConfig(void)
Init(void)
ReadConfigValue(Key key, bool & val)
ReadConfigValue(Key key, uint32_t & val)
ReadConfigValue(Key key, uint64_t & val)
ReadConfigValueBin(Key key, uint8_t *buf, size_t bufSize, size_t & outLen)
ReadConfigValueStr(Key key, char *buf, size_t bufSize, size_t & outLen)
RunConfigUnitTest(void)
void
WriteConfigValue(Key key, bool val)
WriteConfigValue(Key key, uint32_t val)
WriteConfigValue(Key key, uint64_t val)
WriteConfigValueBin(Key key, const uint8_t *data, size_t dataLen)
WriteConfigValueStr(Key key, const char *str)
WriteConfigValueStr(Key key, const char *str, size_t strLen)

受保護的靜態函式

DoAsyncFDSOp(FDSAsyncOp & asyncOp)
FDSWords(size_t s)
constexpr uint16_t
持有指定大小物件所需的 FDS 字詞數量。
ForEachRecord(uint16_t fileId, uint16_t recordKey, ForEachRecordFunct funct)
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)

公開類型

uint32_t Key

受保護類型

每次錄音基金

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_ManufactuceDate

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_PairedAccount 編號

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 的上限值 (每個北歐 SDK)

kFDSFileIdMin

constexpr uint16_t kFDSFileIdMin = 0x0000

可用於 FDS 檔案 ID 的最小值 (每個北歐 SDK)

kFDSRecordKeyMax

constexpr uint16_t kFDSRecordKeyMax = 0xBFFF

可用於 FDS 記錄鍵的最大值 (每個北歐 SDK)

kFDSRecordKeyMin

constexpr uint16_t kFDSRecordKeyMin = 0x0001

用於 FDS 記錄鍵的最小值 (每個北歐 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

sAsyncOpCompleteSem

SemaphoreHandle_t sAsyncOpCompletionSem

公開的靜態函式

ClearConfig 值

WEAVE_ERROR ClearConfigValue(
  Key key
)

ConfigValueExist

bool ConfigValueExists(
  Key key
)

恢復原廠設定設定

WEAVE_ERROR FactoryResetConfig(
  void
)

Init

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
)

ReadConfigValueBin

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
)

執行單元測試

void RunConfigUnitTest(
  void
)

寫入設定值

WEAVE_ERROR 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
)

受保護的靜態函式

DoAsyncFDSOp

WEAVE_ERROR DoAsyncFDSOp(
  FDSAsyncOp & asyncOp
)

FDS 字

constexpr uint16_t FDSWords(
  size_t s
)

持有指定大小物件所需的 FDS 字詞數量。

每次記錄

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

取得檔案 ID

constexpr uint16_t GetFileId(
  uint32_t key
)

從鍵值中擷取 FDS 檔案 ID。

取得記錄金鑰

constexpr uint16_t GetRecordKey(
  uint32_t key
)

從鍵值中擷取 FDS 記錄鍵。

開啟紀錄

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