Sen descrición

Georgii Surkov 9f0aef330e [FL-2956] Initial unit test docs (#1984) %!s(int64=3) %!d(string=hai) anos
.github ce294c3b1e Update toolchain to version 19. Update codeowners. Fix amap analyze. (#1986) %!s(int64=3) %!d(string=hai) anos
.vscode 2d6c2886ae fbt: compile_db fixes (#1981) %!s(int64=3) %!d(string=hai) anos
applications 328d049b6a Add Acurite 609TXC protocol to weather station (#1987) %!s(int64=3) %!d(string=hai) anos
applications_user b9a766d909 [FL-2627] Flipper applications: SDK, build and debug system (#1387) %!s(int64=3) %!d(string=hai) anos
assets aa2ecbe80f infrared: add Kaseikyo IR protocol (#1965) %!s(int64=3) %!d(string=hai) anos
debug 04e50c9f89 fbt: fixes for ufbt pt3 (#1970) %!s(int64=3) %!d(string=hai) anos
documentation 9f0aef330e [FL-2956] Initial unit test docs (#1984) %!s(int64=3) %!d(string=hai) anos
firmware e8913f2e33 Code cleanup: srand, PVS warnings (#1974) %!s(int64=3) %!d(string=hai) anos
furi e8913f2e33 Code cleanup: srand, PVS warnings (#1974) %!s(int64=3) %!d(string=hai) anos
lib aa2ecbe80f infrared: add Kaseikyo IR protocol (#1965) %!s(int64=3) %!d(string=hai) anos
scripts ce294c3b1e Update toolchain to version 19. Update codeowners. Fix amap analyze. (#1986) %!s(int64=3) %!d(string=hai) anos
site_scons 0a86ad43ca fbt: fix for launch_app (#1978) %!s(int64=3) %!d(string=hai) anos
.clang-format b9a766d909 [FL-2627] Flipper applications: SDK, build and debug system (#1387) %!s(int64=3) %!d(string=hai) anos
.editorconfig f6db5dd2a8 Create .editorconfig (#889) %!s(int64=4) %!d(string=hai) anos
.gitattributes fd498bdfcf [FL-2554] Embedded arm-none-eabi toolchain (#1351) %!s(int64=3) %!d(string=hai) anos
.gitignore 2d6c2886ae fbt: compile_db fixes (#1981) %!s(int64=3) %!d(string=hai) anos
.gitmodules 0adad32418 fbt fixes pt4 (#1899) %!s(int64=3) %!d(string=hai) anos
.pvsconfig 2d6c2886ae fbt: compile_db fixes (#1981) %!s(int64=3) %!d(string=hai) anos
.pvsoptions a7a9c38036 Amap and PVS Studio reports in CI/CD (#1526) %!s(int64=3) %!d(string=hai) anos
Brewfile f3b1475ede [FL-2052] New build system based on scons (#1269) %!s(int64=3) %!d(string=hai) anos
CODE_OF_CONDUCT.md 1208a5077f Code of Conduct (#739) %!s(int64=4) %!d(string=hai) anos
CODING_STYLE.md f3b1475ede [FL-2052] New build system based on scons (#1269) %!s(int64=3) %!d(string=hai) anos
CONTRIBUTING.md 389ff92cc1 Naming and coding style convention, new linter tool. (#945) %!s(int64=4) %!d(string=hai) anos
LICENSE dd6be78f44 Add LICENSE (#644) %!s(int64=4) %!d(string=hai) anos
Makefile f3b1475ede [FL-2052] New build system based on scons (#1269) %!s(int64=3) %!d(string=hai) anos
ReadMe.md 6d2b0a3b6c Update ReadMe.md (#1766) %!s(int64=3) %!d(string=hai) anos
RoadMap.md 000ebb8f96 Fixed README formatting & outdated information (#1123) %!s(int64=3) %!d(string=hai) anos
SConstruct 2d6c2886ae fbt: compile_db fixes (#1981) %!s(int64=3) %!d(string=hai) anos
fbt 0adad32418 fbt fixes pt4 (#1899) %!s(int64=3) %!d(string=hai) anos
fbt.cmd 0adad32418 fbt fixes pt4 (#1899) %!s(int64=3) %!d(string=hai) anos
fbt_options.py 04e50c9f89 fbt: fixes for ufbt pt3 (#1970) %!s(int64=3) %!d(string=hai) anos
firmware.scons 2d6c2886ae fbt: compile_db fixes (#1981) %!s(int64=3) %!d(string=hai) anos

ReadMe.md

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.

With STLink

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