Flipper Zero Unleashed Firmware
Go to file
hedger 7178bd20cf
ufbt: fixed FAP_SRC_DIR (#2970)
* fbt, ufbt: fixed "_appdir" internal property and FAP_SRC_DIR not working in ufbt environment
* fbt, ufbt: reworked CompileIcons(); added app's own root to app's #include path
* fbt: cleaner resolve_real_dir_node

Co-authored-by: あく <alleteam@gmail.com>
2023-08-11 01:21:56 +09:00
.github [FL-3435] External apps removed (#2934) 2023-08-10 06:18:40 +09:00
.vscode [FL-3437] fbt: build target for faps (#2888) 2023-07-18 13:39:30 +04:00
applications UI: Clock on Desktop (#2891) 2023-08-11 01:10:15 +09:00
applications_user [FL-2627] Flipper applications: SDK, build and debug system (#1387) 2022-09-15 02:21:03 +09:00
assets BadUSB: qFlipper install script for MacOS (#2915) 2023-08-10 06:10:04 +09:00
documentation FBT: devboard_flash to update WiFi devboard (#2968) 2023-08-10 18:53:12 +09:00
firmware UI: Clock on Desktop (#2891) 2023-08-11 01:10:15 +09:00
furi [FL-3461] RPC: md5 in storage list (#2929) 2023-08-09 06:34:54 +09:00
lib Expose additional functions of the crypto engine to user (#2923) 2023-08-10 17:44:46 +09:00
scripts ufbt: fixed FAP_SRC_DIR (#2970) 2023-08-11 01:21:56 +09:00
site_scons ufbt: fixed FAP_SRC_DIR (#2970) 2023-08-11 01:21:56 +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 [FL-3330] fbt: added hooks for build & dist environments; added FW_ORIGIN_* macro for apps & SDK (#2705) 2023-05-30 01:40:56 +09:00
.gitmodules [FL-3435] External apps removed (#2934) 2023-08-10 06:18:40 +09:00
.pvsconfig [FL-3055] Getter for application data path (#2181) 2023-03-02 03:57:27 +10:00
.pvsoptions [FL-3435] External apps removed (#2934) 2023-08-10 06:18:40 +09:00
CODE_OF_CONDUCT.md Code of Conduct (#739) 2021-10-02 20:32:18 +03:00
CODING_STYLE.md fix: make dialog_file_browser_set_basic_options initialize all fields (#2756) 2023-06-27 18:46:04 +09:00
CONTRIBUTING.md Fixing various typos in readme files #2208 2022-12-28 23:30:20 +09:00
fbt [FL-3461] RPC: md5 in storage list (#2929) 2023-08-09 06:34:54 +09:00
fbt_options.py [FL-3330] fbt: added hooks for build & dist environments; added FW_ORIGIN_* macro for apps & SDK (#2705) 2023-05-30 01:40:56 +09:00
fbt.cmd [FL-3285] Removed STM32CubeWB module (#2608) 2023-05-09 06:30:33 +09:00
firmware.scons [FL-3330] fbt: added hooks for build & dist environments; added FW_ORIGIN_* macro for apps & SDK (#2705) 2023-05-30 01:40:56 +09:00
LICENSE Add LICENSE (#644) 2021-08-13 21:19:42 +03:00
ReadMe.md Update the application catalog link in the readme (#2959) 2023-08-08 15:35:51 +09:00
SConstruct FBT: devboard_flash to update WiFi devboard (#2968) 2023-08-10 18:53:12 +09:00

A pixel art of a Dophin with text: Flipper Zero Official Repo

Flipper Zero Firmware

Contributing

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.

I need help

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.

I want to report an issue

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.

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

Development

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.

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 Build System will take care of all the other dependencies.

Cloning source code

Make sure you have enough space and clone the source code:

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 your Flipper and flash firmware using Flipper Build Tool:

./fbt flash

Flashing firmware using USB

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

Documentation

Project structure

  • applications - applications and services used in firmware
  • assets - assets used by applications and services
  • furi - Furi Core: OS-level primitives and helpers
  • 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, see ReadMe.md files inside those directories for further details.

Links