Skip to content

Arduino 3 doc changes #4966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 18, 2025
Merged

Arduino 3 doc changes #4966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 2 additions & 18 deletions components/light/esp32_rmt_led_strip.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,8 @@ Configuration variables
- **max_refresh_rate** (*Optional*, :ref:`config-time`): A time interval used to limit the number of commands a light
can handle per second. For example, ``16ms`` will limit the light to a refresh rate of about 60Hz. Defaults to
sending commands as quickly as changes are made to the lights.
- **use_psram** (*Optional*, boolean): Set to ``false`` to force internal RAM allocation even if you have the the PSRAM component enabled. This can be useful if you're experiencing issues like flickering with your leds strip. Defaults to ``true``.

IDF configuration variables:
****************************

- **use_psram** (*Optional*, boolean): Set to ``false`` to force internal RAM allocation even if you have the the PSRAM
component enabled. This can be useful if you're experiencing issues like flickering with your leds strip. Defaults to ``true``.
- **rmt_symbols** (*Optional*, int): The amount of RMT memory allocated to this component. Memory is shared by all
receivers and transmitters. On variants other than ``ESP32`` and ``ESP32-S2`` only half the symbol memory is
available to transmitters. Each symbol is 32 bits and contains two values.
Expand All @@ -68,19 +65,6 @@ IDF configuration variables:
- **use_dma** (*Optional*, boolean): Enable DMA on variants that support it. If enabled ``rmt_symbols`` controls
the DMA buffer size and can be set to a large value.

Arduino configuration variables:
********************************

- **rmt_channel** (**Required**, int): The RMT channel to use. Each LED strip needs to use a unique channel.

.. csv-table::
:header: "ESP32 Variant", "Channels"

"ESP32", "0, 1, 2, 3, 4, 5, 6, 7"
"ESP32-C3", "0, 1"
"ESP32-S2", "0, 1, 2, 3"
"ESP32-S3", "0, 1, 2, 3"

- All other options from :ref:`Light <config-light>`.

.. _esp32-rmt-led-strip-manual_timings:
Expand Down
22 changes: 1 addition & 21 deletions components/remote_receiver.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. Useful when multiple
receivers are configured on a single device.

ESP32 IDF configuration variables:
ESP32 configuration variables:
**********************************

- **rmt_symbols** (*Optional*, int): If ``use_dma`` is enabled, ``rmt_symbols`` represents the size of the driver's
Expand All @@ -111,26 +111,6 @@ ESP32 IDF configuration variables:
- **use_dma** (*Optional*, boolean): Enable DMA on variants that support it. If enabled ``rmt_symbols`` controls
the DMA buffer size and can be set to a large value.

ESP32 Arduino configuration variables:
**************************************

- **rmt_channel** (*Optional*, int): The RMT channel to use. The following ESP32 variants have these channels available:

.. csv-table::
:header: "ESP32 Variant", "Channels"

"ESP32", "0, 1, 2, 3, 4, 5, 6, 7"
"ESP32-C3", "2, 3"
"ESP32-C6", "2, 3"
"ESP32-H2", "2, 3"
"ESP32-S2", "0, 1, 2, 3"
"ESP32-S3", "4, 5, 6, 7"

- **memory_blocks** (*Optional*, int): The number of RMT memory blocks used. The maximum
number of blocks shared by all receivers and transmitters depends on the ESP32 variant. Defaults to ``3``.
- **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``. Defaults to ``80``

.. note::

The dumped **raw** code is sequence of pulse widths (durations in microseconds), positive for on-pulses (mark)
Expand Down
20 changes: 1 addition & 19 deletions components/remote_transmitter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. Useful when multiple
transmitters are connected to a single device.

ESP32 IDF configuration variables:
ESP32 configuration variables:
**********************************

- **rmt_symbols** (*Optional*, int): If ``use_dma`` is enabled, ``rmt_symbols`` represents the size of the driver's
Expand All @@ -62,24 +62,6 @@ ESP32 IDF configuration variables:
- **eot_level** (*Optional*, boolean): Overrides the default end of transmit level. Defaults to ``false`` unless ``pin``
is set to inverted or open-drain.

ESP32 Arduino configuration variables:
**************************************

- **rmt_channel** (*Optional*, int): The RMT channel to use. The following ESP32 variants have these channels available:

.. csv-table::
:header: "ESP32 Variant", "Channels"

"ESP32", "0, 1, 2, 3, 4, 5, 6, 7"
"ESP32-C3", "0, 1"
"ESP32-C6", "0, 1"
"ESP32-H2", "0, 1"
"ESP32-S2", "0, 1, 2, 3"
"ESP32-S3", "0, 1, 2, 3"

- **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``. Defaults to ``80``.

Automations:
------------

Expand Down