@@ -54,22 +54,22 @@ Initializes an RMT channel for a specific GPIO pin with the specified direction,
5454
5555 * ``pin `` - GPIO pin number to use for RMT
5656* ``channel_direction `` - Channel direction:
57-
57+
5858 * ``RMT_RX_MODE `` - Receive mode (for reading signals)
5959 * ``RMT_TX_MODE `` - Transmit mode (for sending signals)
6060
6161* ``memsize `` - Number of memory blocks to reserve for this channel:
62-
62+
6363 * ``RMT_MEM_NUM_BLOCKS_1 `` - 1 block
6464 * ``RMT_MEM_NUM_BLOCKS_2 `` - 2 blocks
6565 * ``RMT_MEM_NUM_BLOCKS_3 `` - 3 blocks (ESP32 only)
6666 * ``RMT_MEM_NUM_BLOCKS_4 `` - 4 blocks (ESP32 only)
6767 * ``RMT_MEM_NUM_BLOCKS_5 `` through ``RMT_MEM_NUM_BLOCKS_8 `` - 5-8 blocks (ESP32 only)
6868
6969* ``frequency_Hz `` - RMT channel frequency in Hz (tick frequency). Must be between 312.5 kHz and 80 MHz.
70-
70+
7171 The frequency determines the resolution of pulse durations. For example:
72-
72+
7373 * 10 MHz (100 ns tick) - High precision, suitable for WS2812 LEDs
7474 * 1 MHz (1 µs tick) - Good for most IR protocols
7575 * 400 kHz (2.5 µs tick) - Suitable for slower protocols
@@ -103,7 +103,7 @@ This function affects how ``rmtWrite()``, ``rmtWriteAsync()``, or ``rmtWriteLoop
103103
104104 * ``pin `` - GPIO pin number configured for RMT TX mode
105105* ``EOT_Level `` - End of transmission level:
106-
106+
107107 * ``0 `` (LOW) - Pin will be set to LOW after transmission (default)
108108 * Non-zero (HIGH) - Pin will be set to HIGH after transmission
109109
@@ -137,7 +137,7 @@ This function returns ``true`` if transmission is successful, ``false`` on error
137137 {8, 1, 4, 0}, // High for 8 ticks, Low for 4 ticks (bit '1')
138138 {4, 1, 8, 0} // High for 4 ticks, Low for 8 ticks (bit '0')
139139 };
140-
140+
141141 rmtWrite(pin, symbols, 2, RMT_WAIT_FOR_EVER);
142142
143143 rmtWriteAsync
@@ -192,7 +192,7 @@ Sends RMT data a fixed number of times (repeated transmission).
192192* ``num_rmt_symbols `` - Number of RMT symbols to transmit
193193* ``loop_count `` - Number of times to repeat the transmission (must be at least 1)
194194
195- **Note: **
195+ **Note: **
196196* ``loop_count == 0 `` is invalid (no transmission)
197197* ``loop_count == 1 `` transmits once (no looping)
198198* ``loop_count > 1 `` transmits the data repeatedly
@@ -214,7 +214,7 @@ Checks if the RMT transmission is completed and the channel is ready for transmi
214214
215215This function returns ``true `` when all data has been sent and the channel is ready for a new transmission, ``false `` otherwise.
216216
217- **Note: **
217+ **Note: **
218218* If ``rmtWrite() `` times out or ``rmtWriteAsync() `` is called, this function will return ``false `` until all data is sent out.
219219* ``rmtTransmitCompleted() `` will always return ``true `` when ``rmtWriteLooping() `` is active, because it has no effect in such case.
220220
@@ -229,10 +229,10 @@ Initiates blocking receive operation. Reads RMT data and stores it in the provid
229229
230230 * ``pin `` - GPIO pin number configured for RMT RX mode
231231* ``data `` - Pointer to buffer where received RMT symbols will be stored
232- * ``num_rmt_symbols `` - Pointer to variable containing maximum number of symbols to read.
233-
232+ * ``num_rmt_symbols `` - Pointer to variable containing maximum number of symbols to read.
233+
234234 On return, this variable will contain the actual number of symbols read.
235-
235+
236236* ``timeout_ms `` - Timeout in milliseconds. Use ``RMT_WAIT_FOR_EVER `` for indefinite wait
237237
238238**Blocking mode: ** The function waits until data is received or timeout occurs.
@@ -253,7 +253,7 @@ Initiates non-blocking (asynchronous) receive operation. Returns immediately aft
253253 * ``pin `` - GPIO pin number configured for RMT RX mode
254254* ``data `` - Pointer to buffer where received RMT symbols will be stored
255255* ``num_rmt_symbols `` - Pointer to variable containing maximum number of symbols to read.
256-
256+
257257 On completion, this variable will be updated with the actual number of symbols read.
258258
259259**Non-blocking mode: ** Returns immediately after execution. Use ``rmtReceiveCompleted() `` to check if data is available.
@@ -287,7 +287,7 @@ Sets carrier frequency modulation/demodulation for RMT TX or RX channel.
287287 * ``pin `` - GPIO pin number configured for RMT
288288* ``carrier_en `` - Enable/disable carrier modulation (TX) or demodulation (RX)
289289* ``carrier_level `` - Carrier polarity level:
290-
290+
291291 * ``true `` - Positive polarity (active high)
292292 * ``false `` - Negative polarity (active low)
293293
@@ -311,7 +311,7 @@ Sets the minimum pulse width filter threshold for RX channel. Pulses smaller tha
311311
312312 * ``pin `` - GPIO pin number configured for RMT RX mode
313313* ``filter_pulse_ticks `` - Minimum pulse width in RMT ticks. Pulses (high or low) smaller than this will be filtered out.
314-
314+
315315 Set to ``0 `` to disable the filter.
316316
317317**Note: ** The filter threshold is specified in RMT ticks, which depends on the RMT frequency set during ``rmtInit() ``.
@@ -329,7 +329,7 @@ Sets the maximum idle threshold for RX channel. When no edge is detected for lon
329329
330330 * ``pin `` - GPIO pin number configured for RMT RX mode
331331* ``idle_thres_ticks `` - Maximum idle time in RMT ticks. When no edge is detected for longer than this time, reception ends.
332-
332+
333333 This threshold also defines how many low/high bits are read at the end of the received data.
334334
335335**Note: ** The idle threshold is specified in RMT ticks, which depends on the RMT frequency set during ``rmtInit() ``.
@@ -371,7 +371,7 @@ Each RMT symbol contains two pulses:
371371 .duration1 = 4,
372372 .level1 = 0
373373 };
374-
374+
375375 // Or using struct initialization
376376 rmt_data_t symbol2 = {8, 1, 4, 0};
377377
@@ -395,7 +395,7 @@ Helper macro to calculate the number of RMT symbols in an array.
395395 {8, 1, 4, 0},
396396 {4, 1, 8, 0}
397397 };
398-
398+
399399 size_t num_symbols = RMT_SYMBOLS_OF(data); // Returns 2
400400
401401 RMT_WAIT_FOR_EVER
0 commit comments