Skip to content

Development ​

This section is for people who want to go beyond using the Flipper: build Unleashed Firmware from source, write their own apps in C or JavaScript, debug them on real hardware, talk to the device over the command line, or understand how updates and the hardware work under the hood.

Unleashed

Unleashed is a fork of the official firmware that stays fully compatible with the official API and apps. Almost everything in the official developer documentation applies as-is. The main things to remember:

  • clone https://github.com/DarkFlippers/unleashed-firmware instead of the official repo;
  • when building apps with uFBT, point it at the Unleashed SDK (--index-url=https://up.unleashedflip.com/directory.json), otherwise your app is built against the official SDK and may refuse to load (details);
  • the firmware origin is reported as Unleashed, the current API version on dev is 88.27.

Building the firmware ​

PageWhat you get
Building the firmwareClone, build and flash Unleashed on Linux, macOS and Windows
Flipper Build Tool (fbt)Every fbt target, option and environment variable
Hardware targetsHow targets/ and target.json describe hardware variants (f7, f18)
Building apps on AndroidCompile .fap apps on a phone with Termux + uFBT, no PC

Writing apps ​

PageWhat you get
Your first app in CuFBT, app template, "Hello world" with a dialog, build and run
App manifests (.fam)All application.fam fields, external-app options, private libraries
Furi APIHardware and software architecture, Furi core, furi_assert / furi_check
GUI in appsDialogs, ViewPort, Views & Scenes, view modules
Debugging appsSWD probes, VS Code debugging, Furi HAL debug signals
FuriHalBus APIEnabling/disabling MCU peripherals correctly, DMA channel map
JavaScript on FlipperWrite scripts in JavaScript instead of C (separate group of pages)
Unleashed-only JS modulessubghz, infrared, blebeacon, usbdisk, i2c, spi, vgm — not in stock firmware, not in the official docs

Working with the device ​

PageWhat you get
Command-line interface (CLI)Connect over USB serial; every CLI command with arguments
OTA updatesHow the updater works, manifest fields, [XX-YY] error codes, building packages
Heatshrink tarball formatThe .tar.hs container used for resources in update packages
HardwareTech specs, schematics, 3D models, module and devboard drawings

Testing ​

PageWhat you get
Unit testsBuild and run the on-device unit_tests app, add your own tests
Integration testingThe manual test plan used before merging PRs and releases

Other useful resources ​

Project structure of the firmware repository ​

FolderContents
applicationsApplications and services used in the firmware
assetsAssets used by applications and services
furiFuri Core: OS-level primitives and helpers
debugDebug tools: GDB plugins, SVD file, etc.
documentationDocumentation sources and generator configs
firmwareFirmware source code
libOwn and third-party libraries, drivers
site_sconsBuild helpers
scriptsSupplementary scripts and Python libraries
targetsHardware target definitions (f7, f18)

Many of these folders have their own ReadMe.md — worth reading.

Not affiliated with Flipper Devices. For educational and lawful use only.