Skip to content

Commit c7efc10

Browse files
authored
Update README.md
1 parent e4a1dd8 commit c7efc10

File tree

1 file changed

+24
-19
lines changed

1 file changed

+24
-19
lines changed

README.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,34 @@
1-
# Simple On/Off Remote
2-
## Sub-GHz
1+
# Quac! Remote
2+
## QUick ACtion Remote Control for Flipperzero
3+
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!
34

4-
Main Display
5-
* Saved device 1
6-
* Saved device 2
7-
* Manage Devices
8-
9-
Saved device View
10-
* ON
11-
* OFF
12-
* other
5+
The app does not provide any recording functionality - you must use the existing Flipperzero apps to create the saved files for your action/device. Additionally, you must manage the folder structure manually on your SD card.
136

7+
```
8+
Only Sub-Ghz (.sub) and RFID (.rfid) files are supported at this time, IR is coming soon!
9+
```
1410

1511
## File System Layout
16-
Inside the data folder, create sub-folders per device. Inside each of the device folders, store the raw files that contain the sub-ghz data, etc.
12+
The key to organizing your Quac interface is to organize your `/ext/apps_data/quac` folder structure. Every individual file is assigned a button, and every folder/directory is a "group". Selecting a group will show you the contents of that folder/directory, whether they are individual files or more folders. There is no limit on the number of actions or folders - nest as deep as you want!
13+
14+
You can organize your files by device type, or by function. For example, you may have a folder of "TV" actions, which correspond to Channel Up, Channel Down, Volume Up, Volume Down, etc. Or you may have a "Work Access" folder, which contains files/actions that correspond to Parking Gate, Garage Door, Lobby Entrance.
15+
16+
The files in a folder can be of mixed types. This is Quac's main strendth. So continuing with the "Work Access" example, the Parking Gate can be Sub-Ghz and the Garage Door can be RFID.
1717

18-
The device order list, and button list, is based on the sorted file order. This is enforced by the following naming convention:
18+
## Sorting and Naming
19+
The list view is based on the sorted file and folder order. This is enforced by sorting the actual filenames. When there are cases where you need to enforce a sorted order, you can prepend the file and folder names with `XX_` where `X` is a digit between 0-9. This will let you place an action called `On` before `Off`, even though when sorted alphabeticaly, `Off` would come before `On`. Therefore, you would name your files `00_On.rfid` and `01_Off.rfid` - assuming these are RFID saved signals.
1920

21+
Here's an example file layout:
2022
```
21-
/data_folder
22-
- 00_Device_1
23-
- 01_Device_2
24-
- 00_Button_1.sub
25-
- 01_Button_2.sub
23+
/ext/apps_data/quac
24+
/00_Work
25+
-00_Parking_Gate.sub
26+
-01_Garage_Door.rfid
27+
-02_Office.rfid
28+
/01_Home_Theater
29+
-00_Power_On.ir
30+
-01_Power_Off.ir
2631
```
2732

28-
The first two digits and underscore will be stripped before display. Additionally, underscores in folder and filenames will be replaced with spaces.
33+
When the action files and folders are rendered for display, any `XX_` prefix will be stripped. Additionally, all underscores will be replaced with spaces.
2934

0 commit comments

Comments
 (0)