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)
2020-08-17 22:10:34 +00:00
2020-08-28 15:57:26 +00:00
![](https://github.com/Flipper-Zero/flipperzero-firmware-community/raw/master/wiki_static/firmware-wiki-header.gif)
2020-08-01 19:54:58 +00:00
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.
2020-08-01 19:47:07 +00:00
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.
2020-08-07 06:51:41 +00:00
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.
2020-08-07 06:51:41 +00:00
2020-09-03 04:55:28 +00:00
# Developer blog
2020-08-18 17:18:09 +00:00
2020-09-03 04:55:28 +00:00
You can read project updates in our developer blog:
2020-08-18 17:18:09 +00:00
2020-09-03 04:55:28 +00:00
**[Developer blog index](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Developer-blog)**
2020-08-18 17:18:09 +00:00
2020-09-03 04:55:28 +00:00
# Firmware
2020-08-18 17:18:09 +00:00
2020-09-03 04:55:28 +00:00
**[Firmware page](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Firmware)**
2020-08-18 17:18:09 +00:00
2020-09-03 04:55:28 +00:00
## Build and run:
2020-08-18 17:18:09 +00:00
2020-09-03 04:55:28 +00:00
You can run firmware locally (with HAL stub).
2020-08-18 17:18:09 +00:00
2020-09-03 04:55:28 +00:00
* `docker-compose exec dev make -C target_lo` for build
* `docker-compose exec dev target_lo/build/target_lo` for run
2020-08-18 17:18:09 +00:00
2020-09-03 04:55:28 +00:00
## Architecture and components
2020-08-18 17:18:09 +00:00
2020-08-20 17:35:30 +00:00
Flipper consists of the two main parts:
2020-08-18 17:18:09 +00:00
* Core: OS, HAL, FS, bootloader, FURI
2020-08-20 17:35:30 +00:00
* Applications: features like RFID or Tamagotchi, and also background tasks like button debouncing and backlight control.
2020-08-18 17:18:09 +00:00
2020-09-03 04:55:28 +00:00
### UI
2020-08-18 17:18:09 +00:00
Common UI feature (menu, screens...) at [UI page ](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/UI )
2020-09-03 04:55:28 +00:00
### Features
2020-08-07 06:51:41 +00:00
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 )
2020-09-27 23:30:40 +00:00
* [iButton contact keys ](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/iButton )
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 )
2020-08-02 05:25:17 +00:00
2020-08-15 06:59:22 +00:00
# Hardware
2020-08-02 05:25:17 +00:00
2020-08-18 17:18:09 +00:00
**[Hardware page](https://github.com/Flipper-Zero/flipperzero-firmware-community/wiki/Hardware)**
2020-08-15 06:59:22 +00:00
# Links
2020-08-21 12:41:14 +00:00
* Discord server: [flipperzero.one/discord ](https://flipperzero.one/discord )
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 )
2020-08-17 09:02:31 +00:00
* Forum: [forum.flipperzero.one ](https://forum.flipperzero.one/ )