1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Go to file
bors[bot] 198aadfc0a
Merge #19424
19424: drivers/ws281x: add RMT hardware support for ESP32x SoCs r=maribu a=gschorcht

### Contribution description

This PR provides support for ESP32x RMT that is used to generate WS2812B signals.

All ESP32x SoCs have a [Remote Control Peripheral (RMT)](https://docs.espressif.com/projects/esp-idf/en/v4.4.4/esp32/api-reference/peripherals/rmt.html) that can be used to generate digital waveforms, such as NEC remote control signals or WS2812B RGB LED signals. Each RMT peripheral has either 4 or 8 channels. Some ESP32x SoCs support configuring the clock sources used for each channel separately, while other ESP32x SoCs can only use a single clock source for all channels.

The advantages using the RMT are that the CPU is not busy when generating the WS218x signal and the phase times are accurate to nanoseconds. The disadvantage is that the configuration of the RMT is so complex due to its flexibility that the [ESP-IDF high-level driver for RMT](https://docs.espressif.com/projects/esp-idf/en/v4.4.4/esp32c3/api-reference/peripherals/rmt.html) is used.This requires about 6 kBytes more ROM, about 3 kBytes more IRAM, and 88 bytes more RAM.

Therefore, either the RMT hardware implementation (module `ws2812x_esp32_hw`) as well as the bit-banging software implementation  (module  `ws2812x_esp32_hw`) can be used. RMT hardware implementation (module `ws2812x_esp32_hw`) is used by default.

Timing with hardware implementation:
![ws281x_esp32_rmt](https://user-images.githubusercontent.com/31932013/227791452-5cc1f95e-04ac-43bb-b11c-f131ab7ab1d5.png)

### Testing procedure

`tests/driver_ws281x` should still work, for example:
```
CFLAGS='-DWS281X_PARAM_PIN=GPIO45 -DWS281X_PARAM_NUMOF=47' BOARD=esp32s3-devkit make -j8 -C tests/driver_ws281x flash
```
Test Output:
https://user-images.githubusercontent.com/31932013/227791753-e6d2924e-3364-4387-870f-a56d3a9a8a80.mp4


### Issues/PRs references


Co-authored-by: Gunar Schorcht <gunar@schorcht.net>
2023-03-29 07:42:28 +00:00
.cargo rust: Update dependencies, use riot-wrappers from git 2023-01-24 20:12:58 +01:00
.github .github: Test compile_like_murdock.py 2023-03-24 13:21:30 +01:00
.vscode .vscode/settings.json: import initial RIOT-OS style 2022-11-21 21:31:12 +01:00
boards boards/common/esp32x: add RMT configuration 2023-03-29 00:47:35 +02:00
bootloaders bootloaders: fix bootloader button logic 2023-03-08 13:07:42 +01:00
core core/thread: Fix up stack and TLS alignments 2023-03-04 01:18:36 -08:00
cpu cpu/esp32: add RMT configuration type 2023-03-29 00:47:35 +02:00
dist tools/compile_like_murdock: Add simple test 2023-03-24 13:21:30 +01:00
doc boards/nucleo64: Add pinout diagrams from UM1724 2023-03-17 15:16:31 +01:00
drivers drivers/ws281x: add ESP32x hardware support 2023-03-29 00:47:35 +02:00
examples Merge #19302 2023-03-10 02:22:17 +00:00
fuzzing fuzzing: Add uri_parser fuzzer setup 2022-12-19 13:03:45 +01:00
kconfigs kcfonfigs: introduce feture HAS_PERIPH_USBDEV_HS 2023-03-07 11:26:17 +01:00
makefiles Merge #19374 2023-03-10 14:32:59 +00:00
pkg pkg/nanors: bump version 2023-03-13 11:49:39 +01:00
sys sys/cpp11-compat: Use ztimer64_usec instead of xtimer 2023-03-24 12:36:45 +01:00
tests tests/driver_ws281x: add ESP32x CI boards to test ws281x_esp32_sw 2023-03-29 08:57:36 +02:00
.bandit codacy: disable complaining about python assert 2019-03-01 13:43:37 +01:00
.gitattributes rust: Treat Cargo.lock files as opaque 2021-12-14 13:27:42 +01:00
.gitignore .gitignore: ignore all files within .vscode/ except user's settings 2022-11-21 21:30:28 +01:00
.mailmap mailmap: deduplicate @benpicco 2020-04-28 11:58:44 +02:00
.murdock CI: .murdock: use build checkout for ccache tmp 2023-02-14 10:32:13 +01:00
.murdock.yml CI: use regex for branches in .murdock.yml 2022-12-07 12:53:40 +01:00
bors.toml bors.yaml: re-activate labels check + add block_labels 2023-02-23 15:49:46 +01:00
CITATION.cff CITATION.cff: Initial import 2021-10-22 10:21:57 +02:00
CODE_OF_CONDUCT.md github: add Code of Conduct 2017-12-08 09:10:01 +01:00
CODEOWNERS tests: provide tests for libschc 2023-03-02 11:31:07 +01:00
CODING_CONVENTIONS_C++.md CODING_CONVENTIONS_C++.md: Change space after negation 2021-10-28 10:49:51 +02:00
CODING_CONVENTIONS.md Coding_Convention: clarify: none return is allowed 2021-03-08 14:46:34 +01:00
CONTRIBUTING.md CONTRIBUTING: Remove Freenode reference 2021-06-18 11:11:27 +02:00
doc.txt doc: Link concrete measures from DEVELHELP documentation 2022-01-27 13:49:25 +01:00
Kconfig Kconfig: load application configuration first 2022-04-27 10:31:23 +02:00
LICENSE LICENSE: Fix github badge 2022-08-23 09:46:56 +02:00
LOSTANDFOUND.md LOSTANDFOUND.md: Update with cpu/mips* 2022-09-27 13:43:03 +02:00
MAINTAINING.md MAINTAINING.md: add some notes on Bors 2023-02-27 17:28:16 +01:00
Makefile make: Remove mailing list advertisement 2021-05-12 11:41:25 +02:00
Makefile.base buildsystem/pkg: expand paths early 2022-01-30 19:58:52 +01:00
Makefile.dep Merge #17612 #19332 2023-02-28 02:46:35 +00:00
Makefile.features Makefile.features: output board on error 2023-02-27 22:56:34 +01:00
Makefile.include Make: rename create-Makefile.ci to generate-Makefile.ci 2023-02-04 16:51:36 +01:00
README.md README.md: update CI badge 2022-11-14 14:28:28 +01:00
release-notes.txt release-notes.txt: add 2023.01 release notes 2023-01-31 16:15:41 +01:00
SECURITY.md SECURITY: Describe that declassification is an option 2023-01-15 16:22:32 +01:00
SUBSYSTEMS.md SUBSYSTEMS.md: add myself to relevant parts 2023-02-28 22:08:32 +01:00
uncrustify-riot.cfg uncrustify-riot.cfg: update to coding convention 2021-03-04 17:23:46 +01:00
Vagrantfile tools/packer: adapt for Ubuntu 18.04 2020-02-19 19:23:07 +01:00

Nightly CI status master Nightly HiL CI overview GitHub release License API docs Wiki Stack Overflow questions Twitter Matrix

The friendly Operating System for IoT!

RIOT is a real-time multi-threading operating system that supports a range of devices that are typically found in the Internet of Things (IoT): 8-bit, 16-bit and 32-bit microcontrollers.

RIOT is based on the following design principles: energy-efficiency, real-time capabilities, small memory footprint, modularity, and uniform API access, independent of the underlying hardware (this API offers partial POSIX compliance).

RIOT is developed by an international open source community which is independent of specific vendors (e.g. similarly to the Linux community). RIOT is licensed with LGPLv2.1, a copyleft license which fosters indirect business models around the free open-source software platform provided by RIOT, e.g. it is possible to link closed-source code with the LGPL code.

FEATURES

RIOT provides features including, but not limited to:

  • a preemptive, tickless scheduler with priorities
  • flexible memory management
  • high resolution, long-term timers
  • MTD abstraction layer
  • File System integration
  • support 200+ boards based on AVR, MSP430, ESP8266, ESP32, RISC-V, ARM7 and ARM Cortex-M
  • the native port allows to run RIOT as-is on Linux and BSD. Multiple instances of RIOT running on a single machine can also be interconnected via a simple virtual Ethernet bridge or via a simulated IEEE 802.15.4 network (ZEP)
  • IPv6
  • 6LoWPAN (RFC4944, RFC6282, and RFC6775)
  • UDP
  • RPL (storing mode, P2P mode)
  • CoAP
  • OTA updates via SUIT
  • MQTT
  • USB (device mode)
  • Display / Touchscreen support
  • CCN-Lite
  • LoRaWAN
  • UWB
  • Bluetooth (BLE) via NimBLE

GETTING RIOT

The most convenient way to get RIOT is to clone it via Git

$ git clone https://github.com/RIOT-OS/RIOT

this will ensure that you get all the newest features and bug fixes with the caveat of an ever changing work environment.

If you prefer things more stable, you can download the source code of one of our quarter annual releases via Github as ZIP file or tarball. You can also checkout a release in a cloned Git repository using

$ git pull --tags
$ git checkout <YYYY.MM>

For more details on our release cycle, check our documentation.

GETTING STARTED

  • You want to start the RIOT? Just follow our quickstart guide or try this tutorial. For specific toolchain installation, follow instructions in the getting started page.
  • The RIOT API itself can be built from the code using doxygen. The latest version of the documentation is uploaded daily to doc.riot-os.org.

FORUM

Do you have a question, want to discuss a new feature, or just want to present your latest project using RIOT? Come over to our forum and post to your hearts content.

CONTRIBUTE

To contribute something to RIOT, please refer to our contributing document.

MAILING LISTS

LICENSE

  • Most of the code developed by the RIOT community is licensed under the GNU Lesser General Public License (LGPL) version 2.1 as published by the Free Software Foundation.
  • Some external sources, especially files developed by SICS are published under a separate license.

All code files contain licensing information.

For more information, see the RIOT website:

https://www.riot-os.org