pca9633.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020 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.
 */
 
#ifndef PCA9633_H
#define PCA9633_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include "stdbool.h"
#include "periph/i2c.h"
 
#include "pca9633_regs.h"
 
#define PCA9633_BLINKING_PERIOD_MAX_MS  (10625)
 
#define PCA9633_BLINKING_RATIO_BALANCED 128
 
typedef struct {
    i2c_t i2c_dev;              
    uint16_t i2c_addr;          
    uint8_t reg_pwm_red;        
    uint8_t reg_pwm_green;      
    uint8_t reg_pwm_blue;       
    uint8_t reg_pwm_amber;      
    bool has_amber_channel;      
} pca9633_params_t;
 
typedef struct {
    pca9633_params_t params;     
    uint8_t stored_reg_ledout;   
} pca9633_t;
 
enum {
    PCA9633_OK              = 0,    
    PCA9633_ERROR_I2C       = 1,    
};
 
typedef enum {
    PCA9633_PWM_CHANNEL_0 = PCA9633_REG_PWM0,   
    PCA9633_PWM_CHANNEL_1 = PCA9633_REG_PWM1,   
    PCA9633_PWM_CHANNEL_2 = PCA9633_REG_PWM2,   
    PCA9633_PWM_CHANNEL_3 = PCA9633_REG_PWM3,   
} pca9633_pwm_channel_t;
 
typedef enum {
    PCA9633_LDR_STATE_OFF,
 
    PCA9633_LDR_STATE_ON,
 
    PCA9633_LDR_STATE_IND,
 
    PCA9633_LDR_STATE_IND_GRP,
} pca9633_ldr_state_t;
 
typedef enum {
    PCA9633_AI_DISABLED,
 
    PCA9633_AI_ALL,
 
    PCA9633_AI_IND,
 
    PCA9633_AI_GBL,
 
    PCA9633_AI_IND_GBL,
} pca9633_auto_inc_option_t;
 
typedef enum {
    PCA9633_GROUP_CONTROL_MODE_BLINKING,
 
    PCA9633_GROUP_CONTROL_MODE_DIMMING,
} pca9633_group_control_mode_t;
 
int pca9633_init(pca9633_t *dev, const pca9633_params_t *params);
 
void pca9633_turn_on(pca9633_t* dev);
 
void pca9633_turn_off(pca9633_t* dev);
 
void pca9633_wakeup(pca9633_t* dev);
 
void pca9633_sleep(pca9633_t* dev);
 
void pca9633_set_pwm(pca9633_t* dev,
                     pca9633_pwm_channel_t pwm_channel, uint8_t pwm);
 
void pca9633_set_grp_pwm(pca9633_t* dev, uint8_t pwm);
 
void pca9633_set_blinking(pca9633_t* dev, uint16_t blink_period_ms,
                          uint8_t on_off_ratio);
 
void pca9633_set_rgb(pca9633_t* dev, uint8_t r, uint8_t g, uint8_t b);
 
void pca9633_set_rgba(pca9633_t* dev, uint8_t r, uint8_t g, uint8_t b, uint8_t w);
 
void pca9633_set_ldr_state(pca9633_t* dev,
                           pca9633_ldr_state_t state,
                           pca9633_pwm_channel_t pwm_channel);
 
void pca9633_set_ldr_state_all(pca9633_t* dev, pca9633_ldr_state_t state);
 
void pca9633_set_auto_increment(pca9633_t* dev, pca9633_auto_inc_option_t option);
 
void pca9633_set_group_control_mode(pca9633_t* dev,
                                    pca9633_group_control_mode_t mode);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PCA9633_H */