Skip to content
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.

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

[esp32_rmt_led_strip] Add use_psram to the docs #4579

Closed
wants to merge 3 commits into from
Closed
Changes from 1 commit
Commits
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
Next Next commit
Add use_psram to the docs
  • Loading branch information
Jonathan Swoboda committed Jan 12, 2025
commit 1c18839472a9e308a47a20b91a2514bec103daed
7 changes: 7 additions & 0 deletions components/light/esp32_rmt_led_strip.rst
Original file line number Diff line number Diff line change
@@ -46,6 +46,7 @@ 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): Will allocate the memory from PSRAM instead of DRAM. Defaults to ``true``.

IDF configuration variables:
****************************
@@ -79,6 +80,12 @@ Arduino configuration variables:

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

.. note::

When **use_psram** is configured using IDF all RMT interrupts will be deferred, including RMT interrupts for other
components. RMT transactions rely on ping-pong interrupts, delayed handling can lead to an unpredictable result.
It is recommended to configure allocate the maximum RMT memory possible.

.. _esp32-rmt-led-strip-manual_timings:

Manual Timings