Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-01-26 22:21:38 +01:00
Code Issues Projects Releases Wiki Activity

Added documentation for the CanalSat and CanalSatLD codec (#2318)

Browse Source 
Co-authored-by: H. Árkosi Róbert <robreg@zsurob.hu>
This commit is contained in:
Eric van Blokland 2023-02-09 01:22:09 +01:00 committed by GitHub
parent a5710689b6
commit 53bffad94f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 84 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
components/remote_receiver.rst
View File

@ -31,6 +31,8 @@ Configuration variables:
Set to ``all`` to dump all available codecs:
- **aeha**: Decode and dump AEHA infrared codes.
- **canalsat**: Decode and dump CanalSat infrared codes.
- **canalsatld**: Decode and dump CanalSatLD infrared codes.
- **coolix**: Decode and dump Coolix infrared codes.
- **dish**: Decode and dump Dish infrared codes.
- **jvc**: Decode and dump JVC infrared codes.
@ -69,6 +71,12 @@ Automations:
- **on_aeha** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
AEHA remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::AEHAData`
is passed to the automation for use in lambdas.
- **on_canalsat** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
CanalSat remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::CanalSatData`
is passed to the automation for use in lambdas.
- **on_canalsatld** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
CanalSatLD remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::CanalSatLDData`
is passed to the automation for use in lambdas.
- **on_coolix** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
Coolix remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::CoolixData`
is passed to the automation for use in lambdas.
@ -174,6 +182,28 @@ Remote code selection (exactly one of these has to be included):
- **data** (**Required**, 3-35 bytes list): The code to listen for, see :ref:`remote_transmitter-transmit_aeha`
for more info. Usually you only need to copy this directly from the dumper output.
- **canalsat**: Trigger on a decoded CanalSat remote code with the given data.
.. note::
The CanalSat and CanalSatLD protocols use a higher carrier frequency (56khz) and are very similar.
Depending on the hardware used they may interfere with each other when enabled simultaneously.
- **device** (**Required**, int): The device to trigger on, see dumper output for more info.
- **address** (**Optional**, int): The address (or subdevice) to trigger on, see dumper output for more info. Defaults to ``0``
- **command** (**Required**, int): The command to listen for.
- **canalsatld**: Trigger on a decoded CanalSatLD remote code with the given data.
.. note::
The CanalSat and CanalSatLD protocols use a higher carrier frequency (56khz) and are very similar.
Depending on the hardware used they may interfere with each other when enabled simultaneously.
- **device** (**Required**, int): The device to trigger on, see dumper output for more info.
- **address** (**Optional**, int): The address (or subdevice) to trigger on, see dumper output for more info. Defaults to ``0``
- **command** (**Required**, int): The command to listen for.
- **coolix**: Trigger on a decoded Coolix remote code with the given data.
- **data** (**Required**, int): The 24-bit Coolix code to trigger on, see dumper output for more info.

54
components/remote_transmitter.rst
View File

@ -99,6 +99,60 @@ Configuration variables:
AEHA refers to the Association for Electric Home Appliances in Japan, a format used by Panasonic and many other companies.
.. _remote_transmitter-transmit_canalsat:
``remote_transmitter.transmit_canalsat`` Action
***********************************************
This :ref:`action <config-action>` sends a CanalSat infrared remote code to a remote transmitter.
.. note::
The CanalSat and CanalSatLD protocols use a higher carrier frequency (56khz) and are very similar.
Depending on the hardware used they may interfere with each other when enabled simultaneously.
.. code-block:: yaml
on_...:
- remote_transmitter.transmit_canalsat:
device: 0x25
address: 0x00
command: 0x02
Configuration variables:
- **device** (**Required**, int): The device to send to, see dumper output for more details.
- **address** (**Optional**, int): The address (or subdevice) to send to, see dumper output for more details. Defaults to ``0``
- **command** (**Required**, int): The command to send.
- All other options from :ref:`remote_transmitter-transmit_action`.
.. _remote_transmitter-transmit_canalsatld:
``remote_transmitter.transmit_canalsatld`` Action
*************************************************
This :ref:`action <config-action>` sends a CanalSatLD infrared remote code to a remote transmitter.
.. note::
The CanalSat and CanalSatLD protocols use a higher carrier frequency (56khz) and are very similar.
Depending on the hardware used they may interfere with each other when enabled simultaneously.
.. code-block:: yaml
on_...:
- remote_transmitter.transmit_canalsatld:
device: 0x25
address: 0x00
command: 0x02
Configuration variables:
- **device** (**Required**, int): The device to send to, see dumper output for more details.
- **address** (**Optional**, int): The address (or subdevice) to send to, see dumper output for more details. Defaults to ``0``
- **command** (**Required**, int): The command to send.
- All other options from :ref:`remote_transmitter-transmit_action`.
.. _remote_transmitter-transmit_coolix:
``remote_transmitter.transmit_coolix`` Action