ReadMe.md

Flipper Zero Unleashed Firmware

This firmware is a fork of the original (OFW) version of flipperdevices/flipperzero-firmware and represents the most stable custom build, incorporating new features and improvements to the original components while remaining fully compatible with the API and applications of the original firmware.

Warning

This software is intended solely for experimental purposes and is not meant for any illegal activities. We do not condone unlawful behavior and strongly encourage you to use it only within the bounds of the law.

This project is developed independently and is not affiliated with Flipper Devices.

Also be aware, DarkFlippers/unleashed-firmware is the only official page of the project, there is no paid, premium or closed source versions and if someone contacts you and say they are from our team and try to offer something like that - they are scammers, block that users ASAP

🚀 Usage

Before getting started:

• Review the Official Documentation: docs.flipper.net

• Installation Guide & Version Info:
  How to install the firmware by following the Installation Guide and check the version information (r, e, , c)

• FAQ:
  Find answers to common questions in the FAQ

📦 Releases

Release builds (stable)

• Telegram: t.me/unleashed_fw
• GitHub Releases

Dev builds (unstable)

Note

Built automatically from dev branch

• Web site: dev.unleashedflip.com
• Telegram: t.me/kotnehleb

🆕 What's New

Sub‑GHz Library & HAL

• Regional TX restrictions removed
• Extra Sub-GHz frequencies added
• Frequency range can be extended in settings file (warning: It can damage Flipper's hardware)
• Many rolling code protocols now have the ability to save & send captured signals
• FAAC SLH (Spa) & BFT Mitto (keeloq secure with seed) manual creation
• External CC1101 module support (by quen0n)

Sub‑GHz Main App

• Save last used settings (by derskythe)
• New frequency analyzer (by ClusterM)
• Press OK in frequency analyzer to use detected frequency in Read modes (by derskythe)
• Long press OK button in Sub-GHz Frequency analyzer to switch to Read menu (by derskythe)
• New option to use timestamps + protocol name when you saving file, instead of random name or timestamp only - Enable in Radio Settings -> Protocol Names = ON
• Read mode UI improvements (shows time when signal was received) (by @wosk)
• External CC1101 module support (Hardware SPI used)
• External CC1101 module amplifier control (or LED control) support (enabled by default)
• Hold right in received signal list to delete selected signal
• Custom buttons for Keeloq / Alutech AT4N / Nice Flor S / Somfy Telis / Security+ 2.0 / CAME Atomo - now you can use arrow buttons to send signal with different button code
• Add manually menu extended with new protocols
• FAAC SLH, BFT Mitto / Somfy Telis / Nice Flor S / CAME Atomo, etc. manual creation with programming new remote into receiver (use button 0xF for BFT Mitto, 0x8 (Prog) on Somfy Telis, (right arrow button for other protocols))
• Debug mode counter increase settings (+1 → +5, +10, default: +1)
• Debug PIN output settings for protocol development

Sub‑GHz Apps (by Unleashed Team)

• Sub-GHz Bruteforce - static code brute-force plugin
• Time delay (between signals) setting (hold Up in main screen (says Up to Save)) + configure repeats in protocols list by pressing right button on selected protocol
• Load your own file and select bytes you want to bruteforce or use preconfigured options in protocols list
• Sub-GHz Remote - remote control for 5 sub-ghz files | bind one file for each button
• use the built-in constructor or make config file by following this instruction

Infrared (IR)

• Recompiled IR TV Universal Remote for ALL buttons
• Universal remotes for Projectors, Fans, A/Cs and Audio(soundbars, etc.) → Also always updated and verified by our team
• Infrared → RCA Protocol
• Infrared → External IR modules support (with autodetect by OFW)

NFC/RFID/iButton

• LFRFID and iButton Fuzzer plugins
• Add DEZ 8 display form for EM4100 (by @korden32)
• Extra Mifare Classic keys in system dict
• EMV Protocol + Public data parser (by @Leptopt1los and @wosk)
• NFC Add manually → Mifare Classic with custom UID
• NFC parsers: Umarsh, Zolotaya Korona, Kazan, Metromoney, Moscow Social Card, Troika (reworked) and many others (by @Leptopt1los and @assasinfil)

Quality of Life & Other Features

• Customizable Flipper name Update! Now can be changed in Settings → Desktop (by @xMasterX and @Willy-JL)
• Text Input UI element → Cursor feature (by @Willy-JL)
• Byte Input Mini editor → Press UP multiple times until the nibble editor appears (by @gid9798)
• Clock on Desktop Settings -> Desktop -> Show Clock (by @gid9798)
• Battery percentage display with different styles Settings -> Desktop -> Battery View
• More games in Dummy Mode → click or hold any of arrow buttons
• Lock device with pin (or regular lock if pin not set) by holding UP button on main screen (by an4tur0r)
• BadKB plugin (by Willy-JL, ClaraCrazy, XFW contributors) - (See in Applications → Tools) - (aka BadUSB via Bluetooth)
• BadUSB → Keyboard layouts (by rien > dummy-decoy)
• Custom community plugins and games added + all known working apps can be downloaded in extra pack in every release
• Other small fixes and changes throughout
• See other changes in readme below

Also check the changelog in releases for latest updates!

Current modified and new Sub-GHz protocols list:

Thanks to Official team (to their SubGHz Developer, Skorp) for implementing support (decoder + encoder / or decode only) for these protocols in OFW.

Note

Not all Keeloq systems are supported for decoding or emulation!

Supported Keeloq manufacturers include

Column 1	Column 2	Column 3	Column 4	Column 5
Alligator	Comunello	GSN	Magic_4	SL_A2-A4
Alligator_S-275	Dea_Mio	Guard_RF-311A	Mongoose	SL_A6-A9/Tomahawk_9010
APS-1100_APS-2550	DTM_Neo	Harpoon	Mutanco_Mutancode	SL_B6,B9_dop
Aprimatic	DoorHan	IronLogic	NICE_MHOUSE	Sommer(fsk476)
Beninca	EcoStar	JCM_Tech	NICE_Smilo	Stilmatic
BFT	Elmes_Poland	KEY	Normstahl	Teco
Came_Space	FAAC_RC,XT	Kingates_Stylo4k	Pantera	Tomahawk_TZ-9030
Cenmax	FAAC_SLH	KGB/Subaru	Pantera_CLK	Tomahawk_Z,X_3-5
Cenmax_St-5	Faraon	Leopard	Pantera_XS/Jaguar	ZX-730-750-1055
Cenmax_St-7	Genius_Bravo	Magic_1	Partisan_RX
Centurion	Gibidi	Magic_2	Reff
Monarch	Jolly Motors	Magic_3	Sheriff

Decoders/Encoders or emulation (+ programming mode) support made by @xMasterX

• Marantec24 (static 24 bit) with add manually support
• GangQi (static 34 bit) with button parsing and add manually support (thanks to @mishamyte for captures and testing, thanks @Skorpionm for help)
• Hollarm (static 42 bit) with button parsing and add manually support (thanks to @mishamyte for captures, thanks @Skorpionm for help)
• Hay21 (dynamic 21 bit) with button parsing
• Nero Radio 57bit (+ 56bit support)
• CAME 12bit/24bit encoder fixes (Fixes are now merged in OFW)
• Keeloq: Dea Mio, Genius Bravo, GSN, HCS101, AN-Motors, JCM Tech, MHouse, Nice Smilo, DTM Neo, FAAC RC,XT, Mutancode, Normstahl, Beninca + Allmatic, Stilmatic, CAME Space, Aprimatic (model TR and similar), Centurion Nova (thanks Carlos !), Hormann EcoStar, Novoferm, Sommer, Monarch (thanks @ashphx !), Jolly Motors (thanks @pkooiman !)

Protocols support made by Skorp (original implementation) and @xMasterX (current version)

• CAME Atomo → Update! check out new instructions
• Nice Flor S → How to create new remote - instructions
• FAAC SLH (Spa) → Update!!! (Programming mode!) Check out new instructions
• Keeloq: BFT Mitto → Update! Check out new instructions
• Star Line
• Security+ v1 & v2

Encoders made by @assasinfil and @xMasterX

• Somfy Telis → How to create new remote - instructions
• Somfy Keytis
• KingGates Stylo 4k
• Alutech AT-4N → How to create new remote - instructions
• Nice ON2E (Nice One) → How to create new remote - instructions

❤️ Please support development of the project

The majority of this project is developed and maintained by me, @xMasterX. Our team is small and the guys are working on this project as much as they can solely based on the enthusiasm they have for this project and the community.

• @Leptopt1los - NFC, RFID, Plugins, and many other things
• @gid9798 - SubGHz, Plugins, many other things - currently offline :(
• @assasinfil - SubGHz protocols, NFC parsers
• @Svaarich - UI design and animations
• @amec0e - Infrared assets
• Community moderators in Telegram, Discord, and Reddit
• And of course our GitHub community. Your PRs are a very important part of this firmware and open-source development.

The amount of work done on this project is huge and we need your support, no matter how large or small. Even if you just say, "Thank you Unleashed firmware developers!" somewhere. Doing so will help us continue our work and will help drive us to make the firmware better every time. Also, regarding our releases, every build has and always will be free and open-source. There will be no paywall releases or closed-source apps within the firmware. As long as I am working on this project it will never happen.
You can support us by using links or addresses below:

Service	Remark	QR Code	Link/Wallet
Patreon			patreon.com/mmxdev
Boosty	patreon alternative		boosty.to/mmxdev
CloudTips	only RU payments accepted		pay.cloudtips.ru/p/7b3e9d65
YooMoney	only RU payments accepted		yoomoney.ru/fundraise/XA49mgQLPA0.221209
USDT	TRC20		TSXcitMSnWXUFqiUfEXrTVpVewXy2cYhrs
ETH	BSC/ERC20-Tokens		0xFebF1bBc8229418FF2408C07AF6Afa49152fEc6a
BTC			bc1q0np836jk9jwr4dd7p6qv66d04vamtqkxrecck9
SOL	Solana/Tokens		DSgwouAEgu8iP5yr7EHHDqMNYWZxAqXWsTEeqCAXGLj8
DOGE			D6R6gYgBn5LwTNmPyvAQR6bZ9EtGgFCpvv
LTC			ltc1q3ex4ejkl0xpx3znwrmth4lyuadr5qgv8tmq8z9
BCH			qquxfyzntuqufy2dx0hrfr4sndp0tucvky4sw8qyu3
XMR	Monero		41xUz92suUu1u5Mu4qkrcs52gtfpu9rnZRdBpCJ244KRHf6xXSvVFevdf2cnjS7RAeYr5hn9MsEfxKoFDRSctFjG5fv1Mhn
TON			UQCOqcnYkvzOZUV_9bPE_8oTbOrOF03MnF-VcJyjisTZmsxa

📱 Community Apps

Enhance your Flipper Zero with apps and plugins created by the community:

• Extra Plugins & Packs:
  Check out the latest extra plugins and plugin packs (Extra Pack and Base Pack) on GitHub.

• Source Code & Full List:
  Find the complete list and source code at xMasterX/all-the-plugins.

• Official Apps Catalog:
  Browse the official Flipper Zero Apps Catalog on the web or via the mobile app.

📁 Where I can find IR, Sub-GHz, ... files, DBs, and other stuff?

• UberGuidoZ Playground - Large collection of files - Github
• Awesome Flipper Zero - Github

📘 Instructions

Firmware & main Apps feature

• System: How to change Flipper name
• BadUSB: How to add new keyboard layouts
• Infrared: How to make captures to add them into Universal IR remotes

Sub-GHz

• How to use Flipper as new remote (Nice FlorS, BFT Mitto, Somfy Telis, Aprimatic, AN-Motors, etc..)
• External Radio: How to connect CC1101 module
• Transmission is blocked? How to extend Sub-GHz frequency range
• How to add extra Sub-GHz frequencies
• Configure Sub-GHz Remote App ⚠️ Not recommended, please use embedded configurator

Plugins

• TOTP (Authenticator): config description
• Barcode Generator: How to use
• Multi Converter: How to use
• WAV Player: sample files & how to convert
• Sub-GHz playlist: generator script

GPIO - Plugins that works with external hardware

• Unitemp - Temperature sensors reader: How to use & supported sensors
• [NMEA] GPS: How to use
• i2c Tools How to use
• [NRF24] plugins: How to use
• [WiFi] Scanner: How to use | Web Flasher
• [ESP8266] Deauther: How to use | Web Flasher
• [ESP32] WiFi Marauder: How to use _{docs by UberGuidoZ} | Marauder repo
• [ESP32-CAM] Camera Suite: How to use
• How to Upload .bin to ESP32/ESP8266: Windows | FAP "ESP flasher"
• [GPIO] SentrySafe plugin: How to use

👨‍💻 Firmware & Development

• Developer Documentation - developer.flipper.net
• How to build | Project-structure
• CLion IDE - How to setup workspace for flipper firmware development by Savely Krasovsky
• "Hello world!" - plugin tutorial English _{by DroomOne} | Russian _{by Pavel Yakovlev}
• How to write your own app.

Project structure

• applications - Applications and services used in firmware
• assets - Assets used by applications and services
• furi - Furi Core: OS-level primitives and helpers
• debug - Debug tool: GDB-plugins, SVD-file and etc
• documentation - Documentation generation system configs and input files
• firmware - Firmware source code
• lib - Our and 3rd party libraries, drivers and etc...
• site_scons - Build helpers
• scripts - Supplementary scripts and python libraries home

Also, pay attention to the ReadMe.md files inside those directories.

🔗 Links

• Unleashed web page: flipperunleashed.com

• Unleashed update server, direct .tgz update links for web updater or direct download: unleashedflip.com

• Official Docs: docs.flipper.net

• Official Forum: forum.flipperzero.one

• Update! Developer Documentation developer.flipper.net