Upstream
/
esphome-docs
mirror of https://github.com/esphome/esphome-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

document new uart switch options (#3269) 

Co-authored-by: Samuel Sieb <samuel@sieb.net>
Co-authored-by: H. Árkosi Róbert <robreg@zsurob.hu>
This commit is contained in:
Samuel Sieb 2023-10-17 12:07:33 -07:00 committed by GitHub
parent 986ebe0b81
commit b98a242d4a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
components/switch/uart.rst
View File

@ -26,15 +26,23 @@ The ``uart`` switch platform allows you to send a pre-defined sequence of bytes
name: "UART Recurring Output"
data: [0xDE, 0xAD, 0xBE, 0xEF]
send_every: 1s
- platform: uart
name: "UART On/Off"
data:
turn_on: "TurnOn\r\n"
turn_off: "TurnOff\r\n"
Configuration variables:
------------------------
- **data** (**Required**, string or list of bytes): The data to send via UART. Either an ASCII string
or a list of bytes.
- **name** (**Required**, string): The name for the switch.
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART hub.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **name** (*Optional*, string): The name for the switch.
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART hub.
- **data** (*Optional*, string or list of bytes): The data to send via UART. Either an ASCII string
or a list of bytes or one or both of the following nested options (see example above).
- **turn_on** (*Optional*, string or list of bytes): The data to send when turning on.
- **turn_off** (*Optional*, string or list of bytes): The data to send when turning off.
- **send_every** (*Optional*, :ref:`config-time`): Sends recurring data instead of sending once.
- All other options from :ref:`Switch <config-switch>`.