تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

nl::Weave::DeviceLayer::داخلي::NRF5Config

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

توفّر وظائف وتعريفات للوصول إلى إعدادات الجهاز المستمرة على الأنظمة الأساسية استنادًا إلى Nordic nRF5 SDK.

الملخّص

ويستخدم هذا التنفيذ مكتبة Nordic Flash Data Storage (FDS) كطبقة تخزين أساسية.

ملاحظة: تم تصميم هذه الفئة ليتم دمجها مع الفئة الفرعية الخرسانية من النموذج GeneralConfigurationManagerImpl<>. وعند استخدام هذه الطريقة، تقدِّم الفئة عمليات تنفيذ للأعضاء المُفوَّضين الذين تمت الإشارة إليهم من خلال فئة النموذج (مثل طريقة 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 (لكل حزمة تطوير برامج (Nodic SDK))
kFDSFileIdMin = 0x0000
constexpr uint16_t
الحد الأدنى للقيمة التي يمكن استخدامها لمعرّف ملف FDS (لكل حزمة تطوير برامج الشمال)
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)
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

الأنواع المحمية

تسجيل كل سجلّ

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_ManufacttureDate

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_OperaativeDeviceCert

constexpr Key kConfigKey_OperationalDeviceCert = NRF5ConfigKey(kFileId_WeaveConfig,  0x0012)

kConfigKey_OperaativeDeviceICACerts

constexpr Key kConfigKey_OperationalDeviceICACerts = NRF5ConfigKey(kFileId_WeaveConfig,  0x0013)

kConfigKey_OperaativeDeviceId

constexpr Key kConfigKey_OperationalDeviceId = NRF5ConfigKey(kFileId_WeaveConfig,  0x0011)

kConfigKey_OperaativeDevicePrivateKey

constexpr Key kConfigKey_OperationalDevicePrivateKey = NRF5ConfigKey(kFileId_WeaveConfig,  0x0014)

kConfigKey_إقرانedId

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 (لكل حزمة تطوير برامج (Nodic SDK))

kFDSFileIdMin

constexpr uint16_t kFDSFileIdMin = 0x0000

الحد الأدنى للقيمة التي يمكن استخدامها لمعرّف ملف FDS (لكل حزمة تطوير برامج الشمال)

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_WeaveMan

constexpr uint16_t kFileId_WeaveFactory = 0x235A

ملف FDS يحتوي على قيم تهيئة دائمة يتم تعيينها في وقت التصنيع.

يتم الاحتفاظ بالبيانات أثناء إعادة الضبط على الإعدادات الأصلية.

kPersistedCounterRecordKeyBase

constexpr uint16_t kPersistedCounterRecordKeyBase = kFDSRecordKeyMin

مفتاح السجلّ الأساسي للسجلات التي تحتوي على قيم عدّاد مستمد من Weave.

تتم إضافة معرّف مضاد Weave إلى هذه القيمة لإنشاء مفتاح سجل FDS.

kPersistedCounterRecordKeyMax

constexpr uint16_t kPersistedCounterRecordKeyMax = kFDSRecordKeyMax

الحد الأقصى لمفتاح التسجيل للسجلات التي تحتوي على قيم عدّاد مستمد من Weave.

السمات الثابتة المحمية

حجم الكلمات على الصفحة

constexpr uint16_t kFDSWordSize = 4

SActiveAsyncOp

FDSAsyncOp *volatile sActiveAsyncOp

SasyncOpComplesSem

SemaphoreHandle_t sAsyncOpCompletionSem

الدوال الثابتة العامة

قيمة_الضبط

WEAVE_ERROR ClearConfigValue(
  Key key
)

ConfigValueExists

bool ConfigValueExists(
  Key key
)

إعادة الضبط على الإعدادات الأصلية

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

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
)

رقم تعريف GetFile

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
)