Go to file
Nikolay Minaylov f43b76efc2
[FL-3021] USB/BLE HID Remote icon fix (#2179)
Co-authored-by: あく <alleteam@gmail.com>
2022-12-27 17:03:56 +09:00
.github Fix amap on forks (#2200) 2022-12-27 16:35:57 +09:00
.vscode VSCode: add task 'Serial console' and group task with sequence calling (#2121) 2022-12-14 16:42:13 +09:00
applications [FL-3021] USB/BLE HID Remote icon fix (#2179) 2022-12-27 17:03:56 +09:00
applications_user [FL-2627] Flipper applications: SDK, build and debug system (#1387) 2022-09-15 02:21:03 +09:00
assets Fix quoted error for macOS bad-usb (#2155) 2022-12-27 16:55:25 +09:00
debug [FL-2811] Fix PVS-Studio warnings (#2142) 2022-12-26 21:13:30 +09:00
documentation [FL-3037, FL-3038, FL-3039] File format docs: RFID, iButton, BadUSB (#2177) 2022-12-23 19:25:29 +09:00
firmware [FL-2811] Fix PVS-Studio warnings (#2142) 2022-12-26 21:13:30 +09:00
furi [FL-2811] Fix PVS-Studio warnings (#2142) 2022-12-26 21:13:30 +09:00
lib [FL-2811] Fix PVS-Studio warnings (#2142) 2022-12-26 21:13:30 +09:00
scripts Trigger amap from another repo (#2171) 2022-12-27 05:22:22 +09:00
site_scons Fix typos in various outputs (#2032) 2022-11-23 22:15:08 +09:00
.clang-format [FL-2627] Flipper applications: SDK, build and debug system (#1387) 2022-09-15 02:21:03 +09:00
.editorconfig Create .editorconfig (#889) 2021-12-15 14:33:52 +03:00
.gitattributes [FL-2554] Embedded arm-none-eabi toolchain (#1351) 2022-07-15 01:24:26 +09:00
.gitignore fbt: compile_db fixes (#1981) 2022-11-07 23:54:41 +09:00
.gitmodules fbt fixes pt4 (#1899) 2022-10-26 07:15:02 +09:00
.pvsconfig [FL-2811] Fix PVS-Studio warnings (#2142) 2022-12-26 21:13:30 +09:00
.pvsoptions [FL-2811] Fix PVS-Studio warnings (#2142) 2022-12-26 21:13:30 +09:00
Brewfile [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
CODE_OF_CONDUCT.md Code of Conduct (#739) 2021-10-02 20:32:18 +03:00
CODING_STYLE.md [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
CONTRIBUTING.md Fix for spelling (#2051) 2022-11-29 01:51:51 +09:00
fbt fbt fixes pt4 (#1899) 2022-10-26 07:15:02 +09:00
fbt_options.py [FL- 3014] Untangle NFC from Unit Tests (#2106) 2022-12-10 22:02:34 +09:00
fbt.cmd fbt fixes pt4 (#1899) 2022-10-26 07:15:02 +09:00
firmware.scons fbt: lint fixes (#2008) 2022-11-12 19:03:22 +09:00
LICENSE Add LICENSE (#644) 2021-08-13 21:19:42 +03:00
Makefile [FL-2052] New build system based on scons (#1269) 2022-06-26 21:00:03 +09:00
ReadMe.md Update ReadMe.md (#1766) 2022-09-24 19:36:11 +09:00
RoadMap.md Fixed README formatting & outdated information (#1123) 2022-04-15 21:26:23 +04:00
SConstruct fbt: lint fixes (#2008) 2022-11-12 19:03:22 +09:00

Flipper Zero Firmware

Discord

Show me the code

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

Read the Docs

Check out details on how to build firmware, write applications, un-brick your device and more in documentation folder.

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 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.

Core1 Firmware

Prerequisites:

One-liner: ./fbt firmware_flash

With USB DFU

  1. Download latest Firmware

  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
  1. Run dfu-util -D full.dfu -a 0

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

The FBT tool handles everything, only git is required.

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

Project structure

  • applications - Applications and services used in firmware
  • assets - Assets used by applications and services
  • furi - Furi Core: os level primitives and helpers
  • debug - Debug tool: GDB-plugins, SVD-file and etc
  • documentation - Documentation generation system configs and input files
  • firmware - Firmware source code
  • lib - Our and 3rd party libraries, drivers, etc.
  • scripts - Supplementary scripts and python libraries home

Also pay attention to ReadMe.md files inside those directories.