From ac56a77d26c56013a13bbccf7e7da623f0e49156 Mon Sep 17 00:00:00 2001 From: bukureckid Date: Tue, 9 Apr 2024 23:04:38 +0200 Subject: [PATCH] Add documentation for Dooya RF (#3749) Co-authored-by: Dusan Bukurecki --- components/remote_receiver.rst | 12 ++++++++++++ components/remote_transmitter.rst | 24 ++++++++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/components/remote_receiver.rst b/components/remote_receiver.rst index 838e8ee52..d3eb1f6f5 100644 --- a/components/remote_receiver.rst +++ b/components/remote_receiver.rst @@ -37,6 +37,7 @@ Configuration variables: - **canalsatld**: Decode and dump CanalSatLD infrared codes. - **coolix**: Decode and dump Coolix infrared codes. - **dish**: Decode and dump Dish infrared codes. + - **dooya**: Decode and dump Dooya RF codes. - **drayton**: Decode and dump Drayton Digistat RF codes. - **jvc**: Decode and dump JVC infrared codes. - **keeloq**: Decode and dump KeeLoq RF codes. @@ -113,6 +114,9 @@ Automations: dish network remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::DishData` is passed to the automation for use in lambdas. Beware that Dish remotes use a different carrier frequency (57.6kHz) that many receiver hardware don't decode. +- **on_dooya** (*Optional*, :ref:`Automation `): An automation to perform when a + Dooya RF remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::DooyaData` + is passed to the automation for use in lambdas. - **on_drayton** (*Optional*, :ref:`Automation `): An automation to perform when a Drayton Digistat RF code has been decoded. A variable ``x`` of type :apistruct:`remote_base::DraytonData` is passed to the automation for use in lambdas. @@ -273,6 +277,13 @@ Remote code selection (exactly one of these has to be included): - **address** (*Optional*, int): The number of the receiver to target, between 1 and 16 inclusive. Defaults to ``1``. - **command** (**Required**, int): The Dish command to listen for, between 0 and 63 inclusive. +- **dooya**: Trigger on a decoded Dooya RF remote code with the given data. + + - **id** (**Required**, int): The 24-bit ID code to trigger on. + - **channel** (**Required**, int): The 8-bit channel to listen for. + - **button** (**Required**, int): The 4-bit button to listen for. + - **check** (**Required**, int): The 4-bit check to listen for. Includes an indication that a button is being held down. + - **drayton**: Trigger on a decoded Drayton Digistat RF remote code with the given data. - **address** (**Required**, int): The 16-bit ID code to trigger on, see dumper output for more info. @@ -464,3 +475,4 @@ See Also - `IRRemoteESP8266 `__ by `Mark Szabo-Simon `__ - :apiref:`remote/remote_receiver.h` - :ghedit:`Edit` + diff --git a/components/remote_transmitter.rst b/components/remote_transmitter.rst index 770c32317..5d34b30b3 100644 --- a/components/remote_transmitter.rst +++ b/components/remote_transmitter.rst @@ -273,6 +273,30 @@ Configuration variables: You can find a list of commands in the `LIRC project `__. +.. _remote_transmitter-transmit_dooya: + +``remote_transmitter.transmit_dooya`` Action +********************************************** + +This :ref:`action ` sends a Dooya RF remote code to a remote transmitter. + +.. code-block:: yaml + + on_...: + - remote_transmitter.transmit_dooya: + id: 0x001612E5 + channel: 142 + button: 12 + check: 3 + +Configuration variables: + +- **id** (**Required**, int): The 24-bit ID to send. Each remote has a unique one. +- **channel** (**Required**, int): The 8-bit channel to send, between 0 and 255 inclusive. +- **button** (**Required**, int): The 4-bit button to send, between 0 and 15 inclusive. +- **check** (**Required**, int): 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 :ref:`remote_transmitter-transmit_action`. + .. _remote_transmitter-transmit_drayton: ``remote_transmitter.transmit_drayton`` Action