apds99xx.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Gunar Schorcht
 *
 * 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 APDS99XX_H
#define APDS99XX_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdbool.h>
#include <stdint.h>
 
#include "periph/gpio.h"
#include "periph/i2c.h"
 
#if MODULE_APDS9900
#define APDS99XX_ID          (0x29)  
#define APDS99XX_T_PRX_PULSE (16)    
#define APDS99XX_T_PRX_CNV   (2720)  
#define APDS99XX_T_WAIT_STEP (2720)  
#define APDS99XX_T_ALS_STEP  (2720)  
#define APDS99XX_CNTS_P_STEP (1023)  
#elif MODULE_APDS9901
#define APDS99XX_ID          (0x20)  
#define APDS99XX_T_PRX_PULSE (16)    
#define APDS99XX_T_PRX_CNV   (2720)  
#define APDS99XX_T_WAIT_STEP (2720)  
#define APDS99XX_T_ALS_STEP  (2720)  
#define APDS99XX_CNTS_P_STEP (1023)  
#elif MODULE_APDS9930
#define APDS99XX_ID          (0x39)  
#define APDS99XX_T_PRX_PULSE (16)    
#define APDS99XX_T_PRX_CNV   (2730)  
#define APDS99XX_T_WAIT_STEP (2730)  
#define APDS99XX_T_ALS_STEP  (2730)  
#define APDS99XX_CNTS_P_STEP (1023)  
#elif MODULE_APDS9950
#define APDS99XX_ID          (0x69)  
#define APDS99XX_T_PRX_PULSE (14)    
#define APDS99XX_T_PRX_CNV   (2400)  
#define APDS99XX_T_WAIT_STEP (2400)  
#define APDS99XX_T_ALS_STEP  (2400)  
#define APDS99XX_CNTS_P_STEP (1024)  
#elif MODULE_APDS9960 || DOXYGEN
#define APDS99XX_ID          (0xab)  
#define APDS99XX_T_PRX_PULSE (36)    
#define APDS99XX_T_PRX_CNV   (841)   
#define APDS99XX_T_WAIT_STEP (2780)  
#define APDS99XX_T_ALS_STEP  (2780)  
#define APDS99XX_CNTS_P_STEP (1025)  
#else
#error "Please provide a valid aps99xx variant (apds9900, apds9901, adps9930, apds9950, apds9960)"
#endif
 
#define APDS99XX_I2C_ADDRESS    (0x39)
 
typedef enum {
    APDS99XX_OK,                
    APDS99XX_ERROR_I2C,         
    APDS99XX_ERROR_WRONG_ID,    
    APDS99XX_ERROR_NO_DATA,     
    APDS99XX_ERROR_RAW_DATA,    
} apds99xx_error_codes_t;
 
typedef enum {
    APDS99XX_ALS_GAIN_1 = 0, 
    APDS99XX_ALS_GAIN_8,     
    APDS99XX_ALS_GAIN_16,    
    #if MODULE_APDS9950 || MODULE_APDS9960 || DOXYGEN
    APDS99XX_ALS_GAIN_64,    
    #endif /* MODULE_APDS9950 || MODULE_APDS9960 || DOXYGEN */
    #if MODULE_APDS9900 || MODULE_APDS9901 || APDS9930 || DOXYGEN
    APDS99XX_ALS_GAIN_120,   
    #endif /*   MODULE_APDS9900 || MODULE_APDS9901 || APDS9930 || DOXYGEN */
} apds99xx_als_gain_t;
 
typedef enum {
    APDS99XX_PRX_GAIN_1 = 0,    
    #if MODULE_APDS9930 || MODULE_APDS9960 || DOXYGEN
    APDS99XX_PRX_GAIN_2,        
    APDS99XX_PRX_GAIN_4,        
    APDS99XX_PRX_GAIN_8,        
    #endif /* MODULE_APDS9930 || MODULE_APDS9960 || DOXYGEN */
} apds99xx_prx_gain_t;
 
typedef enum {
    APDS99XX_PRX_DRIVE_100 = 0,  
    APDS99XX_PRX_DRIVE_50,       
    APDS99XX_PRX_DRIVE_25,       
    APDS99XX_PRX_DRIVE_12_5,     
} apds99xx_prx_drive_t;
 
typedef struct {
 
    unsigned dev;          
    uint16_t als_steps;             
    apds99xx_als_gain_t  als_gain;  
    uint8_t prx_pulses;             
    apds99xx_prx_drive_t prx_drive; 
    apds99xx_prx_gain_t  prx_gain;  
    uint16_t wait_steps;    
    bool     wait_long;     
    gpio_t  int_pin;        
} apds99xx_params_t;
 
#if MODULE_APDS99XX_FULL || DOXYGEN
 
typedef struct {
    bool als_int_en;    
    uint8_t als_pers;   
    uint16_t als_thresh_low;  
    uint16_t als_thresh_high; 
    bool prx_int_en;    
    uint8_t prx_pers;   
    uint16_t prx_thresh_low;  
    uint16_t prx_thresh_high; 
} apds99xx_int_config_t;
 
typedef struct {
    bool als_int;    
    bool prx_int;    
} apds99xx_int_source_t;
 
typedef void (*apds99xx_isr_t)(void *arg);
 
#endif /* MODULE_APDS99XX_FULL */
 
typedef struct {
 
    apds99xx_params_t params;          
#if MODULE_APDS99XX_FULL || DOXYGEN
    apds99xx_isr_t isr;                
    void* isr_arg;                     
    bool gpio_init;                    
#endif /* MODULE_APDS99XX_FULL */
 
} apds99xx_t;
 
#if MODULE_APDS9950 || MODULE_APDS9960 || DOXYGEN
 
typedef union {
 
    struct {
        uint16_t    red;    
        uint16_t    green;  
        uint16_t    blue;   
    };
    uint16_t val[3];        
} apds99xx_rgb_t;
#endif
 
int apds99xx_init(apds99xx_t *dev, const apds99xx_params_t *params);
 
int apds99xx_data_ready_als(const apds99xx_t *dev);
 
int apds99xx_read_als_raw(const apds99xx_t *dev, uint16_t *raw);
 
#if MODULE_APDS9900 || MODULE_APDS9901 || MODULE_APDS9930 || DOXYGEN
 
int apds99xx_read_illuminance(const apds99xx_t *dev, uint16_t *lux);
 
#endif /* MODULE_APDS9900 || MODULE_APDS9901 || MODULE_APDS9930 || DOXYGEN */
 
#if MODULE_APDS9950 || MODULE_APDS9960 || DOXYGEN
 
int apds99xx_read_rgb_raw(const apds99xx_t *dev, apds99xx_rgb_t *rgb);
 
#endif /* MODULE_APDS9950 || MODULE_APDS9960 || DOXYGEN */
 
int apds99xx_data_ready_prx(const apds99xx_t *dev);
 
int apds99xx_read_prx_raw(const apds99xx_t *dev, uint16_t *prx);
 
int apds99xx_power_down(const apds99xx_t *dev);
 
int apds99xx_power_up(const apds99xx_t *dev);
 
#if MODULE_APDS99XX_FULL || DOXYGEN
 
int apds99xx_int_config(apds99xx_t *dev, apds99xx_int_config_t* cfg,
                        apds99xx_isr_t isr, void *isr_arg);
 
int apds99xx_int_source(apds99xx_t *dev, apds99xx_int_source_t* src);
 
#endif /* MODULE_APDS99XX_FULL */
 
#ifdef __cplusplus
}
#endif
 
#endif /* APDS99XX_H */