Importing IR codes

You can import infrared (IR) codes into an Infrared-Remote entity either by pasting them one-by-one as custom commands, or by uploading them in a comma-separated values (CSV) file.

Use single imports when you want to customize or add a few additional commands to an existing IR codeset. Use bulk import for devices that cannot be learned with the Unfolded Circle Dock but for which raw PRONTO codes are available from the manufacturer or the Internet.

CSV Preparation

A CSV template file can be downloaded from: Bulk IR code upload template

Format rules

• Default separator character is a comma ,
• An optional comment character (for example #) can be used at the beginning of a line to mark that line as a comment, which will be ignored during import.
  • There is no default comment character; it must be specified during import (see below).
• Empty lines are ignored.
• A header row is required

Expected columns

• key: Name of the command. Should be upper case and limited to 7-bit ASCII characters without spaces.
• format: IR code format. Defaults to PRONTO if not provided.
  • PRONTO for PRONTO raw format (codes starting with 0000).
  • HEX for codes learned with the Unfolded Circle Dock.
• code: the IR code .

Additional rules:

• Column names are case-sensitive.
• The order of the columns does not matter.
• Additional columns are ignored.
• The header row must be the first non-empty, non-comment line.

Example CSV file

"key","format","code"
"Volume_UP","HEX","17;0x2A4C0280E86A;48;0"
"Volume_DOWN","HEX","17;0x2A4C0288E862;48;0"
"POWER_ON","PRONTO","0000 006d 0000 0020 000a 001e 000a 0046 000a 001e ..."

Toggle IR codes

Toggling IR protocols like RC5 and RC6 are automatically handled with HEX format codes. The IR protocol is encoded in the IR code itself and the Remote applies the Iprotocol-specific toggling logic.

Raw PRONTO codes do not include toggle information; they represent only a single IR code. To support toggling with PRONTO, you must provide two IR codes in the code column, separated by a pipe character |. For example:

"TOGGLE_TEST","PRONTO","0000 006D 0000 0020 ... | 0000 006D 0000 0020 ..."

CSV Import

1. In the web-configurator, switch to the Infrared entities view and choose Add new infrared to create a new infrared device:
   
2. Name the device and select Create blank. This creates a blank infrared-remote entity without an associated manufacturer IR dataset.
   
3. Enter a device name for your custom infrared dataset:
   
4. Click on the import infrared codes button next to the Infrared code data set:
   
5. Click Browse and select your prepared CSV file.
   
6. Verify the delimiter and comment settings, especially if you changed the template or use a custom CSV file. The overwrite codes option controls whether existing IR codes are overwritten or only new codes are appended to the existing IR codeset.
7. Click on Upload.
8. A summary about the import process is shown.
   
9. The imported codes are then visible in the Infrared-Remote entity: