Skip to content

Commit 6688206

Browse files
committed
Merge branch 'current' into next
2 parents 060ce26 + 3bdbadb commit 6688206

File tree

4 files changed

+35
-35
lines changed

4 files changed

+35
-35
lines changed

components/light/esp32_rmt_led_strip.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ Only for Arduino platforms (and ESP-IDF <5 which was used until ESPHome 2025), t
2323
2424
light:
2525
- platform: esp32_rmt_led_strip
26-
rmt_channel: 0
2726
...
2827
2928
Configuration variables
@@ -56,21 +55,22 @@ Configuration variables
5655
sending commands as quickly as changes are made to the lights.
5756
- **use_psram** (*Optional*, boolean): Set to ``false`` to force internal RAM allocation even if you have the the PSRAM
5857
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.
58+
- **rmt_symbols** (*Optional*, int): When ``use_dma`` is enabled, this sets the size of the driver's internal DMA
59+
buffer. When DMA is disabled, it specifies how much RMT memory is allocated to the component. RMT memory is shared
60+
across all components and should be allocated in multiples of the block size. On the ``ESP32`` and ``ESP32-S2``
61+
variants, RMT memory is shared between RX and TX components. On other variants, RX and TX have dedicated RMT memory.
6262

6363
.. csv-table::
64-
:header: "ESP32 Variant", "Memory Size", "Block Size"
64+
:header: "ESP32 Variant", "Available Memory", "Block Size"
6565

6666
"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"
67+
"ESP32-C3", "96 symbols", "48 symbols"
68+
"ESP32-C5", "96 symbols", "48 symbols"
69+
"ESP32-C6", "96 symbols", "48 symbols"
70+
"ESP32-H2", "96 symbols", "48 symbols"
71+
"ESP32-P4", "192 symbols", "48 symbols"
7272
"ESP32-S2", "256 symbols", "64 symbols"
73-
"ESP32-S3", "384 symbols", "48 symbols"
73+
"ESP32-S3", "192 symbols", "48 symbols"
7474

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

components/remote_receiver.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -80,29 +80,29 @@ Configuration variables:
8080
- **filter** (*Optional*, :ref:`config-time`): Filter any pulses that are shorter than this. Useful for removing
8181
glitches from noisy signals. Allowed values are in range ``0`` to ``4294967295us``. Defaults to ``50us``.
8282
- **idle** (*Optional*, :ref:`config-time`): The amount of time that a signal should remain stable/unchanged for it to
83-
be considered complete. Allowed values are in range ``0`` to ``4294967295us``. Defaults to ``10ms``.
83+
be considered complete. The maximum value is ``65536us`` on ESP32, and ``4294967295us`` on other platforms. Defaults to ``10ms``.
8484
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. Useful when multiple
8585
receivers are configured on a single device.
8686

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

components/sx127x.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ LoRa configuration variables:
6161
packet size is fixed. If not configured explicit header mode is enabled and variable packet sizes can
6262
be used. Maximum length is 256. Must be greater than zero when using a ``spreading_factor`` of 6.
6363
- **crc_enable** (**Optional**, bool): Enables a payload CRC calculation/check.
64-
- **preamble_size** (**Optional**, int): Length of the preamble in symbols, minimum of 6. Defaults to 8.
64+
- **preamble_size** (**Required**, int): Length of the preamble in symbols, minimum of 6.
6565
- **spreading_factor** (**Optional**, int): Spreading factor, values range from 6 to 12. Defaults to 7.
6666
- **coding_rate** (**Optional**, enum): Coding rate, values can be ``CR_4_5``, ``CR_4_6``, ``CR_4_7``
6767
or ``CR_4_8``. Defaults to ``CR_4_5``.

0 commit comments

Comments
 (0)