nl:: بافت:: DeviceLayer:: داخلی:: 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)
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 را از یک مقدار Key استخراج کنید.
GetRecordKey (uint32_t key)
constexpr uint16_t
یک کلید رکورد FDS را از یک مقدار Key استخراج کنید.
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)

kFDSFileIdMin

constexpr uint16_t kFDSFileIdMin = 0x0000

حداقل مقدار قابل استفاده برای شناسه فایل FDS (به ازای نوردیک 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 به این مقدار اضافه می شود تا کلید رکورد 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 را از یک مقدار Key استخراج کنید.

GetRecordKey

constexpr uint16_t GetRecordKey(
  uint32_t key
)

یک کلید رکورد FDS را از یک مقدار Key استخراج کنید.

OpenRecord

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