Skip to content

Commit f3c49ed

Browse files
author
Astra
authored
Add descriptions for all the faps (#13)
1 parent d8c1593 commit f3c49ed

File tree

13 files changed

+303
-4
lines changed

13 files changed

+303
-4
lines changed

‎avr_isp_programmer/.catalog/README.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# AVR ISP Programmer
2+
3+
The AVR ISP Programmer application allows you to do various things with AVR microcontrollers using the ISP interface. It can autonomously Dump a Flash the microcontroller using files on the SD card. It can also act as an ISP programmer for programming from a desktop IDE via USB. It is compatible with AVR-based microcontrollers, such as the ATmega328P used in the Arduino Uno, ATTiny85, and many others.
4+
5+
## Wiring
6+
7+
The AVR ISP Programmer includes a wiring pinout diagram in the app. You can also find it here:
8+
9+
FLIPPER PIN | AVR PIN
10+
------------|--------
11+
1 | 5V (optional)
12+
2 | MOSI
13+
3 | MISO
14+
4 | CLOCK (optional)
15+
5 | SCK
16+
6 | RESET
17+
7 | -
18+
8 | GND
19+
9 | 3.3V
20+
10 | -
21+
11 | GND
22+
12-18 | -
23+
24+
## Features
25+
26+
### Dump
27+
28+
The Dump feature allows you to dump the contents of the microcontroller's flash memory to a file on your Flipper Zero's SD card. Along with the EEPROM memory, the dump files include the fuses and lock bits of the microcontroller.
29+
30+
This can be used to backup the contents of the microcontroller's flash memory, or to extract the firmware from a device.
31+
32+
### Flash
33+
34+
The Flash feature allows you to flash the contents of a file on your Flipper Zero's SD card to the microcontroller's flash memory. It also flashes the fuses and lock bits of the microcontroller.
35+
36+
This can help you quickly flash multiple devices with the same firmware, or to restore a device to its original firmware if it has been bricked.
37+
38+
### ISP
39+
40+
The ISP feature allows you to use your Flipper Zero as an ISP programmer for your desktop computer. After connecting your Flipper Zero to the AVR microcontroller, you can flash it via USB from your desktop computer using avrdude.
41+
42+
Example command:
43+
44+
```bash
45+
avrdude.exe -p m328p -c stk500v1 -P COMxx -U flash:r:X:\\sketch_sample.hex:i
46+
```
47+
48+
Where:
49+
50+
* `-p m328p` is the brand of your chip,
51+
* `-P COMxx` is the com port number of the ISP programmer
52+
53+
## Supported Microcontrollers
54+
55+
* ATtinyXXXX
56+
* ATmegaXXXX
57+
* AT43Uxxx
58+
* AT76C711
59+
* AT86RF401
60+
* AT90xxxxx
61+
* AT94K
62+
* ATAxxxxx
63+
* ATA664251
64+
* M3000
65+
* LGT8F88P
66+
* LGT8F168P
67+
* LGT8F328P
68+
69+
Along with any other AVR microcontroller that is supported by avrdude.

‎dap_link/.catalog/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# DAP Link
2+
3+
This application allows you to use your Flipper Zero as a [Free-DAP](https://github.com/ataradov/free-dap) based SWD/JTAG debugger. Free-DAP is a free and open source firmware implementation of the [CMSIS-DAP](https://www.keil.com/pack/doc/CMSIS_Dev/DAP/html/index.html) debugger.
4+
5+
## Protocols
6+
7+
SWD, JTAG , CMSIS-DAP v1 (18 KiB/s), CMSIS-DAP v2 (46 KiB/s), VCP (USB-UART).
8+
9+
WinUSB for driverless installation for Windows 8 and above.

‎dap_link/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# Flipper Zero as CMSIS DAP/DAP Link
2+
23
Flipper Zero as a [Free-DAP](https://github.com/ataradov/free-dap) based SWD\JTAG debugger. Free-DAP is a free and open source firmware implementation of the [CMSIS-DAP](https://www.keil.com/pack/doc/CMSIS_Dev/DAP/html/index.html) debugger.
34

45
## Protocols
6+
57
SWD, JTAG , CMSIS-DAP v1 (18 KiB/s), CMSIS-DAP v2 (46 KiB/s), VCP (USB-UART).
68

79
WinUSB for driverless installation for Windows 8 and above.
810

911
## Usage
1012

1113
### VSCode + Cortex-Debug
14+
1215
Set `"device": "cmsis-dap"`
1316

1417
<details>

‎hid_app/.catalog/README_BLE.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# BLE Remote
2+
3+
## Overview
4+
5+
This application allows you to use your Flipper Zero as a HID (Human Interface Device) keyboard or mouse over Bluetooth Low Energy. It can be used to control a computer or a smartphone.
6+
7+
## Pairing
8+
9+
After selecting a mode, open the Bluetooth settings on your computer or smartphone and search for new devices. The Flipper Zero will appear as `Control [NAME]`, where `[NAME]` is the name of your Flipper Zero. Pair with the device and it will be ready to use.
10+
11+
## Modes
12+
13+
### Keynote
14+
15+
Use your Flipper Zero as a wireless presenter for any presentation software that supports keyboard navigation. There is also a vertical version that has the interface and controls rotated 90 degrees for easier use.
16+
17+
### Keyboard
18+
19+
Use your Flipper Zero as a wireless keyboard. Please note that key combinations are not supported.
20+
21+
### Media
22+
23+
Media controller mode allows you to control media playback on your computer or smartphone. It supports the following commands:
24+
25+
* Play/Pause
26+
* Next Track
27+
* Previous Track
28+
* Volume Up
29+
* Volume Down
30+
31+
### Mouse
32+
33+
Use your Flipper Zero as a wireless mouse. Use the D-pad to move the cursor, and click with the OK and BACK buttons.
34+
35+
### TikTok Controller
36+
37+
Use your Flipper Zero as a wireless TikTok controller. It supports the following commands:
38+
39+
* Like
40+
* Next Video
41+
* Previous Video
42+
* Volume Up
43+
* Volume Down
44+
45+
### Mouse Clicker
46+
47+
Repeatedly clicks the mouse button. The click interval can be adjusted with the UP and DOWN buttons.
48+
49+
### Mouse Jiggler
50+
51+
Moves your cursor slightly a few times per second. This can be used to prevent your computer from going to sleep.

‎hid_app/.catalog/README_USB.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# BLE Remote
2+
3+
## Overview
4+
5+
This application allows you to use your Flipper Zero as a HID (Human Interface Device) keyboard or mouse over USB. It can be used to control a computer or a smartphone.
6+
7+
## Modes
8+
9+
### Keynote
10+
11+
Use your Flipper Zero as a presenter for any presentation software that supports keyboard navigation. There is also a vertical version that has the interface and controls rotated 90 degrees for easier use.
12+
13+
### Keyboard
14+
15+
Use your Flipper Zero as a keyboard. Please note that key combinations are not supported.
16+
17+
### Media
18+
19+
Media controller mode allows you to control media playback on your computer or smartphone. It supports the following commands:
20+
21+
* Play/Pause
22+
* Next Track
23+
* Previous Track
24+
* Volume Up
25+
* Volume Down
26+
27+
### Mouse
28+
29+
Use your Flipper Zero as a mouse. Use the D-pad to move the cursor, and click with the OK and BACK buttons.
30+
31+
### TikTok Controller
32+
33+
Use your Flipper Zero as a TikTok controller. It supports the following commands:
34+
35+
* Like
36+
* Next Video
37+
* Previous Video
38+
* Volume Up
39+
* Volume Down
40+
41+
### Mouse Clicker
42+
43+
Repeatedly clicks the mouse button. The click interval can be adjusted with the UP and DOWN buttons.
44+
45+
### Mouse Jiggler
46+
47+
Moves your cursor slightly a few times per second. This can be used to prevent your computer from going to sleep.

‎mass_storage/.catalog/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# USB Mass Storage emulator
2+
3+
This application allows you to use your Flipper Zero as a (very slow) USB mass storage device. You can create a disk image of up to 64MB, and then format and mount it on your computer via USB. All the images are stored on the SD card, which allows you to have multiple images and switch between them.

‎mfkey32/.catalog/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Flipper Zero MFKey32
2+
3+
This application allows you to calculate the keys to Mifare Classic cards from the nonces using the MFkey32 algorithm directly on your Flipper Zero. After collecting the nonces using the Detect Reader feature of the NFC app, they can be used to calculate the keys to the card in the MFKey32 app.
4+
5+
## Usage
6+
7+
After collecting nonces using the Detect Reader option, press the Start button in the MFKey32 app and wait for it to finish. The calculation can take more than 10 minutes, so you'll have to be patient. After the calculation is complete, the keys will be saved to the user key dictionary.
8+
9+
## Credits
10+
11+
Developers: noproto, AG
12+
Thanks: bettse

‎nfc_magic/.catalog/README.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# NFC Magic
2+
3+
This application allows you to check whether your NFC card is Magic, write data to Magic cards, and restore them to their original state.
4+
5+
## What's a "Magic" Card?
6+
7+
A Magic card is a card that allows you to change its UID. Generally, NFC cards have a UID pre-programmed at the factory, and it cannot be changed. However, some cards have a special backdoor feature that allows you to change the UID. These cards are called Magic cards.
8+
9+
## Supported Cards
10+
11+
Currently, not all Magic cards are supported. The following cards are supported:
12+
13+
* Mifare Classic 1K/4K Gen1A/Gen1B (including OTP versions)
14+
* Ultimate Magic Card (Gen4 GTU)
15+
16+
For the Gen4 cards, both the Ultralight and the Classic modes are supported, with the ability to select a custom password.
17+
18+
The following cards are currently not supported:
19+
20+
* Mifare Classic 1K/4K Gen2 (DirectWrite/CUID/FUID/UFUID)
21+
* Mifare Classic 1K/4K Gen3 (APDU)
22+
* Mifare Classic Magic Gen4 (GDM)
23+
* Supercard (Gen1 and Gen2)
24+
* Mifare Ultralight Gen1A/Gen1B (including OTP versions)
25+
* Mifare Ultralight DirectWrite
26+
* Mifare Ultralight EV1 DirectWrite
27+
* Mifare Ultralight C Gen1
28+
* Mifare Ultralight C DirectWrite
29+
* NTAG (all versions)
30+
* DESFire (all versions)
31+
* NFC-V/ISO15693 Magic Cards (all versions)

‎nfc_rfid_detector/.catalog/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Just run the app and hold your Flipper Zero near the reader. The following icons may appear on the screen:
1+
# NFC&LFRFID Field Detector
22

3-
- NFC icon - the reader uses the NFC technology, operating at 13.56 MHz.
4-
- RFID icon - the reader uses the RFID technology, operating at 125 kHz. For RFID readers, the app displays the estimated frequency the reader operates at.
5-
- Both NFC and RFID icons - the reader uses both technologies.
3+
This application allows you to detect the presence of NFC and LF RFID fields. It can be used to check what technology is used in a reader that you don't have documentation for, or to check whether a reader is working properly.
64

5+
## Usage
76

7+
Open the app and bring your Flipper Zero up to the reader. The app will display the detected field type (NFC or LF RFID). For LF RFID, the app will also display the exact frequency of the field. If the reader is using both NFC and LF RFID, the app will display both.

‎picopass/.catalog/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Picopass
2+
3+
This application allows you to read the data from Picopass cards, save it (as either picopass of LFRFID data for multiprotocol readers), change the card keys, and perform key dictionary attacks.

‎signal_generator/.catalog/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Signal Generator
2+
3+
This is a simple signal generator that can be used to generate a signal with a given frequency. There are two modes: PWM and Clock.
4+
5+
## PWM Mode
6+
7+
In PWM mode, the signal is generated by toggling the GPIO pin at the given frequency with a given pulse width. You can also select the GPIO pin on which the signal will be generated.
8+
9+
## Clock Mode
10+
11+
In Clock mode, the signal is generated from the clock signal of the microcontroller. The frequency of the clock signal can be divided by a given value to get the desired frequency. The maximum frequency that can be generated is 64MHz, and the minimum is 32.768kHz. You can also manually select the frequency divider from 1 to 16. The GPIO pin is fixed at 13 (TX).

‎spi_mem_manager/.catalog/README.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# SPI Memory Manager
2+
3+
This application allows you to read, erase, and flash SPI memory chips. It can be used to backup the contents of SPI memory chips, or to restore them to their original state.
4+
5+
## Wiring
6+
7+
The SPI Memory Manager includes a wiring pinout diagram in the app. You can also find it here:
8+
9+
| FLIPPER PIN | SPI PIN |
10+
|-------------|---------|
11+
| 1 | - |
12+
| 2 | MOSI |
13+
| 3 | MISO |
14+
| 4 | CS |
15+
| 5 | CLK |
16+
| 6 | - |
17+
| 7 | - |
18+
| 8 | GND |
19+
| 9 | 3.3V |
20+
| 10 | - |
21+
| 11 | GND |
22+
| 12-17 | - |
23+
| 18 | GND |
24+
25+
## Features
26+
27+
### Read
28+
29+
To read the contents of an SPI memory chip, connect it to your Flipper Zero and press the Read button. The chip type will be detected automatically, and, if it is supported, the contents of the chip will be read and saved to a file on your Flipper Zero's SD card.
30+
31+
### Erase
32+
33+
To erase the contents of an SPI memory chip, connect it to your Flipper Zero and press the Erase button. If the chip type is supported, the chip will be erased.
34+
35+
### Flash
36+
37+
To flash the contents of a file on your Flipper Zero's SD card to an SPI memory chip, connect it to your Flipper Zero, select the Saved menu option in the app, and select the file you want to flash. If the chip type is supported, the file will be flashed to the chip.

‎weather_station/.catalog/README.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Weather Station
2+
3+
This application allows you to read the data from Sub-GHz weather sensors and display it on your Flipper Zero. The interface is identical to the default Sub-GHz app, but the supported protocols are different.
4+
5+
## Supported Protocols
6+
7+
inFactory-TH
8+
ThermoPRO-TX4
9+
Nexus-TH
10+
GT-WT02
11+
GT-WT03
12+
Acurite 592TXR
13+
Acurite-606TX
14+
Acurite-606TXC
15+
LaCrosse_TX
16+
TX141THBv2
17+
Oregon-v1
18+
Oregon2
19+
Oregon3
20+
AmbientWeather
21+
Avriol HG06061
22+
TX8300
23+
Wendox W6276

0 commit comments

Comments
 (0)