diff --git a/FAQ.md b/FAQ.md index 4630ace1..172b23a4 100644 --- a/FAQ.md +++ b/FAQ.md @@ -26,8 +26,26 @@ ## Meta [🔝](#top) +### What is Awesome Flipper Zero? +> 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. + +### What is an Awesome List? +> 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. + + ### How can I contribute to this repo? -> 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. +> 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. + +### I found a mistake, broken link, or something else. What should I do? +> 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). + +### Why are there so many unmerged pull requests? +> 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. + +### This is really cool! Is there a way I can donate to you? +> I really appreciate the kind words, however I'm not accepting personal monetary donations. +> 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/))! +> Besides that, why not support a local charity/organization instead? My personal recommendation is the [Electronic Frontier Foundation](https://supporters.eff.org/donate). ## General [🔝](#top) @@ -182,6 +200,16 @@ 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. +### How can I tell if I'm running the Iceman edition firmware? +
+ From the idle screen, press right to open your Flipper's passport. + Check for the Iceman logo on the left, like in this screenshot: +
+ (Click to reveal screenshot) + Iceman firmware screenshot +
+
+ ## Sub-GHz [🔝](#top) @@ -231,24 +259,24 @@ ### Feature/Compatability table -| Card name/type | Read | Write | Save | Emulate | Notes | -| :--------------- | :--: | :---: | :--: | :-----: | :-------------------- | -| Mifare Classic | ✅ | | ✅ | ✅ | Emulation is hit/miss | -| Mifare DESFire | ✅ | | | | | -| Mifare Ultralight | ✅ | | ✅ | ✅ | Non-password protected | -| EMV Cards | ✅ | | | | Can read bank cards | -| NTAG-21X | ✅ | | ✅ | ✅ | | -| NFC-B | | | | ❌ | No hardware support for emulation | -| iClass/PicoPass | ✅ | | ✅ | ❌ | No STM SDK support for emulation | -| EM4100/EM4102 | ✅ | ❌ | ✅ | ✅ | | -| H10301 | ✅ | ❌ | ✅ | ✅ | | -| Indala | ✅ | ❌ | ✅ | ✅ | | -| T5577 | ✅ | ✅ | ✅ | ✅ | | -| EM4305 | ✅ | ✅ | ✅ | ✅ | | -| Paxton Net2 | ❌ | ❌ | ❌ | ❌ | Hitag2: no support | -| Legic Prime | ❌ | ❌ | ❌ | ❌ | 13.56mhz, but proprietary| +| Card name/type | Read | Write | Save | Emulate | Notes | +| :---------------- | :--: | :---: | :--: | :-----: | :-------------------------------- | +| Mifare Classic | ✅ | ✅ | ✅ | ✅ | Emulation can be a hit or miss | +| Mifare DESFire | ✅ | | | | Can read public files | +| Mifare Ultralight | ✅ | | ✅ | ✅ | Unlock tags with various methods | +| NTAG-21X | ✅ | | ✅ | ✅ | Very similar to Mifare Ultralight | +| EMV Cards | ✅ | | ❌ | ❌ | Can read unencrypted bank cards | +| NFC-B | | | | ❌ | No hardware support for emulation | +| iClass/PicoPass | ✅ | | ✅ | ❌ | No STM SDK support for emulation | +| EM4100/EM4102 | ✅ | ❌ | ✅ | ✅ | | +| H10301 | ✅ | ❌ | ✅ | ✅ | | +| Indala | ✅ | ❌ | ✅ | ✅ | | +| T5577 | ✅ | ✅ | ✅ | ✅ | | +| EM4305 | ✅ | | ✅ | ✅ | | +| Paxton Net2 | ❌ | ❌ | ❌ | ❌ | No support for Hitag2 | +| Legic Prime | ❌ | ❌ | ❌ | ❌ | Proprietary protocol | -***Note:*** *While T5577 and EM4305's can be written, they are rarely handed out as ID badges.* +***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.* ### How do I identify which type of card/tag I have? > 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). @@ -257,8 +285,9 @@ > Run the "Read card" action in the NFC app. Only NFC-A type tags are supported (Mifare/NTAG/Some EMV). > Once successfully read, the tag's type is displayed in bold at the top of the screen. -### Why can't I write an NFC tag? -> This will become possible in the near future with a firmware update. +### Which NFC tags can I write? +> Currently, Mifare Classic's are the only NFC card that can be written to. +> More will be added in the future with firmware updates. ### I was told a Mifare Ultralight/NTAG tag has password-protected sectors. What does that mean? > Either the read was interrupted, or the tag is actually password protected. @@ -303,13 +332,22 @@ ### Is there any way to save then emulate a bank card to authorize transactions? > No, as explained in the previous question. +### Why does the NFC feature table say bank cards can be read? +> Most NFC-enabled bank cards expose their card number unencrypted. The expiration date, CVV, and ZIP code are not revealed. +> The card number alone is not enough to create a transaction, thus there's no reason to add a save option. + ### Can Flipper emulate a payment terminal and authorize transactions? > No. Are you starting to see a pattern here? ### Where is the "USB/LibNFC NFC Reader" feature mentioned in the [September blog post](https://blog.flipperzero.one/september-progress/)? > This was scrapped due to timing issues, more details in [this GitHub issue](https://github.com/flipperdevices/flipperzero-firmware/issues/1173#issuecomment-1127728562). - +### Where can I learn more about NFC and RFID technology? +> - Introduction to both Low Frequency and High Frequency: https://blog.flipperzero.one/rfid/ +> - 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 +> - Mifare Classic: https://learn.adafruit.com/adafruit-pn532-rfid-nfc/mifare +> - The Mifare Family: https://en.wikipedia.org/wiki/MIFARE +> - Datasheets: http://www.proxmark.org/files/Documents/ ## Infrared [🔝](#top) diff --git a/Firmwares.md b/Firmwares.md index 25f9e019..a5d147de 100644 --- a/Firmwares.md +++ b/Firmwares.md @@ -1,6 +1,6 @@

Flipper Zero firmware differences

- :: Last updated Oct 12 2022. :: + :: Last updated Nov 24 2022. ::

This document will (hopefully) maintain a list of differences between various forks of the Flipper Zero firmware.
If I had a dollar for every time I've seen this question asked, @@ -34,23 +34,32 @@

  • Has added most known community tweaks, plugins & games (some may be unstable or incomplete.)
  • Also includes a number of other small tweaks and changes.
    • + -

    Unleashed - DarkFlippers/unleashed-firmware - +

    + 🔓 Unleashed + + DarkFlippers/unleashed-firmware +

    Official flipperdevices/flipperzero-firmware @@ -65,41 +74,52 @@
  • The Flipper team has a list of device names with their corresponding production information (No shipping address) so they can assist you easier in case of an RMA.
    • -

    v1nc - v1nc/flipperzero-firmware - +

    + ⌨ v1nc + + v1nc/flipperzero-firmware +

    -

    Wetox - wetox-team/flipperzero-firmware - +

    + 🎩 Wetox + + wetox-team/flipperzero-firmware +

    -

    MuddledBox - MuddledBox/flipperzero-firmware - +

    + 📦 MuddledBox + + MuddledBox/flipperzero-firmware +

    -

    Summary (TL;DR)

    +

    + 📝 Summary + (TL;DR) +

    +
  • Staying up to date with upstream (official) firmware is important.
    • +
  • TX restriction removal is illegal in most circumstances, use at your own risk.
    • +
  • MuddledBox was the first popular firmware fork, but didn't grow up.
    • +
  • Unleashed is more focused on core functionality, stability, and Sub-GHz protocols.
    • +
  • RogueMaster is more focused on visual tweaks, new items, and changes (some experimental).
    • +
  • RogueMaster is based on Unleashed, but may be less stable than Unleashed in some circumstances.
    • + \ No newline at end of file diff --git a/README.md b/README.md index fbfdad1d..d046f0fa 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,9 @@ - [`T119 bruteforcer` Triggers Retekess T119 restaurant pagers.](https://github.com/xb8/t119bruteforcer) - [`flipperzero-bruteforce` Generate .sub files to brute force Sub-GHz OOK.](https://github.com/tobiabocchi/flipperzero-bruteforce) - [`UNC0V3R3D BadUSB collection` Yet another BadUSB collection.](https://github.com/UNC0V3R3D/Flipper_Zero-BadUsb) +- [`Flipper-StarNew` Universal Intercom Keys.](https://github.com/GlUTEN-BASH/Flipper-Starnew) +- [`FalsePhilosophers Flipper BadUSB` Flipper zero community ducky payload repo.](https://github.com/FalsePhilosopher/badusb) +- [`SerialHex2FlipperZeroInfrared` Convert IR serial messages into FlipperZero compatible IR files.](https://github.com/maehw/SerialHex2FlipperZeroInfrared) ## Applications & Plugins - [`Web Flasher` Flash latest FW from your browser without qFlipper, also lets you paint](https://my.flipp.dev/) @@ -73,6 +76,8 @@ - [`SD Load Applications` Prebuilt applications (FAP) for popular firmware options.](https://github.com/UberGuidoZ/Flipper/tree/main/Applications) - [`Tuning Fork` Use your flipper as a tuning fork.](https://github.com/besya/flipperzero-tuning-fork) - [`GPS` Display data from a serial GPS module.](https://github.com/ezod/flipperzero-gps) +- [`USB HID Autofire` Send left-clicks as a USB HID device.](https://github.com/pbek/usb_hid_autofire) +- [`Flipper Authenticator` Generate TOTP authentication codes.](https://github.com/akopachov/flipper-zero_authenticator/) ## Firmwares & Tweaks @@ -83,9 +88,9 @@ - [`RogueMaster` Unleashed + Official FW fork with assorted community plugins, tweaks, & games.](https://github.com/RogueMaster/flipperzero-firmware-wPlugins) - [`Unleashed` Unlocked firmware with rolling codes support & community plugins, stable tweaks, and games.](https://github.com/DarkFlippers/unleashed-firmware) -- [`v1nc flipper zero firmware` Unleashed fork with support for different Duckyscript keyboard layouts & community plugins](https://github.com/v1nc/flipperzero-firmware) -- [`Muddled Forks` Less-active firmware modifications.](https://github.com/MuddledBox/flipperzero-firmware/tree/muddled_dev) +- [`v1nc flipper zero firmware` Unleashed fork with support for different Duckyscript keyboard layouts & community plugins.](https://github.com/v1nc/flipperzero-firmware) - [`Wetox` Very similar to the official branch, with a few small tweaks.](https://github.com/wetox-team/flipperzero-firmware) +- [`Muddled Forks` Less-active firmware modifications.](https://github.com/MuddledBox/flipperzero-firmware/tree/muddled_dev) - [`OpenHaystack BLE mod` Very old PoC that makes Flipper behave like an AirTag.](https://github.com/AlexStrNik/flipperzero-firmware) ## Modules & Cases @@ -105,6 +110,8 @@ - [`Flipper Zero Boards` ESP32 and NRF24 daughterboards for the Flipper.](https://github.com/DrB0rk/Flipper-Zero-Boards) - [`Flipper Zero Car Mount` Uses foam from the original box.](https://www.thingiverse.com/thing:5464899) - [`Soft TPU cover` Similar to the official silicone case.](https://www.printables.com/en/model/272676-soft-tpu-flipper-zero-cover) +- [`Flipper-Boy` Flipper Zero Case with 22mm Watch Strap Adapter.](https://www.printables.com/model/304243-flipper-boy) +- [`WiFi Devboard Pelican Case` Top case that works with the 4mm FZ Pelican case.](https://github.com/Z3BRO/Flipper-Zero-Pelican-Case-Wifi-Devboard) ## Off-device & Debugging - [`Official Web Interface` Web interface to interact with Flipper, including Paint and SUB/IR analyzer.](https://my.flipp.dev/) @@ -121,7 +128,7 @@ - [`FlippMibo` Yet another Amiibo to Flipper conversion script.](https://github.com/0xz00n/FlipMiibo) - [`mfkey32v2` MFC key recovery reader attack.](https://github.com/equipter/mfkey32v2) - [`Fztea` Connect to your Flipper's UI over serial or make it accessible via SSH.](https://github.com/jon4hz/fztea) -- [`pyFlipper` Unofficial CLI wrapper writter in Python](https://github.com/wh00hw/pyFlipper) +- [`pyFlipper` Unofficial CLI wrapper writter in Python.](https://github.com/wh00hw/pyFlipper) - [`SUB Plotters / comparers` Python package to plot and compare multiple .sub files.](https://github.com/ShotokanZH/flipper_sub_plotters_comparers) - [`ClassicConverted` Converts Mifare Classic binary files to Flipper.](https://github.com/equipter/ClassicConverter) - [`musicxml2fmf` Converts MusicXML files to Flipper Music Format.](https://github.com/white-gecko/musicxml2fmf) @@ -129,6 +136,7 @@ - [`U2F SSH Keys` U2F ECDSA SSH Key Generation using Flipper Zero.](https://gist.github.com/BlackPropaganda/44c40f7855a90e289a9477b654e54eb1) - [`flipper0` Rusty crate with safe interface to Flipper Firmware and autogen bindings underneath.](https://crates.io/crates/flipper0) - [`flipperzero-rs` Hand-crafted bindings to Flipper Firmware with custom build tool.](https://github.com/dcoles/flipperzero-rs) +- [`fzfs` Flipper Zero filesystem driver.](https://github.com/dakhnod/fzfs) ## Notes & References - [`Official battery self-repair guide` How to troubleshoot battery issues.](https://cdn.flipperzero.one/self-repair-guide.pdf) @@ -138,7 +146,7 @@ - [`Reset forgotten PIN` How to reset your device's PIN code.](https://gist.github.com/djsime1/18d73b981249859f17aab3e2bfd2b600) - [`Atmanos Flipper Software Docs` Flipper development tutorials and information.](https://flipper.atmanos.com/docs/overview/intro) - [`Flipper Zero GPIO Pinout` Official GPIO pinouts.](https://miro.com/app/board/uXjVO_LaYYI=/?moveToWidget=3458764522696947614&cot=10) -- [`Add-on Modules GPIO Pinouts` ESP32, ESP8266, ESP32-CAM, ESP32-WROOM, NRF24](https://github.com/UberGuidoZ/Flipper/tree/main/GPIO) +- [`Add-on Modules GPIO Pinouts` ESP32, ESP8266, ESP32-CAM, ESP32-WROOM, NRF24.](https://github.com/UberGuidoZ/Flipper/tree/main/GPIO) - [`Firmware roadmap` Official stock firmware roadmap.](https://miro.com/app/board/uXjVO_3D6xU=/?moveToWidget=3458764522498020058&cot=14) - [`Flipper Zero SW&HW keynote` (OUTDATED) Hardware & software architecture document.](https://miro.com/app/board/o9J_l1XZfbw=/?moveToWidget=3458764514405659414&cot=14) - [`WiFi Dev Board How To` with Marauder firmware by JustCallMeKoko](https://www.reddit.com/r/flipperzero/comments/vn29z2/wifi_dev_board_with_marauder_firmware/) @@ -150,6 +158,7 @@ - [`Flipper Skylanders` How to read a Skylanders figure with Flipper.](https://github.com/V0lk3n/Flipper-Skylanders) - [`Flipper Zero Dimensions` Basic info on screen and case dimensions.](https://github.com/UberGuidoZ/Flipper/tree/main/FlipperZero_Dimensions) +