xlfe / spiffy Goto Github PK

View Code? Open in Web Editor NEW

45.0 14.0 22.0 108 KB

Build a spiffs file system on linux for embedding into the nodemcu ESP8266 spiffs

License: MIT License

Makefile 0.65% C 99.35%

spiffy's Introduction

spiffy

No longer maintained. Please see forks for other repos!

Build a spiffs file system binary for embedding/writing onto the nodemcu ESP8266 spiffs file system

What is it

spiffy builds a binary spiffs image for you to write_flash to a esp8266 runing nodemcu so you can get all the files onto your cool IoT device in one fell swoop.

usage

Clone the repo and build spiffy

git clone https://github.com/xlfe/spiffy.git
cd spiffy
mkdir build
make

create a folder with the files you'd like to embed

mkdir files

and add your lua scripts, etc to ./files/

run spiffy to build the rom

$ ./build/spiffy
Creating rom spiff_rom.bin of size 16384 bytes
Adding files in directory files
init.lua added to spiffs (66 bytes)
$ ll *.bin
-rw-rw-r-- 1 build build 16384 Jan  1 21:00 spiff_rom.bin

NB: The default rom size is 16k - you can edit main.c to change this

burn your rom to the esp device

Thanks for the info The offset for spiffs file system:

eagle.app.v6.flash.bin: 0x00000~len( eagle.app.v6.flash.bin )
eagle.app.v6.irom0text.bin: 0x10000~0x10000 + len( eagle.app.v6.irom0text.bin )
spiffs_embed.bin: (0x10000 + lengthof(iromtext) + 0x4000) & (0xFFFFC000)
Ie: next to the irom0text.bin, but aligned to 4 * 4096 Bytes (0x4000).

For example:

uild@build:/opt/Espressif/nodemcu-firmware/bin$ ll
drwxrwxr-x  3 build build   4096 Dec 31 16:38 .
drwxrwxr-x 17 build build   4096 Jan  1 20:23 ..
-rw-rw-r--  1 build build  52064 Dec 31 16:25 eagle.app.v6.flash.bin
-rwxrwxr-x  1 build build 293568 Dec 31 16:25 eagle.app.v6.irom0text.bin

So to burn my image I would run:

esptool.py --port /dev/ttyUSB0 write_flash STARTADDR ../../spiffy/spiff_rom.bin

Ie: STARTADDR = (0x10000 + lengthof(iromtext) + 0x4000) & (0xFFFFC000)

Done!

spiffy's People

Contributors

Stargazers

Watchers

Forkers

manfredherrmann acalatrava alonewolfx2 deadbok ngocphu811 adiea ajaybhargav kamejoko80 polkabana tuanpmt someburner iot-alex jfollas niclash codywon mayaposch qweewqfly raghujirao

spiffy's Issues

its not working with new firmware

can you check it?
lengthof(iromtext)=341364 soo flash address= 0x64000 and i am writing this adress and i am getting this.spiff bin contain init.lua,dht11.lua

for n,s in pairs(file.list()) do print(n.." size: "..s) end
� size: 48758784
>

More information about calculating offsets

I am having a hard time determining the offsets. It looks like your example use the split image? I have a combined image, what should I use?

Can't build on mingw

I'm getting this error when building on Windows (mingw):

... depend build/spiffs_check.d
... depend build/spiffs_cache.d
... depend build/spiffs_hydrogen.d
... depend build/spiffs_gc.d
... depend build/spiffs_nucleus.d
... depend build/main.d
... compile build/main.o
In file included from src/main.c:1:0:
./src/spiffs.h:183:9: error: field '_errno' declared as a function
   s32_t errno;
         ^

License

Could you specify a license for that repository?
I'm assuming it would be a MIT license, because spiffs uses one. Could you add a LICENSE file for clarity?

Doesn't seem to work with nodemcu update to 0.9.5

I'm exploring this...

Thanks for the tool, really nice.
I'm trying to use srec_cat in conjunction with spiffy. I'm building a spiffy_out.bin and trying to add it to a regular nodemcu_release.bin.
I'm getting my offset this way:

main_firmware_offset=0x$(echo "obase=16; $(($(stat -f%z 0x10000.bin)))" | bc)
spiff_start_offset=0x$(echo "obase=16; $(($(stat -f%z 0x10000.bin) + 16384))" | bc)
srec_cat -output nodemcu-firmware.out.bin -binary 0x10000.bin -fill 0xff $main_firmware_offset $spiff_start_offset ${spiff_start_offset}.bin -binary -offset $spiff_start_offset

my errors are:

srec_cat: 0x10000.bin: 1: warning: ignoring garbage lines
srec_cat: 0x10000.bin: 659: hexadecimal digit expected

Thank you!

filesystem start address modified

file system begin at STARTADDR = (0x10000 + lengthof(iromtext) + 0x4000) & (0xFFFFC000), aligned to 0x4000.

File size limit?

Uploading a

Creating rom spiff_rom.bin of size 196608 bytes
Adding files in directory files
Unable to read file .
Unable to read file ..
bootstrap.css.gz added to spiffs (15615 bytes)
index.html added to spiffs (2876 bytes)
jquery.js.gz added to spiffs (30153 bytes)

Is there anything that could prevent 30K file to appear on the file system?

Make filesystem size a command line option

It would be a goot idea to have a command line option for the file system size. Editing the source code every time the available space in the NodeMCU flash changes is annoying.

ROM misses first letter in file name and has incorrect file size

Gives 1.6MB as file size, bust has nothing to view on NodeMCU.