Skip to content

Add Build LittleFS command #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 30, 2025
Merged

Add Build LittleFS command #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,23 @@

MIT licensed, see LICENSE.md

LittleFS uploader compatible with Arduino IDE 2.2.1 or higher. For use with the [Raspberry Pi Pico RP2040 Arduino core `arduino-pico`](https://github.com/earlephilhower/arduino-pico), the community [ESP8266 Arduino core](https://github.com/esp8266/Arduino) and the community [ESP32 Arduino core](https://github.com/espressif/arduino-esp32).
LittleFS uploader and builder compatible with Arduino IDE 2.2.1 or higher. For use with the [Raspberry Pi Pico RP2040 Arduino core `arduino-pico`](https://github.com/earlephilhower/arduino-pico), the community [ESP8266 Arduino core](https://github.com/esp8266/Arduino) and the community [ESP32 Arduino core](https://github.com/espressif/arduino-esp32).

## Usage
## Usage, uploading a filesystem to the device

`[Ctrl]` + `[Shift]` + `[P]`, then "`Upload LittleFS to Pico/ESP8266/ESP32`".

On macOS, press `[⌘]` + `[Shift]` + `[P]` to open the Command Palette in the Arduino IDE, then "`Upload LittleFS to Pico/ESP8266/ESP32`".

## Usage, building (but not uploading) a filesystem to the device

For most users this is not ever needed, but it can be useful if you are distributing filesystem updates to many devices without needing the IDE. The created filesystem image will be stored in the sketch directory as `mklittlefs.bin`, shown in the command output.

`[Ctrl]` + `[Shift]` + `[P]`, then "`Build LittleFS image in sketch directory`"

On macOS, press `[⌘]` + `[Shift]` + `[P]` to open the Command Palette in the Arduino IDE, then "`Build LittleFS image in sketch directory`"


## Glitches

The first sketch auto-opened by the IDE presently may have corrupted state which causes uploads to fail.
Expand All @@ -19,13 +28,16 @@ You can also open another sketch, close the auto-opened one, then re-open it.

A fix is already in the Arduino repository for this issue.

## Could not open <serial port>

If you get:
```
A fatal error occurred: Could not open <serial port>, the port doesn't exist
ERROR: Upload failed, error code: 2
```
Make sure that you close any open `Serial Monitor` windows.


## Installation

Copy the [VSIX file](https://github.com/earlephilhower/arduino-littlefs-upload/releases) to `~/.arduinoIDE/plugins/` on Mac and Linux or `C:\Users\<username>\.arduinoIDE\plugins\` on Windows (you may need to make this directory yourself beforehand). Restart the IDE.
Expand Down
4 changes: 4 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@
{
"command": "arduino-littlefs-upload.uploadLittleFS",
"title": "Upload LittleFS to Pico/ESP8266/ESP32"
},
{
"command": "arduino-littlefs-upload.buildLittleFS",
"title": "Build LittleFS image in sketch directory"
}
]
},
Expand Down
Loading