File_System Class Reference

File system. More...

#include <hV_File_System.h>

Inheritance diagram for File_System:

Public Member Functions
	File_System ()
	Constructor.
uint8_t	beginFileSystem (uint8_t pinCS=NOT_CONNECTED, uint8_t port=0, int8_t pinDetect=-1, int level=LOW)
	File system initialisation.
uint8_t	endFileSystem ()
	Close file system.
uint8_t	setFolder (STRING_CONST_TYPE name)
	Set the folder for files.
uint8_t	suspendFileSystem ()
	Suspend file system.
uint8_t	resumeFileSystem ()
	Resume file system after suspend.
uint8_t	saveScreen (STRING_CONST_TYPE name, uint8_t multiplier=1)
	Screen saved as file to SD-card.
uint8_t	saveWindow (STRING_CONST_TYPE name, uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, uint8_t multiplier=1)
	Save partial window as file to SD-card.
uint8_t	readScreen (STRING_CONST_TYPE name, uint8_t multiplier=1)
	Load and display BMP file.
void	printFileSystemError ()
	Print the file system error.

Detailed Description

File system.

Shared header for Linux and MCU

Warning

MCU requires an SD-card library

Member Function Documentation

beginFileSystem()

uint8_t File_System::beginFileSystem	(	uint8_t	pinCS = NOT_CONNECTED,
		uint8_t	port = 0,
		int8_t	pinDetect = -1,
		int	level = LOW )

File system initialisation.

Note

Linux ignores all parameters

Warning

MCU requires all parameters

Parameters

pinCS	SD selection, default = NOT_CONNECTED
port	SPI port, default = 0,
pinDetect	SD detection, default = -1 = none
level	expected level when SD-card available, default = LOW

Returns

RESULT_SUCCESS if SD card available, RESULT_ERROR otherwise

Warning

FAT16 only SD-card

Note

Generally,

myFileBMP.beginFileSystem(myBoard.cardCS);

endFileSystem()

uint8_t File_System::endFileSystem

(

)

Close file system.

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

printFileSystemError()

void File_System::printFileSystemError

(

)

Print the file system error.

Note

Details are provided if the SD.h library includes getErrorCode()

#define WITH_GETERRORCODE
uint8_t getErrorCode() {
    return card.errorCode(); // Arduino
    // return sdfs.sdErrorCode(); // Teensy
};

readScreen()

uint8_t File_System::readScreen	(	STRING_CONST_TYPE	name,
		uint8_t	multiplier = 1 )

Load and display BMP file.

Parameters

name

file name

Note

The BMP file should be 5-5-5 coded.

Parameters

multiplier

size of each dot, default = 1 Recommended 2 for small screens Otherwise 1 for medium and large screens

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

Warning

Prefer BMP file generated by saveScreen()

resumeFileSystem()

uint8_t File_System::resumeFileSystem

(

)

Resume file system after suspend.

Switch to SD-card SPI bus, if any

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

saveScreen()

uint8_t File_System::saveScreen	(	STRING_CONST_TYPE	name,
		uint8_t	multiplier = 1 )

Screen saved as file to SD-card.

Parameters

name	file name, only letters and numbers
multiplier	size of each dot, default = 1 Recommended 2 for small screens Otherwise 1 for medium and large screens

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

Note

The resulting BMP file is 5-5-5 coded.

saveWindow()

uint8_t File_System::saveWindow	(	STRING_CONST_TYPE	name,
		uint16_t	x0,
		uint16_t	y0,
		uint16_t	dx,
		uint16_t	dy,
		uint8_t	multiplier = 1 )

Save partial window as file to SD-card.

Parameters

name	file name, only letters and numbers
x0	top left coordinate, x-axis
y0	top left coordinate, y-axis
dx	width to be copied, x-axis
dy	height to be copied, y-axis
multiplier	size of each dot, default = 1 Recommended 2 for small screens Otherwise 1 for medium and large screens

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

Note

The resulting BMP file is 5-5-5 coded.

setFolder()

uint8_t File_System::setFolder

(

STRING_CONST_TYPE

name

)

Set the folder for files.

The folder is created if it does not exist

Parameters

name	folder name, ony letters and numbers

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

suspendFileSystem()

uint8_t File_System::suspendFileSystem

(

)

Suspend file system.

Switch to main SPI and ensure SD-card /CS HIGH

Returns

RESULT_SUCCESS is successful, RESULT_ERROR otherwise

---

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

• hV_File_System.h