https://github.com/pschatzmann/arduino-posix-fs

Arduino Posix API for data in PROGMEM - used by espeak-ng
https://github.com/pschatzmann/arduino-posix-fs

arduino-library

Last synced: 2 months ago
JSON representation

Arduino Posix API for data in PROGMEM - used by espeak-ng

• Host: GitHub
• URL: https://github.com/pschatzmann/arduino-posix-fs
• Owner: pschatzmann
• Created: 2022-10-31T19:52:04.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-08T17:47:43.000Z (4 months ago)
• Last Synced: 2024-10-11T13:36:34.124Z (3 months ago)
• Topics: arduino-library
• Language: C++
• Homepage:
• Size: 514 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# Arduino Posix Filesystem

## Overview 

All regular C or C++ projects that use files are based on the [Posix File Operations](https://www.mkompf.com/cplus/posixlist.html). In Microcontrollers things are quite different and you use a SD library which has it's own API to store files on a SD drive. 

If you want to store larger amount of data on a Microcontroller you can also use the Program Memory (PROGMEM). 

The goals of this project is to provide __Posix File API__ support to Microcontrollers in order to 

access of data in PROGMEM as files (w/o separate file deployment step), so that existing projects can be easily migrated to run on microcontrollers. 

## Documentation

Here is the [link to the class documentation](https://pschatzmann.github.io/arduino-posix-fs/docs/html/annotated.html).

### Implementation & Configuration 

On ESP32 processors this is implmented with the help of the [Virtual filesystem (VFS)](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/storage/vfs.html)

On mbed based implementations we implmenent a [FileSystemLike](https://os.mbed.com/docs/mbed-os/v6.15/mbed-os-api-doxy/classmbed_1_1_file_system_like.html) subclass.

All processors are configured in __ConfigFS.h__

### Using PROGMEM Files

You can convert any file into c source code with the help of __xxd__. Don't forget to change the generated defintion by adding a const to the test string. This makes sure that it is stored in PROGMEM.

Then you can register the files with their corresponding name and size: Here is an [example sketch](examples/in-memory-fs/in-memory-fs.ino) that registers some files. You can read the files with the regualr C or C++ APIs: see [the other examples](examples). 

### Logging

You can set up the logger by providing the log level and the logging output: 

```

  file_systems::FSLogger.begin(file_systems::FSDebug, Serial); 

```

## Supported Platforms

- ESP32 (using the Virtual File System)

- Rasperry Pico (RP2040)

- Arduino implementation based on MBED

## Installation in Arduino

You can download the library as zip and call include Library -> zip library. Or you can git clone this project into the Arduino libraries folder e.g. with

```

cd  ~/Documents/Arduino/libraries

git clone pschatzmann/arduino-posix-fs.git

```

I recommend to use git because you can easily update to the latest version just by executing the ```git pull``` command in the project folder.