From 74686fadb2ac9e1a1a4b9beac7ef3b2636295632 Mon Sep 17 00:00:00 2001 From: Mat931 <49403702+Mat931@users.noreply.github.com> Date: Thu, 2 May 2024 01:22:30 +0000 Subject: [PATCH] Remote receiver improvements (#2797) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Keith Burzinski Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Co-authored-by: H. Árkosi Róbert --- components/remote_receiver.rst | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/components/remote_receiver.rst b/components/remote_receiver.rst index eda32b68c..86affc35a 100644 --- a/components/remote_receiver.rst +++ b/components/remote_receiver.rst @@ -60,8 +60,13 @@ Configuration variables: - **sony**: Decode and dump Sony infrared codes. - **toshiba_ac**: Decode and dump Toshiba AC infrared codes. -- **tolerance** (*Optional*, int): The percentage that the remote signal lengths can deviate in the - decoding process. Defaults to ``25%``. +- **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%``. + + - **type** (**Required**, enum): Set the type of the tolerance. Can be ``percentage`` or ``time``. + - **value** (**Required**, int or :ref:`config-time`): The percentage or time value. Allowed values are in range ``0`` to + ``100%`` or ``0`` to ``4294967295us``. + - **buffer_size** (*Optional*, int): The size of the internal buffer for storing the remote codes. Defaults to ``10kB`` on the ESP32 and ``1kB`` on the ESP8266. - **rmt_channel** (*Optional*, int): The RMT channel to use. Only on **esp32**. @@ -75,14 +80,17 @@ Configuration variables: "ESP32-S3", "4, 5, 6, 7" "ESP32-C3", "2, 3" -- **memory_blocks** (*Optional*, int): The number of RMT memory blocks used. Only used on ESP32 platform. Defaults to - ``3``. +- **memory_blocks** (*Optional*, int): The number of RMT memory blocks used. Only used on ESP32 platform. The maximum + number of blocks shared by all receivers and transmitters depends on the ESP32 variant. Defaults to ``3``. - **filter** (*Optional*, :ref:`config-time`): Filter any pulses that are shorter than this. Useful for removing - glitches from noisy signals. Defaults to ``50us``. + glitches from noisy signals. Allowed values are in range ``0`` to ``4294967295us``. Defaults to ``50us``. - **idle** (*Optional*, :ref:`config-time`): The amount of time that a signal should remain stable (i.e. not - change) for it to be considered complete. Defaults to ``10ms``. + change) for it to be considered complete. Allowed values are in range ``0`` to ``4294967295us``. Defaults to ``10ms``. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. Use this if you have multiple remote receivers. +- **clock_divider** (*Optional*, int): The clock divider used by the RMT peripheral. A clock divider of ``80`` leads to + a resolution of 1 µs per tick, ``160`` leads to 2 µs. Allowed values are in range ``1`` to ``255``. Only used on ESP32 + platform. Defaults to ``80``. .. note::