Default configuration for WS2812/SK6812 RGB LEDs. More...
Detailed Description
Default configuration for WS2812/SK6812 RGB LEDs.
Definition in file ws281x_params.h.
Include dependency graph for ws281x_params.h:Go to the source code of this file.
Macros | |
| #define | WS281X_TIMER_DEV TIMER_DEV(2) |
| Timer used for WS281x (by the timer_gpio_ll implementation) More... | |
| #define | WS281X_TIMER_MAX_VALUE TIMER_2_MAX_VALUE |
| Maximum value of the timer used for WS281x (by the timer_gpio_ll implementation) More... | |
| #define | WS281X_TIMER_FREQ 16000000 |
| Frequency for the timer used for WS281x (by the timer_gpio_ll implementation) More... | |
| #define | WS281X_SAUL_INFO { .name = "WS281X RGB LED" } |
| SAUL info. | |
Variables | |
| static const ws281x_params_t | ws281x_params [] |
| Initialization parameters for WS281x devices. More... | |
| static const saul_reg_info_t | ws281x_saul_info [] |
| Additional meta information to keep in the SAUL registry. More... | |
Default configuration parameters for WS281x RGB LEDs | |
| #define | WS281X_PARAM_PIN (GPIO_PIN(0, 0)) |
| GPIO pin connected to the data pin of the first LED. | |
| #define | WS281X_PARAM_NUMOF (8U) |
| Number of LEDs chained. | |
| #define | WS281X_PARAM_BUF (ws281x_buf) |
| Data buffer holding LED states. | |
| #define | WS281X_PARAMS |
| WS281x initialization parameters. More... | |
| uint8_t | ws281x_buf [WS281X_PARAM_NUMOF *WS281X_BYTES_PER_DEVICE] |
| Data buffer holding the LED states. | |
Macro Definition Documentation
◆ WS281X_PARAMS
| #define WS281X_PARAMS |
WS281x initialization parameters.
Definition at line 52 of file ws281x_params.h.
◆ WS281X_TIMER_DEV
| #define WS281X_TIMER_DEV TIMER_DEV(2) |
Timer used for WS281x (by the timer_gpio_ll implementation)
A single timer is configured for any number of WS281x strands, so this does not need to be part of params.
It is required that the timer has at least 2 channels. (Future versions may require a 3rd channel).
It is required that the timer's MAX_VALUE is 2^n-1, which is a trivial but not explicitly stated case.
This timer is configured at WS281x initialization time, and kept stopped outside of transmissions.
The default value of 2 is chosen because the only platform on which the module is usable is nRF5x, where TIMER_DEV(1) is in use by the radio module. It is strongly advised to explicitly set this timer to a known free timer, as the default may change without notice.
Definition at line 88 of file ws281x_params.h.
◆ WS281X_TIMER_FREQ
| #define WS281X_TIMER_FREQ 16000000 |
Frequency for the timer used for WS281x (by the timer_gpio_ll implementation)
This should be set to a frequency that is a close multiple of 3MHz, depending on the precise low and high times. A value of 16MHz works well.
Definition at line 106 of file ws281x_params.h.
◆ WS281X_TIMER_MAX_VALUE
| #define WS281X_TIMER_MAX_VALUE TIMER_2_MAX_VALUE |
Maximum value of the timer used for WS281x (by the timer_gpio_ll implementation)
This macro needs to be defined to the TIMER_x_MAX_VALUE corresponding to the TIMER_DEV(x) in WS281X_TIMER_DEV.
Definition at line 97 of file ws281x_params.h.
Variable Documentation
◆ ws281x_params
|
static |
Initialization parameters for WS281x devices.
Definition at line 63 of file ws281x_params.h.
◆ ws281x_saul_info
|
static |
Additional meta information to keep in the SAUL registry.
Definition at line 119 of file ws281x_params.h.
