Skip to content
This repository has been archived by the owner on Jul 28, 2024. It is now read-only.

Commit

Permalink
Add descriptions for all the faps (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
Astrrra authored Aug 8, 2023
1 parent d8c1593 commit f3c49ed
Show file tree
Hide file tree
Showing 13 changed files with 303 additions and 4 deletions.
69 changes: 69 additions & 0 deletions avr_isp_programmer/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# AVR ISP Programmer

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.

## Wiring

The AVR ISP Programmer includes a wiring pinout diagram in the app. You can also find it here:

FLIPPER PIN | AVR PIN
------------|--------
1 | 5V (optional)
2 | MOSI
3 | MISO
4 | CLOCK (optional)
5 | SCK
6 | RESET
7 | -
8 | GND
9 | 3.3V
10 | -
11 | GND
12-18 | -

## Features

### Dump

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.

This can be used to backup the contents of the microcontroller's flash memory, or to extract the firmware from a device.

### Flash

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.

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.

### ISP

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.

Example command:

```bash
avrdude.exe -p m328p -c stk500v1 -P COMxx -U flash:r:X:\\sketch_sample.hex:i
```

Where:

* `-p m328p` is the brand of your chip,
* `-P COMxx` is the com port number of the ISP programmer

## Supported Microcontrollers

* ATtinyXXXX
* ATmegaXXXX
* AT43Uxxx
* AT76C711
* AT86RF401
* AT90xxxxx
* AT94K
* ATAxxxxx
* ATA664251
* M3000
* LGT8F88P
* LGT8F168P
* LGT8F328P

Along with any other AVR microcontroller that is supported by avrdude.
9 changes: 9 additions & 0 deletions dap_link/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# DAP Link

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.

## Protocols

SWD, JTAG , CMSIS-DAP v1 (18 KiB/s), CMSIS-DAP v2 (46 KiB/s), VCP (USB-UART).

WinUSB for driverless installation for Windows 8 and above.
3 changes: 3 additions & 0 deletions dap_link/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# Flipper Zero as CMSIS DAP/DAP Link

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.

## Protocols

SWD, JTAG , CMSIS-DAP v1 (18 KiB/s), CMSIS-DAP v2 (46 KiB/s), VCP (USB-UART).

WinUSB for driverless installation for Windows 8 and above.

## Usage

### VSCode + Cortex-Debug

Set `"device": "cmsis-dap"`

<details>
Expand Down
51 changes: 51 additions & 0 deletions hid_app/.catalog/README_BLE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# BLE Remote

## Overview

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.

## Pairing

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.

## Modes

### Keynote

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.

### Keyboard

Use your Flipper Zero as a wireless keyboard. Please note that key combinations are not supported.

### Media

Media controller mode allows you to control media playback on your computer or smartphone. It supports the following commands:

* Play/Pause
* Next Track
* Previous Track
* Volume Up
* Volume Down

### Mouse

Use your Flipper Zero as a wireless mouse. Use the D-pad to move the cursor, and click with the OK and BACK buttons.

### TikTok Controller

Use your Flipper Zero as a wireless TikTok controller. It supports the following commands:

* Like
* Next Video
* Previous Video
* Volume Up
* Volume Down

### Mouse Clicker

Repeatedly clicks the mouse button. The click interval can be adjusted with the UP and DOWN buttons.

### Mouse Jiggler

Moves your cursor slightly a few times per second. This can be used to prevent your computer from going to sleep.
47 changes: 47 additions & 0 deletions hid_app/.catalog/README_USB.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# BLE Remote

## Overview

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.

## Modes

### Keynote

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.

### Keyboard

Use your Flipper Zero as a keyboard. Please note that key combinations are not supported.

### Media

Media controller mode allows you to control media playback on your computer or smartphone. It supports the following commands:

* Play/Pause
* Next Track
* Previous Track
* Volume Up
* Volume Down

### Mouse

Use your Flipper Zero as a mouse. Use the D-pad to move the cursor, and click with the OK and BACK buttons.

### TikTok Controller

Use your Flipper Zero as a TikTok controller. It supports the following commands:

* Like
* Next Video
* Previous Video
* Volume Up
* Volume Down

### Mouse Clicker

Repeatedly clicks the mouse button. The click interval can be adjusted with the UP and DOWN buttons.

### Mouse Jiggler

Moves your cursor slightly a few times per second. This can be used to prevent your computer from going to sleep.
3 changes: 3 additions & 0 deletions mass_storage/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# USB Mass Storage emulator

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.
12 changes: 12 additions & 0 deletions mfkey32/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Flipper Zero MFKey32

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.

## Usage

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.

## Credits

Developers: noproto, AG
Thanks: bettse
31 changes: 31 additions & 0 deletions nfc_magic/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# NFC Magic

This application allows you to check whether your NFC card is Magic, write data to Magic cards, and restore them to their original state.

## What's a "Magic" Card?

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.

## Supported Cards

Currently, not all Magic cards are supported. The following cards are supported:

* Mifare Classic 1K/4K Gen1A/Gen1B (including OTP versions)
* Ultimate Magic Card (Gen4 GTU)

For the Gen4 cards, both the Ultralight and the Classic modes are supported, with the ability to select a custom password.

The following cards are currently not supported:

* Mifare Classic 1K/4K Gen2 (DirectWrite/CUID/FUID/UFUID)
* Mifare Classic 1K/4K Gen3 (APDU)
* Mifare Classic Magic Gen4 (GDM)
* Supercard (Gen1 and Gen2)
* Mifare Ultralight Gen1A/Gen1B (including OTP versions)
* Mifare Ultralight DirectWrite
* Mifare Ultralight EV1 DirectWrite
* Mifare Ultralight C Gen1
* Mifare Ultralight C DirectWrite
* NTAG (all versions)
* DESFire (all versions)
* NFC-V/ISO15693 Magic Cards (all versions)
8 changes: 4 additions & 4 deletions nfc_rfid_detector/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Just run the app and hold your Flipper Zero near the reader. The following icons may appear on the screen:
# NFC&LFRFID Field Detector

- NFC icon - the reader uses the NFC technology, operating at 13.56 MHz.
- 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.
- Both NFC and RFID icons - the reader uses both technologies.
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.

## Usage

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.
3 changes: 3 additions & 0 deletions picopass/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Picopass

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.
11 changes: 11 additions & 0 deletions signal_generator/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Signal Generator

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.

## PWM Mode

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.

## Clock Mode

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).
37 changes: 37 additions & 0 deletions spi_mem_manager/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# SPI Memory Manager

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.

## Wiring

The SPI Memory Manager includes a wiring pinout diagram in the app. You can also find it here:

| FLIPPER PIN | SPI PIN |
|-------------|---------|
| 1 | - |
| 2 | MOSI |
| 3 | MISO |
| 4 | CS |
| 5 | CLK |
| 6 | - |
| 7 | - |
| 8 | GND |
| 9 | 3.3V |
| 10 | - |
| 11 | GND |
| 12-17 | - |
| 18 | GND |

## Features

### Read

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.

### Erase

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.

### Flash

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.
23 changes: 23 additions & 0 deletions weather_station/.catalog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Weather Station

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.

## Supported Protocols

inFactory-TH
ThermoPRO-TX4
Nexus-TH
GT-WT02
GT-WT03
Acurite 592TXR
Acurite-606TX
Acurite-606TXC
LaCrosse_TX
TX141THBv2
Oregon-v1
Oregon2
Oregon3
AmbientWeather
Avriol HG06061
TX8300
Wendox W6276

0 comments on commit f3c49ed

Please sign in to comment.