- Clone this repo
git clone https://github.com/presidentbeef/flipperzero-firmware-mruby.git
- You will need mruby-3.1.0 installed
- Download qFlipper and move it to the
flipperzero-firmware-mruby
directory
Plug in your Flipper to the computer.
- In
lib/mrubyc
, runmake mrblib
(Only need to do this once) - In the root directory, run
./fbt COMPACT=True DEBUG=False
to build the firmware - Run
./qFlipper-x86_64-1.2.1.AppImage cli firmware dist/f7-DC/flipper-z-f7-full-local.dfu
to load the firmware onto the Flipper
Use mruby 3.0.0 to compile programs to mrb bytecode:
mrbc my_app.rb
Use the qFlipper GUI to copy the file (e.g. my_app.mrb
) to the Flipper.
Then use the Ruby application on the Flipper to run your Ruby bytecode!
Welcome to Flipper Zero's Firmware repo! Our goal is to create nice and clean code with good documentation, to make it a pleasure for everyone to work with.
You should clone with
$ git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git
Get Latest Firmware from Update Server
Flipper Zero's firmware consists of two components:
- Core2 firmware set - proprietary components by ST: FUS + radio stack. FUS is flashed at factory and you should never update it.
- Core1 Firmware - HAL + OS + Drivers + Applications.
They both must be flashed in the order described.
With Flipper attached over USB:
./fbt flash_usb
Just building the package:
./fbt updater_package
To update, copy the resulting directory to Flipper's SD card and navigate to update.fuf
file in Archive app.
Prerequisites:
- Linux / macOS
- Terminal
- arm-gcc-none-eabi
- openocd
One liner: ./fbt firmware_flash
-
Download latest Firmware
-
Reboot Flipper to Bootloader
- Press and hold
← Left
+↩ Back
for reset - Release
↩ Back
and keep holding← Left
until blue LED lights up - Release
← Left
- Run
dfu-util -D full.dfu -a 0
- Install Docker Engine and Docker Compose
- Prepare the container:
docker-compose up -d
docker-compose exec dev ./fbt
Check dist/
for build outputs.
Use flipper-z-{target}-full-{suffix}.dfu
to flash your device.
If compilation fails, make sure all submodules are all initialized. Either clone with --recursive
or use git submodule update --init --recursive
.
Check out documentation/fbt.md
for details on building and flashing firmware.
Make sure you have brew and install all the dependencies:
brew bundle --verbose
toolchain="gcc-arm-none-eabi-10.3-2021.10"
toolchain_package="$toolchain-$(uname -m)-linux"
wget -P /opt "https://developer.arm.com/-/media/Files/downloads/gnu-rm/10.3-2021.10/$toolchain_package.tar.bz2"
tar xjf /opt/$toolchain_package.tar.bz2 -C /opt
rm /opt/$toolchain_package.tar.bz2
for file in /opt/$toolchain/bin/* ; do ln -s "${file}" "/usr/bin/$(basename ${file})" ; done
- openocd (debugging/flashing over SWD)
- heatshrink (compiling image assets)
- clang-format (code formatting)
- dfu-util (flashing over USB DFU)
- protobuf (compiling proto sources)
For example, to install them on Debian, use:
apt update
apt install openocd clang-format-13 dfu-util protobuf-compiler
heatshrink has to be compiled from sources.
./fbt
Check dist/
for build outputs.
Use flipper-z-{target}-full-{suffix}.dfu
to flash your device.
Connect your device via ST-Link and run:
./fbt firmware_flash
- Discord: flipp.dev/discord
- Website: flipperzero.one
- Kickstarter page: kickstarter.com
- Forum: forum.flipperzero.one
applications
- Applications and services used in firmwareassets
- Assets used by applications and servicesfuri
- Furi Core: os level primitives and helpersdebug
- Debug tool: GDB-plugins, SVD-file and etcdocker
- Docker image sources (used for firmware build automation)documentation
- Documentation generation system configs and input filesfirmware
- Firmware source codelib
- Our and 3rd party libraries, drivers and etc...scripts
- Supplementary scripts and python libraries home
Also pay attention to ReadMe.md
files inside of those directories.