MicroPython Flipper Zero

This branch contains the FAP version of the MicroPython support for the famous Flipper Zero gadget. The results of the preceding research phase is still available in the poc branch. The lib branch of this repository contains just the MicroPython library. The progress of further research on what can be achieved when moving functionality to the firmware can be found in the fork of the original firmware.

Check the progress in this issue and feel free to share your thoughts and ideas.

Requirements

Git
Make
uFBT available in your PATH (or you have to adjust the Makefile)
Flipper Zero (tested with firmware versions 0.99.1 and 0.100.3)

Setup

git clone --recurse-submodules git@github.com:ofabel/mp-flipper.git

Build

Just open a terminal and run the Makefile targets:

make build

You can also build an launch the application on the attached Flipper Zero device in one command:

make launch

Install

To install a release by hand, just copy the mp_flipper_app.fap file on the SD card of your Flipper (e.g. using the qFlipper app):

You should now be able to start the application on your Flipper: Apps > Tools > uPython

You might need to unconnect qFlipper first to free some space in SRAM.

Usage

Just place your Python files somewhere on the SD card.

The application just starts with an open file browser:

Here you can select any Python file to compile and execute from the SD card:

Disclaimer

This FAP version requires about 120 kB from SRAM to start (needed for the Python runtime and compiler). Due to memory fragmentation it's possible, that the application crashes when you start it (tested with the original 0.100.3 firmware). If this happens, just try again (the crash doesn't harm your device).

This is still work in progress, but already more than just a proof of concept.

There is no documentation of the flipperzero module yet. So just checkout the examples for the syntax. Sadly, REPL support is only available in fhe firmware fork version.