nodemcu-firmware/docs/modules
Christoph Thelen 14cdff107f
Update rmt translator (#3629)
* Choose the number of RMT buffers in the ws2812 module.

The number of buffers required for optimal operation should be selected
by the ws2812 module, not the caller.

* Add parameters for RGB LED bit times.

This patch adds compatibility for different RGB LEDS besides the WS2812.
ESP evaluation boards like the ESP32-C3-DevKitM-1 use an SK68XXMINI-HS
RGB LED which does not respond to the timings of this module.
The patch adds optional parameters for the bit timings to the write
function. If the new parameters are not supplied, the old values are used.
An example for the SK68XXMINI-HS is provided in the documentation.

* Remove restrictions from RTM translator.

The old RMT translator was not able to split the bits of the source
data into the size requested by the RMT transmitter. Either all 8 bits
of an input byte were translated or none.
The new routine removes the restriction by delivering exactly the
requested amount of data to the transmitter, which results in a more
balanced buffering of translated data under load.

* Add a parameter for the RGB LED reset time.

This patch introduces a new optional parameter for the reset time
in the RGB LED communication. The default is 51.2 microseconds. A
value of 0 sends no reset signal, which allows a small optimisation
for consecutive write commands.

Please note that the reset time of the old code should be 50
microseconds, as the define WS2812_DURATION_RESET suggested. Due to the
restrictions of the old RMT translator routine, it was slightly
increased to 51.2 microseconds. This patch keeps the value of 51.2
microseconds to be as compatible as possible.

* Minimize the time drift between RMT channels.

Place all RMT channels in a group to minimize the time drift between
the signals. Please note that this feature is not available on all
platforms.

* Fix the description of the SK6812 LED in the example code.

The SK6812 expects the data for the green LED first, then red and
finally blue. It should be described as a GRB LED.
2024-02-07 17:56:17 -05:00
..
adc.md Initial migration to IDFv5.0 2024-01-30 11:34:03 +11:00
bit.md Make bit module handle 32/64bit integer configs. 2021-08-25 18:58:53 +10:00
bthci.md Fix bit, bthci, can, encoder, eth, i2s docs (#3432) 2021-05-19 21:02:49 +02:00
can.md Fix bit, bthci, can, encoder, eth, i2s docs (#3432) 2021-05-19 21:02:49 +02:00
crypto.md Improved crypto module for ESP32, now with HMAC (#2815) 2019-07-04 23:24:59 +02:00
dac.md Re-organize documentation 2019-01-13 21:30:28 +01:00
dht.md Re-organize documentation 2019-01-13 21:30:28 +01:00
encoder.md Fix bit, bthci, can, encoder, eth, i2s docs (#3432) 2021-05-19 21:02:49 +02:00
eromfs.md IDF web server module (#3502) 2022-03-05 13:51:54 +11:00
eth.md Initial migration to IDFv5.0 2024-01-30 11:34:03 +11:00
file.md Fix typo in `file.md` (#3566) 2023-01-17 16:44:59 +01:00
gpio.md Add node.sleep()(#3370) 2021-01-17 09:00:12 +01:00
heaptrace.md Added heaptrace module. 2021-09-16 13:54:55 +10:00
http.md Add http.put (#3462) 2021-10-05 13:33:27 +11:00
httpd.md IDF web server module (#3502) 2022-03-05 13:51:54 +11:00
i2c.md Fix adc, i2c, file, tmr docs (#3428) 2021-04-27 22:30:46 +02:00
i2s.md Code cleanup to sort out warnings. 2021-07-29 13:47:45 +10:00
ledc.md Fix ledc.md (#3557) 2022-11-10 20:49:16 -05:00
mqtt.md fix(mqtt): select next parameter in connect() 2024-01-30 11:34:03 +11:00
net.md idf4: overhaul to new build system, part 1 of 3 2021-07-15 16:27:03 +10:00
node.md Make node.output() RTOS thread safe. 2021-11-04 22:24:01 +11:00
otaupgrade.md Fix ledc, otaupgrade, pulsecnt, sdmmc, sjson, touch docs (#3436) 2021-05-23 16:29:01 +02:00
ow.md Re-organize documentation 2019-01-13 21:30:28 +01:00
pipe.md Pulled in the 5.1+5.3 docs from the esp8266 branch. 2021-08-22 19:25:39 +10:00
pulsecnt.md Fix ledc, otaupgrade, pulsecnt, sdmmc, sjson, touch docs (#3436) 2021-05-23 16:29:01 +02:00
qrcodegen.md Fix bit, bthci, can, encoder, eth, i2s docs (#3432) 2021-05-19 21:02:49 +02:00
rmt.md Add support for using multiple memory slots in rmt setup (#3568) 2024-02-01 20:31:56 -05:00
rtcmem.md Ported the rtcmem over to ESP32 (#3544) 2022-09-29 21:37:34 -04:00
sdmmc.md Initial migration to IDFv5.0 2024-01-30 11:34:03 +11:00
sigma-delta.md Fix bit, bthci, can, encoder, eth, i2s docs (#3432) 2021-05-19 21:02:49 +02:00
sjson.md Fix ledc, otaupgrade, pulsecnt, sdmmc, sjson, touch docs (#3436) 2021-05-23 16:29:01 +02:00
sodium.md Make sodium.random API behave consistently on all build types 2022-12-19 18:53:04 +11:00
spi.md Upgrade to IDF v5.0.2 2024-01-30 11:34:03 +11:00
struct.md Fix source reference 2019-01-16 23:31:18 +01:00
time.md Fix bit, bthci, can, encoder, eth, i2s docs (#3432) 2021-05-19 21:02:49 +02:00
tmr.md Implement tmr.wdclr() 2021-10-22 12:38:07 +11:00
touch.md Fix ledc, otaupgrade, pulsecnt, sdmmc, sjson, touch docs (#3436) 2021-05-23 16:29:01 +02:00
u8g2.md update to u8g2 2.25.10 2019-04-28 22:26:37 +02:00
uart.md Fix example pins in docs/modules/uart.md 2024-01-30 12:36:10 +11:00
ucg.md Re-organize documentation 2019-01-13 21:30:28 +01:00
wifi.md Prefer Lua booleans over 1/nil or 1/0 2023-02-09 15:52:38 +11:00
ws2812.md Update rmt translator (#3629) 2024-02-07 17:56:17 -05:00