Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.
Trang này được dịch bởi Cloud Translation API.
Switch to English

nl :: Dệt :: DeviceLayer :: Nội bộ :: NRF5Config

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

Cung cấp các chức năng và định nghĩa để truy cập cấu hình thiết bị lâu dài trên các nền tảng dựa trên SDK nRF5 Bắc Âu.

Tóm lược

Việc triển khai này sử dụng thư viện Nordic Flash Data Storage (FDS) làm lớp lưu trữ bên dưới.

LƯU Ý: Lớp này được thiết kế để trộn vào lớp con cụ thể của mẫu GenericConfigurationManagerImpl <>. Khi được sử dụng theo cách này, lớp sẽ tự nhiên cung cấp các triển khai cho các thành viên được ủy quyền được tham chiếu bởi lớp mẫu (ví dụ: phương thức ReadConfigValue ()).

Di sản

Các lớp con đã biết trực tiếp:
  nl :: Weave :: DeviceLayer :: ConfigurationManagerImpl
  nl :: Weave :: DeviceLayer :: Internal :: GroupKeyStoreImpl

Các loại công khai

Key sử dụng
uint32_t

Các loại được bảo vệ

ForEachRecordFunct sử dụng
std::function< WEAVE_ERROR (const fds_flash_record_t &rec, bool &deleteRec)>

Thuộc tính tĩnh công khai

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
Giá trị tối đa có thể được sử dụng cho id tệp FDS (cho mỗi SDK Bắc Âu)
kFDSFileIdMin = 0x0000
constexpr uint16_t
Giá trị tối thiểu có thể được sử dụng cho id tệp FDS (cho mỗi SDK Bắc Âu)
kFDSRecordKeyMax = 0xBFFF
constexpr uint16_t
Giá trị tối đa có thể được sử dụng cho khóa bản ghi FDS (cho mỗi SDK Bắc Âu)
kFDSRecordKeyMin = 0x0001
constexpr uint16_t
Giá trị tối thiểu có thể được sử dụng cho khóa bản ghi FDS (cho mỗi SDK Bắc Âu)
kFileId_WeaveConfig = 0x235B
constexpr uint16_t
Tệp FDS chứa các giá trị cấu hình động được đặt trong thời gian chạy.
kFileId_WeaveCounter = 0x235C
constexpr uint16_t
Tệp FDS chứa các giá trị bộ đếm động được đặt trong thời gian chạy.
kFileId_WeaveFactory = 0x235A
constexpr uint16_t
Tệp FDS chứa các giá trị cấu hình liên tục được đặt tại thời điểm sản xuất.
kPersistedCounterRecordKeyBase = kFDSRecordKeyMin
constexpr uint16_t
Khóa bản ghi cơ sở cho các bản ghi chứa giá trị bộ đếm liên tục Weave.
kPersistedCounterRecordKeyMax = kFDSRecordKeyMax
constexpr uint16_t
Khóa bản ghi tối đa cho các bản ghi chứa giá trị bộ đếm liên tục Weave.

Các thuộc tính tĩnh được bảo vệ

kFDSWordSize = 4
constexpr uint16_t
sActiveAsyncOp
FDSAsyncOp *volatile
sAsyncOpCompletionSem
SemaphoreHandle_t

Chức năng tĩnh công khai

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)

Các chức năng tĩnh được bảo vệ

DoAsyncFDSOp ( FDSAsyncOp & asyncOp)
FDSWords (size_t s)
constexpr uint16_t
Số lượng từ FDS cần thiết để chứa một đối tượng kích thước nhất định.
ForEachRecord (uint16_t fileId, uint16_t recordKey, ForEachRecordFunct funct)
GetFileId (uint32_t key)
constexpr uint16_t
Trích xuất một id tệp FDS từ một giá trị Khóa.
GetRecordKey (uint32_t key)
constexpr uint16_t
Trích xuất khóa bản ghi FDS từ giá trị Khóa.
OpenRecord (NRF5Config::Key key, fds_record_desc_t & recDesc, fds_flash_record_t & rec)

Các loại công khai

Chìa khóa

uint32_t Key

Các loại được bảo vệ

ForEachRecordFunct

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

Thuộc tính tĩnh công khai

kConfigKey_FnaiId

constexpr Key kConfigKey_FabricId = NRF5ConfigKey(kFileId_WeaveConfig,  0x0007)

kConfigKey_FnaiSecret

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_ManosystemuringDate

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_PairsAccountId

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

Giá trị tối đa có thể được sử dụng cho id tệp FDS (cho mỗi SDK Bắc Âu)

kFDSFileIdMin

constexpr uint16_t kFDSFileIdMin = 0x0000

Giá trị tối thiểu có thể được sử dụng cho id tệp FDS (cho mỗi SDK Bắc Âu)

kFDSRecordKeyMax

constexpr uint16_t kFDSRecordKeyMax = 0xBFFF

Giá trị tối đa có thể được sử dụng cho khóa bản ghi FDS (cho mỗi SDK Bắc Âu)

kFDSRecordKeyMin

constexpr uint16_t kFDSRecordKeyMin = 0x0001

Giá trị tối thiểu có thể được sử dụng cho khóa bản ghi FDS (cho mỗi SDK Bắc Âu)

kFileId_WeaveConfig

constexpr uint16_t kFileId_WeaveConfig = 0x235B

Tệp FDS chứa các giá trị cấu hình động được đặt trong thời gian chạy.

Đã xóa trong khi khôi phục cài đặt gốc.

kFileId_WeaveCounter

constexpr uint16_t kFileId_WeaveCounter = 0x235C

Tệp FDS chứa các giá trị bộ đếm động được đặt trong thời gian chạy.

Được giữ lại trong quá trình khôi phục cài đặt gốc.

kFileId_WeaveFactory

constexpr uint16_t kFileId_WeaveFactory = 0x235A

Tệp FDS chứa các giá trị cấu hình liên tục được đặt tại thời điểm sản xuất.

Được giữ lại khi khôi phục cài đặt gốc.

kPersistedCounterRecordKeyBase

constexpr uint16_t kPersistedCounterRecordKeyBase = kFDSRecordKeyMin

Khóa bản ghi cơ sở cho các bản ghi chứa giá trị bộ đếm liên tục Weave.

Id bộ đếm Weave được thêm vào giá trị này để tạo thành khóa bản ghi FDS.

kPersistedCounterRecordKeyMax

constexpr uint16_t kPersistedCounterRecordKeyMax = kFDSRecordKeyMax

Khóa bản ghi tối đa cho các bản ghi có chứa giá trị bộ đếm liên tục Weave.

Thuộc tính tĩnh được bảo vệ

kFDSWordSize

constexpr uint16_t kFDSWordSize = 4

sActiveAsyncOp

FDSAsyncOp *volatile sActiveAsyncOp

sAsyncOpCompletionSem

SemaphoreHandle_t sAsyncOpCompletionSem

Chức năng tĩnh công khai

ClearConfigValue

WEAVE_ERROR ClearConfigValue(
  Key key
)

ConfigValueExists

bool ConfigValueExists(
  Key key
)

FactoryResetConfig

WEAVE_ERROR FactoryResetConfig(
  void
)

Trong đó

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
)

Các chức năng tĩnh được bảo vệ

DoAsyncFDSOp

WEAVE_ERROR DoAsyncFDSOp(
  FDSAsyncOp & asyncOp
)

FDS AdWords

constexpr uint16_t FDSWords(
  size_t s
)

Số lượng từ FDS cần thiết để chứa một đối tượng kích thước nhất định.

ForEachRecord

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

GetFileId

constexpr uint16_t GetFileId(
  uint32_t key
)

Trích xuất id tệp FDS từ giá trị Khóa.

GetRecordKey

constexpr uint16_t GetRecordKey(
  uint32_t key
)

Trích xuất khóa bản ghi FDS từ giá trị Khóa.

OpenRecord

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