vcnl40x0.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Inria
 *
 * 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 VCNL40X0_H
#define VCNL40X0_H
 
#include "saul.h"
#include "periph/i2c.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum {
    VCNL40X0_PROXIMITY_RATE_2 = 0,          
    VCNL40X0_PROXIMITY_RATE_4,              
    VCNL40X0_PROXIMITY_RATE_8,              
    VCNL40X0_PROXIMITY_RATE_16,             
    VCNL40X0_PROXIMITY_RATE_31,             
    VCNL40X0_PROXIMITY_RATE_62,             
    VCNL40X0_PROXIMITY_RATE_125,            
    VCNL40X0_PROXIMITY_RATE_250,            
};
 
enum {
    VCNL40X0_AMBIENT_RATE_1 = 0,            
    VCNL40X0_AMBIENT_RATE_2,                
    VCNL40X0_AMBIENT_RATE_3,                
    VCNL40X0_AMBIENT_RATE_4,                
    VCNL40X0_AMBIENT_RATE_5,                
    VCNL40X0_AMBIENT_RATE_6,                
    VCNL40X0_AMBIENT_RATE_8,                
    VCNL40X0_AMBIENT_RATE_10,               
};
 
enum {
    VCNL40X0_AMBIENT_AVERAGE_1 = 0,         
    VCNL40X0_AMBIENT_AVERAGE_2,             
    VCNL40X0_AMBIENT_AVERAGE_4,             
    VCNL40X0_AMBIENT_AVERAGE_8,             
    VCNL40X0_AMBIENT_AVERAGE_16,            
    VCNL40X0_AMBIENT_AVERAGE_32,            
    VCNL40X0_AMBIENT_AVERAGE_64,            
    VCNL40X0_AMBIENT_AVERAGE_128,           
};
 
enum {
    VCNL40X0_OK = 0,                        
    VCNL40X0_ERR_I2C,                       
    VCNL40X0_ERR_NODEV                      
};
 
typedef struct {
    i2c_t i2c_dev;                          
    uint8_t i2c_addr;                       
    uint8_t led_current;                    
    uint8_t proximity_rate;                 
    uint8_t ambient_rate;                   
    uint8_t ambient_avg;                    
} vcnl40x0_params_t;
 
typedef struct {
    vcnl40x0_params_t params;               
} vcnl40x0_t;
 
int vcnl40x0_init(vcnl40x0_t *dev, const vcnl40x0_params_t *params);
 
uint16_t vcnl40x0_read_proximity(const vcnl40x0_t *dev);
 
uint16_t vcnl40x0_read_ambient_light(const vcnl40x0_t *dev);
 
uint16_t vcnl40x0_read_illuminance(const vcnl40x0_t *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* VCNL40X0_H */