nl::Weave::DeviceLayer::Dahili::NRF5Config

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

Nordic nRF5 SDK'sına dayalı platformlarda kalıcı cihaz yapılandırmasına erişmek için işlevler ve tanımlar sağlar.

Özet

Bu uygulama, temel depolama katmanı olarak Nordic Flash Data Storage (FDS) kitaplığını kullanır.

NOT: Bu sınıf, GenericConfigurationManagerImpl<> şablonunun beton alt sınıfına karışacak şekilde tasarlanmıştır. Bu şekilde kullanıldığında sınıf, şablon sınıfının başvurduğu yetki verilmiş üyeler için doğal olarak uygulamalar sağlar (ör. ReadConfigValue() yöntemi).

Devralma

Doğrudan Bilinen Alt Sınıflar:
nl::Weave::DeviceLayer::ConfigurationManagerImpl
nl::Weave::DeviceLayer::Internal::GroupKeyStoreImpl

Herkese açık türler

Key kullanıcılar
uint32_t

Korunan türler

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

Herkese açık statik özellikler

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
FDS dosya kimliği için kullanılabilecek maksimum değer (Nordic SDK başına)
kFDSFileIdMin = 0x0000
constexpr uint16_t
FDS dosya kimliği için kullanılabilecek minimum değer (Nordic SDK başına)
kFDSRecordKeyMax = 0xBFFF
constexpr uint16_t
FDS kayıt anahtarı için kullanılabilecek maksimum değer (Nordic SDK başına)
kFDSRecordKeyMin = 0x0001
constexpr uint16_t
FDS kayıt anahtarı için kullanılabilecek minimum değer (Nordic SDK başına)
kFileId_WeaveConfig = 0x235B
constexpr uint16_t
Çalışma zamanında ayarlanmış dinamik yapılandırma değerleri içeren FDS dosyası.
kFileId_WeaveCounter = 0x235C
constexpr uint16_t
Çalışma zamanında ayarlanan dinamik sayaç değerleri içeren FDS dosyası.
kFileId_WeaveFactory = 0x235A
constexpr uint16_t
Üretim zamanında belirlenen kalıcı yapılandırma değerleri içeren FDS dosyası.
kPersistedCounterRecordKeyBase = kFDSRecordKeyMin
constexpr uint16_t
Weave kalıcı sayaç değerleri içeren kayıtlar için temel kayıt anahtarı.
kPersistedCounterRecordKeyMax = kFDSRecordKeyMax
constexpr uint16_t
Weave kalıcı sayaç değerleri içeren kayıtlar için maksimum kayıt anahtarı.

Korumalı statik özellikler

kFDSWordSize = 4
constexpr uint16_t
sActiveAsyncOp
FDSAsyncOp *volatile
sAsyncOpCompletionSem
SemaphoreHandle_t

Herkese açık statik işlevler

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)

Korumalı statik işlevler

DoAsyncFDSOp(FDSAsyncOp & asyncOp)
FDSWords(size_t s)
constexpr uint16_t
Belirli bir boyut nesnesini tutmak için gereken FDS kelimelerinin sayısı.
ForEachRecord(uint16_t fileId, uint16_t recordKey, ForEachRecordFunct funct)
GetFileId(uint32_t key)
constexpr uint16_t
Bir Anahtar/değer çiftinden bir FDS dosya kimliği çıkarın.
GetRecordKey(uint32_t key)
constexpr uint16_t
Bir Anahtar/değer çiftinden FDS kayıt anahtarı çıkarın.
OpenRecord(NRF5Config::Key key, fds_record_desc_t & recDesc, fds_flash_record_t & rec)

Herkese açık türler

Anahtar

uint32_t Key

Korunan türler

ForHerRecordFunct

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

Herkese açık statik özellikler

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_Grup Anahtarı

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_MfrCihaz Kimliği

constexpr Key kConfigKey_MfrDeviceId = NRF5ConfigKey(kFileId_WeaveFactory, 0x0002)

kConfigKey_MfrDeviceDeviceKey

constexpr Key kConfigKey_MfrDevicePrivateKey = NRF5ConfigKey(kFileId_WeaveFactory, 0x0004)

kConfigKey_OperasyonelCihazSertifikası

constexpr Key kConfigKey_OperationalDeviceCert = NRF5ConfigKey(kFileId_WeaveConfig,  0x0012)

kConfigKey_OperationalDeviceICASertifikaları

constexpr Key kConfigKey_OperationalDeviceICACerts = NRF5ConfigKey(kFileId_WeaveConfig,  0x0013)

kConfigKey_İşlemCihazıKimliği

constexpr Key kConfigKey_OperationalDeviceId = NRF5ConfigKey(kFileId_WeaveConfig,  0x0011)

kConfigKey_OperasyonelCihazÖzelAnahtarı

constexpr Key kConfigKey_OperationalDevicePrivateKey = NRF5ConfigKey(kFileId_WeaveConfig,  0x0014)

kConfigKey_EşlenmişHesap Kimliği

constexpr Key kConfigKey_PairedAccountId = NRF5ConfigKey(kFileId_WeaveConfig,  0x0009)

kConfigKey_Eşleme Kodu

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_ServiceYapılandırma

constexpr Key kConfigKey_ServiceConfig = NRF5ConfigKey(kFileId_WeaveConfig,  0x0008)

kConfigKey_Service Kimliği

constexpr Key kConfigKey_ServiceId = NRF5ConfigKey(kFileId_WeaveConfig,  0x000A)

kFDSDosya Kimliği

constexpr uint16_t kFDSFileIdMax = 0xBFFF

FDS dosya kimliği için kullanılabilecek maksimum değer (Nordic SDK başına)

kFDSDosya Kimliği Min.

constexpr uint16_t kFDSFileIdMin = 0x0000

FDS dosya kimliği için kullanılabilecek minimum değer (Nordic SDK başına)

kFDSKayıtAnahtarıMaks.

constexpr uint16_t kFDSRecordKeyMax = 0xBFFF

FDS kayıt anahtarı için kullanılabilecek maksimum değer (Nordic SDK başına)

kFDSKayıtAnahtarı

constexpr uint16_t kFDSRecordKeyMin = 0x0001

FDS kayıt anahtarı için kullanılabilecek minimum değer (Nordic SDK başına)

kFileId_WeaveConfig

constexpr uint16_t kFileId_WeaveConfig = 0x235B

Çalışma zamanında ayarlanmış dinamik yapılandırma değerleri içeren FDS dosyası.

Fabrika ayarlarına sıfırlama sırasında temizlenir.

kFileId_WeaveSayaç

constexpr uint16_t kFileId_WeaveCounter = 0x235C

Çalışma zamanında ayarlanan dinamik sayaç değerleri içeren FDS dosyası.

Fabrika ayarlarına sıfırlama sırasında saklanır.

kFileId_WeaveFactory

constexpr uint16_t kFileId_WeaveFactory = 0x235A

Üretim zamanında belirlenen kalıcı yapılandırma değerleri içeren FDS dosyası.

Fabrika ayarlarına sıfırlama sırasında saklanır.

kPersistedSayaçRecordKeyBase

constexpr uint16_t kPersistedCounterRecordKeyBase = kFDSRecordKeyMin

Weave kalıcı sayaç değerleri içeren kayıtlar için temel kayıt anahtarı.

FDS kayıt anahtarını oluşturmak için bu değere Weave sayaç kimliği eklenir.

kPersistedSayaçRecordKeyMax

constexpr uint16_t kPersistedCounterRecordKeyMax = kFDSRecordKeyMax

Weave kalıcı sayaç değerleri içeren kayıtlar için maksimum kayıt anahtarı.

Korumalı statik özellikler

kFDSKelime Boyutu

constexpr uint16_t kFDSWordSize = 4

SActiveAsyncOp

FDSAsyncOp *volatile sActiveAsyncOp

sAsyncOpCompletionSem

SemaphoreHandle_t sAsyncOpCompletionSem

Herkese açık statik işlevler

ClearConfigDeğeri

WEAVE_ERROR ClearConfigValue(
  Key key
)

Yapılandırma Değerleri Var

bool ConfigValueExists(
  Key key
)

FabrikaSıfırlaYapılandırma

WEAVE_ERROR FactoryResetConfig(
  void
)

Başlangıç

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 değeri

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

RunConfigUnitTest

void RunConfigUnitTest(
  void
)

Yazma Yapılandırması Değeri

WEAVE_ERROR WriteConfigValue(
  Key key,
  bool val
)

Yazma Yapılandırması Değeri

WEAVE_ERROR WriteConfigValue(
  Key key,
  uint32_t val
)

Yazma Yapılandırması Değeri

WEAVE_ERROR WriteConfigValue(
  Key key,
  uint64_t val
)

YazmaYapılandırmaValueBin

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

YazmaYapılandırmaDeğerStres

WEAVE_ERROR WriteConfigValueStr(
  Key key,
  const char *str
)

YazmaYapılandırmaDeğerStres

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

Korumalı statik işlevler

DoAsyncFDSOp

WEAVE_ERROR DoAsyncFDSOp(
  FDSAsyncOp & asyncOp
)

FDSKelimeleri

constexpr uint16_t FDSWords(
  size_t s
)

Belirli bir boyut nesnesini tutmak için gereken FDS kelimelerinin sayısı.

Her Kayıt İçin

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

GetFileId

constexpr uint16_t GetFileId(
  uint32_t key
)

Bir Anahtar/değer çiftinden bir FDS dosya kimliği çıkarın.

GetRecordKey

constexpr uint16_t GetRecordKey(
  uint32_t key
)

Bir Anahtar/değer çiftinden FDS kayıt anahtarı çıkarın.

OpenRecord

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