Loading...
Searching...
No Matches
pca9633.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2020 Freie Universität Berlin
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
20#ifndef PCA9633_H
21#define PCA9633_H
22
23#ifdef __cplusplus
24extern "C"
25{
26#endif
27
28#include "stdbool.h"
29#include "periph/i2c.h"
30
31#include "pca9633_regs.h"
32
36#define PCA9633_BLINKING_PERIOD_MAX_MS (10625)
37
43#define PCA9633_BLINKING_RATIO_BALANCED 128
44
48typedef struct {
50 uint16_t i2c_addr;
52 uint8_t reg_pwm_red;
53 uint8_t reg_pwm_green;
54 uint8_t reg_pwm_blue;
55 uint8_t reg_pwm_amber;
59
67
71enum {
74};
75
85
115
151
166
182int pca9633_init(pca9633_t *dev, const pca9633_params_t *params);
183
194
206
213
220
229 pca9633_pwm_channel_t pwm_channel, uint8_t pwm);
230
237void pca9633_set_grp_pwm(pca9633_t* dev, uint8_t pwm);
238
253void pca9633_set_blinking(pca9633_t* dev, uint16_t blink_period_ms,
254 uint8_t on_off_ratio);
255
264void pca9633_set_rgb(pca9633_t* dev, uint8_t r, uint8_t g, uint8_t b);
265
275void pca9633_set_rgba(pca9633_t* dev, uint8_t r, uint8_t g, uint8_t b, uint8_t w);
276
291 pca9633_pwm_channel_t pwm_channel);
292
305
319
331
332#ifdef __cplusplus
333}
334#endif
335
336#endif /* PCA9633_H */
void pca9633_set_ldr_state_all(pca9633_t *dev, pca9633_ldr_state_t state)
Set the LED driver output state for all channels.
void pca9633_turn_off(pca9633_t *dev)
Turn off all LEDs.
void pca9633_set_auto_increment(pca9633_t *dev, pca9633_auto_inc_option_t option)
Set an option for auto increment.
void pca9633_sleep(pca9633_t *dev)
Switch to low power mode.
pca9633_ldr_state_t
LED driver output state, LEDOUT (page 14, below table 13)
Definition pca9633.h:89
void pca9633_set_pwm(pca9633_t *dev, pca9633_pwm_channel_t pwm_channel, uint8_t pwm)
Set individual PWM signal for a given channel.
void pca9633_set_blinking(pca9633_t *dev, uint16_t blink_period_ms, uint8_t on_off_ratio)
Set up values for blinking mode.
void pca9633_set_group_control_mode(pca9633_t *dev, pca9633_group_control_mode_t mode)
Set the group control mode.
void pca9633_set_grp_pwm(pca9633_t *dev, uint8_t pwm)
Set global PWM signal.
void pca9633_set_rgba(pca9633_t *dev, uint8_t r, uint8_t g, uint8_t b, uint8_t w)
Set PWM values for RGBA.
pca9633_auto_inc_option_t
Auto-Increment options (page 10, table 6)
Definition pca9633.h:119
void pca9633_set_ldr_state(pca9633_t *dev, pca9633_ldr_state_t state, pca9633_pwm_channel_t pwm_channel)
Set the LED driver output state for a given channel.
pca9633_pwm_channel_t
PCA9633 PWM channel definitions.
Definition pca9633.h:79
void pca9633_set_rgb(pca9633_t *dev, uint8_t r, uint8_t g, uint8_t b)
Set PWM values for RGB.
pca9633_group_control_mode_t
PCA9633 group control modes.
Definition pca9633.h:155
int pca9633_init(pca9633_t *dev, const pca9633_params_t *params)
Initialization.
void pca9633_wakeup(pca9633_t *dev)
Switch to normal mode.
void pca9633_turn_on(pca9633_t *dev)
Turn on all LEDs.
@ PCA9633_LDR_STATE_IND_GRP
LED driver x individual brightness and group dimming/ blinking can be controlled through its PWMx reg...
Definition pca9633.h:113
@ PCA9633_LDR_STATE_ON
LED driver x is fully on (individual brightness and group dimming/ blinking not controlled)
Definition pca9633.h:99
@ PCA9633_LDR_STATE_IND
LED driver x individual brightness can be controlled through its PWMx register.
Definition pca9633.h:105
@ PCA9633_LDR_STATE_OFF
LED driver x is off.
Definition pca9633.h:93
@ PCA9633_AI_IND
Auto-Increment for individual brightness registers only.
Definition pca9633.h:136
@ PCA9633_AI_ALL
Auto-Increment for all registers.
Definition pca9633.h:129
@ PCA9633_AI_GBL
Auto-Increment for global control registers only.
Definition pca9633.h:142
@ PCA9633_AI_DISABLED
No Auto-Increment.
Definition pca9633.h:123
@ PCA9633_AI_IND_GBL
Auto-Increment for individual and global control registers only.
Definition pca9633.h:149
@ PCA9633_PWM_CHANNEL_1
PWM channel 1.
Definition pca9633.h:81
@ PCA9633_PWM_CHANNEL_3
PWM channel 3.
Definition pca9633.h:83
@ PCA9633_PWM_CHANNEL_2
PWM channel 2.
Definition pca9633.h:82
@ PCA9633_PWM_CHANNEL_0
PWM channel 0.
Definition pca9633.h:80
@ PCA9633_OK
Success.
Definition pca9633.h:72
@ PCA9633_ERROR_I2C
I2C communication error.
Definition pca9633.h:73
@ PCA9633_GROUP_CONTROL_MODE_DIMMING
Control mode for dimming.
Definition pca9633.h:164
@ PCA9633_GROUP_CONTROL_MODE_BLINKING
Control mode for blinking.
Definition pca9633.h:159
uint_fast8_t i2c_t
Default i2c_t type definition.
Definition i2c.h:151
Low-level I2C peripheral driver interface definition.
Register definitions for the PCA9633 I2C PWM controller.
#define PCA9633_REG_PWM0
Brightness control LED0.
#define PCA9633_REG_PWM2
Brightness control LED2.
#define PCA9633_REG_PWM1
Brightness control LED1.
#define PCA9633_REG_PWM3
Brightness control LED3.
PCA9633 device initialization parameters.
Definition pca9633.h:48
uint8_t reg_pwm_blue
Register for blue color.
Definition pca9633.h:54
uint8_t reg_pwm_green
Register for green color.
Definition pca9633.h:53
uint8_t reg_pwm_amber
Register for amber color.
Definition pca9633.h:55
i2c_t i2c_dev
I2C device.
Definition pca9633.h:49
uint8_t reg_pwm_red
Register for red color.
Definition pca9633.h:52
uint16_t i2c_addr
I2C address of device.
Definition pca9633.h:50
bool has_amber_channel
Whether PCA9633 has fourth channel.
Definition pca9633.h:57
PCA9633 PWM device data structure type.
Definition pca9633.h:63
uint8_t stored_reg_ledout
Stored register content of LEDOUT.
Definition pca9633.h:65
pca9633_params_t params
Device initialization parameters.
Definition pca9633.h:64