apa102.h
1.59 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/*
* Copyright (C) 2017 Freie Universität Berlin
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup drivers_apa102 APA102 RGB LED
* @ingroup drivers_actuators
* @brief Driver for chained APA102 RGB LEDs
* @{
*
* @file
* @brief Interface for controlling APA102 LEDs
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/
#ifndef APA102_H
#define APA102_H
#include "color.h"
#include "periph/gpio.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Configuration parameters for (chained) APA102 LEDs
*/
typedef struct {
int led_numof; /**< number of chained LEDs */
gpio_t data_pin; /**< data pin */
gpio_t clk_pin; /**< clock pin */
} apa102_params_t;
/**
* @brief Device descriptor definition for APA102 LEDs
*/
typedef apa102_params_t apa102_t;
/**
* @brief Initialize (chained) APA102 LEDs
*
* @param[out] dev device descriptor
* @param[in] params device configuration
*
* @pre @p dev != NULL
* @pre @p params != NULL
*/
void apa102_init(apa102_t *dev, const apa102_params_t *params);
/**
* @brief Apply the given color values to the connected LED(s)
*
* @param[in] dev device descriptor
* @param[in] vals color values, MUST be of size `dev->led_numof`
*
* @pre @p dev != NULL
* @pre @p vals != NULL
*/
void apa102_load_rgba(const apa102_t *dev, const color_rgba_t vals[]);
#ifdef __cplusplus
}
#endif
#endif /* APA102_H */
/** @} */