Infrared Flipper File Formats
Infrared Remote File Format
Example
Description
Filename extension: .ir
This file format is used to store an infrared remote that consists of an arbitrary number of buttons. Each button is separated from others by a comment character (#
) for better readability.
Known protocols are represented in the parsed
form, whereas non-recognized signals may be saved and re-transmitted as raw
data.
Version history:
Initial version.
Format fields
Name | Use | Type | Description |
---|---|---|---|
name | both | string | Name of the button. Only printable ASCII characters are allowed. |
type | both | string | Type of the signal. Must be |
protocol | parsed | string | Name of the infrared protocol. Refer to |
address | parsed | hex | Payload address. Must be 4 bytes long. |
command | parsed | hex | Payload command. Must be 4 bytes long. |
frequency | raw | uint32 | Carrier frequency, in Hertz, usually 38000 Hz. |
duty_cycle | raw | float | Carrier duty cycle, usually 0.33. |
data | raw | uint32 | Raw signal timings, in microseconds between logic level changes. Individual elements must be space-separated. Maximum timings amount is 1024. |
Infrared Library File Format
Examples
TV Universal Library
A/C Universal Library
Audio Universal Library
Description
Filename extension: .ir
This file format is used to store universal remote libraries. It is identical to the previous format, differing only in the Filetype
field.
It also has predefined button names for each universal library type, so that the universal remote application can understand them. See Universal Remotes for more information.
Version history:
Initial version.
Infrared Test File Format
Examples
See Infrared Unit Tests for various examples.
Description
Filename extension: .irtest
This file format is used to store technical test data that is too large to keep directly in the firmware. It is mostly similar to the two previous formats, with the main difference being the addition of the parsed signal arrays.
Each infrared protocol must have corresponding unit tests complete with an .irtest
file.
Known protocols are represented in the parsed_array
form, whereas raw data has the raw
type.
Note: a single parsed signal must be represented as an array of size 1.
Version history:
Initial version.
Format fields
Name | Use | Type | Description |
---|---|---|---|
name | both | string | Name of the signal. Only printable ASCII characters are allowed. |
type | both | string | Type of the signal. Must be |
count | parsed_array | uint32 | The number of parsed signals in an array. Must be at least 1. |
protocol | parsed_array | string | Same as in previous formats. |
address | parsed_array | hex | Ditto. |
command | parsed_array | hex | Ditto. |
repeat | parsed_array | bool | Indicates whether the signal is a repeated button press. |
frequency | raw | uint32 | Same as in previous formats. |
duty_cycle | raw | float | Ditto. |
data | raw | uint32 | Ditto. |
Signal names
The signal names in an .irtest
file follow a convention <name><test_number>
, where the name is one of:
decoder_input
decoder_expected
encoder_decoder_input,
and the number is a sequential integer: 1, 2, 3, etc., which produces names like decoder_input1
, encoder_decoder_input3
, and so on.
Name | Type | Description |
---|---|---|
decoder_input | raw | A raw signal containing the decoder input. Also used as the expected encoder output. |
decoder_expected | parsed_array | An array of parsed signals containing the expected decoder output. Also used as the encoder input. |
encoder_decoder_input | parsed_array | An array of parsed signals containing both the encoder-decoder input and expected output. |
See Unit Tests for more info.
Last updated