transferred ws2801 module documentation
This commit is contained in:
parent
75580f5dda
commit
36522d59a5
|
@ -0,0 +1,37 @@
|
||||||
|
# WS2801 Module
|
||||||
|
|
||||||
|
## ws2801.init()
|
||||||
|
Initializes the module and sets the pin configuration.
|
||||||
|
|
||||||
|
#### Syntax
|
||||||
|
`ws2801.init(pin_clk, pin_data)`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
- `pin_clk` pin for the clock. Supported are GPIO 0, 2, 4, 5.
|
||||||
|
- `pin_data` pin for the data. Supported are GPIO 0, 2, 4, 5.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
`nil`
|
||||||
|
|
||||||
|
## ws2801.write()
|
||||||
|
Sends a string of RGB Data in 24 bits to WS2801. Don't forget to call `ws2801.init()` before.
|
||||||
|
|
||||||
|
#### Syntax
|
||||||
|
`ws2801.write(string)`
|
||||||
|
|
||||||
|
####Parameters
|
||||||
|
- `string` payload to be sent to one or more WS2801.
|
||||||
|
It should be composed from an RGB triplet per element.
|
||||||
|
- `R1` the first pixel's red channel value (0-255)
|
||||||
|
- `G1` the first pixel's green channel value (0-255)
|
||||||
|
- `B1` the first pixel's blue channel value (0-255)
|
||||||
|
... You can connect a lot of WS2801...
|
||||||
|
- `R2`, `G2`, `B2` are the next WS2801's Red, Green, and Blue channel values
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
`nil`
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
```lua
|
||||||
|
ws2801.write(string.char(255,0,0, 0,255,0, 0,0,255))
|
||||||
|
```
|
|
@ -51,6 +51,7 @@ pages:
|
||||||
- 'u8g': 'en/modules/u8g.md'
|
- 'u8g': 'en/modules/u8g.md'
|
||||||
- 'uart': 'en/modules/uart.md'
|
- 'uart': 'en/modules/uart.md'
|
||||||
- 'ucg': 'en/modules/ucg.md'
|
- 'ucg': 'en/modules/ucg.md'
|
||||||
|
- 'ws2801': 'en/modules/ws2801'
|
||||||
- 'ws2812': 'en/modules/ws2812'
|
- 'ws2812': 'en/modules/ws2812'
|
||||||
- Deutsch:
|
- Deutsch:
|
||||||
- Home: 'de/index.md'
|
- Home: 'de/index.md'
|
||||||
|
|
Loading…
Reference in New Issue