Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

nl::Weave::Geräteschicht::Intern::NRF5Config

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

Bietet Funktionen und Definitionen für den Zugriff auf die dauerhafte Gerätekonfiguration auf Plattformen basierend auf dem Nordic nRF5 SDK.

Fazit

Bei dieser Implementierung wird die Nordic Flash Data Storage (FDS)-Bibliothek als zugrunde liegende Speicherschicht eingesetzt.

HINWEIS: Diese Klasse wurde so konzipiert, dass sie in die konkrete Unterklasse der Vorlage "GenericConfigurationManagerImpl<>" eingefügt wird. Bei dieser Art der Klasse stellt die Klasse natürlich Implementierungen für die delegierten Mitglieder bereit, auf die von der Vorlagenklasse verwiesen wird (z.B. die Methode ReadConfigValue()).

Übernahme

Direkte bekannte Unterklassen:
nl::Weave::DeviceLayer::ConfigurationManagerImpl
nl::Weave::DeviceLayer::Internal::GroupKeyStoreImpl

Öffentliche Typen

Key Verwenden
uint32_t

Geschützte Typen

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

Öffentliche statische Attribute

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
Maximalwert, der für eine FDS-Datei-ID verwendet werden kann (pro Nordic SDK)
kFDSFileIdMin = 0x0000
constexpr uint16_t
Mindestwert, der für eine FDS-Datei-ID verwendet werden kann (pro Nordisches SDK)
kFDSRecordKeyMax = 0xBFFF
constexpr uint16_t
Maximalwert, der für einen FDS-Datensatzschlüssel verwendet werden kann (pro Nordic SDK)
kFDSRecordKeyMin = 0x0001
constexpr uint16_t
Mindestwert, der für einen FDS-Datensatzschlüssel verwendet werden kann (pro Nordic SDK)
kFileId_WeaveConfig = 0x235B
constexpr uint16_t
FDS-Datei mit dynamischen Konfigurationswerten, die zur Laufzeit festgelegt werden.
kFileId_WeaveCounter = 0x235C
constexpr uint16_t
FDS-Datei mit dynamischen Zählerwerten, die zur Laufzeit festgelegt werden.
kFileId_WeaveFactory = 0x235A
constexpr uint16_t
FDS-Datei mit dauerhaften Konfigurationswerten, die bei der Herstellung festgelegt werden.
kPersistedCounterRecordKeyBase = kFDSRecordKeyMin
constexpr uint16_t
Basisdatensatzschlüssel für Datensätze mit Weave-Dauerwerten
kPersistedCounterRecordKeyMax = kFDSRecordKeyMax
constexpr uint16_t
Max. Eintragsschlüssel für Datensätze mit Weave-Dauerwerten.

Geschützte statische Attribute

kFDSWordSize = 4
constexpr uint16_t
sActiveAsyncOp
FDSAsyncOp *volatile
sAsyncOpCompletionSem
SemaphoreHandle_t

Öffentliche statische Funktionen

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)

Geschützte statische Funktionen

DoAsyncFDSOp(FDSAsyncOp & asyncOp)
FDSWords(size_t s)
constexpr uint16_t
Anzahl der FDS-Wörter, die für ein bestimmtes Größenobjekt erforderlich sind.
ForEachRecord(uint16_t fileId, uint16_t recordKey, ForEachRecordFunct funct)
GetFileId(uint32_t key)
constexpr uint16_t
Extrahiert eine ID einer FDS-Datei aus einem Schlüssel/Wert-Paar.
GetRecordKey(uint32_t key)
constexpr uint16_t
Extrahiert einen FDS-Eintragsschlüssel aus einem Schlüssel/Wert-Paar.
OpenRecord(NRF5Config::Key key, fds_record_desc_t & recDesc, fds_flash_record_t & rec)

Öffentliche Typen

Schlüssel

uint32_t Key

Geschützte Typen

FürJedenDatensatz

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

Öffentliche statische Attribute

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)

kFDSFileId

constexpr uint16_t kFDSFileIdMax = 0xBFFF

Maximalwert, der für eine FDS-Datei-ID verwendet werden kann (pro Nordic SDK)

kFDSDatei-ID

constexpr uint16_t kFDSFileIdMin = 0x0000

Mindestwert, der für eine FDS-Datei-ID verwendet werden kann (pro Nordisches SDK)

kFDSRecordKeyMax

constexpr uint16_t kFDSRecordKeyMax = 0xBFFF

Maximalwert, der für einen FDS-Datensatzschlüssel verwendet werden kann (pro Nordic SDK)

kFDSRecordKeyMin

constexpr uint16_t kFDSRecordKeyMin = 0x0001

Mindestwert, der für einen FDS-Datensatzschlüssel verwendet werden kann (pro Nordic SDK)

kFileId_WeaveConfig

constexpr uint16_t kFileId_WeaveConfig = 0x235B

FDS-Datei mit dynamischen Konfigurationswerten, die zur Laufzeit festgelegt werden.

Beim Zurücksetzen auf Werkseinstellungen gelöscht.

kFileId_WeaveCounter

constexpr uint16_t kFileId_WeaveCounter = 0x235C

FDS-Datei mit dynamischen Zählerwerten, die zur Laufzeit festgelegt werden.

Wird beim Zurücksetzen auf die Werkseinstellungen beibehalten.

kFileId_WeaveFactory angegeben

constexpr uint16_t kFileId_WeaveFactory = 0x235A

FDS-Datei mit dauerhaften Konfigurationswerten, die bei der Herstellung festgelegt werden.

Wird beim Zurücksetzen auf die Werkseinstellungen beibehalten.

kPersistedCounterRecordKeyBase

constexpr uint16_t kPersistedCounterRecordKeyBase = kFDSRecordKeyMin

Basisdatensatzschlüssel für Datensätze mit Weave-Dauerwerten

Die Weave-Zähler-ID wird zu diesem Wert hinzugefügt, um den FDS-Eintragsschlüssel zu bilden.

kPersistedCounterRecordKeyMax.

constexpr uint16_t kPersistedCounterRecordKeyMax = kFDSRecordKeyMax

Max. Eintragsschlüssel für Datensätze mit Weave-Dauerwerten.

Geschützte statische Attribute

kFDSWordSize

constexpr uint16_t kFDSWordSize = 4

Logo: sActiveAsyncOp

FDSAsyncOp *volatile sActiveAsyncOp

sAsyncOpCompleteSem-DE

SemaphoreHandle_t sAsyncOpCompletionSem

Öffentliche statische Funktionen

ClearConfigValue

WEAVE_ERROR ClearConfigValue(
  Key key
)

ConfigValueExists

bool ConfigValueExists(
  Key key
)

Werkseinstellungen zurücksetzen

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
)

RunConfigUnitTest

void RunConfigUnitTest(
  void
)

Schreibkonfigurationswert

WEAVE_ERROR WriteConfigValue(
  Key key,
  bool val
)

Schreibkonfigurationswert

WEAVE_ERROR WriteConfigValue(
  Key key,
  uint32_t val
)

Schreibkonfigurationswert

WEAVE_ERROR WriteConfigValue(
  Key key,
  uint64_t val
)

SchreibkonfigurationswertBin

WEAVE_ERROR WriteConfigValueBin(
  Key key,
  const uint8_t *data,
  size_t dataLen
)

Schreibkonfigurationswert

WEAVE_ERROR WriteConfigValueStr(
  Key key,
  const char *str
)

Schreibkonfigurationswert

WEAVE_ERROR WriteConfigValueStr(
  Key key,
  const char *str,
  size_t strLen
)

Geschützte statische Funktionen

Logo: DoAsyncFDSOp

WEAVE_ERROR DoAsyncFDSOp(
  FDSAsyncOp & asyncOp
)

Logo: FDSWords

constexpr uint16_t FDSWords(
  size_t s
)

Anzahl der FDS-Wörter, die für ein bestimmtes Größenobjekt erforderlich sind.

FürJedenDatensatz

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

Dateiname abrufen

constexpr uint16_t GetFileId(
  uint32_t key
)

Extrahiert eine ID einer FDS-Datei aus einem Schlüssel/Wert-Paar.

GetRecordKey

constexpr uint16_t GetRecordKey(
  uint32_t key
)

Extrahiert einen FDS-Eintragsschlüssel aus einem Schlüssel/Wert-Paar.

OpenRecord

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