Skip to content

Commit 0a25070

Browse files
authored
Add documentation for Toto remote transmitter/receiver protocol (#4633)
1 parent 73ddef8 commit 0a25070

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

components/remote_receiver.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ Configuration variables:
6464
- **sony**: Decode and dump Sony infrared codes.
6565
- **toshiba_ac**: Decode and dump Toshiba AC infrared codes.
6666
- **mirage**: Decode and dump Mirage infrared codes.
67+
- **toto**: Decode and dump Toto infrared codes.
6768

6869
- **tolerance** (*Optional*, int, :ref:`config-time` or mapping): The percentage or time that the remote signal lengths
6970
can deviate in the decoding process. Defaults to ``25%``.
@@ -226,6 +227,9 @@ Automations:
226227
- **on_mirage** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
227228
Mirage remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::MirageData`
228229
is passed to the automation for use in lambdas.
230+
- **on_toto** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
231+
Toto remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::TotoData`
232+
is passed to the automation for use in lambdas.
229233

230234
.. code-block:: yaml
231235
@@ -486,6 +490,12 @@ Remote code selection (exactly one of these has to be included):
486490
:ref:`transmitter description <remote_transmitter-transmit_mirage>` for more info. Usually you only need to copy
487491
this directly from the dumper output.
488492

493+
- **toto**: Trigger on a decoded Toto remote code with the given data.
494+
495+
- **command** (**Required**, int): The 1-byte Toto command code to trigger on. Range is 0 to 0xFF.
496+
- **rc_code_1** (*Optional*, int): The first 4-bit Toto code (usually a command parameter) to trigger on. Range is 0 to 0xF.
497+
- **rc_code_2** (*Optional*, int): The second 4-bit Toto code (usually a command parameter) to trigger on. Range is 0 to 0xF.
498+
489499
.. note::
490500

491501
The **CanalSat** and **CanalSatLD** protocols use a higher carrier frequency (56khz) and are very similar.

components/remote_transmitter.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -929,6 +929,30 @@ Configuration variables:
929929
- **code** (**Required**, list): The 14 byte Mirage code to send.
930930
- All other options from :ref:`remote_transmitter-transmit_action`.
931931

932+
.. _remote_transmitter-transmit_toto:
933+
934+
``remote_transmitter.transmit_toto`` **Action**
935+
936+
This :ref:`action <config-action>` sends a Toto infrared remote code to a remote transmitter.
937+
938+
.. code-block:: yaml
939+
940+
on_...:
941+
- remote_transmitter.transmit_toto:
942+
command: 0xED # Set water and seat temperature
943+
rc_code_1: 0x0 # Water heater off
944+
rc_code_2: 0x0 # Seat heater off
945+
# Repeats 3 times at a 32ms interval by default
946+
947+
Configuration variables:
948+
949+
- **command** (**Required**, int): The 1-byte Toto command code to send. Range is 0 to 0xFF.
950+
- **rc_code_1** (*Optional*, int): The first 4-bit Toto code (usually a command parameter) to send. Range is 0 to 0xF.
951+
- **rc_code_2** (*Optional*, int): The second 4-bit Toto code (usually a command parameter) to send. Range is 0 to 0xF.
952+
- All other options from :ref:`remote_transmitter-transmit_action`.
953+
- **Note**: Toto remotes repeat all codes three times at a 32ms interval. This behavior will occur by default, but may be overridden by specifying ``repeat`` and ``wait time`` configuration variables.
954+
955+
932956
.. _remote_transmitter-rc_switch-protocol:
933957

934958
RC Switch Protocol

0 commit comments

Comments
 (0)