Se usó la API de Cloud Translation para traducir esta página.

nl::Weave::DeviceLayer::Internal::NRF5Config

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

Proporciona funciones y definiciones para acceder a la configuración de dispositivos persistentes en plataformas basadas en el SDK nRF5 nórdico.

Resumen

Esta implementación usa la biblioteca de Nordic Flash Data Storage (FDS) como capa de almacenamiento subyacente.

NOTA: Esta clase está diseñada para combinarse con la subclase concreta de la plantilla GenericConfigurationManagerImpl<> Cuando se usa de esta manera, la clase proporciona de manera natural implementaciones para los miembros delegados a los que hace referencia la clase de plantilla (p.ej., el método ReadConfigValue()).

Herencia

Subclases conocidas directas:
nl::Weave::DeviceLayer::ConfigurationManagerImpl
nl::Weave::DeviceLayer::Internal::GroupKeyStoreImpl

Tipos públicos
`Key`	using `uint32_t`

Tipos protegidos
`ForEachRecordFunct`	using `std::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 se puede usar en un ID de archivo FDS (por SDK nórdico)
`kFDSFileIdMin = 0x0000`	`constexpr uint16_t` Valor mínimo que se puede usar para un ID de archivo FDS (por SDK nórdico)
`kFDSRecordKeyMax = 0xBFFF`	`constexpr uint16_t` Valor máximo que se puede usar en una clave de registro FDS (por SDK nórdico)
`kFDSRecordKeyMin = 0x0001`	`constexpr uint16_t` Valor mínimo que se puede usar para una clave de registro FDS (por SDK nórdico)
`kFileId_WeaveConfig = 0x235B`	`constexpr uint16_t` Archivo FDS que contiene valores de configuración dinámicos configurados en el entorno de ejecución.
`kFileId_WeaveCounter = 0x235C`	`constexpr uint16_t` Archivo FDS que contiene valores de contador dinámicos configurados en el tiempo de ejecución.
`kFileId_WeaveFactory = 0x235A`	`constexpr uint16_t` Archivo FDS que contiene valores de configuración persistentes configurados en el momento de la fabricación
`kPersistedCounterRecordKeyBase = kFDSRecordKeyMin`	`constexpr uint16_t` Clave de registro base para los registros que contienen valores de contador persistentes de Weave.
`kPersistedCounterRecordKeyMax = kFDSRecordKeyMax`	`constexpr uint16_t` Clave de registro máx. para los registros que contienen valores de contador persistentes de Weave.

Atributos estáticos protegidos
`kFDSWordSize = 4`	`constexpr uint16_t`
`sActiveAsyncOp`	`FDSAsyncOp *volatile`
`sAsyncOpCompletionSem`	`SemaphoreHandle_t`

Funciones estáticas públicas
`ClearConfigValue(Key key)`	`WEAVE_ERROR`
`ConfigValueExists(Key key)`	`bool`
`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)`	`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)`	`WEAVE_ERROR`
`RunConfigUnitTest(void)`	`void`
`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)`	`WEAVE_ERROR`

Funciones estáticas protegidas
`DoAsyncFDSOp(FDSAsyncOp & asyncOp)`	`WEAVE_ERROR`
`FDSWords(size_t s)`	`constexpr uint16_t` Cantidad de palabras FDS necesarias para contener un objeto de tamaño determinado.
`ForEachRecord(uint16_t fileId, uint16_t recordKey, ForEachRecordFunct funct)`	`WEAVE_ERROR`
`GetFileId(uint32_t key)`	`constexpr uint16_t` Extrae un ID de archivo FDS de un par clave-valor.
`GetRecordKey(uint32_t key)`	`constexpr uint16_t` Extrae una clave de registro FDS de un valor de Key.
`OpenRecord(NRF5Config::Key key, fds_record_desc_t & recDesc, fds_flash_record_t & rec)`	`WEAVE_ERROR`

Tipos públicos

Clave

uint32_t Key

Tipos protegidos

Por cadaRecordFunct

std::function< WEAVE_ERROR(const fds_flash_record_t &rec, bool &deleteRec)> ForEachRecordFunct

Atributos estáticos públicos

ID_de_kConfigKey_Fabric

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)

KKeyKey_GroupKey

constexpr Key kConfigKey_GroupKey = NRF5ConfigKey(kFileId_WeaveConfig,  0x000E)

ID del método kConfigKey_LastUsedEpochKey

constexpr Key kConfigKey_LastUsedEpochKeyId = NRF5ConfigKey(kFileId_WeaveConfig,  0x000C)

kConfigKey_ManufactureDate

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)

ID del método kConfigKey_OperationalDeviceId

constexpr Key kConfigKey_OperationalDeviceId = NRF5ConfigKey(kFileId_WeaveConfig,  0x0011)

kConfigKey_OperationalDevicePrivateKey

constexpr Key kConfigKey_OperationalDevicePrivateKey = NRF5ConfigKey(kFileId_WeaveConfig,  0x0014)

ID del método kConfigKey_PairedAccount

constexpr Key kConfigKey_PairedAccountId = NRF5ConfigKey(kFileId_WeaveConfig,  0x0009)

Código de clave de configuración de kConfigKey

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)

ID del servicio de clave de configuración

constexpr Key kConfigKey_ServiceId = NRF5ConfigKey(kFileId_WeaveConfig,  0x000A)

kFDSFileIdMax

constexpr uint16_t kFDSFileIdMax = 0xBFFF

Valor máximo que se puede usar en un ID de archivo FDS (por SDK nórdico)

kFDSFileIdMin

constexpr uint16_t kFDSFileIdMin = 0x0000

Valor mínimo que se puede usar para un ID de archivo FDS (por SDK nórdico)

kFDSRecordKeyMax

constexpr uint16_t kFDSRecordKeyMax = 0xBFFF

Valor máximo que se puede usar en una clave de registro FDS (por SDK nórdico)

kFDSRecordKeyMin

constexpr uint16_t kFDSRecordKeyMin = 0x0001

Valor mínimo que se puede usar para una clave de registro FDS (por SDK nórdico)

kFileId_WeaveConfig

constexpr uint16_t kFileId_WeaveConfig = 0x235B

Archivo FDS que contiene valores de configuración dinámicos configurados en el entorno de ejecución.

Se borra al restablecer la configuración de fábrica.

kFileId_WeaveCounter

constexpr uint16_t kFileId_WeaveCounter = 0x235C

Archivo FDS que contiene valores de contador dinámicos configurados en el tiempo de ejecución.

Se retienen durante el restablecimiento de la configuración de fábrica.

kFileId_WeaveFactory

constexpr uint16_t kFileId_WeaveFactory = 0x235A

Archivo FDS que contiene valores de configuración persistentes configurados en el momento de la fabricación

Se retienen durante el restablecimiento de la configuración de fábrica.

kPersistedCounterRecordKeyBase

constexpr uint16_t kPersistedCounterRecordKeyBase = kFDSRecordKeyMin

Clave de registro base para los registros que contienen valores de contador persistentes de Weave.

El ID del contador de Weave se agrega a este valor para formar la clave de registro FDS.

kPersistedCounterRecordKeyMax

constexpr uint16_t kPersistedCounterRecordKeyMax = kFDSRecordKeyMax

Clave de registro máx. para los registros que contienen valores de contador persistentes de Weave.

Atributos estáticos protegidos

kFDSWordTamaño

constexpr uint16_t kFDSWordSize = 4

sActiveAsyncOp

FDSAsyncOp *volatile sActiveAsyncOp

sAsyncOpCompletionSem.

SemaphoreHandle_t sAsyncOpCompletionSem

Funciones estáticas públicas

ClearConfigValue

WEAVE_ERROR ClearConfigValue(
  Key key
)

ConfigValueExists

bool ConfigValueExists(
  Key key
)

Restablecer configuración de fábrica

WEAVE_ERROR FactoryResetConfig(
  void
)

Init

WEAVE_ERROR Init(
  void
)

Valor de ReadConfig

WEAVE_ERROR ReadConfigValue(
  Key key,
  bool & val
)

Valor de ReadConfig

WEAVE_ERROR ReadConfigValue(
  Key key,
  uint32_t & val
)

Valor de ReadConfig

WEAVE_ERROR ReadConfigValue(
  Key key,
  uint64_t & val
)

ReadConfigValueBin

WEAVE_ERROR ReadConfigValueBin(
  Key key,
  uint8_t *buf,
  size_t bufSize,
  size_t & outLen
)

LecturaConfigValueStr

WEAVE_ERROR ReadConfigValueStr(
  Key key,
  char *buf,
  size_t bufSize,
  size_t & outLen
)

RunConfigUnitTest

void RunConfigUnitTest(
  void
)

Escribir valor de la configuración

WEAVE_ERROR WriteConfigValue(
  Key key,
  bool val
)

Escribir valor de la configuración

WEAVE_ERROR WriteConfigValue(
  Key key,
  uint32_t val
)

Escribir valor de la configuración

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
)

Funciones estáticas protegidas

DoAsyncFDSOp

WEAVE_ERROR DoAsyncFDSOp(
  FDSAsyncOp & asyncOp
)

FDS Word

constexpr uint16_t FDSWords(
  size_t s
)

Cantidad de palabras FDS necesarias para contener un objeto de tamaño determinado.

Por cada grabación

WEAVE_ERROR ForEachRecord(
  uint16_t fileId,
  uint16_t recordKey,
  ForEachRecordFunct funct
)

ID de archivo get

constexpr uint16_t GetFileId(
  uint32_t key
)

Extrae un ID de archivo FDS de un par clave-valor.

ObtenerRecordKey

constexpr uint16_t GetRecordKey(
  uint32_t key
)

Extrae una clave de registro FDS de un valor de Key.

OpenRecord

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