mirror of
https://github.com/DarkFlippers/unleashed-firmware.git
synced 2025-12-12 04:34:43 +04:00
update readme/changelog & some fixes
This commit is contained in:
72
documentation/SubGHzRemotePlugin.md
Normal file
72
documentation/SubGHzRemotePlugin.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# UniRF Remix
|
||||
|
||||
### The UniRF Tool *requires* the creation of custom user map with `.txt` extension in the `unirf` folder on the sdcard.
|
||||
|
||||
#### If these files are not exist or not configured properly, **you will receive an error each time you try to select wrong file in the UniRF Tool**.
|
||||
|
||||
## You can add as many `.txt` map files as you want, file name doesn't matter!
|
||||
|
||||
### App currenty works only with RAW subghz files
|
||||
|
||||
## Incorrect or unconfigured file error
|
||||
|
||||
If the `.txt` file has not been properly configured, the following error will be thrown when trying to run the UniRF Remix app:
|
||||
|
||||
```
|
||||
Invalid map file!
|
||||
|
||||
Please reconfigure
|
||||
your map file.
|
||||
|
||||
Hold Back to Exit
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Setting up the `unirf/example.txt` file:
|
||||
|
||||
```
|
||||
UP: /ext/subghz/Up.sub
|
||||
DOWN: /ext/subghz/Down.sub
|
||||
LEFT: /ext/subghz/Left.sub
|
||||
RIGHT: /ext/subghz/Right.sub
|
||||
OK: /ext/subghz/Ok.sub
|
||||
ULABEL: Up Label
|
||||
DLABEL: Down Label
|
||||
LLABEL: Left Label
|
||||
RLABEL: Right Label
|
||||
OKLABEL: Ok Label
|
||||
```
|
||||
|
||||
The UP/DOWN/LEFT/RIGHT/OK file locations must be set to the specific file you want mapped to that directional pad direction.
|
||||
|
||||
The ULABEL/DLABEL/LLABEL/RLABEL/OKLABEL variables should be set to the text to be displayed for each of the files set earlier.
|
||||
|
||||
## Example:
|
||||
|
||||
```
|
||||
UP: /ext/subghz/Fan1.sub
|
||||
DOWN: /ext/subghz/Fan2.sub
|
||||
LEFT: /ext/subghz/Door.sub
|
||||
RIGHT: /ext/subghz/Garage3.sub
|
||||
OK: /ext/subghz/Garage3l.sub
|
||||
ULABEL: Fan ON
|
||||
DLABEL: Fan OFF
|
||||
LLABEL: Doorbell
|
||||
RLABEL: Garage OPEN
|
||||
OKLABEL: Garage CLOSE
|
||||
```
|
||||
|
||||
## Notes
|
||||
* ##### App Usage
|
||||
- Press a button to send the assigned capture file.
|
||||
- Press Back button to set how many repeats the app should send. Capped at 5 repeats.
|
||||
- Hold Back button to exit app.
|
||||
- Only RAW SubGhz captures are supported currently.
|
||||
- No skip function.
|
||||
|
||||
* ##### Universal RF Map
|
||||
- File path should not have any spaces or special characters (- and _ excluded).
|
||||
- Labels are limited to 12 characters.
|
||||
- Why? This is to prevent overlapping elements on screen.
|
||||
- For example: If you set your label or file to ```WWWWWWWWWWWWWWW``` you'll be over the screen limits.
|
||||
Reference in New Issue
Block a user