Skip to content

Commit 198a49c

Browse files
authored
feat(rmt): improved commentaries and code clarity
1 parent fdd3ac4 commit 198a49c

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

cores/esp32/esp32-hal-rmt.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ bool rmtWrite(int pin, rmt_data_t *data, size_t num_rmt_symbols, uint32_t timeou
124124
bool rmtWriteAsync(int pin, rmt_data_t *data, size_t num_rmt_symbols);
125125

126126
/**
127-
Writing data up to the reserved memsize, looping continuously (rmtWriteLooping) or fixed
128-
number of times (rmtWriteLoopingCount())
127+
Writing data up to the reserved memsize, looping continuously (rmtWriteLooping()) or fixed
128+
number of times (rmtWriteRepeated())
129129
130130
<rmt_symbol> is a 32 bits structure as defined by rmt_data_t type.
131131
It is possible to use the macro RMT_SYMBOLS_OF(data), if data is an array of rmt_data_t
@@ -135,10 +135,11 @@ bool rmtWriteAsync(int pin, rmt_data_t *data, size_t num_rmt_symbols);
135135
Non-Blocking mode - returns right after execution
136136
Returns <true> on execution success, <false> otherwise
137137
138-
<bool rmtTransmitCompleted(int pin)> will return always <true> while it is looping.
138+
<bool rmtTransmitCompleted(int pin)> will return always <true> while it is looping mode.
139+
looping mode is active for rmtWriteLooping() and for rmtWriteRepeated() when loop_count > 1.
139140
*/
140141
bool rmtWriteLooping(int pin, rmt_data_t *data, size_t num_rmt_symbols);
141-
bool rmtWriteLoopingCount(int pin, rmt_data_t *data, size_t num_rmt_symbols, uint32_t loop_count);
142+
bool rmtWriteRepeated(int pin, rmt_data_t *data, size_t num_rmt_symbols, uint32_t loop_count);
142143

143144
/**
144145
Checks if transmission is completed and the rmtChannel ready for transmitting new data.

0 commit comments

Comments
 (0)