nl:: Weave:: DeviceLayer:: Internal:: NRF5Config
#include <src/adaptations/device-layer/include/Weave/DeviceLayer/nRF5/nRF5Config.h>
توفِّر هذه السياسة وظائف وتعريفات للوصول إلى إعدادات الجهاز الدائمة على الأنظمة الأساسية استنادًا إلى حزمة تطوير البرامج Nordic nRF5.
ملخّص
وتستخدم عملية التنفيذ هذه مكتبة 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 (لكل حزمة Nordic SDK)
|
kFDSFileIdMin = 0x0000
|
constexpr uint16_t
الحد الأدنى للقيمة التي يمكن استخدامها لرقم تعريف ملف FDS (لكل حزمة Nordic SDK)
|
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 (لكل حزمة Nordic SDK)
kFDSFileIdMin
constexpr uint16_t kFDSFileIdMin = 0x0000
الحد الأدنى للقيمة التي يمكن استخدامها لرقم تعريف ملف FDS (لكل حزمة Nordic SDK)
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 )