Skip to content

Commit

Permalink
firmware 1.0.1, latest features
Browse files Browse the repository at this point in the history
  • Loading branch information
rdefeo committed Sep 10, 2024
1 parent c927f76 commit 1bd825b
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 11 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 0.7.0

- Addded support for iButton
- Added IR Import All
- Updated for firmware SDK 1.0.1

## 0.6.3

- Updated for firmware SDK 0.105.0
Expand Down
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

## Quick Action Remote Control for Flipperzero

[Latest Version: 0.6.3](https://github.com/rdefeo/quac/releases)
[Latest Version: 0.7.0](https://github.com/rdefeo/quac/releases)

![build status badge](https://github.com/rdefeo/quac/actions/workflows/build.yml/badge.svg)

This app allows you to organize previously recorded signals, of any type*, so that you can quickly and easily play them back. No more needing to recall whether that door is Sub-GHz or RFID! Just navigate to that action in **Quac!** and press OK to send!

The app does not provide any recording functionality - you must use the existing Flipperzero apps to create the saved files for your action/device. Quac! provides some basic functionality to manage your files. Or, you can manage the folder structure manually on your SD card.

> Support files include: Sub-Ghz (.sub), RFID (.rfid), Infrared (.ir), and NFC (.nfc)
> Supported files include: Sub-Ghz (.sub), RFID (.rfid), Infrared (.ir), NFC (.nfc), and iButton (.ibtn)
## Features

* [Playback of rfid, sub-ghz, IR, NFC signals](README.md#signal-playback)
* [Playback of rfid, sub-ghz, IR, NFC, iButton signals](README.md#signal-playback)
* [Easy navigation](README.md#navigation--controls)
* [Flexible signal organization](README.md#signal-organization) - utilizing the SDcard filesystem
* [In-app file management](README.md#action-settings) - rename, delete, import
Expand All @@ -38,7 +38,7 @@ The app does not provide any recording functionality - you must use the existing

## Signal playback

The signal files are played back as recorded. During playback/transmit, the LED light will flash blue until the action is complete. For RFID and NFC signals, they are continuously played back for their defined durations: RFID - 2.5 seconds and NFC - 1 second. These defaults can be changed in [application Settings](README.md#application-settings).
The signal files are played back as recorded. During playback/transmit, the LED light will flash blue until the action is complete. For RFID, NFC, and iButton signals, they are continuously played back for their defined durations: RFID - 2.5 seconds, NFC - 1 second, iButton - 1 second. These defaults can be changed in [application Settings](README.md#application-settings).

## Signal Organization

Expand Down Expand Up @@ -70,7 +70,8 @@ Long pressing the `Right` button will launch a settings menu for the currently s
* Rename: Allows you to rename the selected item. Useful for changing sorting order. The file extension is preserved on signal files. **Note: folder renaming is broken right now**
* Delete: Deletes files and folders - folders must be empty
* Import Here: Launches file browser to let you select a signal file from anywhere on the SDcard and then copies it to the current folder.
* When importing an IR file, you are prompted to select which IR command to import. This individual command is imported as it's own `.ir` file into the current location.
* When importing an IR file, you are prompted to select which IR command to import. This individual command is imported as it's own `.ir` file into the current location. You can also select `* IMPORT ALL *` to, well, import all commands.
* If an Import fails, the Flipperzero will flash red and buzz - this may be caused by a duplicate filename (i.e. that file/IR command already exists in the current folder) or the target file can not be read.
* Create Group: Prompts for the name of a new folder that will be created at that point in the folder structure.

## Playlists
Expand Down Expand Up @@ -118,17 +119,22 @@ The settings menu will appear as the last item when you are viewing the "root" d
* Show Headers: Toggles display of header/folder text at the top, giving you room for one more item on screen!
* RFID Duration: Changes the length of time a RFID signal is transmitted. Within playlists, this can be overridden per `.rfid` file.
* NFC Duration: Changes the length of time a NFC signal is transmitted. Within playlists, this can be overridden per `.nfc` file.
* iButton Duration: Changes the length of time a iButton signal is transmitted. Within playlists, this can be overridden per `.ibtn` file.
* SubGhz Ext Ant: Whether to try using the external antenna for sub-ghz signals. If this is "Enabled" but no external antenna is attached, or the external antenna can't be accessed, Quac! will fall back to using the internal antenna.
* IR Ext Ant: Whether to use the external device for IR signals. If enabled, but no external IR device is attached to TX, then the internal IR device will be used.
* Show Hidden: Will display files and folders that start with a period (`.`)
* About: Application info

## Troubleshooting

For some errors, Quac! will show an error message on screen. In other cases, it may simply flash the LED red and vibrate. To get more information on what may be happening, it is helpful to connect your Flipperzero to your computer and view the logs. Quac! will print useful information and error information to the log file as it performs its actions. The handy `ufbt cli` command, followed by `log` will show all log statements in real time, and can be very useful if you need to report an error. Check out the [ufbt](https://github.com/flipperdevices/flipperzero-ufbt) page for more information.

## On deck

* suggestions??

## Building / Install

This app is currently built with `ufbt`, intended for the stock firmware. I have not tested this on other firmwares. The `.fap` file can be found in the Releases section on the right.
This app is currently built with [ufbt](https://github.com/flipperdevices/flipperzero-ufbt), intended for the stock firmware. I have not tested this on other firmwares. The `.fap` file can be found in the Releases section on the right.

<a href="https://www.buymeacoffee.com/rdefeo" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
7 changes: 4 additions & 3 deletions README_flipperlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ This app allows you to organize previously recorded signals, of any type, so tha

The app does not provide any recording functionality - you can use the existing Flipperzero apps to create the saved files or import from existing files. Quac! provides some basic functionality to manage your files. Or, you can manage the folder structure manually on your SD card on your PC.

* Supported files include: Sub-Ghz (.sub), RFID (.rfid), Infrared (.ir), and NFC (.nfc)
* Supported files include: Sub-Ghz (.sub), RFID (.rfid), Infrared (.ir), NFC (.nfc), and iButton (.ibtn)

## Features

* Playback of rfid, sub-ghz, IR, and NFC signals
* Playback of rfid, sub-ghz, IR, NFC, and iButton signals
* Easy navigation
* Flexible signal organization
* In-app file management
Expand All @@ -20,7 +20,7 @@ The app does not provide any recording functionality - you can use the existing

## Signal playback

The signal files are played back as recorded. During playback/transmit, the LED light will flash blue until the action is complete. For RFID and NFC signals, they are continuously played back for the durations specified in the Settings.
The signal files are played back as recorded. During playback/transmit, the LED light will flash blue until the action is complete. For RFID, NFC, anbd iButton signals, they are continuously played back for the durations specified in the Settings.

## Signal Organization

Expand All @@ -45,6 +45,7 @@ The settings menu will appear as the last item when you are viewing the "root" d
* Show Headers: Toggles display of header/folder text at the top, giving you room for one more item on screen!
* RFID Duration: Changes the length of time a RFID signal is transmitted. Can be overridden, per RFID file in a Playlist
* NFC Duration: Changes the length of time a NFC signal is transmitted. Can be overridden, per NFC file in a Playlist
* iButton Duration: Changes the length of time a iButton signal is transmitted. Can be overridden, per iButton file in a Playlist
* SubGhz Ext Ant: Enables / Disables use of external sub-ghz antenna
* IR Ext Ant: Enables / Disables use of external IR antenna
* Show Hidden: Toggles display of files/folders that start with a period.
Expand Down
2 changes: 1 addition & 1 deletion application.fam
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ App(
stack_size=2 * 1024,
fap_category="Tools",
# Optional values
fap_version="0.6.3",
fap_version="0.7.0",
fap_icon="images/quac.png", # 10x10 1-bit PNG
fap_description="Quick Action remote control app",
fap_author="Roberto De Feo",
Expand Down
2 changes: 1 addition & 1 deletion quac.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#include "item.h"

#define QUAC_NAME "Quac!"
#define QUAC_VERSION "v0.6.3"
#define QUAC_VERSION "v0.7.0"
#define QUAC_ABOUT \
"Quick Action remote control\n" QUAC_VERSION "\n" \
"github.com/rdefeo/quac"
Expand Down

0 comments on commit 1bd825b

Please sign in to comment.