From ab21cada9386c16715ed5d7f54b2b4bfb6138436 Mon Sep 17 00:00:00 2001 From: rforro Date: Wed, 24 Apr 2024 05:21:12 +0200 Subject: [PATCH] Include roomba ir in docs (#2767) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Richard Forro Co-authored-by: H. Árkosi Róbert Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com> --- components/remote_receiver.rst | 8 ++++++++ components/remote_transmitter.rst | 23 +++++++++++++++++++++++ 2 files changed, 31 insertions(+) diff --git a/components/remote_receiver.rst b/components/remote_receiver.rst index d3eb1f6f5..eda32b68c 100644 --- a/components/remote_receiver.rst +++ b/components/remote_receiver.rst @@ -54,6 +54,7 @@ Configuration variables: - **rc5**: Decode and dump RC5 IR codes. - **rc6**: Decode and dump RC6 IR codes. - **rc_switch**: Decode and dump RCSwitch RF codes. + - **roomba**: Decode and dump Roomba infrared codes. - **samsung**: Decode and dump Samsung infrared codes. - **samsung36**: Decode and dump Samsung36 infrared codes. - **sony**: Decode and dump Sony infrared codes. @@ -165,6 +166,9 @@ Automations: - **on_rc_switch** (*Optional*, :ref:`Automation `): An automation to perform when a RCSwitch RF code has been decoded. A variable ``x`` of type :apistruct:`remote_base::RCSwitchData` is passed to the automation for use in lambdas. +- **on_roomba** (*Optional*, :ref:`Automation `): An automation to perform when a + Roomba remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::RoombaData` + is passed to the automation for use in lambdas. - **on_samsung** (*Optional*, :ref:`Automation `): An automation to perform when a Samsung remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::SamsungData` is passed to the automation for use in lambdas. @@ -398,6 +402,10 @@ Remote code selection (exactly one of these has to be included): - **state** (**Required**, boolean): The on/off state to trigger on. - **protocol** (*Optional*): The RC Switch protocol to use, see :ref:`remote_transmitter-rc_switch-protocol` for more info. +- **roomba**: Trigger on a decoded Roomba remote code with the given data. + + - **data** (**Required**, int): The Roomba code to trigger on, see dumper output for more info. + - **samsung**: Trigger on a decoded Samsung remote code with the given data. - **data** (**Required**, int): The data to trigger on, see dumper output for more info. diff --git a/components/remote_transmitter.rst b/components/remote_transmitter.rst index 5d34b30b3..5bafd4972 100644 --- a/components/remote_transmitter.rst +++ b/components/remote_transmitter.rst @@ -781,6 +781,29 @@ Configuration variables: for more information. - All other options from :ref:`remote_transmitter-transmit_action`. +.. _remote_transmitter-transmit_roomba: + +``remote_transmitter.transmit_roomba`` Action +********************************************* + +This :ref:`action ` sends a Roomba infrared remote code to a remote transmitter. + +.. code-block:: yaml + + on_...: + - remote_transmitter.transmit_roomba: + data: 0x88 # clean + repeat: + times: 3 + wait_time: 17ms + +Configuration variables: + +- **data** (**Required**, int): The Roomba code to send, see dumper output for more info. +- Note that ``repeat`` is still optional, however **Roomba vacuums require that a given code is received at least three times before they will act on it.** If your Roomba still does not respond to sent command increase this value. +- Note that ``wait_time`` is still optional; it will even work without this parameter, but Roomba Remote uses this 17 ms wait time between sent commands. +- All other options from :ref:`remote_transmitter-transmit_action`. + .. _remote_transmitter-transmit_samsung: ``remote_transmitter.transmit_samsung`` Action