Skip to content
Get started

UART Binary Sensor

The uart binary sensor platform watches a UART bus for a fixed sequence of bytes. When the bytes that arrived most recently match the sequence, the sensor publishes ON and then OFF right away, so it behaves like a button press: use on_press to react to it. Keyboard escape sequences and the keys of a serial terminal are the typical use.

# Example configuration entry
binary_sensor:
- platform: uart
id: up
data: [0x1B, 0x5B, 0x41]
on_press:
then:
- display_menu.up
- platform: uart
id: enter
data: "\r"
on_press:
then:
- display_menu.enter
  • data (Required, string or list of bytes): The sequence to watch for, 1 to 255 bytes, as an ASCII string or a list of bytes. The sequence is stored in flash.
  • uart_id (Optional, ID): Manually specify the ID of the UART bus.
  • All other options from Binary Sensor.

All sensors on one bus read the same bytes, and the first sensor whose sequence matches takes them. Two sensors on the same bus therefore cannot have the same sequence, and neither sequence may occur anywhere inside the other (AB and ABC, or B and ABC); the configuration is rejected in that case.