├── Firmwares.md ├── LICENSE ├── README.md └── FAQ.md /Firmwares.md: -------------------------------------------------------------------------------- 1 |

Flipper Zero firmware differences

2 |

3 | :: Last updated Nov 24 2022. :: 4 |

5 |

6 | This document maintains a list of differences between various forks of the 7 | Flipper Zero firmware. 8 |

9 | 10 | 11 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 |
12 | Jump to: 13 | OfficialUnleashedRogueMasterv1ncWetoxMuddledBoxSummary (TL;DR)
23 |

24 | ✅ Official 25 | 26 | flipperdevices/flipperzero-firmware 27 | 28 |

29 | 41 |

42 | 🔓 Unleashed 43 | 44 | DarkFlippers/unleashed-firmware 45 | 46 |

47 | 66 |

67 | 💫 RogueMaster 68 | 69 | RogueMaster/flipperzero-firmware-wPlugins 71 | 72 |

73 | 91 |

92 | ⌨ v1nc 93 | 94 | v1nc/flipperzero-firmware 95 | 96 |

97 | 102 |

103 | 🎩 Wetox 104 | 105 | wetox-team/flipperzero-firmware 106 | 107 |

108 | 116 |

117 | 📦 MuddledBox 118 | 119 | MuddledBox/flipperzero-firmware 120 | 121 |

122 | 128 |

129 | 📝 Summary 130 | (TL;DR) 131 |

132 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 | Awesome Flipper Zero 5 | 6 | 7 |
8 | 9 |

10 | A collection of Awesome resources for the Flipper Zero device.

11 | 12 | Awesome 13 | Powered by dolphins 14 | Approved by Lurat 15 | Hack the planet 16 | 17 |

18 | 19 | 20 | 26 | 32 |
21 |

22 | 👋 New to Flipper Zero? Got questions?
23 | Check out the FAQ Document❗ 24 |

25 |
27 |

28 | 🚫 Not affiliated with
29 | Flipper Devices Inc. 30 |

31 |
33 | 34 |
35 | 36 | 37 | 38 | ## Databases & Dumps 39 | - [`UberGuidoZ Playground` Large collection of files, documentation, and dumps of all kinds.](https://github.com/UberGuidoZ/Flipper) 40 | - [`Flipper-IRDB` Many IR dumps for various appliances.](https://github.com/logickworkshop/Flipper-IRDB) 41 | - [`FlipperZero-TouchTunes` Dumps of TouchTune's remote.](https://github.com/jimilinuxguy/flipperzero-touchtunes) 42 | - [`Flipper Maker` Generate Flipper Zero files on the fly.](https://flippermaker.github.io/) 43 | - [`FlipperAmiibo` Bank vault of Amiibos to Flipper's format.](https://github.com/Gioman101/FlipperAmiibo) 44 | - [`FlipperMusicRTTTL` Collection of musics for FlipperZero Music Player.](https://github.com/neverfa11ing/FlipperMusicRTTTL) 45 | - [`flipper-music-files` Much smaller collection of musics for FlipperZero Music Player.](https://github.com/Tonsil/flipper-music-files) 46 | - [`Generic BadUSB Payloads` Hak5 Duckyscript payloads.](https://github.com/nocomp/Flipper_Zero_Badusb_hack5_payloads) 47 | - [`Flipper BadUSB Payloads` Collection of payloads formatted to work on the Flipper Zero.](https://github.com/I-Am-Jakoby/Flipper-Zero-BadUSB) 48 | - [`FlipperZero-Goodies` Intercom keys, scripts, etc.](https://github.com/wetox-team/flipperzero-goodies) 49 | - [`T119 bruteforcer` Triggers Retekess T119 restaurant pagers.](https://github.com/xb8/t119bruteforcer) 50 | - [`flipperzero-bruteforce` Generate .sub files to brute force Sub-GHz OOK.](https://github.com/tobiabocchi/flipperzero-bruteforce) 51 | - [`UNC0V3R3D BadUSB collection` Yet another BadUSB collection.](https://github.com/UNC0V3R3D/Flipper_Zero-BadUsb) 52 | - [`Flipper-StarNew` Universal Intercom Keys.](https://github.com/GlUTEN-BASH/Flipper-Starnew) 53 | - [`FalsePhilosophers Flipper BadUSB` Flipper zero community ducky payload repo.](https://github.com/FalsePhilosopher/badusb) 54 | - [`SerialHex2FlipperZeroInfrared` Convert IR serial messages into FlipperZero compatible IR files.](https://github.com/maehw/SerialHex2FlipperZeroInfrared) 55 | 56 | ## Applications & Plugins 57 | - [`Flipper-Plugin-Tutorial` Updated plugin tutorial based on new build methods.](https://github.com/csBlueChip/FlipperZero_plugin_howto) 58 | - [`Spectrum analyzer` Sub-GHz frequency spectrum analyzer.](https://github.com/jolcese/flipperzero-firmware/tree/spectrum/applications/spectrum_analyzer) 59 | - [`Tetris` A rudimentary Tetris game.](https://github.com/jeffplang/flipperzero-firmware/tree/tetris_game/applications/tetris_game) 60 | - [`Flappy Bird` The name says it all.](https://github.com/DroomOne/flipperzero-firmware/tree/dev/applications%2Fflappy_bird) 61 | - [`Mouse jiggler` Keeps PC screens on by acting as a moving mouse.](https://github.com/MuddledBox/flipperzero-firmware/tree/Mouse_Jiggler/applications/mouse_jiggler) 62 | - [`floopper-bloopper` LD#47 Game.](https://github.com/glitchcore/floopper-bloopper) 63 | - [`NRF24 & Mousejacking` PoC NRF24 library and mousejack exploitation app.](https://github.com/mothball187/flipperzero-nrf24) 64 | - [`UPC-A Barcode Generator` Can be used to create any UPC-A barcode.](https://github.com/McAzzaMan/flipperzero-firmware/tree/UPC-A_Barcode_Generator/applications/barcode_generator) 65 | - [`Sentry Safe` Plugin that can open any Sentry Safe and Master Lock electronic safe without entering pin code.](https://github.com/H4ckd4ddy/flipperzero-sentry-safe-plugin) 66 | - [`Dec/Hex Converter` Small "real time" decimal/hexadecimal converter.](https://github.com/theisolinearchip/flipperzero_stuff/tree/main/applications/dec_hex_converter) 67 | - [`MultiConverter` Multi-unit converter that can be easily expanded with new units and conversion methods.](https://github.com/theisolinearchip/flipperzero_stuff/tree/main/applications/multi_converter) 68 | - [`Doom` Doom-like clone for Flipper Zero.](https://github.com/p4nic4ttack/doom-flipper-zero) 69 | - [`bpm-tapper` Tap along to a song to measure beats per minute.](https://github.com/panki27/bpm-tapper) 70 | - [`Metronome` Musical metronome.](https://github.com/panki27/Metronome) 71 | - [`USB Keyboard` A refactor of the BT remote to work over USB. Allows the Flipper to act as an USB HID keyboard.](https://github.com/huuck/FlipperZeroUSBKeyboard) 72 | - [`Minesweeper` Minesweeper implementation.](https://github.com/panki27/minesweeper) 73 | - [`SD Load Applications` Prebuilt applications (FAP) for popular firmware options.](https://github.com/UberGuidoZ/Flipper/tree/main/Applications) 74 | - [`Tuning Fork` Use your flipper as a tuning fork.](https://github.com/besya/flipperzero-tuning-fork) 75 | - [`GPS` Display data from a serial GPS module.](https://github.com/ezod/flipperzero-gps) 76 | - [`USB HID Autofire` Send left-clicks as a USB HID device.](https://github.com/pbek/usb_hid_autofire) 77 | - [`Flipper Authenticator` Generate TOTP authentication codes.](https://github.com/akopachov/flipper-zero_authenticator/) 78 | - [`Unitemp` Application for reading temperature, humidity and pressure sensors using Onewire, Singlewire, I2C protocols](https://github.com/quen0n/unitemp-flipperzero) 79 | 80 | ## Firmwares & Tweaks 81 | 82 | 83 | 84 | 85 |
Hey you!
🔰 Click here for a feature
comparison of these firmwares!
86 | 87 | - [`Unleashed` Unlocked firmware with rolling codes support & community plugins, stable tweaks, and games.](https://github.com/DarkFlippers/unleashed-firmware) 88 | - [`RogueMaster` Fork of Unleashed firmware with custom graphics, experimental tweaks, community plugins and games.](https://github.com/RogueMaster/flipperzero-firmware-wPlugins) 89 | - [`v1nc flipper zero firmware` Unleashed fork with support for different Duckyscript keyboard layouts & community plugins.](https://github.com/v1nc/flipperzero-firmware) 90 | - [`Wetox` Very similar to the official branch, with a few small tweaks.](https://github.com/wetox-team/flipperzero-firmware) 91 | - [`Muddled Forks` Less-active firmware modifications.](https://github.com/MuddledBox/flipperzero-firmware/tree/muddled_dev) 92 | - [`OpenHaystack BLE mod` Very old PoC that makes Flipper behave like an AirTag.](https://github.com/AlexStrNik/flipperzero-firmware) 93 | 94 | ## Modules & Cases 95 | - [`FlipperZero-Hardware` 3D-Printable cases with custom iButton interface.](https://github.com/s0ko1ex/FlipperZero-Hardware) 96 | - [`Flipper Zero Cases` 3D-Printable case & cover models.](https://github.com/MuddledBox/FlipperZeroCases) 97 | - [`FlipperZero-Protoboards-Kicad` KiCad prototype boards.](https://github.com/lomalkin/flipperzero-protoboards-kicad) 98 | - [`Pelican case` Big case to hold Flipper and USB.](https://www.printables.com/model/204882-flipper-zero-case) 99 | - [`Hard case` Smaller than pelican case, but still bulky.](https://www.thingiverse.com/thing:5387015) 100 | - [`WiFi Module v1 Case` Small cover for the WiFi dev board.](https://www.printables.com/model/179910-case-for-flipper-zero-wi-fi-module-v1) 101 | - [`Flipper screen protector` An alternative screen protector for Flipper.](https://www.photodon.com/p/2419-01.html) 102 | - [`WiFi Scanner Module` Scans for WiFi networks via a custom Wemos module board.](https://github.com/SequoiaSan/FlipperZero-WiFi-Scanner_Module) 103 | - [`WiFi Scanner Module Flasher` Web flasher for module firmware above.](https://sequoiasan.github.io/FlipperZero-WiFi-Scanner_Module/) 104 | - [`WiFi DSTIKE Deauther` Preforms WiFi deauth attacks via a custom ESP8266 module board.](https://github.com/SequoiaSan/FlipperZero-Wifi-ESP8266-Deauther-Module) 105 | - [`WiFi Deauther Module Flasher` Web flasher for module firmware above.](https://sequoiasan.github.io/FlipperZero-Wifi-ESP8266-Deauther-Module/) 106 | - [`Skadis holder` Flipper Zero holder for Ikea Skadis.](https://www.thingiverse.com/thing:5434476) 107 | - [`Flipper Zero Boards` ESP32 and NRF24 daughterboards for the Flipper.](https://github.com/DrB0rk/Flipper-Zero-Boards) 108 | - [`Flipper Zero Car Mount` Uses foam from the original box.](https://www.thingiverse.com/thing:5464899) 109 | - [`Soft TPU cover` Similar to the official silicone case.](https://www.printables.com/en/model/272676-soft-tpu-flipper-zero-cover) 110 | - [`Flipper-Boy` Flipper Zero Case with 22mm Watch Strap Adapter.](https://www.printables.com/model/304243-flipper-boy) 111 | - [`WiFi Devboard Pelican Case` Top case that works with the 4mm FZ Pelican case.](https://github.com/Z3BRO/Flipper-Zero-Pelican-Case-Wifi-Devboard) 112 | - [`RGB Backlight mod` Replace your Flipper LCD's backlight with Adafruit Neopixels.](https://github.com/Z3BRO/Flipper-Zero-RBG-Backlight) 113 | 114 | ## Off-device & Debugging 115 | - [`Official Web Interface` Web interface to interact with Flipper, including Paint and SUB/IR analyzer.](https://my.flipp.dev/) 116 | - [`OOK to .sub` Python script to generate Flipper RAW .sub files from OOK bitstreams.](https://gist.github.com/jinschoi/f39dbd82e4e3d99d32ab6a9b8dfc2f55) 117 | - [`csv2ir` Script to convert IRDB CSV's to Flipper .ir files.](https://github.com/Spexivus/csv2ir) 118 | - [`flipperzero-sesproject` Segger Embedded Studio project.](https://github.com/hedger/flipperzero-sesproject) 119 | - [`FlipperScripts` Modify the state and level of your dolphin.](https://github.com/DroomOne/FlipperScripts) 120 | - [`Viewing system logs` Dump system logs to serial CLI.](https://gist.github.com/jaflo/50c35c46f3ecada7a18c9e5cc203a3f8) 121 | - [`AmiiboFlipperConverter` Script that converts Amiibo's to Flipper format.](https://github.com/Lucaslhm/AmiiboFlipperConverter/) 122 | - [`CLI Tools` Python scripts to screenshot/stream screen.](https://github.com/lomalkin/flipperzero-cli-tools) 123 | - [`Flipper File Toolbox` Scripts for generating Flipper data files.](https://github.com/evilpete/flipper_toolbox) 124 | - [`Marauder for Wifi Dev Board` See Flipper.bin in Releases by JustCallMeKoko.](https://github.com/justcallmekoko/ESP32Marauder) 125 | - [`VertProntoIR2FlipperIR` Converts Vert Pronto IR codes to Flipper format.](https://github.com/SkeletonMan03/VertProntoIR2FlipperIR) 126 | - [`FlippMibo` Yet another Amiibo to Flipper conversion script.](https://github.com/0xz00n/FlipMiibo) 127 | - [`mfkey32v2` MFC key recovery reader attack.](https://github.com/equipter/mfkey32v2) 128 | - [`Fztea` Connect to your Flipper's UI over serial or make it accessible via SSH.](https://github.com/jon4hz/fztea) 129 | - [`pyFlipper` Unofficial CLI wrapper writter in Python.](https://github.com/wh00hw/pyFlipper) 130 | - [`SUB Plotters / comparers` Python package to plot and compare multiple .sub files.](https://github.com/ShotokanZH/flipper_sub_plotters_comparers) 131 | - [`ClassicConverted` Converts Mifare Classic binary files to Flipper.](https://github.com/equipter/ClassicConverter) 132 | - [`musicxml2fmf` Converts MusicXML files to Flipper Music Format.](https://github.com/white-gecko/musicxml2fmf) 133 | - [`BadUSB keyboard converter` Payload converted for non-US keyboard layouts.](http://helppox.com/badusbconvert.html) 134 | - [`U2F SSH Keys` U2F ECDSA SSH Key Generation using Flipper Zero.](https://gist.github.com/BlackPropaganda/44c40f7855a90e289a9477b654e54eb1) 135 | - [`flipper0` Rusty crate with safe interface to Flipper Firmware and autogen bindings underneath.](https://crates.io/crates/flipper0) 136 | - [`flipperzero-rs` Hand-crafted bindings to Flipper Firmware with custom build tool.](https://github.com/dcoles/flipperzero-rs) 137 | - [`fzfs` Flipper Zero filesystem driver.](https://github.com/dakhnod/fzfs) 138 | 139 | ## Notes & References 140 | - [`Official battery self-repair guide` How to troubleshoot battery issues.](https://cdn.flipperzero.one/self-repair-guide.pdf) 141 | - [`Official firmware recovery guide` How to troubleshoot firmware issues.](https://docs.flipperzero.one/basics/firmware-update/firmware-recovery) 142 | - [`FZ Firmware Comparisons` Comparison of custom firmwares listed in this repo.](https://github.com/djsime1/awesome-flipperzero/blob/main/Firmwares.md) 143 | - [`Flipper Zero Hacking 101` Guides with screenshots, files, and general help.](https://flipper.pingywon.com/) 144 | - [`Reset forgotten PIN` How to reset your device's PIN code.](https://gist.github.com/djsime1/18d73b981249859f17aab3e2bfd2b600) 145 | - [`Atmanos Flipper Software Docs` Flipper development tutorials and information.](https://flipper.atmanos.com/docs/overview/intro) 146 | - [`Flipper Zero GPIO Pinout` Official GPIO pinouts.](https://miro.com/app/board/uXjVO_LaYYI=/?moveToWidget=3458764522696947614&cot=10) 147 | - [`Add-on Modules GPIO Pinouts` ESP32, ESP8266, ESP32-CAM, ESP32-WROOM, NRF24.](https://github.com/UberGuidoZ/Flipper/tree/main/GPIO) 148 | - [`Firmware roadmap` Official stock firmware roadmap.](https://miro.com/app/board/uXjVO_3D6xU=/?moveToWidget=3458764522498020058&cot=14) 149 | - [`Flipper Zero SW&HW keynote` (OUTDATED) Hardware & software architecture document.](https://miro.com/app/board/o9J_l1XZfbw=/?moveToWidget=3458764514405659414&cot=14) 150 | - [`Unofficial Community Wiki` To help consolidate all things Flipper (official and unofficial).](https://flipperzero.miraheze.org/wiki/Main_Page) 151 | - [`Flipper Zero disassembly guide` Difficulty: Moderate, Time: 8-15 Minutes.](https://www.ifixit.com/Guide/Flipper+Zero+Disassembly/151455) 152 | - [`Alternative disassembly video` Third-party video for disassembling the Flipper.](https://youtu.be/38pHe7M4vl8) 153 | - [`ESP32 Marauder on WiFi dev board` Portable WiFi/Bluetooth pentesting.](https://github.com/justcallmekoko/ESP32Marauder/wiki/flipper-zero) 154 | - [`ESP32 Marauder guide video` Companion video for the above link.](https://youtu.be/_YLTpNo5xa0) 155 | - [`Flipper Skylanders` How to read a Skylanders figure with Flipper.](https://github.com/V0lk3n/Flipper-Skylanders) 156 | - [`Flipper Zero Dimensions` Basic info on screen and case dimensions.](https://github.com/UberGuidoZ/Flipper/tree/main/FlipperZero_Dimensions) 157 | 158 | 159 | 160 | 161 |
162 |

Want to make changes?

163 |
164 | You can Edit this file and open a Pull Request, 165 | or Start a discussion with your ideas.
166 | Read the Meta FAQ section for more info. 167 |
168 | -------------------------------------------------------------------------------- /FAQ.md: -------------------------------------------------------------------------------- 1 | 2 | Flipper Zero FAQ 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 |
Table of Contents
MetaGeneralSub-GHzNFC & RFIDInfraredBadUSBiButtonWiFi board
18 | 19 | ## Preamble [🔝](#top) 20 | - *This is a community FAQ. Please consider also reading the [Official docs](https://docs.flipperzero.one/).* 21 | - *It is written with information from the latest dev firmware, you may have to wait for a firmware (pre)release before some of the questions/answers become relevant.* 22 | - *This FAQ is still being worked on, and contributions are welcome.* 23 | - *If your question isn't answered here, **SEARCH** the [Discord](https://flipperzero.one/discord) and check pinned messages before asking there.* 24 | 25 | 26 | 27 | ## Meta [🔝](#top) 28 | 29 | ### What is Awesome Flipper Zero? 30 | > It's an [Awesome List](https://github.com/sindresorhus/awesome/blob/main/awesome.md) that I ([djsime1](https://dj.je)) created shortly after receiving Lurat, my lovely dolphin sidekick. 31 | 32 | ### What is an Awesome List? 33 | > An [Awesome List](https://github.com/sindresorhus/awesome/blob/main/awesome.md) is a collection of links and resources related to some project or topic. Think of it like a central curated hub to discover interesting stuff. 34 | 35 | 36 | ### How can I contribute to this repo? 37 | > Perferably, open a [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) with your changes, or use one of the methods in the next question to contact me. 38 | 39 | ### I found a mistake, broken link, or something else. What should I do? 40 | > Open a [new discussion](https://github.com/djsime1/awesome-flipperzero/discussions/new) on this repo, or contact me via one of the methods listed on [this page](https://dj.je/pages/contact). 41 | 42 | ### Why are there so many unmerged pull requests? 43 | > If there's multiple small pull requests open at the same time, I'll often merge them together as a single update. Due to the way GitHub works, I'm unable to mark them as merged when I do this. To compensate, I include the contributors as co-authors on the commit, and mention the Pull Request ID's as part of the update message. 44 | 45 | ### This is really cool! Is there a way I can donate to you? 46 | > I really appreciate the kind words, however I'm not accepting personal monetary donations. 47 | > If you're really insistent, I'll accept a Discord Nitro gift ([`@DJ#9822`](https://discord.gg/9rduBhctJ6)) or Steam Game ([`/id/djsime1`](https://steamcommunity.com/id/djsime1/))! 48 | > Besides that, why not support a local charity/organization instead? My personal recommendation is the [Electronic Frontier Foundation](https://supporters.eff.org/donate). 49 | 50 | 51 | 52 | ## General [🔝](#top) 53 | 54 | ### What MicroSD Card should I use? 55 | > - It should be a reputable brand (Like SanDisk, Sony, etc.) because often cheaper cards don't fully support the communication protocol Flipper uses. 56 | > - The card should have a capacity between 4 and 64 GB, but an 8 GB card is MORE than enough. 57 | > - After inserting the card, use the Flipper's setting menu to format (clear) and test the card. 58 | > - Before ejecting the card, unmount it via the Settings menu to ensure data isn't corrupted. 59 | > - Note: You might need a paperclip or similar object to push the SD Card in and out of the device. 60 | > - Read the [official documentation](https://docs.flipperzero.one/basics/sd-card) for more information! 61 | 62 | ### How do I install databases and dumps? 63 | > Make sure there's a working MicroSD Card in the device first by following the steps above. 64 | > Once you download the dump, you can use qFlipper or the Flipper mobile app to transfer them. If you're transfering a large file or many at once, you can also eject the SD Card from Flipper and insert it in your computer for faster transfers. 65 | > - In qFlipper: Plug your device in, go to the file browser tab, navigate into the SD Card, and drop files in their corresponding folders (The folder names are similar to the file extensions). 66 | > - For mobile apps: Make sure you're connected via Bluetooth, save the file to the app's archive, and synchronize it back to the device. 67 | > - For plugging the SD Card into your PC, drop files in their corresponding folders (The folder names are similar to the file extensions). 68 | 69 | ### How do I install applications and plugins? 70 | > Assuming the application has been packaged as a `.fap` file, installing it is as easy as placing it inside the `apps` directory on your Flipper's SD card. You can launch the app from the `Applications` app. If the app hasn't been compiled into a `.fap`, either *kindly* ask the author or compile it yourself. 71 | 72 | ### How do I install custom firmwares? 73 | > First, ask yourself if you really need to. Sure, it might be fun to break out of Sub-GHz transmission restrictions, but how often are you actually going to do that? Is it really worth breaking the law? 74 | > After you've ignored the previous sentences, make sure there's a working MicroSD Card in your Flipper and head over to the repository of your perferred firmware. Look for releases and find the `.dfu` file or update package (typically a `.tar`, `.tar.gz`, or `.zip` file, it always contains a file named `update.fuf`). 75 | > - If you only have a `.dfu`, it must be installed using the "Install from file" option in qFlipper. Select the file and begin the installation. 76 | > - If you have an update package, you can either install it with qFlipper, or install it manually through the Micro SD card by following the steps below. 77 | > - To manually install an update package, extract and transfer the folder (not the original archive file) to the `update` folder on the SD Card (create the folder if it doesn't already exist). Once transferred, go to the desktop/idle screen of the Flipper, press down to access the file browser, then left to view all folders. From there, open the `update` folder (typically at the bottom of the list) and find the folder you just transferred. Lastly, select the file named `update` and choose "Run in app" to install the firmware. 78 | > 79 | > If there was no pre-compiled update file/package, you'll have to build the firmware yourself. See the next question for details. 80 | > For more information, read the [official documentation](https://docs.flipperzero.one/basics/firmware-update). 81 | 82 | ### Where and when are developer Q&A sessions held? 83 | > Question and Answer session are held every week on Saturday, at 01:00 and 13:00 (GMT) 84 | > 85 | > | Time zone | Side A | Side B | 86 | > | :------------: | :-----: | :-----: | 87 | > | GMT/UTC | 01:00 | 13:00 | 88 | > | Pacific (PDT) | 6:00 PM | 6:00 AM | 89 | > | Mountain (MDT) | 7:00 PM | 7:00 AM | 90 | > | Central (CDT) | 8:00 PM | 8:00 AM | 91 | > | Eastern (EDT) | 9:00 PM | 9:00 AM | 92 | > | China Standard | 09:00 | 21:00 | 93 | > | India Standard | 06:30 | 18:30 | 94 | 95 | ### Are there archives of past Q&A sessions? 96 | > Archival is a community effort, so only some are available. 97 | > [https://github.com/flipperdevices/flipper-questions-and-answers](https://github.com/flipperdevices/flipper-questions-and-answers) 98 | 99 | ### How do I write/compile my own applications/plugins/firmware/assets? 100 |
101 | (The following is a summary of the official FBT docs.)
102 | Since the introduction of Flipper Build Tool (FBT), this has become very easy! You should have a basic understanding of working on a command line before proceeding. The only prerequisite install is Git. You should also have an IDE installed, VSCode is recommended since the firmware repo has config files for it. 103 |
104 | Expand me for the rest of the steps. 105 | (WIP, sorry to curb your enthusiasm.) 106 |
107 |
108 | 109 | ### Can I make my own Flipper instead of buying one? 110 | > Probably not. While the firmware and schematics are mostly public, actually sourcing the components is extremely difficult. Multiple core pieces, such as the screen, were specifically produced to be used in Flipper manufacturing. 111 | 112 | ### How do I get a black-shell Flipper? 113 | > This is no longer possible*, they were Kickstarter-backer exclusives. 114 | > (*No longer possible unless you're willing to shill out hundreds of dollars for one on eBay.) 115 | 116 | ### How do I invert the screen/change backlight color/change case cover, etc. 117 | > These are all hardware mods, generally inaccessible to the average user. Look up/ask around on how to do them if you're really interested, [r/flipperzero](https://old.reddit.com/r/flipperzero/) is a good place to start. 118 | 119 | ### Will there be future hardware revisions? 120 | > Technically speaking, there's going to be a **very minor** hardware revision in the near future. Functionally speaking, it will be identical to every other Flipper Zero already sold. The revision only replaces a few internal components and doesn't offer any new features compared to existing devices, so don't bother waiting to buy it. 121 | > Besides that, there are concepts for a [Flipper One](https://flipperzero.one/one), but without a timeline for release. 122 | 123 | ### What is Dummy Mode? 124 | > Currently, it only allows the Snake game to be opened when active. In the future, it will hide every app except games, in case your device is ever inspected or seized. 125 | 126 | ### My device is frozen, how do I reboot/fix it? 127 | > - To reboot the device: hold the BACK and LEFT buttons, then release simultaneously. If that didn't work, *disconnect the USB cable* and hold BACK for 30 seconds. This will preform a normal reboot. 128 | > - To enter DFU/Recovery mode: Hold BACK and LEFT, then release BACK while still holding LEFT after a few seconds. When the screen lights up, you can release LEFT. 129 | > - To exit DFU/Recovery mode: Follow steps for a normal reboot under the first bullet point. 130 | > 131 | > If nothing works or the device is completely bricked, first make sure it's charged by plugging it in for 15-30 minutes. As a final resort, if you can't get it to turn on after charging, *unplug the USB cable* and hold OK plus BACK for 30 seconds. **There will be no indication**, but the device is now in recovery mode. Plug it in to a PC and use qFlipper to recover the firmware. 132 | > Read the official docs for [Control](https://docs.flipperzero.one/basics/control), [Reboot](https://docs.flipperzero.one/basics/reboot), and [Firmware recovery](https://docs.flipperzero.one/basics/firmware-update/firmware-recovery). 133 | 134 | ### How do I access the CLI/Logs? 135 |
136 | To access the Serial CLI, click one of the following based on your platform. 137 |
138 | Desktop web browser* 139 | *Chromium browsers only, such as: Google Chrome, Microsoft Edge, Opera/Opera GX, Brave, and Vivaldi. 140 | 149 |
150 |
151 | Windows 152 | 167 |
168 |
169 | MacOS/Linux 170 | Note: I'm a filthy Windows user without any way to verify this procedure. Let me know if it's wrong! 171 | 182 |
183 |
184 | Android 185 | 195 |
196 |
197 | iPhone 198 | Unfortunately, iOS is incapable of accessing a serial terminal over USB; try one of the other methods. 199 |
200 | On the Flipper, open the settings, go to System, and set Log Level to Debug. (You can keep Debug set to off unless someone asks you to turn it on) 201 | Once you have the CLI open, type log and press enter to start watching logs. Press Ctrl-C or Cmd-C to exit log mode. 202 |
203 | 204 | ### How can I tell if I'm running the Iceman edition firmware? 205 |
206 | From the idle screen, press right to open your Flipper's passport. 207 | Check for the Iceman logo on the left, like in this screenshot: 208 |
209 | (Click to reveal screenshot) 210 | Iceman firmware screenshot 211 |
212 |
213 | 214 | 215 | 216 | ## Sub-GHz [🔝](#top) 217 | 218 | ### How do I hack my neighbors garage or unlock some random persons car?!? 219 | > Short answer: You don't. That's illegal, and NOT what Flipper was designed for. 220 | 221 | ### What does "This frequency can only be used for RX in your region" mean? 222 | > Due to legal regulations, Flipper is not allowed to transmit on certain frequencies depending on your device's provisioned location. 223 | > Provisioning occurs whenever you update your firmware via qFlipper or the mobile app and is based on your rough location. 224 | 225 | ### How do I find the frequency of a device/transponder? 226 | > If it's a commonly used frequency, bring the device *really close* to the Flipper and use the Frequency analyzer. 227 | > If that didn't work, check for the device's FCC ID. It's legally required to be somewhere on the device if it's sold in the US. 228 | > Then, look up that ID on [FCC ID.io](https://fccid.io). 229 | 230 | ### I can't tune Flipper to capture a specific frequency. 231 | > You'll need to edit the `setting_user` and `setting_frequency_analyzer_user` to change the frequencies available for selection in the app. The files are located in `subghz/assets` on the SD card. 232 | > Note that this won't magically unlock those frequencies, you're still bound by the device's limitations. 233 | 234 | ### I captured a garage/car/etc. signal, but it doesn't work when I replay it. 235 | > Unless the item of interest is extremely old, it probably uses rolling codes. Read more below. 236 | 237 | ### What is a rolling code? 238 | > Think of it like this: Imagine your garage door was programmed to open whenever it received the code "1234" from a transponder. 239 | > This would be a static code, where a replay attack (Read RAW) would be able to open the garage. 240 | > Since replay attacks are so easy, most devices will shuffle the code after each use. 241 | > So the first time you open your garage, the transponder sends "1234" and the second time it sends "5678." 242 | > Rolling codes aren't that simple, but you get the gist. 243 | 244 | ### I replayed a rolling code and now my original keyfob/transponder doesn't work. 245 | > You'll have to re-sync your old device manually, since it's now lagging behind on the rolling code. 246 | 247 | ### What is a Debruin/Brute force code? 248 | > A brute force code tries every possible code for a specific bit length, however this is inefficient. 249 | > Example: 0001, 0002, 0003, 0004 ... 9998, 9999. 250 | > Debruin sequences are more efficient by merging multiple codes together. 251 | > Example: 365, 136, and 650 can all be found in 13650 by looking at groups of 3 digits individually. 252 | 253 | ### Can I attach a more powerful antenna? 254 | > Yes and no. You can't just attach any antenna directly via the GPIO pins, however you could use a separate processor on a protoboard and control it from Flipper, assuming you write your own code to do that. 255 | > For example, you could write your own code on a NRF24 and accompanying Flipper app to control it over GPIO. 256 | 257 | 258 | 259 | ## NFC & RFID [🔝](#top) 260 | 261 | ### Feature/Compatability table 262 | 263 | | Card name/type | Read | Write | Save | Emulate | Notes | 264 | | :---------------- | :--: | :---: | :--: | :-----: | :-------------------------------- | 265 | | Mifare Classic | ✅ | ✅ | ✅ | ✅ | Emulation can be a hit or miss | 266 | | Mifare DESFire | ✅ | | | | Can read public files | 267 | | Mifare Ultralight | ✅ | | ✅ | ✅ | Unlock tags with various methods | 268 | | NTAG-21X | ✅ | | ✅ | ✅ | Very similar to Mifare Ultralight | 269 | | EMV Cards | ✅ | | ❌ | ❌ | Can read unencrypted bank cards | 270 | | NFC-B | | | | ❌ | No hardware support for emulation | 271 | | iClass/PicoPass | ✅ | | ✅ | ❌ | No STM SDK support for emulation | 272 | | EM4100/EM4102 | ✅ | ❌ | ✅ | ✅ | | 273 | | H10301 | ✅ | ❌ | ✅ | ✅ | | 274 | | Indala | ✅ | ❌ | ✅ | ✅ | | 275 | | T5577 | ✅ | ✅ | ✅ | ✅ | | 276 | | EM4305 | ✅ | | ✅ | ✅ | | 277 | | Paxton Net2 | ❌ | ❌ | ❌ | ❌ | No support for Hitag2 | 278 | | Legic Prime | ❌ | ❌ | ❌ | ❌ | Proprietary protocol | 279 | 280 | ***Key:*** *Check = Already implimented as of latest official firmware. No mark = Could be implemented in the future. Cross mark = Unlikely to ever be implemented or impossible.* 281 | 282 | ### How do I identify which type of card/tag I have? 283 | > To determine the protocol (NFC, RFID, or iClass/PicoPass) you'll need to attempt reading in each corresponding app. If nothing works, check the tag/card for any markings or indications. As a last resort, take a picture of the card/fob and the reader and ask in the [Flipper Discord server](https://flipperzero.one/discord). 284 | 285 | ### How do I identify which type of NFC tag I have? 286 | > Run the "Read card" action in the NFC app. Only NFC-A type tags are supported (Mifare/NTAG/Some EMV). 287 | > Once successfully read, the tag's type is displayed in bold at the top of the screen. 288 | 289 | ### Which NFC tags can I write? 290 | > Currently, Mifare Classic's are the only NFC card that can be written to. 291 | > More will be added in the future with firmware updates. 292 | 293 | ### I was told a Mifare Ultralight/NTAG tag has password-protected sectors. What does that mean? 294 | > Either the read was interrupted, or the tag is actually password protected. 295 | > First, try reading the tag again but make sure it stays on the back of the device until the info screen pops up. 296 | > If you're still seeing the warning, Flipper can unlock *legally distinct NFC-enabled figurines that are pronounced like "Ameebo"* and Xaomi air filter tags, but be warned that there's a risk of **bricking** your tag if you use the wrong password too many times. 297 | 298 | ### Why does it take so long to read a Mifare Classic? 299 | > Mifare classics are split up into sectors, these sectors are protected by two keys. To read a Mifare Classic, Flipper uses a dictionary attack, which takes a big list currently comprised of 1241 common keys, and checks them individually against each sector on the card. If you know the keys, they can be manually added to the User Dictionary under the "Extra Actions" menu. 300 | 301 | ### What does it mean when no sectors could be read on a Mifare Classic? 302 | > The data on Mifare Classic cards is split up into sectors, and each sector is protected by two keys. 303 | > If no sectors were read, then Flipper's dictionary attack has failed to find any valid keys. 304 | > If you know the keys, you can manually input them under the "Extra Actions" menu of the NFC app. Otherwise, try attacking the reader with mfkey32v2 as described a few questions down. 305 | 306 | ### What does it mean when some but not all sectors could be read on a Mifare Classic? 307 | > The data on Mifare Classic cards is split up into sectors, and each sector is protected by two keys. 308 | > The read wasn't successful, but it didn't fail either. Some of the card's data was read and saved, but not all. 309 | > Even if not all sectors were read, you should inspect the dump with the mobile app to see if the missing data is necessary or not. In a few rare cases, semi-read cards can be emulated in place of the original without issue. 310 | > If you still need the rest of the keys, read the next question. 311 | 312 | ### How to I get Mifare Classic keys from a reader with [mfkey32v2](https://github.com/equipter/mfkey32v2)? 313 | > (WIP, Note to self: https://regex101.com/r/iXmE2N/2) 314 | 315 | ### Why isn't Mifare Classic emulation working? 316 | > Flipper emulates Mifare Classics according to official specification docs (at 13.56 mhz), however certain card readers operate at slightly different frequencies (such as 13.50 mhz). Since Flipper is unable to detect the frequency (like a real card does), it also can't correct for these minor errors. 317 | > As a result, data transmission doesn't always occur when the reader expects it, and thus emulation is imperfect. 318 | > There are a few theoretical ways to fix this with software, but the best option would require hardware modification. 319 | 320 | ### Why can't I save/emulate Mifare DESFire? 321 | > DESFire is a very complicated and much more secure chipset. There are no known attacks against it yet. 322 | 323 | ### What are the .shd files in the NFC directory? 324 | > These are shadow files, and they're created whenever an emulated tag is written to. 325 | > They store a copy of the original file with whatever was written. This way, the original file remains untouched. 326 | 327 | ### How do I edit the data in a saved tag? 328 | > You'll need to use a NFC-enabled smartphone with an app that can write tags. One of the easiest to use apps is called NFC Tools, available for both [Android](https://play.google.com/store/apps/details?id=com.wakdev.wdnfc) and [iOS](https://apps.apple.com/us/app/nfc-tools/id1252962749). Due to Mifare Classic emulation quirks, you can only edit the data of saved NTAG and Mifare Ultralight tags. Create an empty NTAG216 with the "Add Manually" action in the NFC app if you don't have one already. Save that tag, then open it from the list. Once you start emulating the tag, you can use the NFC Tools smartphone app to write information on to the emulated tag. This is saved to a .shd file with the same name as the emulated tag. If you need a quick way to generate a tag containing a URL, you can use [Flipper Maker's NFC Creator tool](https://flippermaker.github.io/) online. 329 | 330 | ### Why doesn't my bank card work when I emulate it? 331 | > EMV Credit/Debit cards are mostly encrypted. The information Flipper reads is the unencrypted portion of the card. This alone is not enough to emulate and complete a transaction. It is impossible to read the encrypted parts. 332 | 333 | ### Is there any way to save then emulate a bank card to authorize transactions? 334 | > No, as explained in the previous question. 335 | 336 | ### Why does the NFC feature table say bank cards can be read? 337 | > Most NFC-enabled bank cards expose their card number unencrypted. The expiration date, CVV, and ZIP code are not revealed. 338 | > The card number alone is not enough to create a transaction, thus there's no reason to add a save option. 339 | 340 | ### Can Flipper emulate a payment terminal and authorize transactions? 341 | > No. Are you starting to see a pattern here? 342 | 343 | ### Where is the "USB/LibNFC NFC Reader" feature mentioned in the [September blog post](https://blog.flipperzero.one/september-progress/)? 344 | > This was scrapped due to timing issues, more details in [this GitHub issue](https://github.com/flipperdevices/flipperzero-firmware/issues/1173#issuecomment-1127728562). 345 | 346 | ### Where can I learn more about NFC and RFID technology? 347 | > - Introduction to both Low Frequency and High Frequency: https://blog.flipperzero.one/rfid/ 348 | > - Types of NFC https://www.rfwireless-world.com/Tutorials/NFC-Type1-Tag-vs-NFC-Type2-Tag-vs-NFC-Type3-Tag-NFC-Type4-Tag-Types.html 349 | > - Mifare Classic: https://learn.adafruit.com/adafruit-pn532-rfid-nfc/mifare 350 | > - The Mifare Family: https://en.wikipedia.org/wiki/MIFARE 351 | > - Datasheets: http://www.proxmark.org/files/Documents/ 352 | > - Common RFID Standards and protocols: https://www.asiarfid.com/common-rfid-standards-and-protocols.html 353 | > - RFID Standards: ISO, IEC, EPCglobal: https://www.electronics-notes.com/articles/connectivity/rfid-radio-frequency-identification/standards-iec-iso-epcglobal.php 354 | 355 | ## Infrared [🔝](#top) 356 | 357 | ### How do I add more devices to the "Universal Remotes" menu? 358 | > While it isn't possible to add new items under the universal menu, there exist plenty of repositories containing many dumps of IR remotes. The most popular is [Flipper-IRDB](https://github.com/logickworkshop/Flipper-IRDB). 359 | > (Note: When downloading, it's *highly recommended* to unmount the SD Card from your Flipper and directly plug it in to your computer.) If you only need a remote for one device, you can use [Flipper Maker's IR Device tool](https://flippermaker.github.io/) to create and transfer it on the go. 360 | 361 | ### The universal TV remote doesn't work besides the power button. 362 | > The stock universal tv remote database mostly contains power codes, and very few of everything else. This file (Located at `infrared/assets/tv.ir` on the SD Card) be manually replaced with one containing extra codes for all buttons. To do so, download [this file](https://raw.githubusercontent.com/UberGuidoZ/Flipper/main/Infrared/tv.ir) and use qFlipper to transfer it into the path from the previous sentence. 363 | 364 | ### What are CSV/Pronto/IR Plus codes? 365 | > All three are different formats of infrared databases. They are not natively compatible with Flipper, but repositories exist that hold converted and compatible versions, such as [Flipper-IRDB](https://github.com/logickworkshop/Flipper-IRDB). 366 | 367 | 368 | 369 | ## BadUSB [🔝](#top) 370 | 371 | ### I'm on a Non-US QWERTY keyboard, how do I make scripts work? 372 | > Until a solution is put into the firmware, your best choice is trying one of the following converters: 373 | > - [http://helppox.com/badusbconvert.html](http://helppox.com/badusbconvert.html) 374 | > - [https://flippermaker.github.io/](https://flippermaker.github.io/) (BadUSB String To Alt Code) 375 | 376 | 377 | 378 | ## iButton [🔝](#top) 379 | > *(WIP)* 380 | 381 | 382 | 383 | ## WiFi board [🔝](#top) 384 | > *(WIP)* --------------------------------------------------------------------------------