M5Stack-SD-Updater

M5Stack-SD-Updater is an Arduino library for M5Stack to package you apps on a SD card and load them from a menu.

It is inspired by gamebuino, however it does not use a modified bootloader.

PREREQUISITES:

Make sure you have the following libraries:

MSStack: https://github.com/m5stack/M5Stack
ArduinoJSON: https://github.com/bblanchon/ArduinoJson/
QRCode: https://github.com/ricmoo/qrcode
M5Stack-SD-Updater (this project): perform a manual installation
~~M5StackSAM: https://github.com/tomsuch/M5StackSAM~~

Important Notes for M5StackSAM: Temporarily apply this patch or install this pre-patched version https://github.com/tobozo/M5StackSAM (There's an ongoing PR so things will eventually get sorted).

Open both sketch from the "examples/M5Stack-SD-Update" menu.

1) Compile the "M5Stack-SD-Menu.ino" example. This sketch is the menu app. It must be compiled once (sketch / export compiled binary) and saved on the SD Card as "menu.bin" for persistence. It should also be flashed on the M5Stack.

2) Merge and compile the "M5Stack-SDLoader-Snippet.ino" example. Now it is possible to embed any M5 app by implementing the M5Stack SD Loader Snippet. This sketch can be used as a boilerplate to code an app from scratch.

For an existing M5 app, find the line:

  #include <M5Stack.h>

And add this:

  #include "M5StackUpdater.h"

In your setup() function, find the following statements:

  M5.begin();
  Wire.begin()

And add this after 'Wire.begin();':

  if(digitalRead(BUTTON_A_PIN) == 0) {
    Serial.println("Will Load menu binary");
    updateFromFS(SD);
    ESP.restart();
  }

Export the compiled binary (Sketch/Export Compiled Binary) and choose one of the above methods to get the app on the M5Stack:

Manually copy it to the sd card
Clear the content of the /data folder, put the binary there and use the ESP32 Sketch Data Uploader utility (available from the Tools menu in the Arduino IDE).

3) Repeat this for all applications, jpg images or json meta files to import

USAGE:

When an app is loaded in memory, booting the M5Stack with the BTN_A pushed will flash back the menu.bin into memory. When the menu is loaded in memory, it will list all available apps on the sdcard and load them on demand. Booting the M5Stack with the BTN_A pushed will power it off.

Some artwork can be added, the menu will scan for these file types:

.bin compiled application binary
.jpg image/icon (max 200x100)
.json file with dimensions descriptions:

{"width":128,"height":128, "authorName":"tobozo","projectURL":"http://blah","credits":"thanks"}

The file names must match and case matters. jpg and json files are optional but must both be set if provided. The value for projectURL property will be rendered as a QR Code in the info window.

LIMITATIONS:

SD Library limits file names (including path) to 32 chars, M5StackSam has a slightly higher limit
FAT specifications prevent having more than 512 files on the SD Card, but this menu is limited to 256 Items anyway
Long file names will eventually get covered by the jpg image, better stay under 8 chars (not including the extension)

OPTIONAL:

The JoyPSP Controls for M5Stack SD Menu necessary code can safely be disabled in the menu example. It's using a 4 Wires PSP JoyPad breakout on Pins 35 and 36, which are appropriate for analog reading.

The JoyPSP only handles up/down actions for the meantime, more controls will be added soon.

ROADMAP:

Not defined yet, but looking at how fast this library landed in platform.io, there's a possibility it will soon exist in different flavours (i.e. as an ESP-IDF component) or with more features. Contributors welcome!

biblepaywallet / M5Stack-SD-Updater

M5Stack-SD-Updater

PREREQUISITES:

USAGE:

LIMITATIONS:

OPTIONAL:

ROADMAP:

REFERENCES:

About

Languages