Flipper/Infrared/ir_remote/Readme.md

# IR Remote (Alternate Remote Application from [Hong5489](https://github.com/Hong5489/ir_remote))

This is an application (FAP) similar to the [UniversalRF Remix](https://github.com/ESurge/flipperzero-firmware-unirfremix) but for infrared (IR) files. The author states "I do this plugin for convenience, because the main IR app need to navigate for different button abit troublesome (buttons like up,down,left,right,back). I found it useful for TV and TV box." We agree!

IR Remote supports both short press and long press (hold) input for different IR buttons. Compiled FAP has been tested on [Unleashed](https://github.com/DarkFlippers/unleashed-firmware) and [RogueMaster](https://github.com/RogueMaster/flipperzero-firmware-wPlugins) firmwares.

## How to use

The path of the actual IR file should be listed after `REMOTE:` at the top.<br>
The rest of the buttons should be defined by the button `name:` listed in the original IR file.

The first section are short press, the last with `HOLD` is long press (hold).

Example of the configuration file:
```
REMOTE: /ext/infrared/IRDB/TVs/Roku/Roku.ir
UP: Up
DOWN: Down
LEFT: Left
RIGHT: Right
OK: Ok
BACK: Back
UPHOLD: V_up
DOWNHOLD: V_down
LEFTHOLD: Play
RIGHTHOLD: Home
OKHOLD: Power
```

Leave a line empty if it will not be used for a button.

1. Make sure the file is saved as a `txt` file with Unix (LF) line ending.
2. Make a new folder in the root of your SD card named `ir_remote`.
3. Place your TXT map file from above into the `ir_remote` folder.
4. Open the app, choose the configuration file, then enjoy!
5. Hold the back button to exit the app. (This cannot be programmed in the map file.)

![IR_Remote](https://user-images.githubusercontent.com/57457139/207985275-e5e5e1cb-28f6-48cc-bec1-5f8db5d95584.gif)

NOTE: If using RogueMaster, place the `ir_remote` folder into the `infrared` folder on the SD.
Adding further description 2022-12-15 23:05:07 +00:00			`# IR Remote (Alternate Remote Application from [Hong5489](https://github.com/Hong5489/ir_remote))`
Create Readme.md 2022-12-11 17:52:43 +00:00
Adding further description 2022-12-15 23:05:07 +00:00			`This is an application (FAP) similar to the [UniversalRF Remix](https://github.com/ESurge/flipperzero-firmware-unirfremix) but for infrared (IR) files. The author states "I do this plugin for convenience, because the main IR app need to navigate for different button abit troublesome (buttons like up,down,left,right,back). I found it useful for TV and TV box." We agree!`
Create Readme.md 2022-12-11 17:52:43 +00:00
Adding further description 2022-12-15 23:05:07 +00:00			`IR Remote supports both short press and long press (hold) input for different IR buttons. Compiled FAP has been tested on [Unleashed](https://github.com/DarkFlippers/unleashed-firmware) and [RogueMaster](https://github.com/RogueMaster/flipperzero-firmware-wPlugins) firmwares.`
Create Readme.md 2022-12-11 17:52:43 +00:00
			`## How to use`

Adding further description 2022-12-15 23:05:07 +00:00			The path of the actual IR file should be listed after `REMOTE:` at the top.<br>
			The rest of the buttons should be defined by the button `name:` listed in the original IR file.
Create Readme.md 2022-12-11 17:52:43 +00:00
Adding further description 2022-12-15 23:05:07 +00:00			The first section are short press, the last with `HOLD` is long press (hold).
Create Readme.md 2022-12-11 17:52:43 +00:00
			`Example of the configuration file:`
			```
Adding further description 2022-12-15 23:05:07 +00:00			`REMOTE: /ext/infrared/IRDB/TVs/Roku/Roku.ir`
Create Readme.md 2022-12-11 17:52:43 +00:00			`UP: Up`
			`DOWN: Down`
			`LEFT: Left`
			`RIGHT: Right`
Adding further description 2022-12-15 23:05:07 +00:00			`OK: Ok`
Create Readme.md 2022-12-11 17:52:43 +00:00			`BACK: Back`
Adding further description 2022-12-15 23:05:07 +00:00			`UPHOLD: V_up`
			`DOWNHOLD: V_down`
			`LEFTHOLD: Play`
			`RIGHTHOLD: Home`
			`OKHOLD: Power`
Create Readme.md 2022-12-11 17:52:43 +00:00			```

Adding further description 2022-12-15 23:05:07 +00:00			`Leave a line empty if it will not be used for a button.`
Create Readme.md 2022-12-11 17:52:43 +00:00
Adding further description 2022-12-15 23:05:07 +00:00			1. Make sure the file is saved as a `txt` file with Unix (LF) line ending.
			2. Make a new folder in the root of your SD card named `ir_remote`.
			3. Place your TXT map file from above into the `ir_remote` folder.
			`4. Open the app, choose the configuration file, then enjoy!`
			`5. Hold the back button to exit the app. (This cannot be programmed in the map file.)`
Create Readme.md 2022-12-11 17:52:43 +00:00
Adding further description 2022-12-15 23:05:07 +00:00			`![IR_Remote](https://user-images.githubusercontent.com/57457139/207985275-e5e5e1cb-28f6-48cc-bec1-5f8db5d95584.gif)`
Create Readme.md 2022-12-11 17:52:43 +00:00
Adding further description 2022-12-15 23:05:07 +00:00			NOTE: If using RogueMaster, place the `ir_remote` folder into the `infrared` folder on the SD.