Our main goal is to build a healthy and sustainable community around Flipper, so we're 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.
The best place to search for answers is our User Documentation. If you can't find the answer there, check our Discord Server or our Forum.
If you've found an issue and want to report it, please check our Issues page. Make sure the description contains information about the firmware version you're using, your platform, and a clear explanation of the steps to reproduce the issue.
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, reach out to us 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 make sure your code is compatible with our Project License.
Finally, open a Pull Request and make sure that CI/CD statuses are all green.
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. C, C++, and armv7m assembly languages are supported for Flipper applications.
Supported development platforms:
Supported in-circuit debuggers (optional but highly recommended):
Flipper Build System will take care of all the other dependencies.
Make sure you have enough space and clone the source code:
git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git
Build firmware using Flipper Build Tool:
./fbt
Connect your in-circuit debugger to your Flipper and flash firmware using Flipper Build Tool:
./fbt flash
Make sure your Flipper is on, and your firmware is functioning. Connect your Flipper with a USB cable and flash firmware using Flipper Build Tool:
./fbt flash_usb
applications
- applications and services used in firmwareassets
- assets used by applications and servicesfuri
- Furi Core: OS-level primitives and helpersdebug
- debug tool: GDB plugins, an SVD file, etc.documentation
- documentation generation system configs and input filesfirmware
- firmware source codelib
- our and 3rd party libraries, drivers, etc.scripts
- supplementary scripts and python libraries homeAlso, see ReadMe.md
files inside those directories for further details.