Skip to content

Commit

Permalink
Add documentation for Toto remote transmitter/receiver protocol (#4633)
Browse files Browse the repository at this point in the history
  • Loading branch information
G-Two authored Feb 7, 2025
1 parent 73ddef8 commit 0a25070
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
10 changes: 10 additions & 0 deletions components/remote_receiver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ Configuration variables:
- **sony**: Decode and dump Sony infrared codes.
- **toshiba_ac**: Decode and dump Toshiba AC infrared codes.
- **mirage**: Decode and dump Mirage infrared codes.
- **toto**: Decode and dump Toto infrared codes.

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

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

- **toto**: Trigger on a decoded Toto remote code with the given data.

- **command** (**Required**, int): The 1-byte Toto command code to trigger on. Range is 0 to 0xFF.
- **rc_code_1** (*Optional*, int): The first 4-bit Toto code (usually a command parameter) to trigger on. Range is 0 to 0xF.
- **rc_code_2** (*Optional*, int): The second 4-bit Toto code (usually a command parameter) to trigger on. Range is 0 to 0xF.

.. note::

The **CanalSat** and **CanalSatLD** protocols use a higher carrier frequency (56khz) and are very similar.
Expand Down
24 changes: 24 additions & 0 deletions components/remote_transmitter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -929,6 +929,30 @@ Configuration variables:
- **code** (**Required**, list): The 14 byte Mirage code to send.
- All other options from :ref:`remote_transmitter-transmit_action`.

.. _remote_transmitter-transmit_toto:

``remote_transmitter.transmit_toto`` **Action**

This :ref:`action <config-action>` sends a Toto infrared remote code to a remote transmitter.

.. code-block:: yaml
on_...:
- remote_transmitter.transmit_toto:
command: 0xED # Set water and seat temperature
rc_code_1: 0x0 # Water heater off
rc_code_2: 0x0 # Seat heater off
# Repeats 3 times at a 32ms interval by default
Configuration variables:

- **command** (**Required**, int): The 1-byte Toto command code to send. Range is 0 to 0xFF.
- **rc_code_1** (*Optional*, int): The first 4-bit Toto code (usually a command parameter) to send. Range is 0 to 0xF.
- **rc_code_2** (*Optional*, int): The second 4-bit Toto code (usually a command parameter) to send. Range is 0 to 0xF.
- All other options from :ref:`remote_transmitter-transmit_action`.
- **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.


.. _remote_transmitter-rc_switch-protocol:

RC Switch Protocol
Expand Down

0 comments on commit 0a25070

Please sign in to comment.