riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

drivers/ws281x: fix documentation

Browse Source 
extend ws281x documentation with usage for ESP32 and VT100

fix indendation
This commit is contained in:
mtreffers 2020-04-06 02:44:22 +02:00
parent 34e3861498
commit 1ca28b8181
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
drivers/include/ws281x.h
View File

@ -40,7 +40,7 @@
* ## ESP32 * ## ESP32
* *
* The ESP32 implementation is frequency independent, as frequencies above 80MHz * The ESP32 implementation is frequency independent, as frequencies above 80MHz
* are high enough to support big banging without assembly. * are high enough to support bit banging without assembly.
* *
* ## Native/VT100 * ## Native/VT100
* *
@ -48,12 +48,23 @@
* *
* ### Usage * ### Usage
* *
* Add the following to your `Makefile` to use the ATmega backend: * Add the following to your `Makefile` to use:
* *
* * the ATmega backend:
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Makefile * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Makefile
* USEMODULE += ws281x_atmega * USEMODULE += ws281x_atmega
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* *
* * the ESP32 backend:
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Makefile
* USEMODULE += ws281x_esp32
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* * the native/VT100 backend:
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Makefile
* USEMODULE += ws281x_vt100
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* @{ * @{
* *
* @file * @file