From 13e66a3a829d9e47e0ff120d9f0d5992d7121619 Mon Sep 17 00:00:00 2001 From: rdefeo <58139796+rdefeo@users.noreply.github.com> Date: Tue, 5 Mar 2024 22:37:59 -0500 Subject: [PATCH 1/6] Added navigation to readme --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index d657770a11b..34fd28592fe 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,11 @@ The app does not provide any recording functionality - you must use the existing ## File System Layout 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! +## Navigation / Controls +- Pressing `OK` on a folder will open/navigate to that folder and display it's contents. +- Pressing `OK` on an action (indicated as a label surrounded by a border) will transmit that signal. +- Pressing `Back` will take you up one folder + 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 strength! So continuing with the "Work Access" example, the Parking Gate can be Sub-Ghz and the Garage Door can be RFID. From 2097b8d4b5c2445baf47703e2cf6d2f771a73e62 Mon Sep 17 00:00:00 2001 From: rdefeo <58139796+rdefeo@users.noreply.github.com> Date: Tue, 5 Mar 2024 22:39:18 -0500 Subject: [PATCH 2/6] Update README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 34fd28592fe..b829fcd67ed 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,14 @@ The app does not provide any recording functionality - you must use the existing -## File System Layout -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! - ## Navigation / Controls -- Pressing `OK` on a folder will open/navigate to that folder and display it's contents. +- Pressing `OK` on a folder label will open/navigate to that folder and display it's contents. - Pressing `OK` on an action (indicated as a label surrounded by a border) will transmit that signal. - Pressing `Back` will take you up one folder +- Pressing `Up` and `Down` will, you know, select things up and down... + +## File System Layout +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. From 58a1ea3d11eefbbdfcf4a2f2ab3467d302e8e038 Mon Sep 17 00:00:00 2001 From: rdefeo <58139796+rdefeo@users.noreply.github.com> Date: Tue, 5 Mar 2024 22:40:48 -0500 Subject: [PATCH 3/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b829fcd67ed..ebb8655bf9d 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ Here's an example file layout for the screenshots above: -01_Power_Off.ir ``` -When the action files and folders are rendered for display, any `XX_` prefix will be stripped. Additionally, all underscores will be replaced with spaces. Casing is preserved. +When the action files and folders are rendered for display, any `XX_` prefix will be stripped. All underscores will be replaced with spaces. Extensions will be stripped. Casing is preserved. ## Signal playback The signal files are played back as recorded. During playback/transmit, the LED light will flash green until the action is complete. For RFID signals, they are continuously played back for 3 seconds. From b884fea5a669ba3ca8b3536d9b27df9f54fafce4 Mon Sep 17 00:00:00 2001 From: rdefeo <58139796+rdefeo@users.noreply.github.com> Date: Tue, 5 Mar 2024 22:42:18 -0500 Subject: [PATCH 4/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ebb8655bf9d..bdc5a31c10d 100644 --- a/README.md +++ b/README.md @@ -62,4 +62,4 @@ The signal files are played back as recorded. During playback/transmit, the LED - Improved UI ## Building / Install -This app is currently built with `ufbt`, intended for the stock firmware. I have not tested this on other firmwares. I will post the `.fap` shortly. +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. From c135a68d26f785deec40ed8b38ea0571be105409 Mon Sep 17 00:00:00 2001 From: rdefeo <58139796+rdefeo@users.noreply.github.com> Date: Tue, 5 Mar 2024 23:00:10 -0500 Subject: [PATCH 5/6] Create CHANGELOG.md --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000000..8b562b5e149 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +## 0.1 +- First release! +- Supports Sub-GHz and RFID files +- Items can be sorted based on filename prefix +- Item labels are pretty-printed From c70747e8c20940a0bbf80b396bb64554b72c38e8 Mon Sep 17 00:00:00 2001 From: rdefeo <58139796+rdefeo@users.noreply.github.com> Date: Thu, 7 Mar 2024 19:39:38 -0500 Subject: [PATCH 6/6] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bdc5a31c10d..89f039755bf 100644 --- a/README.md +++ b/README.md @@ -56,9 +56,11 @@ When the action files and folders are rendered for display, any `XX_` prefix wil ## Signal playback The signal files are played back as recorded. During playback/transmit, the LED light will flash green until the action is complete. For RFID signals, they are continuously played back for 3 seconds. -## Features on deck... maybe? +## On deck... maybe? +- Playlist support: Thinking a `.qpl` file (Quac playlist file - just a text file), that lists the full path of every command you wish to play back. Playlists would be rendered as buttons. Support a `pause [ms]` command so you can space out the actions inside of a playlist. +- Hidden file/folder support: Hide files and folders if they start with a `.`. This allows you to place/organize the files used by a playlist in your current directory structure, without them appearing as buttons/groups in the app. - Horizontal layout -- Customize length of RFID playback +- Customize length of RFID playback. (Per file? hmm...) - Improved UI ## Building / Install