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)

<img src="https://habrastorage.org/webt/eo/m0/e4/eom0e4btudte7nrhnyic-laiog0.png" />

Welcome to [Flipper Zero](https://flipperzero.one/)'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. 

# Update firmware

<a href="https://update.flipperzero.one/full_firmware_latest.bin"><img width="300" src="https://update.flipperzero.one/latest-firmware-banner.png" /></a>


Flipper Zero's firmware consists of two components: Bootloader and main firmware. Bootloader controls firmware update process over USB. You need working bootloader installed before update firmware over USB.

1. Download latest [Firmware](https://update.flipperzero.one/full_firmware_latest.bin)

2. Reboot Flipper to Bootloader 
 - Press and hold `← Left` + `↩ Back` for reset 
 - Release `← Left` and keep holding `↩ Back` until blue LED lights up
 - Release `↩ Back`
<img src="https://habrastorage.org/webt/uu/c3/g2/uuc3g2n36f2sju19rskcvjzjf6w.png" />

1. Run `dfu-util -D firmware.bin -a 0 -s 0x08008000:leave`

## Build from source

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)

# Links
* Task tracker: [Jira](https://flipperzero.atlassian.net/)
* 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
Readme fix 2020-11-04 09:49:35 +00:00			`<img src="https://habrastorage.org/webt/eo/m0/e4/eom0e4btudte7nrhnyic-laiog0.png" />`
add more description 2020-08-01 19:54:58 +00:00
Readme fix 2020-11-04 09:49:35 +00:00			`Welcome to [Flipper Zero](https://flipperzero.one/)'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
Readme fix 2020-11-04 09:49:35 +00:00			`# Update firmware`
add dockerfiles for build 2020-08-07 06:51:41 +00:00
Refactoring firmware uploading to update server (#238) * Replace f2 to f3 2020-11-15 10:14:52 +00:00			`<a href="https://update.flipperzero.one/full_firmware_latest.bin"><img width="300" src="https://update.flipperzero.one/latest-firmware-banner.png" /></a>`
add dockerfiles for build 2020-08-07 06:51:41 +00:00
[Wiki] Firmware update, fixes 2020-10-23 08:42:53 +00:00
Remove wiki from github (#216) 2020-11-03 22:29:36 +00:00			`Flipper Zero's firmware consists of two components: Bootloader and main firmware. Bootloader controls firmware update process over USB. You need working bootloader installed before update firmware over USB.`
[Wiki] Firmware update, fixes 2020-10-23 08:42:53 +00:00
Readme fix 2020-11-04 09:49:35 +00:00			`1. Download latest [Firmware](https://update.flipperzero.one/full_firmware_latest.bin)`
[Wiki] Firmware update, fixes 2020-10-23 08:42:53 +00:00
Readme fix 2020-11-04 09:49:35 +00:00			`2. Reboot Flipper to Bootloader`
			- Press and hold `← Left` + `↩ Back` for reset
			- Release `← Left` and keep holding `↩ Back` until blue LED lights up
			- Release `↩ Back`
			`<img src="https://habrastorage.org/webt/uu/c3/g2/uuc3g2n36f2sju19rskcvjzjf6w.png" />`
[Wiki] Firmware update, fixes 2020-10-23 08:42:53 +00:00
Readme fix 2020-11-04 09:49:35 +00:00			1. Run `dfu-util -D firmware.bin -a 0 -s 0x08008000:leave`
[Wiki] Firmware update, fixes 2020-10-23 08:42:53 +00:00
			`## Build from source`
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
move wiki/Home to readme 2020-08-15 06:59:22 +00:00			`# Links`
Readme fix 2020-11-04 09:49:35 +00:00			`* Task tracker: [Jira](https://flipperzero.atlassian.net/)`
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/)`