consoleSerialFlash.h

Description

utils/consoleSerialFlash.h provides the following function to a console application:

s_console_serial_flash_cmds() :
- dir <-a> – shows the directory of the SerialFlash, dir -a show more details of each file
- eraseAll – formates the SerialFlash

Note: The SerialFlash has to be initialised in the in setup() function first, before it can be accessed by the console functions!

Syntax (examples)

#include "utils/consoleSerialFlash.h" . . . SerialFlash.begin(); . . . s_console_string = s_console_serial_flash_cmds( s_console_string );

Parameters

String s_console_string – String that holds the user command. Normally returned by s_console_routine() or a previous console function.

Returns

String : the user command or an empty String “” if the user command was recognised and processed by this function. (see of commands above)

Example Codes:

#include "consoleLogin.h"
#include "utils/consoleSerialFlash.h"
void setup()
{
  SerialFlash.begin();
  console_init(&Serial);
}
void loop()
{
  String s_console_string = s_console_routine();
  s_console_serial_flash_cmds(s_console_string);
}

Notes and Warnings

This function and its commands might be helpful to test and learn how to work with files in the SerialFlash.

See the source code as example code for your own application:

 C:\Users\yourName\AppData\Local\Arduino15\packages\dice\hardware\samc\1.0.0\libraries\Console\src\...

In a ‘real world’ application, these functions might not be necessary or it might even be problematic to offer the end-user the opportunity to list or delete files in the serial flash memory.

Please keep in mind that each included file and its used function increase the size of the resulting application. So in order to keep the application binaries as small as possible, include only functions that are really necessary for the final application.

An example can be found in the Arduino IDE menu:
File -> Examples -> Consoles -> Dev_Console