🤬
  • Update 52 Many FAQ questions changed, still have a few things to write.

  • Loading...
  • David committed 2 years ago
    0587adaf
    1 parent c3261b36
  • ■ ■ ■ ■ ■ ■
    FAQ.md
    skipped 17 lines
    18 18   
    19 19  ## Preamble [🔝](#top)
    20 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.*
    21 22  - *This FAQ is still being worked on, and contributions are welcome.*
    22 23  - *If your question isn't answered here, **SEARCH** the [Discord](https://flipperzero.one/discord) and check pinned messages before asking there.*
    23 24   
    skipped 12 lines
    36 37   
    37 38  ### Why are there so many unmerged pull requests?
    38 39  > 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.
     40 + 
     41 +### This is really cool! Is there a way I can donate to you?
     42 +> I really appreciate the kind words, however I'm not accepting personal monetary donations.
     43 +> 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/))!
     44 +> Besides that, why not support a local charity/organization instead? My personal recommendation is the [Electronic Frontier Foundation](https://supporters.eff.org/donate).
    39 45   
    40 46   
    41 47   
    skipped 15 lines
    57 63  > - For plugging the SD Card into your PC, drop files in their corresponding folders (The folder names are similar to the file extensions).
    58 64   
    59 65  ### How do I install applications and plugins?
    60  -> The links listed in this repo can't be installed as easily as drag-and-drop.
    61  -> Most of them have to be manually merged into the firmware and fully recompiled. (Documentation coming soon)
    62  -> As for ELF/FAP's, they're in a very early stage of development and require a special version of the firmware to be installed. I DO NOT recommend using them until they are officially merged into the main firmware.
    63  -> *If you're really insistent, install the firmware from [this comment](https://github.com/flipperdevices/flipperzero-firmware/pull/1387#issuecomment-1182470778), place the `.elf` or `.fap` file in the `apps` directory on the SD Card (create it if necessary), and use the ELF loader application to run them.*
    64  - 
    65  -### How do I write my own applications/plugins/firmware?
    66  -> *(WIP)*
     66 +> 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.
    67 67   
    68 68  ### How do I install custom firmwares?
    69 69  > 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?
    70  -> 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 updater package (typically a `.tar` or `.zip` file, always contains a file named `update.fuf`).
     70 +> 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 updater package (typically a `.tar` or `.zip` file, it always contains a file named `update.fuf`).
    71 71  > - If you only have a `.dfu`, it can be installed using the "Install from file" option in qFlipper. Select the file and begin the installation.
    72  -> - If you have an updater package, extract and transfer the folder (not the original archive file) to the `update` folder on the SD Card (create if needed). Once transferred, go to the 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.
     72 +> - If you have an updater 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.
    73 73  >
    74 74  > If there was no pre-compiled update file/package, you'll have to build the firmware yourself. See the next question for details.
    75 75  > For more information, read the [official documentation](https://docs.flipperzero.one/basics/firmware-update).
    76 76   
    77  -### How do I compile my own firmware/applications/assets?
    78  -> *(WIP)*
     77 +### How do I write/compile my own applications/plugins/firmware/assets?
     78 +<blockquote>
     79 + <em>(The following is a summary of the <a href="https://github.com/flipperdevices/flipperzero-firmware/blob/dev/documentation/fbt.md">official FBT docs</a>.)</em><br>
     80 + Since the introduction of <a href="https://github.com/flipperdevices/flipperzero-firmware/blob/dev/documentation/fbt.md">Flipper Build Tool (FBT)</a>, this has become very easy! You should have a basic understanding of working on a command line before proceeding. The only prerequisite install is <a href="https://git-scm.com/downloads">Git</a>. You should also have an IDE installed, <a href="https://code.visualstudio.com/">VSCode</a> is recommended since the <a href="https://github.com/flipperdevices/flipperzero-firmware">firmware repo</a> has <a href="https://github.com/flipperdevices/flipperzero-firmware/blob/dev/documentation/fbt.md#vscode-integration">config files</a> for it.
     81 + <details>
     82 + <summary>Expand me for the rest of the steps.</summary>
     83 + <em>(WIP, sorry to curb your enthusiasm.)</em>
     84 + </details>
     85 +</blockquote>
    79 86  
    80 87  ### Can I make my own Flipper instead of buying one?
    81  -> Probably not. While the firwmare and schematics are mostly public, actually sourcing the components is extremely difficult. Multiple core pieces, such as the screen, were specficially produced to be used in Flipper manufacturing.
     88 +> 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.
    82 89  
    83  -### How do I get a black-case Flipper?
    84  -> This is no longer possible, they were Kickstarter-backer exclusives.
     90 +### How do I get a black-shell Flipper?
     91 +> This is no longer possible*, they were Kickstarter-backer exclusives.
     92 +> (*No longer possible unless you're willing to shill out hundreds of dollars for one on eBay.)
    85 93  
    86 94  ### How do I invert the screen/change backlight color/change case cover, etc.
    87  -> These are all hardware mods, inaccessible to the average user. Look up/ask around on how to do them.
     95 +> 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.
    88 96   
    89 97  ### Will there be future hardware revisions?
    90  -> [Not for the Flipper Zero.](https://discord.com/channels/740930220399525928/746304505879986267/1001167062728720395) While there are concepts for a [Flipper One](https://flipperzero.one/one), there is not any timeline for release.
     98 +> 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.
     99 +> Besides that, there are concepts for a [Flipper One](https://flipperzero.one/one), but without a timeline for release.
    91 100   
    92  -### What is DUMB mode?
    93  -> It's a yet to be implimented mode that would hide all of the potentially malicious apps/features of Flipper.
     101 +### What is Dummy Mode?
     102 +> It's a work-in-progress feature that hides every app except games, in case your device is ever seized.
    94 103   
    95 104  ### My device is frozen, how do I reboot/fix it?
    96 105  > - 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.
    skipped 81 lines
    178 187  > Short answer: You don't. That's illegal, and NOT what Flipper was designed for.
    179 188   
    180 189  ### What does "This frequency can only be used for RX in your region" mean?
    181  -> Due to legal regulations, Flipper is not allowed to transmit on certain frequencies depending on your order location.
    182  -> For more information, referr to the [official documentation](https://docs.flipperzero.one/sub-ghz/frequencies)
    183  -> If you have no regard for laws, you can use custom firmwares such as Unleashed to bypass this restriction **at your own risk.**
     190 +> Due to legal regulations, Flipper is not allowed to transmit on certain frequencies depending on your device's provisioned location.
     191 +> Provisioning occurs whenever you update your firmware via qFlipper or the mobile app and is based on your rough location.
    184 192   
    185 193  ### How do I find the frequency of a device/transponder?
    186 194  > If it's a commonly used frequency, bring the device *really close* to the Flipper and use the Frequency analyzer.
    skipped 1 lines
    188 196  > Then, look up that ID on [FCC ID.io](https://fccid.io).
    189 197   
    190 198  ### I can't tune Flipper to capture a specific frequency.
    191  -> *(WIP)*
     199 +> 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.
     200 +> Note that this won't magically unlock those frequencies, you're still bound by the device's limitations.
    192 201   
    193 202  ### I captured a garage/car/etc. signal, but it doesn't work when I replay it.
    194 203  > Unless the item of interest is extremely old, it probably uses rolling codes. Read more below.
    skipped 13 lines
    208 217  > Example: 0001, 0002, 0003, 0004 ... 9998, 9999.
    209 218  > Debruin sequences are more efficient by merging multiple codes together.
    210 219  > Example: 365, 136, and 650 can all be found in 13650 by looking at groups of 3 digits individually.
     220 + 
     221 +### Can I attach a more powerful antenna?
     222 +> 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.
     223 +> For example, you could write your own code on a NRF24 and accompanying Flipper app to control it over GPIO.
    211 224   
    212 225   
    213 226   
    skipped 10 lines
    224 237  | NTAG-21X | ✅ | | ✅ | ✅ | |
    225 238  | NFC-B | | | | ❌ | No hardware support for emulation |
    226 239  | iClass/PicoPass | ✅ | | ✅ | ❌ | No STM SDK support for emulation |
    227  -| EM4100/EM4102 | ✅ | | ✅ | ✅ | |
    228  -| H10301 | ✅ | | ✅ | ✅ | |
    229  -| Indala | ✅ | | ✅ | ✅ | |
    230  -| T5577 | ✅ | ✅ | ✅ | ✅ | |
     240 +| EM4100/EM4102 | ✅ | | ✅ | ✅ | |
     241 +| H10301 | ✅ | | ✅ | ✅ | |
     242 +| Indala | ✅ | | ✅ | ✅ | |
     243 +| T5577 | ✅ | ✅ | ✅ | ✅ | |
     244 +| EM4305 | ✅ | ✅ | ✅ | ✅ | |
    231 245  | Paxton Net2 | ❌ | ❌ | ❌ | ❌ | Hitag2: no support |
    232 246  | Legic Prime | ❌ | ❌ | ❌ | ❌ | 13.56mhz, but proprietary|
     247 + 
     248 +***Note:*** *While T5577 and EM4305's can be written, they are rarely handed out as ID badges.*
    233 249   
    234 250  ### How do I identify which type of card/tag I have?
    235 251  > 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).
    skipped 3 lines
    239 255  > Note that you've only read the card UID and type, *not the actual data.* For that you need to select the "Run compatible app" option.
    240 256   
    241 257  ### Why can't I write an NFC tag?
    242  -> Currently unsupported, but is being worked on.
     258 +> This will become possible in the near future with a firmware update.
    243 259   
    244  -### Mifare Ultralight/NTAG was detected, but nothing happens when I'm trying to read the data.
    245  -> This happens when the tag is password protected. There's no quick fix for this, but solutions are in the works.
     260 +### I was told a Mifare Ultralight/NTAG tag has password-protected sectors. What does that mean?
     261 +> Either the read was interrupted, or the tag is actually password protected.
     262 +> First, try reading the tag again but make sure it stays on the back of the device until the info screen pops up.
     263 +> If you're still seeing the warning, Flipper can unlock Amiibo and some Xaomi tags, but be warned that there's a risk of **bricking** your tag if you use the wrong password too many times.
    246 264   
    247 265  ### Why does it take so long to read a Mifare Classic?
    248  -> 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 about 2000 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.
     266 +> 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.
    249 267   
    250 268  ### What does it mean when no sectors could be read on a Mifare Classic?
    251  -> The data on Mifare Classic cards is split up into sectors, and each section is protected by two keys.
    252  -> The read has failed, meaning the card didn't use any common keys. If you have access to the card reader, [mfkey32v2](https://github.com/equipter/mfkey32v2) can be used to pull keys from it.
     269 +> The data on Mifare Classic cards is split up into sectors, and each sector is protected by two keys.
     270 +> If no sectors were read, then Flipper's dictionary attack has failed to find any valid keys.
     271 +> 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.
    253 272   
    254 273  ### What does it mean when some but not all sectors could be read on a Mifare Classic?
    255 274  > The data on Mifare Classic cards is split up into sectors, and each sector is protected by two keys.
    256 275  > The read wasn't successful, but it didn't fail either. Some of the card's data was read and saved, but not all.
    257  -> Even if not all sectors were read, there's a slim chance a partial save will work with emulation.
     276 +> 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.
     277 +> If you still need the rest of the keys, read the next question.
     278 + 
     279 +### How to I get Mifare Classic keys from a reader with [mfkey32v2](https://github.com/equipter/mfkey32v2)?
     280 +> (WIP, Note to self: https://regex101.com/r/iXmE2N/2)
    258 281   
    259 282  ### Why isn't Mifare Classic emulation working?
    260 283  > There are a number of reasons, some of which can be fixed while others can't. The first thing you should check is that all sectors were read from the card. If not, look at the questions above.
    skipped 13 lines
    274 297  ### Why doesn't my bank card work when I emulate it?
    275 298  > 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.
    276 299   
    277  -### Where is the "USB NFC Reader" feature mentioned in the [september blog post](https://blog.flipperzero.one/september-progress/)?
     300 +### Where is the "USB/LibNFC NFC Reader" feature mentioned in the [September blog post](https://blog.flipperzero.one/september-progress/)?
    278 301  > This was scrapped due to timing issues, more details in [this GitHub issue](https://github.com/flipperdevices/flipperzero-firmware/issues/1173#issuecomment-1127728562).
    279 302   
    280 303   
    skipped 15 lines
    296 319  ## BadUSB [🔝](#top)
    297 320  > *(WIP)*
    298 321   
     322 + 
     323 + 
     324 +## iButton [🔝](#top)
     325 +> *(WIP)*
     326 + 
     327 + 
     328 + 
     329 +## WiFi board [🔝](#top)
     330 +> *(WIP)*
  • ■ ■ ■ ■ ■
    README.md
    skipped 52 lines
    53 53   
    54 54  <table align="right">
    55 55   <tr><th><strong>OwO whats this?</strong></th></tr>
    56  - <tr><td>✨ <em>This section will be succeeded by<br><a href="https://github.com/flipper-aquarium">Aquarium</a> once SD-Card apps are released.</em></td></tr>
     56 + <tr><td>✨ <em>This section will be succeeded by<br><a href="https://github.com/flipper-aquarium">Aquarium</a> in the near future.</em></td></tr>
    57 57  </table>
    58 58   
    59 59  - [`Flipper-Plugin-Tutorial` Building a Custom "Hello world" plugin.](https://github.com/mfulz/Flipper-Plugin-Tutorial)
    skipped 59 lines
    119 119  - [`musicxml2fmf` Converts MusicXML files to Flipper Music Format.](https://github.com/white-gecko/musicxml2fmf)
    120 120   
    121 121  ## Notes & References
    122  -<table align="right">
    123  - <tr><th><strong>Important notice.</strong></th></tr>
    124  - <tr><td>⚠️ <em>The Flipper team <a href="https://github.com/flipperdevices/flipperzero-firmware/pull/1269">recently changed</a><br>how the firmware is built. Some docs<br>and tutorials may be outdated!</em></td></tr>
    125  -</table>
    126  - 
    127 122  - [`Official battery self-repair guide` How to troubleshoot battery issues.](https://cdn.flipperzero.one/self-repair-guide.pdf)
    128 123  - [`Official firmware recovery guide` How to troubleshoot firmware issues.](https://docs.flipperzero.one/basics/firmware-update/firmware-recovery)
    129 124  - [`FZ Firmware Comparisons` Comparison of custom firmwares listed in this repo.](https://github.com/djsime1/awesome-flipperzero/blob/main/Firmwares.md)
    skipped 18 lines
    148 143  <div align="center">
    149 144   You can <kbd><a href="https://github.com/djsime1/awesome-flipperzero/edit/main/README.md">Edit this file</a></kbd> and open a Pull Request,
    150 145   or <kbd><a href="https://github.com/djsime1/awesome-flipperzero/discussions">Start a discussion</a></kbd> with your ideas.<br>
    151  - <em>(A GitHub account is required for both)</em>
    152  - <details>
    153  - <summary><em>Why so many umerged pull requests?</em></summary>
    154  - 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.
    155  - </details>
     146 + Read the <a href="https://github.com/djsime1/awesome-flipperzero/blob/main/FAQ.md#meta-">Meta FAQ section</a> for more info.
    156 147  </div>
    157 148   
Please wait...
Page is in error, reload to recover