uEspConfigLibFSEEPROM Class Reference

The deffinitive ESP32 and ESP8266 configuration Arduino library, uEspConfigLib - EEPROM writing implementation part. More...

#include <uEspConfigLibFSEEPROM.h>

Inheritance diagram for uEspConfigLibFSEEPROM:

Collaboration diagram for uEspConfigLibFSEEPROM:

Public Member Functions
	uEspConfigLibFSEEPROM (const bool=false, const uint8_t=UEEPROMLIB_ADDRESS)
	Constructor. More...
	uEspConfigLibFSEEPROM (const char *, const bool=false, const uint8_t=UEEPROMLIB_ADDRESS)
	Constructor. More...
bool	openToRead ()
	Opens the file for read. More...
bool	openToWrite ()
	Opens the file for write. More...
bool	readLine (String *)
	Reads a whole line from current file. More...
bool	write (const char *)
	Writes content to current file. More...
bool	closeFile ()
	Closes current file. More...
Public Member Functions inherited from uEspConfigLibFSInterface
virtual bool	openToRead ()
	Opens the file for read. More...
virtual bool	openToWrite ()
	Opens the file for write. More...
virtual bool	readLine (String *)
	Reads a whole line from current file. More...
virtual bool	write (const char *)
	Writes content to current file. More...
virtual bool	closeFile ()
	Closes current file. More...
uint8_t	status ()
	Returns current status. More...

Detailed Description

The deffinitive ESP32 and ESP8266 configuration Arduino library, uEspConfigLib - EEPROM writing implementation part.

The deffinitive ESP32 and ESP8266 configuration Arduino library, uEspConfigLib - EEPROM FileSystem interface implementation part.

This library consist in 2 parts:

One main library, uEspConfigLib, that manages configuration options, defaults, configuration site (HTML and JSON), configuration processing (from a POST of previous site) and configuration storage.

One interface to manage different configuration storages.

Currently storage classes are: SD-card, LittleFS, SPIFFS and none (values are lost after restart).

Constructor & Destructor Documentation

uEspConfigLibFSEEPROM() [1/2]

uEspConfigLibFSEEPROM::uEspConfigLibFSEEPROM	(	const bool	init = false,
		const uint8_t	address = UEEPROMLIB_ADDRESS
	)

Constructor.

Parameters

init	Set to true if you want to initialize and format (if needed) the filesystem
address	EEPROM I2C address

uEspConfigLibFSEEPROM() [2/2]

uEspConfigLibFSEEPROM::uEspConfigLibFSEEPROM	(	const char *	path,
		const bool	init = false,
		const uint8_t	address = UEEPROMLIB_ADDRESS
	)

Constructor.

Parameters

path	File path on filesystem
init	Set to true if you want to initialize and format (if needed) the filesystem
address	EEPROM I2C address

Member Function Documentation

closeFile()

bool uEspConfigLibFSEEPROM::closeFile ( )

virtual

Closes current file.

Returns

False on error

Reimplemented from uEspConfigLibFSInterface.

openToRead()

bool uEspConfigLibFSEEPROM::openToRead ( )

virtual

Opens the file for read.

Returns

False on error

Reimplemented from uEspConfigLibFSInterface.

openToWrite()

bool uEspConfigLibFSEEPROM::openToWrite ( )

virtual

Opens the file for write.

Returns

False on error

Reimplemented from uEspConfigLibFSInterface.

readLine()

bool uEspConfigLibFSEEPROM::readLine ( String *  line )

virtual

Reads a whole line from current file.

Parameters

line	String pointer where line will be read

Returns

False on error

Reimplemented from uEspConfigLibFSInterface.

write()

bool uEspConfigLibFSEEPROM::write ( const char *  data )

virtual

Writes content to current file.

Parameters

data	char array pointer to be written

Returns

False on error

Reimplemented from uEspConfigLibFSInterface.

---

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

• uEspConfigLibFSEEPROM.h
• uEspConfigLibFSEEPROM.cpp