Go to file
hedger a91d319839
[FL-3162] Moved ufbt to fbt codebase (#2520)
* scripts: moved ufbt code
* ufbt: fixed tool path
* ufbt: fixed linter/formatter target descriptions
* scripts: ufbt: cleanup
* fbt: moved fap launch target to tools; ufbt fixes
* fbt: fixed missing headers from SDK
* ufbt: removed debug output
* ufbt: moved project template to main codebase
* ufbt: fixed vscode_dist
* ufbt: path naming changes
* fbt: error message for older ufbt versions
* ufbt: docs fixes
* ufbt: fixed build dir location
* fbt: fixes for extapps objcopy
* fbt: extapps: removed extra debug output; fixed formatting
* ufbt: handle launch target for multiple known apps
* ufbt: dropping wrapper; linter fixes
* ufbt: fixed boostrap path
* ufbt: renamed entrypoint
* ufbt: updated vscode config
* ufbt: moved sconsign db location
* ufbt: fixed sconsign path
* fbt: SDK builders rework
* fbt: reworked sdk packaging
* ufbt: additional checks and state processing
* ufbt: fixed sdk state file location
* dist: not packaging pycache
* dump commit json content
* Github: more workflow debug prints
* Github: fix incorrect commit meta extraction in get_env.py
* ufbt, fbt: changed SConsEnvironmentError->StopError
* fbtenv: no longer needs SCRIPT_PATH pre-set
* ufbt: fixed sdk state check
* scripts: exception fixes for storage.py
* scripts: fbtenv: added FBT_TOOLCHAIN_PATH for on Windows for compat
* ufbt: app template: creating .gitkeep for images folder
* ufbt: app template: fixed .gitkeep creation
* docs: formatting fixes for AppManifests; added link to ufbt
* fbt: added link to PyPI for old ufbt versions
* sdk: fixed dir component paths

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2023-04-06 10:44:37 +08:00
.github Github: wipe workspace before checkout (#2527) 2023-03-22 15:26:40 +04:00
.vscode fbt: FBT_QUIET option; docs on environment (#2403) 2023-02-17 21:22:08 +09:00
applications [FL-3162] Moved ufbt to fbt codebase (#2520) 2023-04-06 10:44:37 +08:00
applications_user [FL-2627] Flipper applications: SDK, build and debug system (#1387) 2022-09-15 02:21:03 +09:00
assets [FL-3152] Screen streaming improvements (#2498) 2023-03-23 03:00:48 +10:00
debug [FL-3161] Improved debugging experience for external apps (#2507) 2023-03-21 00:03:55 +09:00
documentation [FL-3162] Moved ufbt to fbt codebase (#2520) 2023-04-06 10:44:37 +08:00
firmware [FL-3224] SD Driver: do not cache sd status. (#2560) 2023-04-06 10:26:33 +08:00
furi Improved thread lifecycle (#2534) 2023-03-28 16:34:49 +09:00
lib Furi: more gpio checks in HAL (#2549) 2023-04-06 10:19:39 +08:00
scripts [FL-3162] Moved ufbt to fbt codebase (#2520) 2023-04-06 10:44:37 +08:00
site_scons [FL-3162] Moved ufbt to fbt codebase (#2520) 2023-04-06 10:44:37 +08: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 Add more detail to saved info screen (#2548) 2023-04-04 11:21:43 +08:00
.gitmodules [FL-3152] Screen streaming improvements (#2498) 2023-03-23 03:00:48 +10:00
.pvsconfig [FL-3055] Getter for application data path (#2181) 2023-03-02 03:57:27 +10:00
.pvsoptions [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
CODE_OF_CONDUCT.md Code of Conduct (#739) 2021-10-02 20:32:18 +03:00
CODING_STYLE.md Change camelCase to PascalCase in code style (#2329) 2023-01-29 12:53:35 +07:00
CONTRIBUTING.md Fixing various typos in readme files #2208 2022-12-28 23:30:20 +09:00
fbt gh: use shallow clones whenever possible (#2491) 2023-03-16 00:24:56 +09:00
fbt_options.py [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +09:00
fbt.cmd gh: use shallow clones whenever possible (#2491) 2023-03-16 00:24:56 +09:00
firmware.scons [FL-3162] Moved ufbt to fbt codebase (#2520) 2023-04-06 10:44:37 +08:00
LICENSE Add LICENSE (#644) 2021-08-13 21:19:42 +03:00
ReadMe.md ReadMe: edit text, move Links to the end (#2219) 2023-01-07 03:05:58 +09:00
SConstruct [FL-3097] fbt, faploader: minimal app module implementation (#2420) 2023-03-14 23:29:28 +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 (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.

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
  • debug - debug tool: GDB plugins, an SVD file, 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, see ReadMe.md files inside those directories for further details.

Links