flipperzero-firmware/README.md
2020-10-13 03:03:39 +03:00

3.9 KiB

Flipper Zero Firmware community repo

Discord

Welcome to Flipper 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 about creating issue, editing wiki, improving codebase and configuring environment.

Developer blog

You can read project updates in our developer blog:

Developer blog index

Firmware

Firmware page

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

Features

Hardware

Hardware page

Tools

Links