flipperzero-firmware/README.md

# Flipper Zero Firmware community repo

[![Discord](https://img.shields.io/discord/740930220399525928.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](http://flipperzero.one/discord)

![](https://github.com/Flipper-Zero/flipperzero-firmware-community/raw/master/wiki_static/firmware-wiki-header.gif)

Welcome to [Flipper Zero](https://flipperzero.one/zero)'s Firmware repo! Our goal is to create nice and clean code along with good documentation, to make it a pleasure for everyone to work with. This repo will become completely public closer to the device shipping date. 

**We are open for changes!** You can suggest changes for any part of the code, wiki, guidelines, workflow, automation, etc.

If you are deary to start, please read [contribution guide](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Contributing) about creating issue, editing wiki, improving codebase and configuring environment.

# Developer blog

You can read project updates in our developer blog:

**[Developer blog index](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Developer-blog)**

# Firmware

**[Firmware page](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Firmware)**

## Build and run:

You can run firmware locally (with HAL stub):

* `docker-compose exec dev make -C firmware TARGET=local APP_TEST=1 run` for running tests
* `docker-compose exec dev make -C firmware TARGET=local APP_*=1 run` for running examples (see `applications/applications.mk` for list of applications/examples)

Or you can use your dev. board:

`docker-compose exec dev make -C firmware TARGET=f2 APP_*=1 flash` for build and flash dev board (see `applications/applications.mk` for list of applications/examples)

## Architecture and components

Flipper consists of the two main parts:

* Core: OS, HAL, FS, bootloader, FURI
* Applications: features like RFID or Tamagotchi, and also background tasks like button debouncing and backlight control.

### User Interface

[User Interface](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/UI)

### Features

* [Basic Features](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Basic-features)
* [Sub-1 GHz radio](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Sub-1-GHz-radio) (Transceiver Based on CC1101 chip for 315/433/868 MHz)
* [125 kHz RFID](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/125-kHz-RFID)
* [Infrared](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Infrared)
* [iButton contact keys](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/iButton)
* [USB](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/USB)
* [Bluetooth](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Bluetooth)
* [GPIO/HW Modules](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/GPIO)
* [NFC](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/NFC)
* [U2F](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/U2F)
* [Tamagotchi](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Tamagotchi)
* [Plugins](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Plugins)

# Hardware

**[Hardware page](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Hardware)**

# Tools

* [St-Link](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/ST-Link)
* [VPN](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/VPN)

# Links

* Discord server: [flipperzero.one/discord](https://flipperzero.one/discord)
* Project website: [flipperzero.one](https://flipperzero.one)
* Kickstarter page: [kickstarter.com](https://www.kickstarter.com/projects/flipper-devices/flipper-zero-tamagochi-for-hackers)
* Forum: [forum.flipperzero.one](https://forum.flipperzero.one/)
-												move badge on next line
											
										
										
											2020-09-17 07:43:04 +00:00
+								# Flipper Zero Firmware community repo
 								[![Discord](https://img.shields.io/discord/740930220399525928.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](http://flipperzero.one/discord)
-												Update README.md
											
										
										
											2020-08-17 22:10:34 +00:00
-												Updated wiki pages to use lfs objects (#58)

- Added stm32f4 hal and ll drivers pdf
- Removed all the lfs objects to the old wiki
- Removed lfs gitattribute garbage

Signed-off-by: Henry Pauli <henry@mixict.nl>

Co-authored-by: Henry Paulissen <henry@mixict.nl>
											
										
										
											2020-08-28 15:57:26 +00:00
+								![](https://github.com/Flipper-Zero/flipperzero-firmware-community/raw/master/wiki_static/firmware-wiki-header.gif)
-												add more description

											
										
										
											2020-08-01 19:54:58 +00:00
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
+								Welcome to [Flipper Zero](https://flipperzero.one/zero)'s Firmware repo! Our goal is to create nice and clean code along with good documentation, to make it a pleasure for everyone to work with. This repo will become completely public closer to the device shipping date.
-												add some links

											
										
										
											2020-08-01 19:47:07 +00:00
-												Devblog (#83)

* add first devblog post

* add release link

* add devblog to sidebar
											
										
										
											2020-09-03 04:55:28 +00:00
+								**We are open for changes!** You can suggest changes for any part of the code, wiki, guidelines, workflow, automation, etc.
-												add dockerfiles for build

											
										
										
											2020-08-07 06:51:41 +00:00
-												Devblog (#83)

* add first devblog post

* add release link

* add devblog to sidebar
											
										
										
											2020-09-03 04:55:28 +00:00
+								If you are deary to start, please read [contribution guide](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Contributing) about creating issue, editing wiki, improving codebase and configuring environment.
-												add dockerfiles for build

											
										
										
											2020-08-07 06:51:41 +00:00
-												Devblog (#83)

* add first devblog post

* add release link

* add devblog to sidebar
											
										
										
											2020-09-03 04:55:28 +00:00
+								# Developer blog
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
-												Devblog (#83)

* add first devblog post

* add release link

* add devblog to sidebar
											
										
										
											2020-09-03 04:55:28 +00:00
+								You can read project updates in our developer blog:
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
-												Devblog (#83)

* add first devblog post

* add release link

* add devblog to sidebar
											
										
										
											2020-09-03 04:55:28 +00:00
+								**[Developer blog index](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Developer-blog)**
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
-												Devblog (#83)

* add first devblog post

* add release link

* add devblog to sidebar
											
										
										
											2020-09-03 04:55:28 +00:00
+								# Firmware
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
-												Devblog (#83)

* add first devblog post

* add release link

* add devblog to sidebar
											
										
										
											2020-09-03 04:55:28 +00:00
+								**[Firmware page](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Firmware)**
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
-												Devblog (#83)

* add first devblog post

* add release link

* add devblog to sidebar
											
										
										
											2020-09-03 04:55:28 +00:00
+								## Build and run:
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
-												Target refactoring and cube update (#161)

* Lib: move cube to libs. Firmware: prepare for code base refactoring, detach from cube, port to cmsis_os2.

* Firmware, target f2: regenerate project with latest cube package, tim17 for os ticks.

* Firmware: unified codebase.

* Core: do not include semaphore on old targets. Firmware: dfu uplaod target.

* CI: submodules, add firmware build.

* CI: proper submodule config.

* refactor build system

* CI: update chain to use new targets. Documentation: update to match current structure.

* CI: clean before rebuild.

* Add local test

docker-compose exec dev make -C firmware TARGET=local TEST=1 run

* Makefile: target specific build directory. CI: updated artifacts path.

* Makefile: init git submodules if they don't exists.

* Makefile: debug rule now doesn't reset MCU, prevent SIGINT propagation to st-util.

* Makefile: proper rebuild sequence in zz and zzz

* Makefile: timestamp tracking for flash and upload commands.

* Apps: modular build. Input: fix flipper hal inline.

* Wiki: proper bootloader link.

* Applications: fix broken build for local targets.

* add st-flash to docker

* fix build

* force rebuild app

* move app force to firmware part

* fix build deps

* qrcode build ok

* fix example display

* add testing routine

* update build instruction

Co-authored-by: Aleksandr Kutuzov <aku@plooks.com>
Co-authored-by: aanper <mail@s3f.ru>
											
										
										
											2020-10-07 09:37:43 +00:00
+								You can run firmware locally (with HAL stub):
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
-												Target refactoring and cube update (#161)

* Lib: move cube to libs. Firmware: prepare for code base refactoring, detach from cube, port to cmsis_os2.

* Firmware, target f2: regenerate project with latest cube package, tim17 for os ticks.

* Firmware: unified codebase.

* Core: do not include semaphore on old targets. Firmware: dfu uplaod target.

* CI: submodules, add firmware build.

* CI: proper submodule config.

* refactor build system

* CI: update chain to use new targets. Documentation: update to match current structure.

* CI: clean before rebuild.

* Add local test

docker-compose exec dev make -C firmware TARGET=local TEST=1 run

* Makefile: target specific build directory. CI: updated artifacts path.

* Makefile: init git submodules if they don't exists.

* Makefile: debug rule now doesn't reset MCU, prevent SIGINT propagation to st-util.

* Makefile: proper rebuild sequence in zz and zzz

* Makefile: timestamp tracking for flash and upload commands.

* Apps: modular build. Input: fix flipper hal inline.

* Wiki: proper bootloader link.

* Applications: fix broken build for local targets.

* add st-flash to docker

* fix build

* force rebuild app

* move app force to firmware part

* fix build deps

* qrcode build ok

* fix example display

* add testing routine

* update build instruction

Co-authored-by: Aleksandr Kutuzov <aku@plooks.com>
Co-authored-by: aanper <mail@s3f.ru>
											
										
										
											2020-10-07 09:37:43 +00:00
+								* `docker-compose exec dev make -C firmware TARGET=local APP_TEST=1 run` for running tests
 								* `docker-compose exec dev make -C firmware TARGET=local APP_*=1 run` for running examples (see `applications/applications.mk` for list of applications/examples)
 								Or you can use your dev. board:
 								`docker-compose exec dev make -C firmware TARGET=f2 APP_*=1 flash` for build and flash dev board (see `applications/applications.mk` for list of applications/examples)
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
-												Devblog (#83)

* add first devblog post

* add release link

* add devblog to sidebar
											
										
										
											2020-09-03 04:55:28 +00:00
+								## Architecture and components
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
-												readme update
											
										
										
											2020-08-20 17:35:30 +00:00
+								Flipper consists of the two main parts:
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
 								* Core: OS, HAL, FS, bootloader, FURI
-												readme update
											
										
										
											2020-08-20 17:35:30 +00:00
+								* Applications: features like RFID or Tamagotchi, and also background tasks like button debouncing and backlight control.
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
-												Ui guidlines (#140)

* User Interface Wiki page

Co-authored-by: Valeria Aquamine <valerie@flipperdevices.com>
											
										
										
											2020-09-29 10:59:31 +00:00
+								### User Interface
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
-												Ui guidlines (#140)

* User Interface Wiki page

Co-authored-by: Valeria Aquamine <valerie@flipperdevices.com>
											
										
										
											2020-09-29 10:59:31 +00:00
+								[User Interface](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/UI)
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
-												Devblog (#83)

* add first devblog post

* add release link

* add devblog to sidebar
											
										
										
											2020-09-03 04:55:28 +00:00
+								### Features
-												add dockerfiles for build

											
										
										
											2020-08-07 06:51:41 +00:00
-												Fix broken links
											
										
										
											2020-08-17 09:02:31 +00:00
+								* [Basic Features](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Basic-features)
 								* [Sub-1 GHz radio](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Sub-1-GHz-radio) (Transceiver Based on CC1101 chip for 315/433/868 MHz)
 								* [125 kHz RFID](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/125-kHz-RFID)
 								* [Infrared](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Infrared)
-												Wiki Updates

											
										
										
											2020-09-27 23:30:40 +00:00
+								* [iButton contact keys](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/iButton)
-												Fix broken links
											
										
										
											2020-08-17 09:02:31 +00:00
+								* [USB](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/USB)
 								* [Bluetooth](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Bluetooth)
 								* [GPIO/HW Modules](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/GPIO)
 								* [NFC](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/NFC)
 								* [U2F](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/U2F)
 								* [Tamagotchi](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Tamagotchi)
 								* [Plugins](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Plugins)
-												change readme

											
										
										
											2020-08-02 05:25:17 +00:00
-												move wiki/Home to readme

											
										
										
											2020-08-15 06:59:22 +00:00
+								# Hardware
-												change readme

											
										
										
											2020-08-02 05:25:17 +00:00
-												fat update for readme

											
										
										
											2020-08-18 17:18:09 +00:00
+								**[Hardware page](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Hardware)**
-												move wiki/Home to readme

											
										
										
											2020-08-15 06:59:22 +00:00
-												St-Link Wiki page (#143)

* ST-Link Downgrade Manual

											
										
										
											2020-09-29 14:56:29 +00:00
+								# Tools
 								* [St-Link](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/ST-Link)
-												Developers VPN manual

											
										
										
											2020-10-02 19:39:39 +00:00
+								* [VPN](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/VPN)
-												St-Link Wiki page (#143)

* ST-Link Downgrade Manual

											
										
										
											2020-09-29 14:56:29 +00:00
-												move wiki/Home to readme

											
										
										
											2020-08-15 06:59:22 +00:00
+								# Links
-												Discord server added to README
											
										
										
											2020-08-21 12:41:14 +00:00
+								* Discord server: [flipperzero.one/discord](https://flipperzero.one/discord)
-												move wiki/Home to readme

											
										
										
											2020-08-15 06:59:22 +00:00
+								* Project website: [flipperzero.one](https://flipperzero.one)
 								* Kickstarter page: [kickstarter.com](https://www.kickstarter.com/projects/flipper-devices/flipper-zero-tamagochi-for-hackers)
-												Fix broken links
											
										
										
											2020-08-17 09:02:31 +00:00
+								* Forum: [forum.flipperzero.one](https://forum.flipperzero.one/)