Welcome to the Flipper Community Wiki¶
This site contains the unofficial community driven knowledge base for the Flipper Zero.
Ready to continue onwards?
- Check out the Getting Started guide!
- Read through the Frequently Asked Questions!
Also check out the cool Flipper Discord Community Server!¶
This Discord Flipper Zero focused server is community first and community-led by many of the long time people that were present in the official server, with more freedom to teach and interact with the community! Want to join in the fun? Click the link!
Looking to contribute?
See our Contributing page!
Note: The content of this wiki is created and maintained by the community and does not represent the official views, statements, or endorsements of Flipper Devices. All Flipper artwork is attributed to Flipper Devices unless otherwise stated. see the about page for more info
Latest Updates:¶
Wi-Fi Devboard
The official Wi-Fi development board sold by Flipper Devices is at it's core an ESP32-S2, which can be technically be flashed with any firmware that supports the ESP32. While the board does support 2.4 GHz Wi-Fi, the S2 model does not support Bluetooth. Additionally, the official board only supports 2.4 GHz Wi-Fi and does NOT support 5 GHz Wi-Fi. Official Purpose Of The Wi-Fi Development Board The official Wi-Fi development board sold by Flipper Devices is geared primarily for debugging firmware and application for the Flipper Zero. Due to this, it arrives pre-flashed with the BlackMagic firmware to enable both wired and wireless debugging. Documentation for how to begin debugging with the board can be found in the official flipper zero documentation. Community Uses For The Board If one does not desire to do development with the board or wants to try a different use for the board, it is possible to flash the Wi-Fi board with alternate firmware to try new functions. The following is a partial list of a few popular community firmware that one may use for the board that also have companion apps for the Flipper Zero: - Marauder, an offensive security testing platform for ESP32 based devices, featuring both Wi-Fi tools and Bluetooth tools for hardware supporting bluetooth. - FlipperHTTP, a multi-purpose firmware that uses HTTP requests to retrieve information from websites, download applications from the catalog, connect with users on social media platforms, and extract data from APIs. - GhostESP, a firmware that provides tools to perform comprehensive Wi-Fi and Bluetooth Low Energy (BLE) analysis, execute targeted wireless tests, and explore dynamic wireless environments.
Installing GhostESP
This guide shows how to install GhostESP onto an ESP32 based board for use with the Flipper Zero. GhostESP can also be used on its own, but the steps below focus on a Flipper-friendly setup. The steps are similar for other ESP32 based boards, but you will need to select the firmware build for your specific board. There are three methods listed below to flash the board. You only need to select one method. The general steps are: 1. Check the Prerequisites 1. Choose ^^one^^ method to flash your board under Flashing Methods 1. Follow the After Flashing steps to connect to your board 1. Optional: Install the GhostESP companion app Prerequisites - A compatible ESP32 board. GhostESP supports the ESP32-Wroom, ESP32-S2, ESP32-S3, ESP32-C3, ESP32-C5, ESP32-C6, and ESP32-P4. See the supported hardware page for the full compatibility matrix.
Troubleshooting
It is recommended first that you check out the ^^Device Troubleshooting section of the official troubleshooting docs^^ before proceeding below, as your question may be answered there. For guides to troubleshoot some of the more obscure Flipper Zero issues, see the items below: [TOC] Flipper Zero Error code on updating If you are experiencing an error code when updating, you can look at the error code list from the OTA update process docs to narrow down your issue. In most cases, errors are typically caused by an improperly formatted or failing MicroSD card and will correspond to the Updating resources error code section. Forgotten/unknown Flipper Zero PIN See the official docs page for PIN reset instructions. If you are still having problems, browse your MicroSD card and delete the hidden .int folder and try the above steps in the docs again.
Overview
Flipper Zero development is done via two primary tools: - FBT: This tool is the complete build tool, and it included when doing a full clone of the flipper zero firmware repository. This tool allows for the building of any component (firmware, app, or animation) for the Flipper Zero. - UFBT: Considered the 'lite' version of FBT, this tool is focused on external app building only. Both of these tool currently provide a command in their respective documentation to get a Visual Studio Code environment up and running. Development Documentation The official documentation for development can be found here. App development resources can also be found here within the same site. Work is ongoing to continue to add more information to the official development docs, and the source code is still currently the best way to study how things work. As linked in the official development docs, a few sample applications can be found here. Useful Links
Basics of Building Firmware & Apps
This guide aims to introduce one to building and installing a release version of the firmware, as well as how to build one application from source using the Flipper Build Tool. Prerequisites This guide assumes you have the following: - Knowledge of how to navigate files and folders using cd in the command line - A working install of Git - About 2 gigabytes of free space - Access to the Flipper Zero Firmware github page Building Your First Firmware 1. Create a folder on your PC where you will store the firmware - Ideally the path to this folder should have no spaces in the name to avoid any issues (I.E. C:\Users\yourname\Desktop\myfirmware\)