History

Christian Schwinne c4f084a991 Merge JSON ircodes (#2048 ) * add decodeIRJson and JSON remote option * handle JSON API commands also * removed code that forced IR codes in a certain range to be decoded by decodeIR24. Generate default ir.json files for currently supported remotes. * comment out printing API commands in IR handling * refactor decodeIRJson to change how ir.json is loaded add support for calling several c functions * Handle setting palette when effect is still on default solid and will not display it * remove colorUpdated notifier that was pasted in accidentally * Update to handle both 24-key and 24-key old remotes (#1969) * Update readme.md * Update ir.cpp Handle both 24-key and 24-key old in decodeIR switch statement * Re-add JSON remote option Co-authored-by: Scott Bailey <scottrbailey@gmail.com> Co-authored-by: Artacus <40248830+scottrbailey@users.noreply.github.com>		2021-07-01 00:17:07 +02:00
..
6-key_ir.json	Merge JSON ircodes (#2048 )	2021-07-01 00:17:07 +02:00
9-key_ir.json	Merge JSON ircodes (#2048 )	2021-07-01 00:17:07 +02:00
21-key_ir.json	Merge JSON ircodes (#2048 )	2021-07-01 00:17:07 +02:00
24-key_ir.json	Merge JSON ircodes (#2048 )	2021-07-01 00:17:07 +02:00
32-key_ir.json	Merge JSON ircodes (#2048 )	2021-07-01 00:17:07 +02:00
40-key-black_ir.json	Merge JSON ircodes (#2048 )	2021-07-01 00:17:07 +02:00
40-key-blue_ir.json	Merge JSON ircodes (#2048 )	2021-07-01 00:17:07 +02:00
44-key_ir.json	Merge JSON ircodes (#2048 )	2021-07-01 00:17:07 +02:00
ir_json_maker.py	Merge JSON ircodes (#2048 )	2021-07-01 00:17:07 +02:00
IR_Remote_Codes.xlsx	Merge JSON ircodes (#2048 )	2021-07-01 00:17:07 +02:00
readme.md	Merge JSON ircodes (#2048 )	2021-07-01 00:17:07 +02:00

readme.md

JSON IR remote

Purpose

The JSON IR remote allows users to customize IR remote behavior without writing custom code and compiling. It also enables using any remote that is compatible with your IR receiver. Using the JSON IR remote, you can map buttons from any remote to any HTTP request API or JSON API command.

Usage

Upload the IR config file, named ir.json to your board using the [ip address]/edit url. Pick from one of the included files or create your own.
On the config > LED settings page, set the correct IR pin.
On the config > Sync Interfaces page, select "JSON Remote" as the Infrared remote.

Modification

See if there is a json file with the same number of buttons as your remote. Many remotes will have the same internals and emit the same codes but have different labels.
In the ir.json file, each key will be the hex encoded IR code.
The "cmd" property will be the HTTP Request API or JSON API to execute when that button is pressed.
A limited number of c functions are supported (!incBrightness, !decBrightness, !presetFallback)
When using !presetFallback, include properties PL (preset to load), FX (effect to fall back to) and FP (palette to fall back to)
If the command is repeatable and does not contain the "~" character, add a "rpt": true property.
Other properties are ignored, but having a label property may help when editing.

Sample: { "0xFF629D": {"cmd": "T=2", "rpt": true, "label": "Toggle on/off"}, // HTTP command "0xFF9867": {"cmd": "A=~16", "label": "Inc brightness"}, // HTTP command with incrementing
"0xFF38C7": {"cmd": {"bri": 10}, "label": "Dim to 10"}, // JSON command "0xFF22DD": {"cmd": "!presetFallback", "PL": 1, "FX": 16, "FP": 6,
"label": "Preset 1 or fallback to Saw - Party"}, // c function }