ec57dd310a
* fbt: using SOURCE_DATE_EPOCH from environment for build timestamp (if set) Co-authored-by: hedger <hedger@users.noreply.github.com> |
||
---|---|---|
.github | ||
applications | ||
assets | ||
debug | ||
docker | ||
documentation | ||
firmware | ||
furi | ||
lib | ||
scripts | ||
site_scons | ||
.clang-format | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.gitmodules | ||
Brewfile | ||
CODE_OF_CONDUCT.md | ||
CODING_STYLE.md | ||
CONTRIBUTING.md | ||
docker-compose.yml | ||
fbt | ||
fbt_options.py | ||
fbt.cmd | ||
firmware.scons | ||
LICENSE | ||
Makefile | ||
ReadMe.md | ||
RoadMap.md | ||
SConstruct |
Flipper Zero Firmware
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.
Clone the Repository
You should clone with
$ git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git
Update firmware
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 offline update package
With Flipper attached over USB:
./fbt --with-updater flash_usb
Just building the package:
./fbt --with-updater updater_package
To update, copy the resulting directory to Flipper's SD card and navigate to update.fuf
file in Archive app.
With STLink
Core1 Firmware
Prerequisites:
- Linux / macOS
- Terminal
- arm-gcc-none-eabi
- openocd
One liner: ./fbt firmware_flash
With USB DFU
-
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
Build with Docker
Prerequisites
- Install Docker Engine and Docker Compose
- Prepare the container:
docker-compose up -d
Compile everything
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
.
Build on Linux/macOS
Check out documentation/fbt.md
for details on building and flashing firmware.
macOS Prerequisites
Make sure you have brew and install all the dependencies:
brew bundle --verbose
Linux Prerequisites
gcc-arm-none-eabi
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
Optional dependencies
- 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.
Compile everything
./fbt
Check dist/
for build outputs.
Use flipper-z-{target}-full-{suffix}.dfu
to flash your device.
Flash everything
Connect your device via ST-Link and run:
./fbt firmware_flash
Links
- Discord: flipp.dev/discord
- Website: flipperzero.one
- Kickstarter page: kickstarter.com
- Forum: forum.flipperzero.one
Project structure
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.