uEspConfigLib
https://github.com/Naguissa/uEspConfigLib
Public Member Functions | List of all members
uEspConfigLibFSNone Class Reference

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

#include <uEspConfigLibFSNone.h>

Inheritance diagram for uEspConfigLibFSNone:
Inheritance graph
[legend]
Collaboration diagram for uEspConfigLibFSNone:
Collaboration graph
[legend]

Public Member Functions

 uEspConfigLibFSNone (const bool)
 Constructor. More...
 
 uEspConfigLibFSNone (const char *, const bool)
 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 - NO 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

◆ uEspConfigLibFSNone() [1/2]

uEspConfigLibFSNone::uEspConfigLibFSNone ( const bool  init = false)

Constructor.

Parameters
initSet to true if you want to initialize and format (if needed) the filesystem

◆ uEspConfigLibFSNone() [2/2]

uEspConfigLibFSNone::uEspConfigLibFSNone ( const char *  unused,
const bool  init = false 
)

Constructor.

Parameters
unusedFile path on filesystem
initSet to true if you want to initialize and format (if needed) the filesystem

Member Function Documentation

◆ closeFile()

bool uEspConfigLibFSNone::closeFile ( )
virtual

Closes current file.

Returns
False on error

Reimplemented from uEspConfigLibFSInterface.

◆ openToRead()

bool uEspConfigLibFSNone::openToRead ( )
virtual

Opens the file for read.

Returns
False on error

Reimplemented from uEspConfigLibFSInterface.

◆ openToWrite()

bool uEspConfigLibFSNone::openToWrite ( )
virtual

Opens the file for write.

Returns
False on error

Reimplemented from uEspConfigLibFSInterface.

◆ readLine()

bool uEspConfigLibFSNone::readLine ( String *  unused)
virtual

Reads a whole line from current file.

Parameters
lineString pointer where line will be read
Returns
False on error

Reimplemented from uEspConfigLibFSInterface.

◆ write()

bool uEspConfigLibFSNone::write ( const char *  unused)
virtual

Writes content to current file.

Parameters
datachar array pointer to be written
Returns
False on error

Reimplemented from uEspConfigLibFSInterface.


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