nl:: Weave:: DeviceLayer:: Internal:: NRF5Config
#include <src/adaptations/device-layer/include/Weave/DeviceLayer/nRF5/nRF5Config.h>
Fornece funções e definições para acessar a configuração de dispositivos persistida em plataformas com base no SDK Nordic nRF5.
Resumo
Essa implementação usa a biblioteca Nórdica Flash Data Storage (FDS) como a camada de armazenamento subjacente.
OBSERVAÇÃO: esta classe foi projetada para ser mesclada à subclasse concreta do modelo GenericConfigurationManagerImpl<> . Quando usada dessa maneira, a classe fornece naturalmente implementações para os membros delegados referenciados pela classe do modelo (por exemplo, o método ReadConfigValue()).
Herança
Subclasses conhecidas conhecidas:nl::Weave::DeviceLayer::ConfigurationManagerImpl
nl::Weave::DeviceLayer::Internal::GroupKeyStoreImpl
Tipos públicos |
|
---|---|
Key
|
usinguint32_t
|
Tipos protegidos |
|
---|---|
ForEachRecordFunct
|
usingstd::function< WEAVE_ERROR(const fds_flash_record_t &rec, bool &deleteRec)>
|
Atributos estáticos públicos |
|
---|---|
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
Valor máximo que pode ser usado para um ID de arquivo FDS (por SDK nórdico)
|
kFDSFileIdMin = 0x0000
|
constexpr uint16_t
Valor mínimo que pode ser usado para um ID de arquivo FDS (por SDK nórdico)
|
kFDSRecordKeyMax = 0xBFFF
|
constexpr uint16_t
Valor máximo que pode ser usado para uma chave de registro FDS (por SDK nórdico)
|
kFDSRecordKeyMin = 0x0001
|
constexpr uint16_t
Valor mínimo que pode ser usado para uma chave de registro FDS (por SDK nórdico)
|
kFileId_WeaveConfig = 0x235B
|
constexpr uint16_t
Arquivo FDS com valores de configuração dinâmicos definidos no momento da execução.
|
kFileId_WeaveCounter = 0x235C
|
constexpr uint16_t
Arquivo FDS com valores de contador dinâmico definidos no tempo de execução.
|
kFileId_WeaveFactory = 0x235A
|
constexpr uint16_t
Arquivo FDS com valores de configuração permanentes definidos no momento da fabricação.
|
kPersistedCounterRecordKeyBase = kFDSRecordKeyMin
|
constexpr uint16_t
Chave de registro base para registros que contêm valores de contador persistentes do Weave
|
kPersistedCounterRecordKeyMax = kFDSRecordKeyMax
|
constexpr uint16_t
Chave de registro máxima para registros que contêm valores de contador persistentes do Weave.
|
Atributos estáticos protegidos |
|
---|---|
kFDSWordSize = 4
|
constexpr uint16_t
|
sActiveAsyncOp
|
FDSAsyncOp *volatile
|
sAsyncOpCompletionSem
|
SemaphoreHandle_t
|
Funções estáticas públicas |
|
---|---|
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)
|
Funções estáticas protegidas |
|
---|---|
DoAsyncFDSOp(FDSAsyncOp & asyncOp)
|
|
FDSWords(size_t s)
|
constexpr uint16_t
Número de palavras FDS necessárias para armazenar um determinado objeto de tamanho.
|
ForEachRecord(uint16_t fileId, uint16_t recordKey, ForEachRecordFunct funct)
|
|
GetFileId(uint32_t key)
|
constexpr uint16_t
Extraia um ID de arquivo FDS de um valor de chave.
|
GetRecordKey(uint32_t key)
|
constexpr uint16_t
Extrair uma chave de registro FDS de um valor Key.
|
OpenRecord(NRF5Config::Key key, fds_record_desc_t & recDesc, fds_flash_record_t & rec)
|
Tipos públicos
Chave
uint32_t Key
Tipos protegidos
Função
std::function< WEAVE_ERROR(const fds_flash_record_t &rec, bool &deleteRec)> ForEachRecordFunct
Atributos estáticos públicos
kConfigKey_FabricId
constexpr Key kConfigKey_FabricId = NRF5ConfigKey(kFileId_WeaveConfig, 0x0007)
kConfigKey_FabricSecret
constexpr Key kConfigKey_FabricSecret = NRF5ConfigKey(kFileId_WeaveConfig, 0x000B)
kConfigKey_FailedSafeArmed
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_ManufabricingDate
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
Valor máximo que pode ser usado para um ID de arquivo FDS (por SDK nórdico)
kFDSFileIdMin
constexpr uint16_t kFDSFileIdMin = 0x0000
Valor mínimo que pode ser usado para um ID de arquivo FDS (por SDK nórdico)
kFDSRecordKeyMax
constexpr uint16_t kFDSRecordKeyMax = 0xBFFF
Valor máximo que pode ser usado para uma chave de registro FDS (por SDK nórdico)
kFDSRecordKeyMin
constexpr uint16_t kFDSRecordKeyMin = 0x0001
Valor mínimo que pode ser usado para uma chave de registro FDS (por SDK nórdico)
kFileId_WeaveConfig.
constexpr uint16_t kFileId_WeaveConfig = 0x235B
Arquivo FDS com valores de configuração dinâmicos definidos no momento da execução.
Apagado durante a redefinição para a configuração original.
kFileId_WeaveCounter
constexpr uint16_t kFileId_WeaveCounter = 0x235C
Arquivo FDS com valores de contador dinâmico definidos no tempo de execução.
Retido durante a redefinição para a configuração original.
kFileId_WeaveFactory
constexpr uint16_t kFileId_WeaveFactory = 0x235A
Arquivo FDS com valores de configuração permanentes definidos no momento da fabricação.
Retido durante a redefinição para a configuração original.
kPersistedCounterRecordKeyBase
constexpr uint16_t kPersistedCounterRecordKeyBase = kFDSRecordKeyMin
Chave de registro base para registros que contêm valores de contador persistentes do Weave
O ID do contador do Weave é adicionado a esse valor para formar a chave de registro do FDS.
kPersistedCounterRecordKeyMax
constexpr uint16_t kPersistedCounterRecordKeyMax = kFDSRecordKeyMax
Chave de registro máxima para registros que contêm valores de contador persistentes do Weave.
Atributos estáticos protegidos
kFDSWordSize
constexpr uint16_t kFDSWordSize = 4
sActiveAsyncOp
FDSAsyncOp *volatile sActiveAsyncOp
SAsyncOpCompleteSem
SemaphoreHandle_t sAsyncOpCompletionSem
Funções estáticas públicas
ValorDoConfig
WEAVE_ERROR ClearConfigValue( Key key )
ConfigValueExists
bool ConfigValueExists( Key key )
Redefinir para configuração original
WEAVE_ERROR FactoryResetConfig( void )
Init
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 )
Teste de unidade de configuração
void RunConfigUnitTest( void )
Valor de gravação
WEAVE_ERROR WriteConfigValue( Key key, bool val )
Valor de gravação
WEAVE_ERROR WriteConfigValue( Key key, uint32_t val )
Valor de gravação
WEAVE_ERROR WriteConfigValue( Key key, uint64_t val )
GraveConfigValueBin
WEAVE_ERROR WriteConfigValueBin( Key key, const uint8_t *data, size_t dataLen )
GravarConfigValueStr
WEAVE_ERROR WriteConfigValueStr( Key key, const char *str )
GravarConfigValueStr
WEAVE_ERROR WriteConfigValueStr( Key key, const char *str, size_t strLen )
Funções estáticas protegidas
DoAsyncFDSOp (em inglês)
WEAVE_ERROR DoAsyncFDSOp( FDSAsyncOp & asyncOp )
Palavras FDS
constexpr uint16_t FDSWords( size_t s )
Número de palavras FDS necessárias para armazenar um determinado objeto de tamanho.
ForEveryRecord
WEAVE_ERROR ForEachRecord( uint16_t fileId, uint16_t recordKey, ForEachRecordFunct funct )
GetFileId.
constexpr uint16_t GetFileId( uint32_t key )
Extraia um ID de arquivo FDS de um valor de chave.
GetRecordKey
constexpr uint16_t GetRecordKey( uint32_t key )
Extrair uma chave de registro FDS de um valor Key.
Registro aberto
WEAVE_ERROR OpenRecord( NRF5Config::Key key, fds_record_desc_t & recDesc, fds_flash_record_t & rec )