ws281x_params.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2019 Marian Buschsieweke
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
19 #ifndef WS281X_PARAMS_H
20 #define WS281X_PARAMS_H
21 
22 #include "board.h"
23 #include "saul_reg.h"
24 
25 #include "ws281x.h"
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
35 #ifndef WS281X_PARAM_PIN
36 #define WS281X_PARAM_PIN (GPIO_PIN(0, 0))
37 #endif
38 #ifndef WS281X_PARAM_NUMOF
39 #define WS281X_PARAM_NUMOF (8U)
40 #endif
41 #ifndef WS281X_PARAM_BUF
45 extern uint8_t ws281x_buf[WS281X_PARAM_NUMOF * WS281X_BYTES_PER_DEVICE];
46 #define WS281X_PARAM_BUF (ws281x_buf)
47 #endif
48 
49 #ifndef WS281X_PARAMS
53 #define WS281X_PARAMS { \
54  .pin = WS281X_PARAM_PIN, \
55  .numof = WS281X_PARAM_NUMOF, \
56  .buf = WS281X_PARAM_BUF, \
57  }
58 #endif
64 static const ws281x_params_t ws281x_params[] =
65 {
66  WS281X_PARAMS
67 };
68 
88 #if !defined(WS281X_TIMER_DEV) || defined(DOXYGEN)
89 #define WS281X_TIMER_DEV TIMER_DEV(2)
90 #endif
91 
97 #ifndef WS281X_TIMER_MAX_VALUE
98 #define WS281X_TIMER_MAX_VALUE TIMER_2_MAX_VALUE
99 #endif
100 
106 #ifndef WS281X_TIMER_FREQ
107 #define WS281X_TIMER_FREQ 16000000
108 #endif
109 
113 #ifndef WS281X_SAUL_INFO
114 #define WS281X_SAUL_INFO { .name = "WS281X RGB LED" }
115 #endif
116 
120 static const saul_reg_info_t ws281x_saul_info[] =
121 {
122  WS281X_SAUL_INFO
123 };
124 
125 #ifdef __cplusplus
126 }
127 #endif
128 
129 #endif /* WS281X_PARAMS_H */
WS281X_BYTES_PER_DEVICE
#define WS281X_BYTES_PER_DEVICE
The number of bytes to allocate in the data buffer per LED.
Definition: ws281x.h:104
saul_reg.h
SAUL registry interface definition.
saul_reg_info_t
Additional data to collect for each entry.
Definition: saul_reg.h:49
ws281x_params_t
Struct to hold initialization parameters for a WS281x RGB LED.
Definition: ws281x.h:109
ws281x.h
WS2812/SK6812 RGB LED Driver.
WS281X_SAUL_INFO
#define WS281X_SAUL_INFO
SAUL info.
Definition: ws281x_params.h:114
ws281x_params
static const ws281x_params_t ws281x_params[]
Initialization parameters for WS281x devices.
Definition: ws281x_params.h:64
ws281x_saul_info
static const saul_reg_info_t ws281x_saul_info[]
Additional meta information to keep in the SAUL registry.
Definition: ws281x_params.h:120
WS281X_PARAM_NUMOF
#define WS281X_PARAM_NUMOF
Number of LEDs chained.
Definition: ws281x_params.h:39
ws281x_buf
uint8_t ws281x_buf[WS281X_PARAM_NUMOF *WS281X_BYTES_PER_DEVICE]
Data buffer holding the LED states.
WS281X_PARAMS
#define WS281X_PARAMS
WS281x initialization parameters.
Definition: ws281x_params.h:53