nl::Weave::DeviceLayer::Internal::ESP32Config

#include <src/adaptations/device-layer/include/Weave/DeviceLayer/ESP32/ESP32Config.h>

Provides functions and definitions for accessing device configuration information on the ESP32.

Summary

This class is designed to be mixed-in to concrete implementation classes as a means to provide access to configuration information to generic base classes.

Inheritance

Direct Known Subclasses:
  nl::Weave::DeviceLayer::ConfigurationManagerImpl
  nl::Weave::DeviceLayer::Internal::GroupKeyStoreImpl

Public static attributes

kConfigKey_DeviceCert
const Key
kConfigKey_DeviceId
const Key
kConfigKey_DevicePrivateKey
const Key
kConfigKey_FabricId
const Key
kConfigKey_FabricSecret
const Key
kConfigKey_FailSafeArmed
const Key
kConfigKey_GroupKeyIndex
const Key
kConfigKey_LastUsedEpochKeyId
const Key
kConfigKey_ManufacturingDate
const Key
kConfigKey_PairedAccountId
const Key
kConfigKey_PairingCode
const Key
kConfigKey_ProductRevision
const Key
kConfigKey_SerialNum
const Key
kConfigKey_ServiceConfig
const Key
kConfigKey_ServiceId
const Key
kConfigKey_WiFiStationSecType
const Key
kConfigNamespace_WeaveConfig[]
const char
kConfigNamespace_WeaveCounters[]
const char
kConfigNamespace_WeaveFactory[]
const char
kGroupKeyNamePrefix[]
const char
kMaxConfigKeyNameLength = 15
constexpr size_t

Public static functions

ClearConfigValue(Key key)
ClearNamespace(const char *ns)
ConfigValueExists(Key key)
bool
EnsureNamespace(const char *ns)
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)
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)

Structs

nl::Weave::DeviceLayer::Internal::ESP32Config::Key

Public static attributes

kConfigKey_DeviceCert

const Key kConfigKey_DeviceCert

kConfigKey_DeviceId

const Key kConfigKey_DeviceId

kConfigKey_DevicePrivateKey

const Key kConfigKey_DevicePrivateKey

kConfigKey_FabricId

const Key kConfigKey_FabricId

kConfigKey_FabricSecret

const Key kConfigKey_FabricSecret

kConfigKey_FailSafeArmed

const Key kConfigKey_FailSafeArmed

kConfigKey_GroupKeyIndex

const Key kConfigKey_GroupKeyIndex

kConfigKey_LastUsedEpochKeyId

const Key kConfigKey_LastUsedEpochKeyId

kConfigKey_ManufacturingDate

const Key kConfigKey_ManufacturingDate

kConfigKey_PairedAccountId

const Key kConfigKey_PairedAccountId

kConfigKey_PairingCode

const Key kConfigKey_PairingCode

kConfigKey_ProductRevision

const Key kConfigKey_ProductRevision

kConfigKey_SerialNum

const Key kConfigKey_SerialNum

kConfigKey_ServiceConfig

const Key kConfigKey_ServiceConfig

kConfigKey_ServiceId

const Key kConfigKey_ServiceId

kConfigKey_WiFiStationSecType

const Key kConfigKey_WiFiStationSecType

kConfigNamespace_WeaveConfig

const char kConfigNamespace_WeaveConfig[]

kConfigNamespace_WeaveCounters

const char kConfigNamespace_WeaveCounters[]

kConfigNamespace_WeaveFactory

const char kConfigNamespace_WeaveFactory[]

kGroupKeyNamePrefix

const char kGroupKeyNamePrefix[]

kMaxConfigKeyNameLength

constexpr size_t kMaxConfigKeyNameLength = 15

Public static functions

ClearConfigValue

WEAVE_ERROR ClearConfigValue(
  Key key
)

ClearNamespace

WEAVE_ERROR ClearNamespace(
  const char *ns
)

ConfigValueExists

bool ConfigValueExists(
  Key key
)

EnsureNamespace

WEAVE_ERROR EnsureNamespace(
  const char *ns
)

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
)

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
)