unleashed-firmware/ReadMe.md

Flipper Zero Firmware

• Flipper Zero Official Website. A simple way to explain to your friends what the Flipper Zero can do
• Flipper Zero Firmware Update. Improvements for your dolphin: latest firmware releases, upgrade tools for PC and Mobile devices
• User Documentation. Learn more about your dolphin: specs, usage guides, and everything that you wanted to ask

Contributing

Our main goal is to build a healthy, sustainable community around the Flipper and be open to any new ideas and contributions. We also have some rules and taboos here, so please read this page and our Code Of Conduct carefully.

I need help

The best place to search for answers is our User Documentation. If you can't find the answer there, you can check our Discord Server or our Forum.

I want to report an issue

If you've found an issue and want to report it, please check our Issues page. Make sure that the description contains information about the firmware version you're using, your platform, and the proper steps to reproduce the issue.

I want to contribute code

Before opening a PR, please confirm that your changes must be contained in the firmware. Many ideas can easily be implemented as external applications and published in the Flipper Application Catalog (coming soon). If you are unsure, you can ask on the Discord Server or the Issues page, and we'll help you find the right place for your code.

Also, please read our Contribution Guide, and our Coding Style, and ensure that your code is compatible with our project License.

Finally, open a Pull Request and ensure that CI/CD statuses are all green.

Development

The Flipper Zero Firmware is written in C, with some bits and pieces written in C++ and armv7m assembly languages. An intermediate level of C knowledge is recommended for comfortable programming. For Flipper applications, we support C, C++, and armv7m assembly languages.

Requirements

Supported development platforms:

• Windows 10+ with PowerShell and Git (x86_64)
• macOS 12+ with Command Line tools (x86_64, arm64)
• Ubuntu 20.04+ with build-essential and Git (x86_64)

Supported in-circuit debuggers (optional but highly recommended):

• Flipper Zero Wi-Fi Development Board
• ST-Link
• J-Link

Everything else will be taken care of by Flipper Build System.

Cloning Source Code

Ensure that you have enough space and clone source code with Git:

git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git

Building

Build firmware using Flipper Build Tool:

./fbt

Flashing Firmware using an in-circuit debugger

Connect your in-circuit debugger to the Flipper and flash firmware using Flipper Build Tool:

./fbt flash

Flashing Firmware using USB

Ensure that your Flipper is working, connect it using a USB cable and flash firmware using Flipper Build Tool:

./fbt flash_usb

Documentation

• Flipper Build Tool - building, flashing, and debugging Flipper software
• Applications, Application Manifest - developing, building, deploying, and debugging Flipper applications
• Hardware combos and Un-bricking - recovering your Flipper from most nasty situations
• Flipper File Formats - everything about how Flipper stores your data and how you can work with it
• Universal Remotes - contributing your infrared remote to the universal remote database
• Firmware Roadmap
• And much more in the Documentation folder

Links

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

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.