Remote Transmitter
The remote_transmitter component lets you send various common remote control signals, such as infrared
or 433 MHz radio frequency (RF) signals.
The component is split into two parts:
- The remote transmitter “hub”, which defines the pin and a few additional settings, and…
- Individual actions to send encoded remote signals.
See Setting up IR Devices and Setting up RF Devices for details.
NOTE
This component performs best with an ESP32 or variant; most have a dedicated RMT hardware peripheral which ensures accurate signal timing. The ESP32-C2 and ESP32-C61 lack RMT hardware and use a software (GPIO bitbang) implementation instead.
# Example configuration entryremote_transmitter: pin: GPIOXX carrier_duty_percent: 50%Configuration variables
Section titled “Configuration variables”-
pin (Required, Pin): The pin to transmit the remote signal on.
-
carrier_duty_percent (Required, int): How much of the time the remote is on. For example, infrared protocols modulate the signal using a carrier signal. Set this to
50%if you’re using IR LEDs and100%for RF applications like 433 MHz transmitters. -
id (Optional, ID): Manually specify the ID used for code generation. Useful when multiple transmitters are connected to a single device.
-
non_blocking (Optional, boolean): If enabled, transmissions return immediately and complete in the background; the
on_completeautomation triggers once the transmission finishes. Only available on ESP32 variants with RMT hardware, where it defaults totrue, and on RTL8720C and BK7238, where it defaults tofalse.
ESP32 RMT configuration variables
Section titled “ESP32 RMT configuration variables”NOTE
The following options apply only to ESP32 variants with RMT hardware. They are not available on the ESP32-C2 and ESP32-C61, which use a software implementation.
- rmt_symbols (Optional, int): When
use_dmais enabled, this sets the size of the driver’s internal DMA buffer. When DMA is disabled, it specifies how much RMT memory is allocated to the component. RMT memory is shared across all components and should be allocated in multiples of the block size. On theESP32andESP32-S2variants, RMT memory is shared between RX and TX components. On other variants, RX and TX have their own RMT memory, but a TX component can also use RX memory that no RX component uses.
| ESP32 Variant | Available Memory | Block Size |
|---|---|---|
| ESP32 | 512 symbols | 64 symbols |
| ESP32-C3 | 96 symbols | 48 symbols |
| ESP32-C5 | 96 symbols | 48 symbols |
| ESP32-C6 | 96 symbols | 48 symbols |
| ESP32-H2 | 96 symbols | 48 symbols |
| ESP32-H21 | 96 symbols | 48 symbols |
| ESP32-H4 | 96 symbols | 48 symbols |
| ESP32-P4 | 192 symbols | 48 symbols |
| ESP32-S2 | 256 symbols | 64 symbols |
| ESP32-S3 | 192 symbols | 48 symbols |
| ESP32-S31 | 192 symbols | 48 symbols |
Each component uses its own RMT channel: remote_receiver uses an RX channel, remote_transmitter and
esp32_rmt_led_strip use a TX channel. A channel uses at least one block of memory, so the number of channels is the
available memory divided by the block size, for example 8 on the ESP32 and 2 on the ESP32-C3. On the ESP32 and
ESP32-S2, RX and TX components share these channels. On other variants, RX and TX each have this many channels.
ESPHome checks all esp32_rmt_led_strip, remote_transmitter and remote_receiver components together. Validation
fails if:
- they need more channels than are available
- more than one RX or more than one TX component sets
use_dma, since only one channel per direction supports DMA rmt_symbolsis an odd number or smaller than one block- without
use_dma,rmt_symbolsis larger than one channel can use. On theESP32andESP32-S2that is all the RMT memory; on other variants it is the RX memory for an RX component, or the TX and RX memory together for a TX component - a transmitter or LED strip with
use_dmasetsrmt_symbolsabove 2046
A component with use_dma uses one block. When it compiles, ESPHome also works out which memory each channel gets when
the components are set up: by setup_priority, then in the order of the configuration. A component that refers to
another component by ID, such as a power_supply, can be set up after the ones that follow it. If a channel does not
fit, ESPHome logs a warning that suggests an rmt_symbols value that fits, or a setup_priority that sets up the
smaller ones first. esphome config does not show this warning. The order matters because a TX channel can extend into
memory that the next one would need: on an ESP32-S3, a 48 symbol strip followed by a 288 symbol strip fits, but not
the other way round.
-
clock_resolution (Optional, int): The clock resolution used by the RMT peripheral in Hz. Defaults to
1000000. -
use_dma (Optional, boolean): Enable DMA on variants that support it. If enabled
rmt_symbolscontrols the DMA buffer size and can be set to a large value, up to 2046. -
eot_level (Optional, boolean): Overrides the default end of transmit level. Defaults to
falseunlesspinis set to inverted or open-drain.
Automations
Section titled “Automations”-
on_transmit (Optional, Automation): An automation to perform before data is sent. Useful if the radio / IR hardware needs to change state or power on.
-
on_complete (Optional, Automation): An automation to perform after data has been sent. Useful if the radio / IR hardware needs to change state or power off.
# Example automationremote_transmitter: ... on_transmit: then: - switch.turn_on: tx_enable on_complete: then: - switch.turn_off: tx_enableRemote Transmitter Actions
Section titled “Remote Transmitter Actions”Remote transmitters support a number of actions that can be used to send remote codes. All supported protocols are listed below. All actions have these additional configuration variables:
on_...: - remote_transmitter.transmit_x: # ... repeat: times: 5 wait_time: 10msConfiguration variables
Section titled “Configuration variables”-
repeat (Optional): Defines the number of times the code is repeated when transmitted. By default, codes are sent only once.
- times (int, templatable): The number of times to repeat the code.
- wait_time (Time, templatable): The time to wait between repeats (in µs as a result of a lambda).
-
transmitter_id (Optional, ID): The remote transmitter to send the remote code with. Defaults to the first one defined in the configuration.
If you’re looking for the same functionality as is default in the rpi_rf integration in Home Assistant, you’ll want
to set the times to 10 and the wait_time to 0s.
remote_transmitter.transmit_abbwelcome Action
Section titled “remote_transmitter.transmit_abbwelcome Action”This action sends a ABB-Welcome message to the intercom bus. The message type, addresses, address length and data can vary a lot between ABB-Welcome systems. Please refer to the received messages while performing actions like ringing a doorbell or opening a door.
on_...: - remote_transmitter.transmit_abbwelcome: source_address: 0x1001 # your indoor station address destination_address: 0x4001 # door address three_byte_address: false # address length of your system message_type: 0x0d # unlock door, on some systems 0x0e is used instead data: [0xab, 0xcd, 0xef] # message data, see receiver dumpConfiguration variables
Section titled “Configuration variables”-
source_address (Required, int, templatable): The source address to send the command from, see received messages for more info. For indoor stations the last byte of the address represents the apartment number set by the dials on the back of the indoor station and is transmitted in hexadecimal format.
-
destination_address (Required, int, templatable): The destination address to send the command to, see received messages for more info.
-
three_byte_address (Optional, boolean, templatable): The length of the source and destination address.
falsemeans two bytes andtruemeans three bytes. Please check the received messages to see which address length is used by your system. For example,[XXXX > XXXX]appears in the receiver log for two byte addresses and[XXXXXX > XXXXXX]for three byte addresses. Defaults tofalse. -
retransmission (Optional, boolean, templatable): Should only be
trueif this message has been transmitted before with the samemessage_id. Typically, messages are transmitted up to three times with a 1 second interval if no reply is received. Defaults tofalse. -
message_type (Required, int, templatable): The message type, see dumper output for more info. The highest bit indicates a reply.
-
message_id (Optional, int, templatable): The message ID, see dumper output for more info. Defaults to a randomly generated ID if this message is not a reply or retransmission.
-
data (Optional, 0-7 bytes list, templatable): The code to send. Usually you only need to copy this directly from the dumper output. Defaults to
[] -
All other options from Remote Transmitter Actions.
NOTE
ABB-Welcome messages are sent over the two-wire bus of your intercom system. A custom receiver and transmitter circuit is required. More info
remote_transmitter.transmit_aeha Action
Section titled “remote_transmitter.transmit_aeha Action”This action sends a AEHA code to a remote transmitter.
on_...: - remote_transmitter.transmit_aeha: address: 0x1FEF data: [0x1F, 0x3E, 0x06, 0x5F]Configuration variables
Section titled “Configuration variables”-
address (Required, int, templatable): The address to send the command to, see dumper output for more details.
-
data (Required, list, templatable): The command to send; a length of 2-35 bytes can be specified for one packet.
-
carrier_frequency (Optional, float, templatable): Set a frequency to send the signal with for infrared signals. Defaults to
38000Hz. -
All other options from Remote Transmitter Actions.
AEHA refers to the Association for Electric Home Appliances in Japan, a format used by Panasonic and many other companies.
remote_transmitter.transmit_aok Action
Section titled “remote_transmitter.transmit_aok Action”This action sends an A-OK RF remote code to a remote transmitter. A-OK is used by remote controls for roller shutters, awnings and similar motors on 433MHz and 868MHz.
on_...: - remote_transmitter.transmit_aok: remote_id: 0x123456 channels: 0x1000 command: 0x43Configuration Variables
Section titled “Configuration Variables”- remote_id (Required, int, templatable): The 24-bit ID of the remote to send as. Range is 0 to 0xFFFFFF.
- channels (Required, int, templatable): The 16-bit channel mask to send the command to. Each of the 16 channels on the remote corresponds to one bit of the mask. Multiple bits can be set at once to broadcast the command to multiple receivers.
- command (Required, int, templatable): The 1-byte command code to send. Range is 0 to 0xFF.
- All other options from Remote Transmitter Actions.
Set dump: aok on a remote receiver to read these values from an existing remote.
NOTE
Remotes send each code several times. If the device does not react to a single transmission, set repeat,
for example times: 8 with wait_time: 5ms.
remote_transmitter.transmit_beo4 Action
Section titled “remote_transmitter.transmit_beo4 Action”This action sends a B&O Beo4 infrared protocol code to a remote transmitter.
on_...: - remote_transmitter.transmit_beo4: source: '0x01' command: '0x0d'Configuration variables
Section titled “Configuration variables”- source (Required, int, templatable): The 8-bit source to send, e.g. 0x00=video,0x01=audio,…, see dumper output for more info.
- command (Required, int, templatable): The command to send, e.g. 0x01=num1, 0x0d=mute,…, see dumper output for more info.
- All other options from Remote Transmitter Actions.
remote_transmitter.transmit_brennenstuhl Action
Section titled “remote_transmitter.transmit_brennenstuhl Action”This action sends a brennenstuhl protocol code to a remote transmitter.
on_...: - remote_transmitter.transmit_brennenstuhl: code: 0xBD2E2CConfiguration variables
Section titled “Configuration variables”- code (Required, int, templatable): The 24-bit code to send.
- All other options from Remote Transmitter Actions.
NOTE
The brennenstuhl devices use rolling codes, i.e. each button of the remote generates 4 different codes in a pseudo random manner. See Rolling Codes for details and a complete YAML example.
remote_transmitter.transmit_byronsx Action
Section titled “remote_transmitter.transmit_byronsx Action”This action sends a Byron Doorbell RF protocol code to a remote transmitter.
on_...: - remote_transmitter.transmit_byronsx: address: '0x4f' command: '0x2'Configuration variables
Section titled “Configuration variables”- address (Required, int, templatable): The 8-bit ID to send, see dumper output for more info.
- command (Optional, int, templatable): The command to send, see dumper output for more info. Defaults to
0x10. - All other options from Remote Transmitter Actions.
remote_transmitter.transmit_canalsat Action
Section titled “remote_transmitter.transmit_canalsat Action”This action sends a CanalSat infrared remote code to a remote transmitter.
NOTE
The CanalSat and CanalSatLD protocols use a higher carrier frequency (56kHz) and are very similar. Depending on the hardware used they may interfere with each other when enabled simultaneously.
on_...: - remote_transmitter.transmit_canalsat: device: 0x25 address: 0x00 command: 0x02Configuration variables
Section titled “Configuration variables”-
device (Required, int, templatable): The device to send to, see dumper output for more details.
-
address (Optional, int, templatable): The address (or sub-device) to send to, see dumper output for more details. Defaults to
0. -
command (Required, int, templatable): The command to send.
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_canalsatld Action
Section titled “remote_transmitter.transmit_canalsatld Action”This action sends a CanalSatLD infrared remote code to a remote transmitter.
NOTE
The CanalSat and CanalSatLD protocols use a higher carrier frequency (56kHz) and are very similar. Depending on the hardware used they may interfere with each other when enabled simultaneously.
on_...: - remote_transmitter.transmit_canalsatld: device: 0x25 address: 0x00 command: 0x02Configuration variables
Section titled “Configuration variables”-
device (Required, int, templatable): The device to send to, see dumper output for more details.
-
address (Optional, int, templatable): The address (or sub-device) to send to, see dumper output for more details. Defaults to
0. -
command (Required, int, templatable): The command to send.
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_coolix Action
Section titled “remote_transmitter.transmit_coolix Action”This action sends one or two 24-bit Coolix infrared remote codes to a remote transmitter.
on_...: - remote_transmitter.transmit_coolix: first: 0xB23FE4 second: 0xB23FE4Configuration variables
Section titled “Configuration variables”-
first (Required, uint32_t, templatable): The first 24-bit Coolix code to send; see dumper output for more info.
-
second (Optional, uint32_t, templatable): The second 24-bit Coolix code to send; see dumper output for more info.
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_dish Action
Section titled “remote_transmitter.transmit_dish Action”This action sends a Dish Network infrared remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_dish: address: 1 command: 16Configuration variables
Section titled “Configuration variables”- address (Optional, int, templatable): The number of the receiver to target, between 1 and 16 inclusive. Defaults to
1. - command (Required, int, templatable): The command to send, between 0 and 63 inclusive.
- All other options from Remote Transmitter Actions.
You can find a list of commands in the LIRC project.
remote_transmitter.transmit_dooya Action
Section titled “remote_transmitter.transmit_dooya Action”This action sends a Dooya RF remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_dooya: id: 0x001612E5 channel: 142 button: 12 check: 3Configuration variables
Section titled “Configuration variables”-
id (Required, int, templatable): The 24-bit ID to send. Each remote has a unique one.
-
channel (Required, int, templatable): The 8-bit channel to send, between 0 and 255 inclusive.
-
button (Required, int, templatable): The 4-bit button to send, between 0 and 15 inclusive.
-
check (Required, int, templatable): The 4-bit check to send. Includes an indication that a button is being held down. See dumper output for more info.
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_drayton Action
Section titled “remote_transmitter.transmit_drayton Action”This action sends a Drayton Digistat RF remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_drayton: address: '0x6180' data: '0x8'Configuration variables
Section titled “Configuration variables”Set address and either data or both channel and command.
- address (Required, int, templatable): The 16-bit address to send, see dumper output for more info. It is the 12-bit thermostat ID followed by a 4-bit pairing field. The pairing field is normally 0; setting bit 0 lets a receiver in pairing mode learn the ID.
- data (Optional, int, templatable): The 4-bit data value to send. Range is
0to0xF. Bit0x8means the thermostat calls for heat and bit0x2means low battery, so0x8is On with the battery OK and0x0is Off. The other two bits have not been seen set. The checksum is calculated and added for you. Cannot be used withchannelandcommand. - channel (Optional, int, templatable): The legacy 5-bit channel, the low 5 checksum
bits. Range is
0to0x1F. Must be used together withcommand; kept for configurations written for the first Drayton release. - command (Optional, int, templatable): The legacy 7-bit command, the 4 data bits
followed by the top 3 checksum bits. Range is
0to0x7F. Must be used together withchannel. The packet is sent fromchannelandcommandas they are, with no checksum calculated. - All other options from Remote Transmitter Actions.
remote_transmitter.transmit_dyson Action
Section titled “remote_transmitter.transmit_dyson Action”This action sends a Dyson cool AM07 infrared protocol code to a remote transmitter.
on_...: - remote_transmitter.transmit_dyson: code: '0x1200' index: !lambda |- uint8_t idx = id(idx); id(idx) = (id(idx) + 1) & 3; return idx;Configuration variables
Section titled “Configuration variables”- code (Required, int, templatable): The 16-bit code to trigger on, e.g. 0x1200=power, 0x1215=fan++, 0x122a=swing…, see dumper output for more info.
- index (Optional, int, templatable): The 8-bit rolling index. Defaults to
0xFF. - All other options from Remote Transmitter Actions.
NOTE
The dyson devices use rolling codes, i.e. each remote button generates 4 different codes in a pseudo random manner. On every transmit the index variable must loop to let the ..transmit_dyson function generate a code that differs from the previous one.
remote_transmitter.transmit_gobox Action
Section titled “remote_transmitter.transmit_gobox Action”This action sends a command to a Go-Box via the IR transmitter.
on_...: - remote_transmitter.transmit_gobox: code: 0xfa05Configuration variables
Section titled “Configuration variables”- code (Required, int, templatable): The command to send. Known commands are:
-
MENU = 0xaa55,
-
RETURN = 0x22dd,
-
UP = 0x0af5,
-
LEFT = 0x8a75,
-
RIGHT = 0x48b7,
-
DOWN = 0xa25d,
-
OK = 0xc837,
-
TOGGLE = 0xb847,
-
PROFILE = 0xfa05
-
FASTER = 0xf00f,
-
SLOWER = 0xd02f,
-
LOUDER = 0xb04f,
-
SOFTER = 0xf807,
-
All other options from Remote Transmitter Actions.
-
remote_transmitter.transmit_hob2hood Action
Section titled “remote_transmitter.transmit_hob2hood Action”This action sends a Hob2Hood infrared remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_hob2hood: command: light_onConfiguration variables
Section titled “Configuration variables”- command (Required, enum, templatable): The Hob2Hood command to send,
see dumper output for more info.
light_offlight_onfan_offfan_lowfan_mediumfan_highfan_max
- All other options from Remote Transmitter Actions.
remote_transmitter.transmit_jvc Action
Section titled “remote_transmitter.transmit_jvc Action”This action sends a JVC infrared remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_jvc: data: 0x1234Configuration variables
Section titled “Configuration variables”- data (Required, int, templatable): The JVC code to send, see dumper output for more info.
- All other options from Remote Transmitter Actions.
remote_transmitter.transmit_keeloq Action
Section titled “remote_transmitter.transmit_keeloq Action”This action sends KeeLoq RF remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_keeloq: address: '0x57ffe7b' command: '0x02' code: '0xd19ef0a9' repeat: times: 3 wait_time: 15ms # Six suffix bits after the 66-bit word - remote_transmitter.transmit_keeloq: address: '0x116ea01' command: '0x08' code: '0xd19ef0a9' suffix: '0x2A' suffix_bits: 6 # Jarolift TDEF group frame (72 bits) - remote_transmitter.transmit_keeloq: address: '0x1234500' command: '0x8' code: '0xF94A09F2' group: '0x0F' repeat: times: 2 wait_time: 0msConfiguration variables
Section titled “Configuration variables”- address (Required, int, templatable): The 28-bit address to send, see dumper output for more info.
- command (Optional, int, templatable): The 4-bit command/button code to send, see dumper output for more info. Defaults to
0x10. - code (Required, int, templatable): The 32-bit encrypted field to send.
- level (Optional, boolean, templatable): Low battery level status bit. Defaults to false.
- suffix (Optional, int, templatable): Extra bits sent after the 66-bit HCS301
word, lowest bit first, in the same PWM coding. A fixed value that does not fit in suffix_bits fails
validation; a lambda value is cut to the lowest suffix_bits bits at run time. Defaults to
0. - suffix_bits (Optional, int, templatable): How many suffix bits to send, from
0to16; a lambda value above16is capped at16. Defaults to0, which sends only the 66-bit word. - group (Optional, int, templatable): The 8 group bits (channels 9 to 16) of a
72-bit Jarolift TDEF frame, sent after the 64-bit word in place of the low battery and repeat bits. Channels 1
to 8 are part of the encrypted code. Combining it with suffix or suffix_bits is rejected, and
level must stay
false(no lambda). - All other options from Remote Transmitter Actions.
- A repeat wait_time of 15ms, as in the first example, replicates the repetition of an HCS301. The Jarolift example repeats its frame with no extra wait: the guard time that ends every KeeLoq frame already separates the two copies.
remote_transmitter.transmit_haier Action
Section titled “remote_transmitter.transmit_haier Action”This action sends a Haier code to a remote transmitter. The 8-bit checksum is added automatically.
on_...: - remote_transmitter.transmit_haier: code: [0xA6, 0xDA, 0x00, 0x00, 0x40, 0x40, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x05]Configuration variables
Section titled “Configuration variables”- code (Required, list, templatable): The 8 or 13 byte Haier code to send.
- All other options from Remote Transmitter Actions.
remote_transmitter.transmit_ira211 Action
Section titled “remote_transmitter.transmit_ira211 Action”This action sends a Siemens IRA211 infrared remote code to a remote transmitter.
SYNC and POWER frames carry the full state (temperature, mode and fan); TEMP_UP, TEMP_DOWN, MODE and FAN
carry only the field they change, so the other values are ignored for those commands.
on_...: - remote_transmitter.transmit_ira211: command: SYNC temperature: 22.5 mode: TIMER fan_mode: HIGHConfiguration variables
Section titled “Configuration variables”- command (Required, string, templatable): The command to send. One of
TEMP_UP,TEMP_DOWN,MODE,FAN,POWERorSYNC. - temperature (Optional, float, templatable): The target temperature in °C, from
5to35in0.5steps. Defaults to20. - mode (Optional, string, templatable): The operating mode. One of
PROTECTION,TIMERorCOMFORT. Defaults toCOMFORT. - fan_mode (Optional, string, templatable): The fan speed. One of
AUTO,LOW,MEDIUMorHIGH. Defaults toAUTO. - All other options from Remote Transmitter Actions.
remote_transmitter.transmit_lg Action
Section titled “remote_transmitter.transmit_lg Action”This action sends an LG infrared remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_lg: data: 0x20DF10EF # power on/off nbits: 32Configuration variables
Section titled “Configuration variables”- data (Required, int, templatable): The LG code to send, see dumper output for more info.
- nbits (Optional, int, templatable): The number of bits to send. Defaults to
28. - All other options from Remote Transmitter Actions.
remote_transmitter.transmit_magiquest Action
Section titled “remote_transmitter.transmit_magiquest Action”This action sends a MagiQuest wand code to a remote transmitter.
on_...: - remote_transmitter.transmit_magiquest: wand_id: 0x01234567 magnitude: 0x080CConfiguration variables
Section titled “Configuration variables”-
wand_id (Required, int, templatable): The wand ID to send, as a hex integer in the old frame layout (see the note below): the id a dumper before 2026.11 printed, which is the id a current dumper prints without its five lowest bits.
-
magnitude (Optional, int, templatable): The magnitude value to send, in the old frame layout (see the note below). If omitted, sends 0xFFFF (which the real wand never uses).
-
All other options from Remote Transmitter Actions.
NOTE
This action still sends the frame layout ESPHome has always used, which is not the layout a real wand sends. The receiver decodes real wand frames since 2026.11, so a frame sent by this action is not decoded by another ESPHome device running 2026.11 or later; receivers on earlier versions still accept it.
remote_transmitter.transmit_midea Action
Section titled “remote_transmitter.transmit_midea Action”This action sends a 40-bit Midea code to a remote transmitter. 8-bits of checksum added automatically.
on_...: - remote_transmitter.transmit_midea: code: [0xA2, 0x08, 0xFF, 0xFF, 0xFF]
on_...: - remote_transmitter.transmit_midea: code: !lambda |- // Send a FollowMe code with the current temperature. return {0xA4, 0x82, 0x48, 0x7F, (uint8_t)(id(temp_sensor).state + 1)};Configuration variables
Section titled “Configuration variables”-
code (Required, list, templatable): The 40-bit Midea code to send as a list of hex or integers.
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_nec Action
Section titled “remote_transmitter.transmit_nec Action”This action sends an NEC infrared remote code to a remote transmitter.
NOTE
In version 2021.12, the order of transferring bits was corrected from MSB to LSB in accordance with the NEC
standard. Therefore, if the configuration file has come from an earlier version of ESPhome, it is necessary to
reverse the order of the address and command bits when moving to 2021.12 or above. For example,
address: 0x84ED, command: 0x13EC becomes 0xB721 and 0x37C8, respectively. In additional, ESPHome
does not automatically generate parity bits or pad values to 2 bytes. For example, to send command 0x0, you
need to use 0xFF00 (0x00 being the command and 0xFF being the logical inverse).
on_...: - remote_transmitter.transmit_nec: address: 0x1234 command: 0x78AB command_repeats: 1Configuration variables
Section titled “Configuration variables”-
address (Required, int, templatable): The 16-bit address to send, see dumper output for more details.
-
command (Required, int, templatable): The 16-bit NEC command to send.
-
command_repeats (Optional, int, templatable): How many times the command is signalled in one transmission, from
1to10. The full frame goes out once; each further count adds an NEC repeat frame (the 9 ms header mark, a 2.25 ms space and one stop mark, every 108 ms), which is what a held button on a real remote sends. With the software bit-bang transmitter (platforms that are not ESP32 RMT, RTL8720C or BK7238) the whole transmission runs with interrupts disabled, so keep this small there. Defaults to1. -
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_nexa Action
Section titled “remote_transmitter.transmit_nexa Action”This action a Nexa RF remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_nexa: device: 0x38DDB4A state: 1 group: 0 channel: 15 level: 0Configuration variables
Section titled “Configuration variables”-
device (Required, int, templatable): The Nexa device code to send, see dumper output for more info.
-
state (Required, int, templatable): The Nexa state code to send (0-OFF, 1-ON, 2-DIMMER LEVEL), see dumper output for more info.
-
group (Required, int, templatable): The Nexa group code to send, see dumper output for more info.
-
channel (Required, int, templatable): The Nexa channel code to send, see dumper output for more info.
-
level (Required, int, templatable): The Nexa level code to send, see dumper output for more info.
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_nexus Action
Section titled “remote_transmitter.transmit_nexus Action”This action sends a 36-bit Nexus temperature and humidity sensor code, as used by Digoo and similar 433 MHz weather sensors, to a remote transmitter.
on_...: - remote_transmitter.transmit_nexus: channel: 1 address: 42 temperature: 34.5 humidity: 51Configuration variables
Section titled “Configuration variables”- channel (Required, int, templatable): The channel to send, 1 to 4.
- address (Required, int, templatable): The 8-bit address (sensor ID) to send, 0 to 255. Each sensor has its own.
- temperature (Required, float, templatable): The temperature to send in °C, with a resolution of 0.1 °C, between -204.8 and 204.7.
- humidity (Required, int, templatable): The humidity to send in %. The field is 8 bits wide, so values up to 255 are accepted.
- battery_level (Optional, boolean, templatable): The battery flag to send,
truefor a normal battery andfalsefor a low one. Defaults totrue. - force_update (Optional, boolean, templatable): The forced transmission flag,
truewhen the sensor sends because its button was pressed. Defaults tofalse. - All other options from Remote Transmitter Actions. Real sensors send each
frame about ten times, so set
repeatwith a similar count for receivers that expect it.
remote_transmitter.transmit_onkyori Action
Section titled “remote_transmitter.transmit_onkyori Action”This action sends an Onkyo RI remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_onkyori: data: 0xD9 # A-9050 power on; codes differ between modelsConfiguration variables
Section titled “Configuration variables”- data (Required, int, templatable): The Onkyo RI code to send. Codes are 12 bits
wide, so the range is
0x000to0xFFF. A lambda that returns a wider value is not transmitted and an error is logged. Codes differ between models, see the links below. - All other options from Remote Transmitter Actions.
Onkyo RI
Section titled “Onkyo RI”Onkyo RI (“Remote Interactive”) is a wired protocol, not an infrared one. Onkyo used it to link its own components together over a 3.5 mm mono cable.
RI has no carrier. carrier_duty_percent is still required by remote_transmitter, but it has
no effect on RI.
WARNING
The RI signal swings between 0 V and 5 V. Most ESP32 GPIOs are not 5 V tolerant. Put a level shifter between the GPIO and the RI jack.
Code lists and protocol descriptions are published by the LIRC project, fredboboss and docbender/Onkyo-RI.
remote_transmitter.transmit_panasonic Action
Section titled “remote_transmitter.transmit_panasonic Action”This action sends a Panasonic infrared remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_panasonic: address: 0x1FEF command: 0x1F3E065F
# A 56-bit code - remote_transmitter.transmit_panasonic: nbits: 56 address: 0x4004 address_2: 0x0E command: 0x0100BCBDConfiguration variables
Section titled “Configuration variables”- address (Required, int, templatable): The 16-bit address to send the command to, see dumper output for more details.
- address_2 (Optional, int, templatable): The extra 8-bit address byte of a 56-bit
code, see dumper output for more details. Only allowed with
nbits: 56. Defaults to0. - command (Required, int, templatable): The 32-bit command to send.
- nbits (Optional, int, templatable): The number of bits of the remote code,
48or56. Defaults to48. - carrier_frequency (Optional, float, templatable): Set a frequency to send the signal
with for infrared signals. Defaults to
35000Hz. - All other options from Remote Transmitter Actions.
remote_transmitter.transmit_pd_pioneer Action
Section titled “remote_transmitter.transmit_pd_pioneer Action”This action sends a PD Pioneer mini-split infrared code to a remote transmitter. The checksum byte is added automatically when 13 data bytes are provided.
on_...: - remote_transmitter.transmit_pd_pioneer: code: [0x23, 0xCB, 0x26, 0x02, 0x00, 0x40, 0xC0, 0x00, 0xC3, 0x00, 0x00, 0x00, 0x00]Configuration variables
Section titled “Configuration variables”-
code (Required, list, templatable): The 13- or 14-byte PD Pioneer code to send as a list of hex or integers. The fourth byte must be
0x01(settings frame) or0x02(fan frame); the checksum byte is filled in for you, so 13 bytes are enough. See dumper output for more info. -
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_pioneer Action
Section titled “remote_transmitter.transmit_pioneer Action”This action sends a Pioneer infrared remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_pioneer: rc_code_1: 0xA556 rc_code_2: 0xA506 repeat: times: 2Configuration variables
Section titled “Configuration variables”-
rc_code_1 (Required, int, templatable): The remote control code to send, see dumper output for more details.
-
rc_code_2 (Optional, int, templatable): The secondary remote control code to send; some codes are sent in two parts.
-
Note that
repeatis still optional, however Pioneer devices may require that a given code is received multiple times before they will act on it. Add this if your device does not respond to commands sent with this action. -
All other options from Remote Transmitter Actions.
At the time this action was created, Pioneer maintained listings of IR codes used for their devices. If unable to find your specific device in the documentation, find a device in the same class; the codes are largely shared among devices within a given class.
remote_transmitter.transmit_pioneer_wyt Action
Section titled “remote_transmitter.transmit_pioneer_wyt Action”This action sends a raw infrared frame for Pioneer Diamante Pro mini split heat pumps, the WYT model family, to a remote transmitter. The frame is 14 bytes; give the first 13 and the checksum is appended, or give all 14 and the last byte is replaced by the computed checksum.
on_...: - remote_transmitter.transmit_pioneer_wyt: code: [0x23, 0xCB, 0x26, 0x01, 0x00, 0x24, 0x03, 0x05, 0x00, 0x00, 0x00, 0x00, 0x80]Configuration variables
Section titled “Configuration variables”- code (Required, list of 13 or 14 bytes, templatable): The frame to send. The checksum is computed from the first 13 bytes and stored in the 14th.
- All other options from Remote Transmitter Actions.
remote_transmitter.transmit_pronto Action
Section titled “remote_transmitter.transmit_pronto Action”This action sends a raw code to a remote transmitter specified in Pronto format.
on_...: - remote_transmitter.transmit_pronto: data: "0000 006D 0010 0000 0008 0020 0008 0046 000A 0020 0008 0020 0008 001E 000A 001E 000A 0046 000A 001E 0008 0020 0008 0020 0008 0046 000A 0046 000A 0046 000A 001E 000A 001E 0008 06C3"Configuration variables
Section titled “Configuration variables”-
data (Required, string, templatable): The raw code to send specified as a string. Many remote control Pronto codes can be found on http://remotecentral.com
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_raw Action
Section titled “remote_transmitter.transmit_raw Action”This action sends a raw code to a remote transmitter.
on_...: - remote_transmitter.transmit_raw: code: [4088, -1542, 1019, -510, 513, -1019, 510, -509, 511, -510, 1020, -1020, 1022, -1019, 510, -509, 511, -510, 511, -509, 511, -510, 1020, -1019, 510, -511, 1020, -510, 512, -508, 510, -1020, 1022, -1021, 1019, -1019, 511, -510, 510, -510, 1022, -1020, 1019, -1020, 511, -511, 1018, -1022, 1020, -1019, 1021, -1019, 1020, -511, 510, -1019, 1023, -1019, 1019, -510, 512, -508, 510, -511, 512, -1019, 510, -509]Configuration variables
Section titled “Configuration variables”-
code (Required, list, templatable): The raw code to send as a list of integers. Positive numbers represent a digital high signal and negative numbers a digital low signal. The number itself encodes how long the signal should last (in microseconds).
-
carrier_frequency (Optional, float, templatable): Optionally set a frequency to send the signal with for infrared signals. Defaults to
0Hz. -
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_rc5 Action
Section titled “remote_transmitter.transmit_rc5 Action”This action sends an RC5 infrared remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_rc5: address: 0x1F command: 0x3FConfiguration variables
Section titled “Configuration variables”- address (Required, int, templatable): The address to send, see dumper output for more details.
- command (Required, int, templatable): The RC5 command to send.
- All other options from Remote Transmitter Actions.
remote_transmitter.transmit_rc5x Action
Section titled “remote_transmitter.transmit_rc5x Action”This action sends an RC5X (Marantz Extended RC5) infrared remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_rc5x: address: 0x10 command: 0x00 extension: 0x06Configuration variables
Section titled “Configuration variables”- address (Required, int, templatable): The address to send, see dumper output for more details. Range is 0 to 0x1F.
- command (Required, int, templatable): The RC5X command to send. Range is 0 to 0x7F.
- extension (Required, int, templatable): The RC5X extension field to send. Range is 0 to 0x3F.
- All other options from Remote Transmitter Actions.
remote_transmitter.transmit_rc6 Action
Section titled “remote_transmitter.transmit_rc6 Action”This action sends an RC6 infrared remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_rc6: address: 0x1F command: 0x3FConfiguration variables
Section titled “Configuration variables”- address (Required, int, templatable): The address to send, see dumper output for more details.
- command (Required, int, templatable): The RC6 command to send.
- All other options from Remote Transmitter Actions.
remote_transmitter.transmit_rc_switch_raw Action
Section titled “remote_transmitter.transmit_rc_switch_raw Action”This action sends a raw RC-Switch code to a remote transmitter.
on_...: - remote_transmitter.transmit_rc_switch_raw: code: '001010011001111101011011' protocol: 1Configuration variables
Section titled “Configuration variables”-
code (Required, string, templatable): The raw code to send, copy this from the dump output.
-
protocol (Optional, templatable): The RC Switch protocol to use, see RC Switch Protocol for more information.
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_rc_switch_type_a Action
Section titled “remote_transmitter.transmit_rc_switch_type_a Action”This action sends a type A RC-Switch code to a remote transmitter.
on_...: - remote_transmitter.transmit_rc_switch_type_a: group: '01001' device: '10110' state: off protocol: 1Configuration variables
Section titled “Configuration variables”-
group (Required, string, templatable): The group to send the command to.
-
device (Required, string, templatable): The device in the group to send the command to.
-
state (Required, boolean, templatable): The on/off state to send.
-
protocol (Optional, templatable): The RC Switch protocol to use, see RC Switch Protocol for more information.
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_rc_switch_type_b Action
Section titled “remote_transmitter.transmit_rc_switch_type_b Action”This action sends a type B RC-Switch code to a remote transmitter.
on_...: - remote_transmitter.transmit_rc_switch_type_b: address: 1 channel: 3 state: off protocol: 1Configuration variables
Section titled “Configuration variables”-
address (Required, int, templatable): The address to send the command to.
-
channel (Required, int, templatable): The channel to send the command to.
-
state (Required, boolean, templatable): The on/off state to send.
-
protocol (Optional, templatable): The RC Switch protocol to use, see RC Switch Protocol for more information.
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_rc_switch_type_c Action
Section titled “remote_transmitter.transmit_rc_switch_type_c Action”This action sends a type C RC-Switch code to a remote transmitter.
on_...: - remote_transmitter.transmit_rc_switch_type_c: family: 'C' group: 3 device: 1 state: off protocol: 1Configuration variables
Section titled “Configuration variables”-
family (Required, string, templatable): The family to send the command to. Range is
atop. -
group (Required, int, templatable): The group to send the command to. Range is 1 to 4.
-
device (Required, int, templatable): The device to send the command to. Range is 1 to 4.
-
state (Required, boolean, templatable): The on/off state to send.
-
protocol (Optional, templatable): The RC Switch protocol to use, see RC Switch Protocol for more information.
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_rc_switch_type_d Action
Section titled “remote_transmitter.transmit_rc_switch_type_d Action”This action sends a type D RC-Switch code to a remote transmitter.
on_...: - remote_transmitter.transmit_rc_switch_type_d: group: 'c' device: 1 state: off protocol: 1Configuration variables
Section titled “Configuration variables”-
group (Required, string, templatable): The group to send the command to. Range is
atod. -
device (Required, int, templatable): The device to send the command to. Range is 1 to 3.
-
state (Required, boolean, templatable): The on/off state to send.
-
protocol (Optional, templatable): The RC Switch protocol to use, see RC Switch Protocol for more information.
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_roomba Action
Section titled “remote_transmitter.transmit_roomba Action”This action sends a Roomba infrared remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_roomba: data: 0x88 # clean repeat: times: 3 wait_time: 17msConfiguration variables
Section titled “Configuration variables”- data (Required, int, templatable): The Roomba code to send, see dumper output for more info.
- All other options from Remote Transmitter Actions.
Important:
-
While
repeatis optional, Roomba vacuums require that a given code is received at least three times before they will respond to it. If your Roomba does not respond to the command, increase this value. -
While
wait_timeis optional, the Roomba Remote uses a 17 ms wait time between commands. However, it appears to work without this parameter.
remote_transmitter.transmit_samsung Action
Section titled “remote_transmitter.transmit_samsung Action”This action sends a Samsung infrared remote code to a remote transmitter. It transmits codes up to 64 bits in length in a single packet.
on_...: - remote_transmitter.transmit_samsung: data: 0x1FEF05E4 # additional example for 48-bit codes: - remote_transmitter.transmit_samsung: data: 0xB946F50A09F6 nbits: 48Configuration variables
Section titled “Configuration variables”- data (Required, int, templatable): The data to send, see dumper output for more details.
- nbits (Optional, int, templatable): The number of bits to send. Defaults to
32. - All other options from Remote Transmitter Actions.
remote_transmitter.transmit_samsung36 Action
Section titled “remote_transmitter.transmit_samsung36 Action”This action sends a Samsung36 infrared remote code to a remote transmitter.
It transmits the address and command in two packets separated by a “space”.
on_...: - remote_transmitter.transmit_samsung36: address: 0x0400 command: 0x000E00FFConfiguration variables
Section titled “Configuration variables”- address (Required, int, templatable): The address to send, see dumper output for more details.
- command (Required, int, templatable): The Samsung36 command to send, see dumper output for more details.
- All other options from Remote Transmitter Actions.
remote_transmitter.transmit_symphony Action
Section titled “remote_transmitter.transmit_symphony Action”This action sends a Symphony infrared remote code to a remote transmitter.
It transmits constant bit-time frames with a footer gap. Physical Symphony remotes typically
send the same frame twice separated by a ~35 ms gap. Use command_repeats to control how
many identical frames are sent; defaults to 2.
on_...: - remote_transmitter.transmit_symphony: data: 0x0E88 nbits: 12 command_repeats: 2Configuration variables
Section titled “Configuration variables”-
data (Required, int, templatable): The Symphony code to send, see dumper output for more info.
-
nbits (Required, int, templatable): The number of bits to send. Typical values:
8,12, or16. -
command_repeats (Optional, int, templatable): Number of times to send the same frame in one transmission. Defaults to
2to match typical handsets. -
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_sony Action
Section titled “remote_transmitter.transmit_sony Action”This action a Sony infrared remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_sony: data: 0x123 nbits: 12Configuration variables
Section titled “Configuration variables”- data (Required, int, templatable): The Sony code to send, see dumper output for more info.
- nbits (Optional, int, templatable): The number of bits to send. Defaults to
12. - All other options from Remote Transmitter Actions.
remote_transmitter.transmit_somfy_rts Action
Section titled “remote_transmitter.transmit_somfy_rts Action”This action sends a Somfy RTS command, as used by Somfy blinds, shutters and
awnings on 433.42 MHz, to a remote transmitter. ESPHome acts as one more remote: it has its own address and a rolling
code that must grow by one with every command, so keep the code in a global with
restore_value: true and increment it in the lambda. Pair the device by holding the program button on an existing
remote until the motor jogs, then sending control: 0x8 from ESPHome. Real remotes send each frame several times,
so use repeat.
on_...: - remote_transmitter.transmit_somfy_rts: address: 0x123456 control: 0x2 key: 0xA0 rolling_code: !lambda return id(rolling_code)++; repeat: times: 3 wait_time: 30msConfiguration variables
Section titled “Configuration variables”- address (Required, int, templatable): The 24-bit address ESPHome uses as a remote. Pick any value and keep it.
- control (Required, int, templatable): The 4-bit command:
0x1My (stop),0x2Up,0x4Down,0x8Prog. Combinations such as0x3(My and Up) are sent as given. - key (Required, int, templatable): The 8-bit encryption key byte;
0xA0works for most receivers. - rolling_code (Required, int, templatable): The 16-bit rolling code. Each command must use a higher code than the one before, or the receiver ignores it.
- control_in_key (Optional, boolean, templatable): Some remotes put the command in
the low nibble of the key byte instead of the control nibble. Set this if the device does not react; the low
nibble of
keymust then be0. Defaults tofalse. - All other options from Remote Transmitter Actions.
remote_transmitter.transmit_toshiba_ac Action
Section titled “remote_transmitter.transmit_toshiba_ac Action”This action sends a Toshiba AC infrared remote code to a remote transmitter.
NOTE
This action transmits codes using the new(er) Toshiba AC protocol and likely will not work with older units.
on_...: - remote_transmitter.transmit_toshiba_ac: rc_code_1: 0xB24DBF4040BF rc_code_2: 0xD5660001003CConfiguration variables
Section titled “Configuration variables”-
rc_code_1 (Required, int, templatable): The remote control code to send, see dumper output for more details.
-
rc_code_2 (Optional, int, templatable): The secondary remote control code to send; some codes are sent in two parts.
-
All other options from Remote Transmitter Actions.
remote_transmitter.transmit_mirage Action
Section titled “remote_transmitter.transmit_mirage Action”This action sends a 112-bit Mirage code to a remote transmitter. 8-bits of checksum added automatically.
on_...: - remote_transmitter.transmit_mirage: code: [0x56, 0x77, 0x00, 0x00, 0x22, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]Configuration variables
Section titled “Configuration variables”- code (Required, list, templatable): The 14 byte Mirage code to send.
- All other options from Remote Transmitter Actions.
remote_transmitter.transmit_toto Action
Section titled “remote_transmitter.transmit_toto Action”This action sends a Toto infrared remote code to a remote transmitter.
on_...: - remote_transmitter.transmit_toto: code: 0x1200 # Close lid # Repeats 3 times at a 36ms interval by defaultConfiguration variables
Section titled “Configuration variables”- code (Required, int, templatable): The 2-byte Toto command code to send. Range is 0 to 0xFFFF.
- All other options from Remote Transmitter Actions.
NOTE
Toto remotes repeat all codes three times at a 36ms interval. This behavior will occur by default, but may be overridden by specifying repeat and wait time configuration variables.
remote_transmitter.digital_write Action
Section titled “remote_transmitter.digital_write Action”This action sets the output value of the pin.
on_...: - remote_transmitter.digital_write: value: trueConfiguration variables
Section titled “Configuration variables”-
transmitter_id (Optional, ID): The remote transmitter to set the pin value on. Defaults to the first one defined in the configuration.
-
value (Required, bool, templatable): The output value of the pin.
RC Switch Protocol
Section titled “RC Switch Protocol”All RC Switch protocol settings have these settings:
-
Either the value is an integer, then the inbuilt protocol definition with the given number is used.
-
Or a key-value mapping is given, then there are these settings:
-
pulse_length (Required, int): The pulse length of the protocol - how many microseconds one pulse should last for.
-
sync (Optional): The number of high/low pulses for the sync header, defaults to
[1, 31] -
zero (Optional): The number of high/low pulses for a zero bit, defaults to
[1, 3] -
one (Optional): The number of high/low pulses for a one bit, defaults to
[3, 1] -
inverted (Optional, boolean): If this protocol is inverted. Defaults to
false.
-
Lambda calls
Section titled “Lambda calls”Actions may also be called from lambdas. The .transmit() call can be populated with
raw timings or encoded data for a specific protocol by following the examples below.
.transmit(): Returns a call to populate with data and send.
// Example - transmit raw timingsauto call = id(my_transmitter).transmit();auto *data = call.get_data();for (int32_t i = 0; i < 4; i++) { data->item(600, 600);}uint8_t bytes[] = {0x12, 0x34, 0x56, 0x78};for (uint8_t byte : bytes) { for (int32_t i = 7; i >= 0; i--) { if (byte & (1 << i)) { data->item(400, 200); } else { data->item(200, 400); } }}call.set_send_times(3);call.set_send_wait(2000);call.perform();// Example - transmit using the Pioneer protocolauto call = id(my_transmitter).transmit();esphome::remote_base::PioneerData data = {0xA556, 0xA506};esphome::remote_base::PioneerProtocol().encode(call.get_data(), data);call.set_send_times(2);call.perform();