nl::Weave::DeviceLayer::ConfigurationManager

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

Provides access to runtime and build-time configuration information for a Weave device.

Summary

Inheritance

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

Public types

@369 enum

Friend classes

::nl::Weave::DeviceLayer::Internal::DeviceControlServer
friend class
::nl::Weave::DeviceLayer::Internal::GenericPlatformManagerImpl
friend class
::nl::Weave::DeviceLayer::PlatformManagerImpl
friend class
::nl::Weave::DeviceLayer::TraitManager
friend class

Public functions

ClearServiceProvisioningData()
ComputeProvisioningHash(uint8_t *hashBuf, size_t hashBufSize)
GetBLEDeviceIdentificationInfo(Ble::WeaveBLEDeviceIdentificationInfo & deviceIdInfo)
GetDeviceCertificate(uint8_t *buf, size_t bufSize, size_t & certLen)
GetDeviceDescriptor(WeaveDeviceDescriptor & deviceDesc)
GetDeviceDescriptorTLV(uint8_t *buf, size_t bufSize, size_t & encodedLen)
GetDeviceId(uint64_t & deviceId)
GetDevicePrivateKey(uint8_t *buf, size_t bufSize, size_t & keyLen)
GetFabricId(uint64_t & fabricId)
GetFirmwareBuildTime(uint16_t & year, uint8_t & month, uint8_t & dayOfMonth, uint8_t & hour, uint8_t & minute, uint8_t & second)
GetFirmwareRevision(char *buf, size_t bufSize, size_t & outLen)
GetManufacturingDate(uint16_t & year, uint8_t & month, uint8_t & dayOfMonth)
GetPairedAccountId(char *buf, size_t bufSize, size_t & accountIdLen)
GetPairingCode(char *buf, size_t bufSize, size_t & pairingCodeLen)
GetPrimary802154MACAddress(uint8_t *buf)
GetPrimaryWiFiMACAddress(uint8_t *buf)
GetProductId(uint16_t & productId)
Device product id assigned by the vendor.
GetProductRevision(uint16_t & productRev)
Product revision number assigned by the vendor.
GetQRCodeString(char *buf, size_t bufSize)
GetSerialNumber(char *buf, size_t bufSize, size_t & serialNumLen)
GetServiceConfig(uint8_t *buf, size_t bufSize, size_t & serviceConfigLen)
GetServiceId(uint64_t & serviceId)
GetVendorId(uint16_t & vendorId)
Id of the vendor that produced the device.
GetWiFiAPSSID(char *buf, size_t bufSize)
InitiateFactoryReset()
void
IsMemberOfFabric()
bool
IsPairedToAccount()
bool
IsServiceProvisioned()
bool
StoreDeviceCertificate(const uint8_t *cert, size_t certLen)
StoreDeviceId(uint64_t deviceId)
StoreDevicePrivateKey(const uint8_t *key, size_t keyLen)
StoreFabricId(uint64_t fabricId)
StoreManufacturingDate(const char *mfgDate, size_t mfgDateLen)
StorePairedAccountId(const char *accountId, size_t accountIdLen)
StorePairingCode(const char *pairingCode, size_t pairingCodeLen)
StorePrimary802154MACAddress(const uint8_t *buf)
StorePrimaryWiFiMACAddress(const uint8_t *buf)
StoreProductRevision(uint16_t productRev)
StoreSerialNumber(const char *serialNum, size_t serialNumLen)
StoreServiceConfig(const uint8_t *serviceConfig, size_t serviceConfigLen)
StoreServiceProvisioningData(uint64_t serviceId, const uint8_t *serviceConfig, size_t serviceConfigLen, const char *accountId, size_t accountIdLen)

Protected functions

ConfigurationManager()=default
ConfigurationManager(const ConfigurationManager &)=delete
ConfigurationManager(const ConfigurationManager &&)=delete
operator=(const ConfigurationManager &)=delete
~ConfigurationManager()=default

Public types

@369

 @369

Friend classes

::nl::Weave::DeviceLayer::Internal::DeviceControlServer

friend class ::nl::Weave::DeviceLayer::Internal::DeviceControlServer

::nl::Weave::DeviceLayer::Internal::GenericPlatformManagerImpl

friend class ::nl::Weave::DeviceLayer::Internal::GenericPlatformManagerImpl

::nl::Weave::DeviceLayer::PlatformManagerImpl

friend class ::nl::Weave::DeviceLayer::PlatformManagerImpl

::nl::Weave::DeviceLayer::TraitManager

friend class ::nl::Weave::DeviceLayer::TraitManager

Public functions

ClearServiceProvisioningData

WEAVE_ERROR ClearServiceProvisioningData()

ComputeProvisioningHash

WEAVE_ERROR ComputeProvisioningHash(
  uint8_t *hashBuf,
  size_t hashBufSize
)

GetBLEDeviceIdentificationInfo

WEAVE_ERROR GetBLEDeviceIdentificationInfo(
  Ble::WeaveBLEDeviceIdentificationInfo & deviceIdInfo
)

GetDeviceCertificate

WEAVE_ERROR GetDeviceCertificate(
  uint8_t *buf,
  size_t bufSize,
  size_t & certLen
)

GetDeviceDescriptor

WEAVE_ERROR GetDeviceDescriptor(
  WeaveDeviceDescriptor & deviceDesc
)

GetDeviceDescriptorTLV

WEAVE_ERROR GetDeviceDescriptorTLV(
  uint8_t *buf,
  size_t bufSize,
  size_t & encodedLen
)

GetDeviceId

WEAVE_ERROR GetDeviceId(
  uint64_t & deviceId
)

GetDevicePrivateKey

WEAVE_ERROR GetDevicePrivateKey(
  uint8_t *buf,
  size_t bufSize,
  size_t & keyLen
)

GetFabricId

WEAVE_ERROR GetFabricId(
  uint64_t & fabricId
)

GetFirmwareBuildTime

WEAVE_ERROR GetFirmwareBuildTime(
  uint16_t & year,
  uint8_t & month,
  uint8_t & dayOfMonth,
  uint8_t & hour,
  uint8_t & minute,
  uint8_t & second
)

GetFirmwareRevision

WEAVE_ERROR GetFirmwareRevision(
  char *buf,
  size_t bufSize,
  size_t & outLen
)

GetManufacturingDate

WEAVE_ERROR GetManufacturingDate(
  uint16_t & year,
  uint8_t & month,
  uint8_t & dayOfMonth
)

GetPairedAccountId

WEAVE_ERROR GetPairedAccountId(
  char *buf,
  size_t bufSize,
  size_t & accountIdLen
)

GetPairingCode

WEAVE_ERROR GetPairingCode(
  char *buf,
  size_t bufSize,
  size_t & pairingCodeLen
)

GetPrimary802154MACAddress

WEAVE_ERROR GetPrimary802154MACAddress(
  uint8_t *buf
)

GetPrimaryWiFiMACAddress

WEAVE_ERROR GetPrimaryWiFiMACAddress(
  uint8_t *buf
)

GetProductId

WEAVE_ERROR GetProductId(
  uint16_t & productId
)

Device product id assigned by the vendor.

GetProductRevision

WEAVE_ERROR GetProductRevision(
  uint16_t & productRev
)

Product revision number assigned by the vendor.

GetQRCodeString

WEAVE_ERROR GetQRCodeString(
  char *buf,
  size_t bufSize
)

GetSerialNumber

WEAVE_ERROR GetSerialNumber(
  char *buf,
  size_t bufSize,
  size_t & serialNumLen
)

GetServiceConfig

WEAVE_ERROR GetServiceConfig(
  uint8_t *buf,
  size_t bufSize,
  size_t & serviceConfigLen
)

GetServiceId

WEAVE_ERROR GetServiceId(
  uint64_t & serviceId
)

GetVendorId

WEAVE_ERROR GetVendorId(
  uint16_t & vendorId
)

Id of the vendor that produced the device.

GetWiFiAPSSID

WEAVE_ERROR GetWiFiAPSSID(
  char *buf,
  size_t bufSize
)

InitiateFactoryReset

void InitiateFactoryReset()

IsMemberOfFabric

bool IsMemberOfFabric()

IsPairedToAccount

bool IsPairedToAccount()

IsServiceProvisioned

bool IsServiceProvisioned()

StoreDeviceCertificate

WEAVE_ERROR StoreDeviceCertificate(
  const uint8_t *cert,
  size_t certLen
)

StoreDeviceId

WEAVE_ERROR StoreDeviceId(
  uint64_t deviceId
)

StoreDevicePrivateKey

WEAVE_ERROR StoreDevicePrivateKey(
  const uint8_t *key,
  size_t keyLen
)

StoreFabricId

WEAVE_ERROR StoreFabricId(
  uint64_t fabricId
)

StoreManufacturingDate

WEAVE_ERROR StoreManufacturingDate(
  const char *mfgDate,
  size_t mfgDateLen
)

StorePairedAccountId

WEAVE_ERROR StorePairedAccountId(
  const char *accountId,
  size_t accountIdLen
)

StorePairingCode

WEAVE_ERROR StorePairingCode(
  const char *pairingCode,
  size_t pairingCodeLen
)

StorePrimary802154MACAddress

WEAVE_ERROR StorePrimary802154MACAddress(
  const uint8_t *buf
)

StorePrimaryWiFiMACAddress

WEAVE_ERROR StorePrimaryWiFiMACAddress(
  const uint8_t *buf
)

StoreProductRevision

WEAVE_ERROR StoreProductRevision(
  uint16_t productRev
)

StoreSerialNumber

WEAVE_ERROR StoreSerialNumber(
  const char *serialNum,
  size_t serialNumLen
)

StoreServiceConfig

WEAVE_ERROR StoreServiceConfig(
  const uint8_t *serviceConfig,
  size_t serviceConfigLen
)

StoreServiceProvisioningData

WEAVE_ERROR StoreServiceProvisioningData(
  uint64_t serviceId,
  const uint8_t *serviceConfig,
  size_t serviceConfigLen,
  const char *accountId,
  size_t accountIdLen
)

Protected functions

ConfigurationManager

 ConfigurationManager()=default

ConfigurationManager

 ConfigurationManager(
  const ConfigurationManager &
)=delete

ConfigurationManager

 ConfigurationManager(
  const ConfigurationManager &&
)=delete

operator=

ConfigurationManager & operator=(
  const ConfigurationManager &
)=delete

~ConfigurationManager

 ~ConfigurationManager()=default