nl:: Weave:: DeviceLayer:: Internal:: NRF5Config
#include <src/adaptations/device-layer/include/Weave/DeviceLayer/nRF5/nRF5Config.h>
यह नॉर्डिक nRF5 SDK टूल पर आधारित प्लैटफ़ॉर्म पर, डिवाइस के किसी मौजूदा कॉन्फ़िगरेशन को ऐक्सेस करने के लिए फ़ंक्शन और परिभाषाएं बताता है.
खास जानकारी
यह लागू करने के लिए, स्टोरेज लेयर के तौर पर नॉर्डिक फ़्लैश डेटा स्टोरेज (एफ़डीएस) लाइब्रेरी का इस्तेमाल किया जाता है.
ध्यान दें: इस क्लास को जेनेरिकConfigurationManagerImpl<> टेंप्लेट के कंक्रीट सब-क्लास में मिलाने के लिए डिज़ाइन किया गया है. इस तरह इस्तेमाल किए जाने पर, क्लास स्वाभाविक रूप से, टेंप्लेट क्लास (उदाहरण के लिए, 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 टूल के हिसाब से)
|
kFDSFileIdMin = 0x0000
|
constexpr uint16_t
FDS फ़ाइल आईडी के लिए इस्तेमाल की जा सकने वाली कम से कम वैल्यू (नॉर्डिक SDK टूल के हिसाब से)
|
kFDSRecordKeyMax = 0xBFFF
|
constexpr uint16_t
एफ़डीएस रिकॉर्ड कुंजी के लिए इस्तेमाल की जा सकने वाली ज़्यादा से ज़्यादा वैल्यू (नॉर्डिक SDK टूल के हिसाब से)
|
kFDSRecordKeyMin = 0x0001
|
constexpr uint16_t
FDS रिकॉर्ड कुंजी के लिए इस्तेमाल की जा सकने वाली कम से कम वैल्यू (नॉर्डिक SDK टूल के हिसाब से)
|
kFileId_WeaveConfig = 0x235B
|
constexpr uint16_t
रनटाइम के दौरान सेट की गई डाइनैमिक कॉन्फ़िगरेशन वैल्यू वाली एफ़डीएस फ़ाइल.
|
kFileId_WeaveCounter = 0x235C
|
constexpr uint16_t
रनटाइम के दौरान सेट की गई डाइनैमिक काउंटर वैल्यू वाली एफ़डीएस फ़ाइल.
|
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
दिए गए साइज़ वाले ऑब्जेक्ट को होल्ड करने के लिए, एफ़डीएस शब्दों की संख्या.
|
ForEachRecord(uint16_t fileId, uint16_t recordKey, ForEachRecordFunct funct)
|
|
GetFileId(uint32_t key)
|
constexpr uint16_t
कुंजी की वैल्यू से FDS फ़ाइल आईडी एक्सट्रैक्ट करें.
|
GetRecordKey(uint32_t key)
|
constexpr uint16_t
कुंजी की वैल्यू से एफ़डीएस रिकॉर्ड कुंजी एक्सट्रैक्ट करें.
|
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
एफ़डीएस रिकॉर्ड कुंजी के लिए इस्तेमाल की जा सकने वाली ज़्यादा से ज़्यादा वैल्यू (नॉर्डिक SDK टूल के हिसाब से)
kFDSRecordKeyMin
constexpr uint16_t kFDSRecordKeyMin = 0x0001
FDS रिकॉर्ड कुंजी के लिए इस्तेमाल की जा सकने वाली कम से कम वैल्यू (नॉर्डिक SDK टूल के हिसाब से)
kFileId_WeaveConfig
constexpr uint16_t kFileId_WeaveConfig = 0x235B
रनटाइम के दौरान सेट की गई डाइनैमिक कॉन्फ़िगरेशन वैल्यू वाली एफ़डीएस फ़ाइल.
फ़ैक्ट्री रीसेट करने के दौरान मिटा दिया गया.
kFileId_WeaveCounter
constexpr uint16_t kFileId_WeaveCounter = 0x235C
रनटाइम के दौरान सेट की गई डाइनैमिक काउंटर वैल्यू वाली एफ़डीएस फ़ाइल.
फ़ैक्ट्री रीसेट करने के दौरान, उन फ़ाइलों को सेव करके रखा जाएगा.
kFileId_WeaveFactory
constexpr uint16_t kFileId_WeaveFactory = 0x235A
FDS फ़ाइल, जिसमें मैन्युफ़ैक्चरिंग के समय सेट की गई स्थायी कॉन्फ़िगरेशन वैल्यू मौजूद हैं.
फ़ैक्ट्री रीसेट करने के दौरान, उन फ़ाइलों को सेव करके रखा जाएगा.
kPersistedCounterRecordKeyBase
constexpr uint16_t kPersistedCounterRecordKeyBase = kFDSRecordKeyMin
Weave बनाए रखने वाली काउंटर वैल्यू वाले रिकॉर्ड के लिए बेस रिकॉर्ड कुंजी.
एफ़डीएस रिकॉर्ड कुंजी बनाने के लिए, इस वैल्यू में Weave काउंटर आईडी जोड़ा जाता है.
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 )
दिए गए साइज़ वाले ऑब्जेक्ट को होल्ड करने के लिए, एफ़डीएस शब्दों की संख्या.
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 )
कुंजी की वैल्यू से एफ़डीएस रिकॉर्ड कुंजी एक्सट्रैक्ट करें.
OpenRecord
WEAVE_ERROR OpenRecord( NRF5Config::Key key, fds_record_desc_t & recDesc, fds_flash_record_t & rec )