Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rdefeo authored Mar 6, 2024
1 parent e4a1dd8 commit c7efc10
Showing 1 changed file with 24 additions and 19 deletions.
43 changes: 24 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,34 @@
# Simple On/Off Remote
## Sub-GHz
# Quac! Remote
## QUick ACtion Remote Control for Flipperzero
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!

Main Display
* Saved device 1
* Saved device 2
* Manage Devices

Saved device View
* ON
* OFF
* other
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.

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

## File System Layout
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.
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!

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.

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.

The device order list, and button list, is based on the sorted file order. This is enforced by the following naming convention:
## Sorting and Naming
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.

Here's an example file layout:
```
/data_folder
- 00_Device_1
- 01_Device_2
- 00_Button_1.sub
- 01_Button_2.sub
/ext/apps_data/quac
/00_Work
-00_Parking_Gate.sub
-01_Garage_Door.rfid
-02_Office.rfid
/01_Home_Theater
-00_Power_On.ir
-01_Power_Off.ir
```

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

0 comments on commit c7efc10

Please sign in to comment.