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

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

#include <uEspConfigLibFSInterface.h>

Inheritance diagram for uEspConfigLibFSInterface:
Inheritance graph
[legend]

Public Member Functions

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 - FileSystem interface 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).

Member Function Documentation

◆ closeFile()

virtual bool uEspConfigLibFSInterface::closeFile ( )
inlinevirtual

Closes current file.

Returns
False on error

Reimplemented in uEspConfigLibFSLittlefs, uEspConfigLibFSNone, uEspConfigLibFSSd, and uEspConfigLibFSSpiffs.

◆ openToRead()

virtual bool uEspConfigLibFSInterface::openToRead ( )
inlinevirtual

Opens the file for read.

Returns
False on error

Reimplemented in uEspConfigLibFSLittlefs, uEspConfigLibFSNone, uEspConfigLibFSSd, and uEspConfigLibFSSpiffs.

◆ openToWrite()

virtual bool uEspConfigLibFSInterface::openToWrite ( )
inlinevirtual

Opens the file for write.

Returns
False on error

Reimplemented in uEspConfigLibFSLittlefs, uEspConfigLibFSNone, uEspConfigLibFSSd, and uEspConfigLibFSSpiffs.

◆ readLine()

virtual bool uEspConfigLibFSInterface::readLine ( String *  )
inlinevirtual

Reads a whole line from current file.

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

Reimplemented in uEspConfigLibFSLittlefs, uEspConfigLibFSNone, uEspConfigLibFSSd, and uEspConfigLibFSSpiffs.

◆ status()

uint8_t uEspConfigLibFSInterface::status ( )
inline

Returns current status.

Returns
Current status

◆ write()

virtual bool uEspConfigLibFSInterface::write ( const char *  )
inlinevirtual

Writes content to current file.

Parameters
datachar array pointer to be written
Returns
False on error

Reimplemented in uEspConfigLibFSLittlefs, uEspConfigLibFSNone, uEspConfigLibFSSd, and uEspConfigLibFSSpiffs.


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