From 9bb6cd134dd85f216689b5fb9f401f2ff5ca05ac Mon Sep 17 00:00:00 2001 From: cvwillegen Date: Tue, 12 Apr 2022 21:39:42 +0200 Subject: [PATCH] Include documentation on Pronto receive capability (#1878) --- components/remote_receiver.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/components/remote_receiver.rst b/components/remote_receiver.rst index 69b2f44cc..84521c65c 100644 --- a/components/remote_receiver.rst +++ b/components/remote_receiver.rst @@ -40,7 +40,8 @@ Configuration variables: - **nexa**: Decode and dump Nexa (RF) codes. - **panasonic**: Decode and dump Panasonic infrared codes. - **pioneer**: Decode and dump Pioneer infrared codes. - - **raw**: Print all remote codes in their raw form. Useful for using arbitrary protocols. + - **pronto**: Print remote code in Pronto form. Useful for using arbitrary protocols. + - **raw**: Print all remote codes in their raw form. Also useful for using arbitrary protocols. - **rc5**: Decode and dump RC5 IR codes. - **rc_switch**: Decode and dump RCSwitch RF codes. - **samsung**: Decode and dump Samsung infrared codes. @@ -101,6 +102,9 @@ Automations: - **on_pioneer** (*Optional*, :ref:`Automation `): An automation to perform when a pioneer remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::PioneerData` is passed to the automation for use in lambdas. +- **on_pronto** (*Optional*, :ref:`Automation `): An automation to perform when a + Pronto remote code has been decoded. A variable ``x`` of type ``std::string`` + is passed to the automation for use in lambdas. - **on_raw** (*Optional*, :ref:`Automation `): An automation to perform when a raw remote code has been decoded. A variable ``x`` of type ``std::vector`` is passed to the automation for use in lambdas. @@ -213,6 +217,11 @@ Remote code selection (exactly one of these has to be included): - **rc_code_1** (**Required**, int): The remote control code to trigger on, see dumper output for more details. +- **pronto**: Trigger on a Pronto remote code with the given code. + + - **data** (**Required**, string): The code to listen for, see :ref:`remote_transmitter-transmit_raw` + for more info. Usually you only need to copy this directly from the dumper output. + - **raw**: Trigger on a raw remote code with the given code. - **code** (**Required**, list): The code to listen for, see :ref:`remote_transmitter-transmit_raw`