No description
Find a file
Georgii Surkov 139660d206
[FL-3846] Event Loop Timers (#3721)
* Implement POC event loop tmers (not all edge cases are handled)
* Use a separate ready list to allow for (re)starting and stopping of timers from callback
* Improve the test application
* Improve timer API and test application
* Improve timeout calculation logic
* Improve timer API, update documentation
* Fix API usage error
* Update doxygen comments
* Revert the old (correct) check
* Improve function naming
* Check whether a timer was on the expired list before processing it
* Implement tick callback
* Add critical sections to improve timer consistency
* Simplify event loop timer API
* Remove redundant search
* Refactor timer logic, use message queue
* Simplify FuriEventLoopTimer API
* Improve event loop timer logic
* Update the f18 target
* Remove superfluous clears
* Correct f18 api symbols
* Fix doxygen comments
* Update .pvsconfig
* Use a double push list instead of deque
* Update .pvsconfig
* Add pending callback functionality
* Restore unprocessed flags when applicable
* Refactor Dolphin app to use FuriEventLoop
* Improve naming
* Update naming some more
* Fix a typo Co-authored-by: Silent <CookiePLMonster@users.noreply.github.com>
* Fix wait time in example
* Bump API version
* Debug: multiple of 25 timings in event loop blink test
* Separate FuriEventLoopTimer to its own set of files
* Improve start time calculation for periodic timers
* Do not use dynamic allocations for timer requests
* Split the tick functionality in separate files, rearrange code
* Improve timer queue handling
* Properly reset GPIO pins in the test app
* Properly initialise GPIO pins in the test app too
* Furi: variable naming in event loop
* Furi: fix spelling in event loop

Co-authored-by: あく <alleteam@gmail.com>
Co-authored-by: Silent <CookiePLMonster@users.noreply.github.com>
2024-07-02 13:09:50 +01:00
.github cleanup of various warnings from clangd (#3682) 2024-06-03 14:43:23 +01:00
.vscode fbt, vscode: tweaks for cdb generation for clangd (#3680) 2024-06-01 13:20:51 +01:00
applications [FL-3846] Event Loop Timers (#3721) 2024-07-02 13:09:50 +01:00
applications_user [FL-2627] Flipper applications: SDK, build and debug system (#1387) 2022-09-15 02:21:03 +09:00
assets ReadMe: update outdated bits and pieces (#3726) 2024-06-20 18:18:31 +01:00
documentation New js modules documentation added (#3736) 2024-06-30 12:18:46 +01:00
furi [FL-3846] Event Loop Timers (#3721) 2024-07-02 13:09:50 +01:00
lib LFRFID Securakey: Add Support for RKKTH Plain Text Format (#3728) 2024-06-30 19:11:49 +01:00
scripts Updater: resource compression (#3716) 2024-06-30 11:38:48 +01:00
site_scons fbt: added -Wstrict-prototypes for main firmware (#3557) 2024-04-02 02:02:45 +09:00
targets [FL-3846] Event Loop Timers (#3721) 2024-07-02 13:09:50 +01:00
.clang-format [FL-2627] Flipper applications: SDK, build and debug system (#1387) 2022-09-15 02:21:03 +09:00
.clangd cleanup of various warnings from clangd (#3682) 2024-06-03 14:43:23 +01: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 fbt, vscode: tweaks for cdb generation for clangd (#3680) 2024-06-01 13:20:51 +01:00
.gitmodules Revert "TLSF memory allocator. Less free flash, moar free ram. (#3572)" (#3651) 2024-05-16 18:43:27 +04:00
.pvsconfig [FL-3846] Event Loop Timers (#3721) 2024-07-02 13:09:50 +01:00
.pvsoptions Revert "TLSF memory allocator. Less free flash, moar free ram. (#3572)" (#3651) 2024-05-16 18:43:27 +04:00
.sublime-project Code Cleanup: unused includes, useless checks, unused variables, etc... (#3696) 2024-06-11 03:04:29 +10: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 Toolchain fixes (#3451) 2024-02-26 16:16:19 +04:00
fbt.cmd Toolchain fixes (#3451) 2024-02-26 16:16:19 +04:00
fbt_options.py Update radio stack to v1.19.0 (#3545) 2024-04-09 16:01:55 +09:00
firmware.scons fbt, vscode: tweaks for cdb generation for clangd (#3680) 2024-06-01 13:20:51 +01:00
LICENSE Add LICENSE (#644) 2021-08-13 21:19:42 +03:00
ReadMe.md ReadMe: update outdated bits and pieces (#3726) 2024-06-20 18:18:31 +01:00
SConstruct fbt: fixed missing FBT_FAP_DEBUG_ELF_ROOT to dist env (#3563) 2024-04-02 20:30:42 +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. If you want to contribute to the firmware development, or modify it for your own needs, you can also check our Developer Documentation.

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.

Firmware RoadMap

Firmware RoadMap Miro Board

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
  • applications_users - Place for your additional applications and services
  • assets - Assets used by applications and services
  • documentation - Documentation generation system configs and input files
  • furi - Furi Core: OS-level primitives and helpers
  • lib - Our and 3rd party libraries, drivers, tools and etc...
  • site_scons - Build system configuration and modules
  • scripts - Supplementary scripts and various python libraries
  • targets - Firmware targets: platform specific code

Also, see ReadMe.md files inside those directories for further details.

Links