Skip to content

Commit 0c96460

Browse files
swoboda1337swoboda1337
authored
Improve rmt_symbols docs (#5143)
1 parent 31c0a99 commit 0c96460

File tree

3 files changed

+33
-32
lines changed

3 files changed

+33
-32
lines changed

‎components/light/esp32_rmt_led_strip.rst

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,21 +56,22 @@ Configuration variables
5656
sending commands as quickly as changes are made to the lights.
5757
- **use_psram** (*Optional*, boolean): Set to ``false`` to force internal RAM allocation even if you have the the PSRAM
5858
component enabled. This can be useful if you're experiencing issues like flickering with your leds strip. Defaults to ``true``.
59-
- **rmt_symbols** (*Optional*, int): The amount of RMT memory allocated to this component. Memory is shared by all
60-
receivers and transmitters. On variants other than ``ESP32`` and ``ESP32-S2`` only half the symbol memory is
61-
available to transmitters. Each symbol is 32 bits and contains two values.
59+
- **rmt_symbols** (*Optional*, int): When ``use_dma`` is enabled, this sets the size of the driver's internal DMA
60+
buffer. When DMA is disabled, it specifies how much RMT memory is allocated to the component. RMT memory is shared
61+
across all components and should be allocated in multiples of the block size. On the ``ESP32`` and ``ESP32-S2``
62+
variants, RMT memory is shared between RX and TX components. On other variants, RX and TX have dedicated RMT memory.
6263

6364
.. csv-table::
64-
:header: "ESP32 Variant", "Memory Size", "Block Size"
65+
:header: "ESP32 Variant", "Available Memory", "Block Size"
6566

6667
"ESP32", "512 symbols", "64 symbols"
67-
"ESP32-C3", "192 symbols", "48 symbols"
68-
"ESP32-C5", "192 symbols", "48 symbols"
69-
"ESP32-C6", "192 symbols", "48 symbols"
70-
"ESP32-H2", "192 symbols", "48 symbols"
71-
"ESP32-P4", "384 symbols", "48 symbols"
68+
"ESP32-C3", "96 symbols", "48 symbols"
69+
"ESP32-C5", "96 symbols", "48 symbols"
70+
"ESP32-C6", "96 symbols", "48 symbols"
71+
"ESP32-H2", "96 symbols", "48 symbols"
72+
"ESP32-P4", "192 symbols", "48 symbols"
7273
"ESP32-S2", "256 symbols", "64 symbols"
73-
"ESP32-S3", "384 symbols", "48 symbols"
74+
"ESP32-S3", "192 symbols", "48 symbols"
7475

7576
- **use_dma** (*Optional*, boolean): Enable DMA on variants that support it. If enabled ``rmt_symbols`` controls
7677
the DMA buffer size and can be set to a large value.

‎components/remote_receiver.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -87,22 +87,22 @@ Configuration variables:
8787
ESP32 configuration variables:
8888
**********************************
8989

90-
- **rmt_symbols** (*Optional*, int): If ``use_dma`` is enabled, ``rmt_symbols`` represents the size of the driver's
91-
internal DMA buffer. If DMA is not enabled, ``rmt_symbols`` determines the amount of RMT memory allocated to this
92-
component. Memory is shared by all receivers and transmitters. On variants other than ``ESP32`` and ``ESP32-S2``,
93-
only half of the symbol memory is available to receivers. Each symbol is 32 bits and contains two values.
90+
- **rmt_symbols** (*Optional*, int): When ``use_dma`` is enabled, this sets the size of the driver's internal DMA
91+
buffer. When DMA is disabled, it specifies how much RMT memory is allocated to the component. RMT memory is shared
92+
across all components and should be allocated in multiples of the block size. On the ``ESP32`` and ``ESP32-S2``
93+
variants, RMT memory is shared between RX and TX components. On other variants, RX and TX have dedicated RMT memory.
9494

9595
.. csv-table::
96-
:header: "ESP32 Variant", "Memory Size", "Block Size"
96+
:header: "ESP32 Variant", "Available Memory", "Block Size"
9797

9898
"ESP32", "512 symbols", "64 symbols"
99-
"ESP32-C3", "192 symbols", "48 symbols"
100-
"ESP32-C5", "192 symbols", "48 symbols"
101-
"ESP32-C6", "192 symbols", "48 symbols"
102-
"ESP32-H2", "192 symbols", "48 symbols"
103-
"ESP32-P4", "384 symbols", "48 symbols"
99+
"ESP32-C3", "96 symbols", "48 symbols"
100+
"ESP32-C5", "96 symbols", "48 symbols"
101+
"ESP32-C6", "96 symbols", "48 symbols"
102+
"ESP32-H2", "96 symbols", "48 symbols"
103+
"ESP32-P4", "192 symbols", "48 symbols"
104104
"ESP32-S2", "256 symbols", "64 symbols"
105-
"ESP32-S3", "384 symbols", "48 symbols"
105+
"ESP32-S3", "192 symbols", "48 symbols"
106106

107107
- **receive_symbols** (*Optional*, int): Maximum receive length in symbols. On some variants the maximum receive is
108108
limited to ``rmt_symbols``.

‎components/remote_transmitter.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,22 +41,22 @@ Configuration variables:
4141
ESP32 configuration variables:
4242
**********************************
4343

44-
- **rmt_symbols** (*Optional*, int): If ``use_dma`` is enabled, ``rmt_symbols`` represents the size of the driver's
45-
internal DMA buffer. If DMA is not enabled, ``rmt_symbols`` determines the amount of RMT memory allocated to this
46-
component. Memory is shared by all receivers and transmitters. On variants other than ``ESP32`` and ``ESP32-S2``,
47-
only half of the symbol memory is available to transmitters. Each symbol is 32 bits and contains two values.
44+
- **rmt_symbols** (*Optional*, int): When ``use_dma`` is enabled, this sets the size of the driver's internal DMA
45+
buffer. When DMA is disabled, it specifies how much RMT memory is allocated to the component. RMT memory is shared
46+
across all components and should be allocated in multiples of the block size. On the ``ESP32`` and ``ESP32-S2``
47+
variants, RMT memory is shared between RX and TX components. On other variants, RX and TX have dedicated RMT memory.
4848

4949
.. csv-table::
50-
:header: "ESP32 Variant", "Memory Size", "Block Size"
50+
:header: "ESP32 Variant", "Available Memory", "Block Size"
5151

5252
"ESP32", "512 symbols", "64 symbols"
53-
"ESP32-C3", "192 symbols", "48 symbols"
54-
"ESP32-C5", "192 symbols", "48 symbols"
55-
"ESP32-C6", "192 symbols", "48 symbols"
56-
"ESP32-H2", "192 symbols", "48 symbols"
57-
"ESP32-P4", "384 symbols", "48 symbols"
53+
"ESP32-C3", "96 symbols", "48 symbols"
54+
"ESP32-C5", "96 symbols", "48 symbols"
55+
"ESP32-C6", "96 symbols", "48 symbols"
56+
"ESP32-H2", "96 symbols", "48 symbols"
57+
"ESP32-P4", "192 symbols", "48 symbols"
5858
"ESP32-S2", "256 symbols", "64 symbols"
59-
"ESP32-S3", "384 symbols", "48 symbols"
59+
"ESP32-S3", "192 symbols", "48 symbols"
6060

6161
- **clock_resolution** (*Optional*, int): The clock resolution used by the RMT peripheral in Hz. Defaults to ``1000000``.
6262
- **use_dma** (*Optional*, boolean): Enable DMA on variants that support it. If enabled ``rmt_symbols`` controls

0 commit comments

Comments
 (0)