• Stars
    star
    12,714
  • Rank 2,521 (Top 0.05 %)
  • Language
    C
  • License
    GNU General Publi...
  • Created over 4 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Flipper Zero firmware source code
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.

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 (coming soon). 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.

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
  • assets - assets used by applications and services
  • furi - Furi Core: OS-level primitives and helpers
  • documentation - documentation generation system configs and input files
  • firmware - firmware source code
  • lib - our and 3rd party libraries, drivers, etc.
  • scripts - supplementary scripts and python libraries home

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

Links

More Repositories

1

Flipper-Android-App

Android Mobile app to rule all Flipper's family
Kotlin
1,519
star
2

qFlipper

qFlipper — desktop application for updating Flipper Zero firmware via PC
C++
1,147
star
3

Flipper-iOS-App

iOS Mobile App to rule all Flipper's family
Swift
723
star
4

flipper-application-catalog

Flipper Application Catalog
Python
579
star
5

flipperzero-ufbt

Compact tool for building and debugging applications for Flipper Zero.
Python
562
star
6

flipperzero-3d-models

Flipper Zero 3D models
510
star
7

blackmagic-esp32-s2

C
493
star
8

flipperzero-good-faps

Flipper Zero Official Apps maintained by Flipper Team and Friends
C
297
star
9

docs

Flipper Zero documentation repo
Python
182
star
10

flipperzero-sd-card-examples

Examples of all types of files stored on Flipper Zero SD card
166
star
11

lab.flipper.net

JavaScript
146
star
12

flipperzero-devboard-stlinkv3

Devboard for Flipper Zero based on ST-Link V3
108
star
13

flipperzero-nfc-tools

Repository contains nfc tools for Flipper companions
C
106
star
14

flipperzero-toolchain

Flipper Zero Embedded Toolchain
Shell
101
star
15

flipperzero-ufbt-action

Official ufbt Action wrapper for building Flipper Zero applications
95
star
16

flipperzero-game-engine

C
89
star
17

flipperzero-protobuf

This repository contains Flipper Zero RPC protocol protobuf description
77
star
18

flipperzero-catalog-sample-app

C
60
star
19

flipperzero_protobuf_py

Python
58
star
20

video-game-module

C
58
star
21

go-flipper

Go
56
star
22

flipperzero-remote-testbench-front

Remote testbench for Flipper zero - Frontend
JavaScript
43
star
23

flipperzero-nfc-rpc

Examples for control NFC over RPC
Python
41
star
24

webdfu

Driver for working with DFU in a browser over WebUSB
TypeScript
36
star
25

flipper-hackathon-moscow

Flipper Hackathon Moscow 2021
36
star
26

flipper-menu-generator

Generates menu tree image from markdown code
JavaScript
36
star
27

update.flipperzero.one

JavaScript
28
star
28

flipperzero-documentation

CSS
28
star
29

Casper-flipper-blog-theme

Handlebars
26
star
30

flipperzero-game-engine-example

Flipper Zero game engine example project
C
25
star
31

flipper-questions-and-answers

Flipper Question and Answer sessions archive
22
star
32

stm32wb_copro_scripts

Python
22
star
33

homebrew-flipper

Ruby
21
star
34

webflipper

Web client
JavaScript
20
star
35

flipper-update-indexer

Flipper update file uploader and indexer
Python
20
star
36

flipper-documentation-indexer

Python
17
star
37

map-gcc-parser-python

Python
14
star
38

.github

14
star
39

flipper-update-server

Go
13
star
40

flpr.app

HTML
11
star
41

stm32wb_copro

C++
11
star
42

flipper-tilda-webserver

Tilda exporter and webserver
Python
11
star
43

flipperzero-protobuf-jvm

9
star
44

floopper-bloopper

C
9
star
45

welcomer-bot

Python
9
star
46

IRDB

Flipper IR database with device catalogs
9
star
47

flipper-map-reporter

Map file analyser CI/CD
Shell
9
star
48

flipper-k8s-db-backuper

Make backups of databases in k8s
Python
9
star
49

docker-rsync-server

Shell
8
star
50

flipper-factory-reset

Fully reset flipper and set it to the shipping state
Python
8
star
51

sub-sync

Sync Ghost and Sendinblue subscribers
Go
8
star
52

discord-backers-bot

Go
7
star
53

inotify-safe-mv

Dockerfile
7
star
54

flipperzero-protobuf-metric

Protobuf for flipper metrics
7
star
55

discord-notifier

Go
6
star
56

thumbnail-autogen

Dockerfile
5
star
57

chmocker

Chroot-based Docker-like pseudo-containers for MacOS
Python
5
star
58

firmware-report-server

Flipper Zero FW build report analyzer backend
Python
5
star
59

QA-flipper-units

Simple script to run the unit tests inside flipper and validate the result
Python
5
star
60

go-metric

Server for metric from application
Go
4
star
61

firmware-report-client

Svelte
3
star
62

flipper-url-shortener

Python
3
star
63

ship-flipp

Go
2
star
64

flipper-catalog-apps-downloader

Python
1
star
65

IRDB-Backend

Backend for IRDB database
Kotlin
1
star
66

flipper-github-runner-docker-qa

Self-hosted github actions runners for QA
Python
1
star
67

flipper-local-ssl

Flipper LAN SSL Deployer
Python
1
star