Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-26 17:27:47 +01:00
Code Issues Projects Releases Wiki Activity

Added docs for Nexa codec (#1313)

Browse Source 
Co-authored-by: Stefan Grufman <stefan.grufman@gmail.com>
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Stefan Grufman 2022-01-10 11:35:45 +01:00 committed by GitHub
parent 9717d75b05
commit b8427a1632
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
components/remote_receiver.rst
View File

@ -36,6 +36,7 @@ Configuration variables:
- **lg**: Decode and dump LG infrared codes. - **lg**: Decode and dump LG infrared codes.
- **midea**: Decode and dump Midea infrared codes. - **midea**: Decode and dump Midea infrared codes.
- **nec**: Decode and dump NEC infrared codes. - **nec**: Decode and dump NEC infrared codes.
- **nexa**: Decode and dump Nexa (RF) codes.
- **panasonic**: Decode and dump Panasonic infrared codes. - **panasonic**: Decode and dump Panasonic infrared codes.
- **pioneer**: Decode and dump Pioneer infrared codes. - **pioneer**: Decode and dump Pioneer infrared codes.
- **raw**: Print all remote codes in their raw form. Useful for using arbitrary protocols. - **raw**: Print all remote codes in their raw form. Useful for using arbitrary protocols.
@ -87,6 +88,9 @@ Automations:
Therefore, if the the configuration file has come from an earlier version of ESPhome, it is necessary to reverse the order of the address and command bits when moving to 2021.12 or above. Therefore, if the the configuration file has come from an earlier version of ESPhome, it is necessary to reverse the order of the address and command bits when moving to 2021.12 or above.
For example, address: 0x84ED, command: 0x13EC becomes 0xB721 and 0x37C8 respectively. For example, address: 0x84ED, command: 0x13EC becomes 0xB721 and 0x37C8 respectively.
- **on_nexa** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
Nexa RF code has been decoded. A variable ``x`` of type :apiclass:`remote_base::NexaData`
is passed to the automation for use in lambdas.
- **on_panasonic** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a - **on_panasonic** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
Panasonic remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::PanasonicData` Panasonic remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::PanasonicData`
is passed to the automation for use in lambdas. is passed to the automation for use in lambdas.
@ -183,6 +187,14 @@ Remote code selection (exactly one of these has to be included):
- **address** (**Required**, int): The address to trigger on, see dumper output for more info. - **address** (**Required**, int): The address to trigger on, see dumper output for more info.
- **command** (**Required**, int): The NEC command to listen for. - **command** (**Required**, int): The NEC command to listen for.
- **nexa**: Trigger on a decoded Nexa RF code with the given data.
- **device** (**Required**, int): The Nexa device code to trigger on, see dumper output for more info.
- **group** (**Required**, int): The Nexa group code to trigger on, see dumper output for more info.
- **state** (**Required**, int): The Nexa state code to trigger on, see dumper output for more info.
- **channel** (**Required**, int): The Nexa channel code to trigger on, see dumper output for more info.
- **level** (**Required**, int): The Nexa level code to trigger on, see dumper output for more info.
- **panasonic**: Trigger on a decoded Panasonic remote code with the given data. - **panasonic**: Trigger on a decoded Panasonic remote code with the given data.
- **address** (**Required**, int): The address to trigger on, see dumper output for more info. - **address** (**Required**, int): The address to trigger on, see dumper output for more info.

24
components/remote_transmitter.rst
View File

@ -196,6 +196,30 @@ Configuration variables:
- **command** (**Required**, int): The NEC command to send. - **command** (**Required**, int): The NEC command to send.
- All other options from :ref:`remote_transmitter-transmit_action`. - All other options from :ref:`remote_transmitter-transmit_action`.
``remote_transmitter.transmit_nexa`` Action
*******************************************
This :ref:`action <config-action>` a Nexa RF remote code to a remote transmitter.
.. code-block:: yaml
on_...:
- remote_transmitter.nexa:
device: 0x38DDB4A
state: 1
group: 0
channel: 15
level: 0
Configuration variables:
- **device** (**Required**, int): The Nexa device code to send, see dumper output for more info.
- **state** (**Required**, int): The Nexa state code to send (0-OFF, 1-ON, 2-DIMMER LEVEL), see dumper output for more info.
- **group** (**Required**, int): The Nexa group code to send, see dumper output for more info.
- **channel** (**Required**, int): The Nexa channel code to send, see dumper output for more info.
- **level** (**Required**, int): The Nexa level code to send, see dumper output for more info.
- All other options from :ref:`remote_transmitter-transmit_action`.
.. _remote_transmitter-transmit_panasonic: .. _remote_transmitter-transmit_panasonic:
``remote_transmitter.transmit_panasonic`` Action ``remote_transmitter.transmit_panasonic`` Action