Repository files navigation

Welcome toFlipper 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 order described.

Prerequisites:

• Linux / macOS
• Terminal
• arm-gcc-none-eabi
• openocd

One liner:make flash

Prerequisites:

• Linux / macOS
• Terminal
• STM32_Programmer_CLI (v2.5.0) added to $PATH

One liner:make flash_radio

1. Download latestFirmware

2. Reboot Flipper to Bootloader

• Press and hold← Left +↩ Back for reset
• Release↩ Back and keep holding← Left until blue LED lights up
• Release← Left

3. Rundfu-util -D full.dfu -a 0

1. InstallDocker Engine and Docker Compose
2. Prepare the container:

docker-compose up -d

docker-composeexec dev make

Checkdist/ for build outputs.

Useflipper-z-{target}-full-{suffix}.dfu to flash your device.

If compilation fails, make sure all submodules are all initialized. Either clone with--recursive or usegit submodule update --init --recursive.

Make sure you havebrew 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 /optrm /opt/$toolchain_package.tar.bz2forfilein /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 updateapt install openocd clang-format-13 dfu-util protobuf-compiler

heatshrink has to be compiledfrom sources.

make

Checkdist/ for build outputs.

Useflipper-z-{target}-full-{suffix}.dfu to flash your device.

Connect your device via ST-Link and run:

make whole

• Discord:flipp.dev/discord
• Website:flipperzero.one
• Kickstarter page:kickstarter.com
• Forum:forum.flipperzero.one

• applications - Applications and services used in firmware
• assets - Assets used by applications and services
• core - Furi Core: os level primitives and helpers
• debug - Debug tool: GDB-plugins, SVD-file and etc
• docker - Docker image sources (used for firmware build automation)
• documentation - Documentation generation system configs and input files
• firmware - Firmware source code
• lib - Our and 3rd party libraries, drivers and etc...
• make - Make helpers
• scripts - Supplementary scripts and python libraries home

Also pay attention toReadMe.md files inside of those directories.