mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2024-12-25 14:22:27 +03:00

[FL-870] Auto-generated firmware documentation take two (#2944 )

* Add doxygen and doxygen-awesome css, cleanup docs files
* Ignore more libraries and remove leftover local variables
* Create an actual intro page
* .md files linting
* Add doxygen action
* Fix Doxygen path
* Fix doxyfile path
* Try to upload
* Change docs branch
* Add submudules checkout
* Disable doxygen on PR
* Mention the firmware docs in the readme
* More dev docs mentions in the readme
* Fix runner group, add tags
* Test dev in PR
* Disable running on PR
* Fix a typo in the doxyfile
* Try upload to S3
* Fix local path
* Fix S3 ACL
* Add delete flag, unifying dev and tags
* Update ignored directories
* More ignored directories
* Even more ignored directories
* Fix submodule
* Change S3 uploader
* Change S3 uploader version
* Fix aws sync flags
* Fix ACL
* Disable ACL
* Improve ignores, add WiFi devboard docs
* TEMP: generate dev docs
* TEMP: generate 0.89.0 docs
* Disabling PR trigger
* Enable submodules and test build
* Enable test build
* Disable test build
* Change docs directory structure
* Fix accidentally committed submodule
* Fix submodules
* Update links to the developer documentation
* Markdown linting
* Update workflow, enable test build
* Fix doxygen dir path
* Update Doxyfile-awesome.cfg
* Change paths
* Fix upload docs path
* Disable pull_request debug trigger
* Disable tags building
* Remove autolinks and namespaces
* Establish basic documentation structure
* Add missing changes
* Improve stylesheet, move some files
* Improve examples
* Improve the main page
* Improve application dev docs
* Improve system programming docs
* Improve development tools docs
* Improve other docs
* Improve application examples
* Fix formatting
* Fix PVS-studio warnings
* Improve visuals
* Fix doxygen syntax warnings
* Fix broken links
* Update doxygen action

Co-authored-by: DrunkBatya <drunkbatya.js@gmail.com>
Co-authored-by: あく <alleteam@gmail.com>
Co-authored-by: Georgii Surkov <georgii.surkov@outlook.com>
Co-authored-by: Georgii Surkov <37121527+gsurkov@users.noreply.github.com>

2024-03-06 15:25:21 +09:00

17 KiB

Raw Blame History

Welcome to the Flipper Zero Unleashed Firmware repo!

This firmware is a fork from flipperdevices/flipperzero-firmware

Most stable custom firmware focused on new features and improvements of original firmware components, with almost no UI changes

FAQ (frequently asked questions)

Follow this link to find answers to most asked questions

Dev builds (unstable)

Releases in Telegram

https://t.me/unleashed_fw

What's changed

Sub-GHz lib & hal
- Regional TX restrictions removed
- Extra Sub-GHz frequencies
- 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 frequency (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)
- 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
- 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 -> Debug TX PIN output settings
NFC/RFID/iButton
- LFRFID/iButton Fuzzer plugins
- Extra Mifare Classic keys
- EMV Protocol + Public data parser (by @Leptopt1los and @wosk)
- NFC/LFRFID - Stop emulation after 5 mins to avoid antenna damage (by @Leptopt1los)
- 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)
- BadBT plugin (BT version of BadKB) (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 decoders for these protocols in OFW.

Keeloq [Not ALL systems supported for decode or emulation!] - Supported manufacturers list

Encoders or sending made by @xMasterX:

Nero Radio 57bit (+ 56bit encoder improvements)
CAME 12bit/24bit encoder fixes (Fixes 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 !)

Encoders or sending made by @Eng1n33r(first implementation in Q2 2022) & @xMasterX (current version):

CAME Atomo -> Update! check out new instructions
Nice Flor S -> How to create new remote - instructions
FAAC SLH (Spa) -> Update!!! Check out new instructions
Keeloq: BFT Mitto -> Update! Check out new instructions
Star Line
Security+ v1 & v2 (encoders was made in OFW)

Encoders made by @assasinfil & @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. I'm unemployed, and the only income I receive is from your donations. 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, IR Assets (only ACs), Plugins, and many other things
@gid9798 - SubGHz, Plugins, many other things
@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	Link/Wallet
Patreon		https://patreon.com/mmxdev
Boosty	patreon alternative	https://boosty.to/mmxdev
cloudtips	only RU payments accepted	https://pay.cloudtips.ru/p/7b3e9d65
YooMoney	only RU payments accepted	https://yoomoney.ru/fundraise/XA49mgQLPA0.221209
USDT	(TRC20)	`TSXcitMSnWXUFqiUfEXrTVpVewXy2cYhrs`
BCH		`qquxfyzntuqufy2dx0hrfr4sndp0tucvky4sw8qyu3`
ETH	(BSC/ERC20-Tokens)	`darkflippers.eth` (or `0xFebF1bBc8229418FF2408C07AF6Afa49152fEc6a`)
BTC		`bc1q0np836jk9jwr4dd7p6qv66d04vamtqkxrecck9`
DOGE		`D6R6gYgBn5LwTNmPyvAQR6bZ9EtGgFCpvv`
LTC		`ltc1q3ex4ejkl0xpx3znwrmth4lyuadr5qgv8tmq8z9`
XMR	(Monero)	`41xUz92suUu1u5Mu4qkrcs52gtfpu9rnZRdBpCJ244KRHf6xXSvVFevdf2cnjS7RAeYr5hn9MsEfxKoFDRSctFjG5fv1Mhn`
TON		`EQCOqcnYkvzOZUV_9bPE_8oTbOrOF03MnF-VcJyjisTZmpGf`