Inheritance diagram for Supla::FramSpi:

Collaboration diagram for Supla::FramSpi:

[legend]

Public Member Functions
	FramSpi (int8_t clk, int8_t miso, int8_t mosi, int8_t framCs, unsigned int storageStartingOffset=0)

	FramSpi (int8_t framCs, unsigned int storageStartingOffset=0)

bool	init ()

void	commit ()

Public Member Functions inherited from Supla::Storage
	Storage (unsigned int storageStartingOffset=0, unsigned int availableSize=0, enum WearLevelingMode=WearLevelingMode::OFF)

virtual void	setStateSavePeriod (uint32_t periodMs)

virtual void	deleteAll ()

virtual void	eraseSector (unsigned int address, int size)

void	enableChannelNumbers ()

bool	isAddChannelNumbersEnabled () const

void	setDeleteAllMethodEnabled (bool value)
	Enables or disables delete all method which is called during factory reset.

Protected Member Functions
int	readStorage (unsigned int offset, unsigned char *buf, int size, bool logs)

int	writeStorage (unsigned int offset, const unsigned char *buf, int size)

Protected Member Functions inherited from Supla::Storage
bool	getInitResult () const

virtual int	updateStorage (unsigned int, const unsigned char *, int)

virtual bool	saveStateAllowed (uint32_t)

virtual void	scheduleSave (uint32_t delayMsMax, uint32_t delayMsMin)

bool	registerSection (int sectionId, int offset, int size, bool addCrc, bool addBackupCopy)

bool	readSection (int sectionId, unsigned char *data, int size)

bool	writeSection (int sectionId, const unsigned char *data, int size)

bool	deleteSection (int sectionId)

Protected Attributes
Adafruit_FRAM_SPI	fram

Protected Attributes inherited from Supla::Storage
const uint32_t	storageStartingOffset = 0

const uint32_t	availableSize = 0

enum WearLevelingMode	wearLevelingMode = WearLevelingMode::OFF

uint32_t	saveStatePeriod = 1000

uint32_t	lastWriteTimestamp = 0

SpecialSectionInfo *	firstSectionInfo = nullptr

StateStorageInterface *	stateStorage = nullptr

bool	addChannelNumbers = false

bool	deleteAllMethodEnabled = true

bool	initResult = false

Additional Inherited Members
Public Types inherited from Supla::Storage
enum class	WearLevelingMode { OFF = 0 , BYTE_WRITE_MODE = 1 , SECTOR_WRITE_MODE = 2 }

Static Public Member Functions inherited from Supla::Storage
static Storage *	Instance ()

static Config *	ConfigInstance ()

static void	SetConfigInstance (Config *instance)

static bool	IsConfigStorageAvailable ()

static bool	Init ()

static bool	SaveStateAllowed (uint32_t)

static void	ScheduleSave (uint32_t delayMsMax, uint32_t delayMsMin=0)
	Schedules save of state storage in given time range.

static bool	IsStateStorageValid ()

static void	LoadStateStorage ()

static void	WriteStateStorage ()

static bool	ReadState (unsigned char *, int)

static bool	WriteState (const unsigned char *, int)

static void	EraseSector (unsigned int offset, int size)

static bool	RegisterSection (int sectionId, int offset, int size, bool addCrc, bool addBackupCopy)

static bool	ReadSection (int sectionId, unsigned char *data, int size)

static bool	WriteSection (int sectionId, const unsigned char *data, int size)

static bool	DeleteSection (int sectionId)

Static Public Attributes inherited from Supla::Storage
static bool	storageInitDone = false

Static Protected Member Functions inherited from Supla::Storage
static void	WriteElementsState ()

Static Protected Attributes inherited from Supla::Storage
static Storage *	instance = nullptr

static Config *	configInstance = nullptr

Member Function Documentation

◆ commit()

void Supla::FramSpi::commit ( )

inlinevirtual

bool Supla::FramSpi::init ( )

inlinevirtual

Reimplemented from Supla::Storage.

int Supla::FramSpi::readStorage	(	unsigned int	offset,
		unsigned char *	buf,
		int	size,
		bool	logs )

inlineprotectedvirtual

int Supla::FramSpi::writeStorage	(	unsigned int	offset,
		const unsigned char *	buf,
		int	size )

inlineprotectedvirtual

The documentation for this class was generated from the following file: