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 ได้ (ตาม SDK ของ Nordic)
kFDSFileIdMin = 0x0000
constexpr uint16_t
ค่าขั้นต่ำที่ใช้กับรหัสไฟล์ FDS ได้ (ตาม SDK ของ Nordic)
kFDSRecordKeyMax = 0xBFFF
constexpr uint16_t
ค่าสูงสุดที่ใช้สำหรับคีย์ระเบียน FDS (ตาม SDK ของ Nordic)
kFDSRecordKeyMin = 0x0001
constexpr uint16_t
ค่าขั้นต่ำที่ใช้กับคีย์ระเบียน FDS ได้ (ตาม SDK ของ Nordic)
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 จากค่าคีย์
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

ประเภทที่ได้รับการป้องกัน

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 ได้ (ตาม SDK ของ Nordic)

kFDSFileIdMin

constexpr uint16_t kFDSFileIdMin = 0x0000

ค่าขั้นต่ำที่ใช้กับรหัสไฟล์ FDS ได้ (ตาม SDK ของ Nordic)

kFDSRecordKeyMax

constexpr uint16_t kFDSRecordKeyMax = 0xBFFF

ค่าสูงสุดที่ใช้สำหรับคีย์ระเบียน FDS (ตาม SDK ของ Nordic)

kFDSRecordKeyMin

constexpr uint16_t kFDSRecordKeyMin = 0x0001

ค่าขั้นต่ำที่ใช้กับคีย์ระเบียน FDS ได้ (ตาม SDK ของ Nordic)

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 ลงในค่านี้เพื่อสร้างคีย์ระเบียน 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
)

เริ่มต้น

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 จากค่าคีย์

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
)