diff --git a/ReadMe.md b/ReadMe.md index e12c72070..8a6b5c007 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -31,6 +31,11 @@ Our Discord Community:

+### **Update to the latest official firmware before proceeding** + +
+
+ ## With offline update on flipper ### **Replace (CURRENT VERSION) with version that you downloaded from releases** @@ -80,7 +85,16 @@ then select **`flipper-z-f7-full-(CURRENT VERSION).dfu`** ### **Replace (CURRENT VERSION) with version that you downloaded from releases** 3. Run `dfu-util -D flipper-z-f7-full-(CURRENT VERSION).dfu -a 0` -4. If you doing install for first time or migrating from official fw, unpack 3 folders from archive `sd-card-(CURRENT VERSION).zip` onto your microSD card +4. If you doing install for first time or migrating from official fw, unpack 3 folders from archive `sd-card-(CURRENT VERSION).zip` to your microSD card + +
+
+ +# After install: +- ### If you installed using .dfu - unpack 3 folders from archive `sd-card-(CURRENT VERSION).zip` to your microSD card +
+ +- ## [How To: Configure UniversalRF Remix App](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/UniRFRemix.md)

@@ -129,6 +143,13 @@ Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device. If compilation fails, make sure all submodules are all initialized. Either clone with `--recursive` or use `git submodule update --init --recursive`. +# Apps included + +- [Clock/Stopwatch (By CompaqDisc, Stopwatch & Sound Alert By RogueMaster)](https://github.com/RogueMaster/flipperzero-firmware-wPlugins/blob/unleashed/applications/clock_app/clock_app.c) +- [UniversalRF Remix (By ESurge)(Original UniversalRF By jimilinuxguy)](https://github.com/ESurge/flipperzero-firmware-unirfremix) +- [WAV Player (By DrZlo13)](https://github.com/flipperdevices/flipperzero-firmware/tree/zlo/wav-player) With Fix From [Atmanos](https://github.com/at-manos) +- [Tetris (By jeffplang)](https://github.com/jeffplang/flipperzero-firmware/tree/tetris_game/applications/tetris_game) + # Links * Unofficial Discord: [discord.gg/58D6E8BtTU](https://discord.gg/58D6E8BtTU) diff --git a/documentation/UniRFRemix.md b/documentation/UniRFRemix.md index ee6843d82..6cdd732ed 100644 --- a/documentation/UniRFRemix.md +++ b/documentation/UniRFRemix.md @@ -37,4 +37,35 @@ The UP/DOWN/LEFT/RIGHT/OK file locations must be set to the specific file you wa The ULABEL/DLABEL/LLABEL/RLABEL/OKLABEL variables should be set to the text to be displayed for each of the files set earlier. +## Example: +``` +Filetype: Flipper SubGhz RAW File +Version: 1 +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 + - Backwards compatible with [jimilinuxguy Universal RF Remote](https://github.com/jimilinuxguy/flipperzero-universal-rf-remote) map file. You should be able to use the map file as is with both versions. + - Recommend that you update the map file (if you using "jimilinuxguy's Universal RF" file) to the version included in this repo. + - 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.