vl6180x.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 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 VL6180X_H
#define VL6180X_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdbool.h>
#include <stdint.h>
 
#include "periph/gpio.h"
#include "periph/i2c.h"
 
#include "vl6180x_regs.h"
 
#define VL6180X_I2C_ADDR    (0x29)  
typedef enum {
    VL6180X_OK              = 0,    
    VL6180X_ERROR_I2C       = 1,    
    VL6180X_ERROR_WRONG_ID  = 2,    
    VL6180X_ERROR_NO_PIN    = 3,    
    VL6180X_ERROR_NO_DATA   = 4,    
    VL6180X_ERROR_RNG       = 5,    
    VL6180X_ERROR_ALS       = 6,    
    VL6180X_ERROR_NOT_READY = 7,    
} vl6180x_error_t;
 
typedef enum {
    VL6180X_ALS_GAIN_20   = 0,  
    VL6180X_ALS_GAIN_10   = 1,  
    VL6180X_ALS_GAIN_5    = 2,  
    VL6180X_ALS_GAIN_2_5  = 3,  
    VL6180X_ALS_GAIN_1_67 = 4,  
    VL6180X_ALS_GAIN_1_25 = 5,  
    VL6180X_ALS_GAIN_1    = 6,  
    VL6180X_ALS_GAIN_40   = 7,  
} vl6180x_als_gain_t;
 
typedef enum {
    VL6180X_RNG_OK = 0,                     
    VL6180X_RNG_VCSEL_CONT_TEST = 1,        
    VL6180X_RNG_VCSEL_WD_TEST = 2,          
    VL6180X_RNG_VCSEL_WD = 3,               
    VL6180X_RNG_PLL1_LOCK = 4,              
    VL6180X_RNG_PLL2_LOCK = 5,              
    VL6180X_RNG_EARLY_CONV_EST = 6,         
    VL6180X_RNG_MAX_CONV = 7,               
    VL6180X_RNG_NO_TARGET = 8,              
    VL6180X_RNG_MAX_SNR = 11,               
    VL6180X_RNG_RAW_ALGO_UNDERFLOW = 12,    
    VL6180X_RNG_RAW_ALGO_OVERFLOW = 13,     
    VL6180X_RNG_ALGO_UNDERFLOW = 14,        
    VL6180X_RNG_ALGO_OVERFLOW = 15,         
} vl6180x_rng_status_t;
 
typedef enum {
    VL6180X_ALS_OK = 0,                    
    VL6180X_ALS_OVERFLOW = 1,              
    VL6180X_ALS_UNDERFLOW = 2,             
} vl6180x_als_status_t;
 
typedef enum {
    VL6180X_INT_NONE = 0, 
    VL6180X_INT_LOW  = 1, 
    VL6180X_INT_HIGH = 2, 
    VL6180X_INT_OUT  = 3, 
    VL6180X_INT_DRDY = 4, 
} vl6180x_int_mode_t;
 
typedef struct {
#if IS_USED(MODULE_VL6180X_RNG) || DOXYGEN
    vl6180x_int_mode_t rng_int; 
#endif
#if IS_USED(MODULE_VL6180X_ALS) || DOXYGEN
    vl6180x_int_mode_t als_int; 
#endif
} vl6180x_int_config_t;
 
typedef struct {
#if IS_USED(MODULE_VL6180X_RNG) || DOXYGEN
    uint8_t rng_high;   
    uint8_t rng_low;    
#endif
#if IS_USED(MODULE_VL6180X_ALS) || DOXYGEN
    uint16_t als_high;  
    uint16_t als_low;   
#endif
} vl6180x_int_thresh_t;
 
typedef struct {
    unsigned i2c_dev;        
    uint8_t  i2c_addr;       
#if IS_USED(MODULE_VL6180X_SHUTDOWN) || DOXYGEN
    gpio_t   shutdown_pin;  
#endif /* IS_USED(MODULE_VL6180X_SHUTDOWN) || DOXYGEN */
 
#if IS_USED(MODULE_VL6180X_IRQ) || DOXYGEN
    gpio_t               int_pin;     
    vl6180x_int_config_t int_cfg;     
    vl6180x_int_thresh_t int_thresh;  
#endif /* IS_USED(MODULE_VL6180X_IRQ) || DOXYGEN */
 
    uint8_t period;
 
#if IS_USED(MODULE_VL6180X_RNG) || DOXYGEN
    uint8_t rng_max_time;  
#endif /* IS_USED(MODULE_VL6180X_RNG) || DOXYGEN */
 
#if IS_USED(MODULE_VL6180X_ALS) || DOXYGEN
    uint16_t als_int_time; 
    uint16_t als_lux_res;  
    vl6180x_als_gain_t als_gain; 
#endif /* IS_USED(MODULE_VL6180X_ALS) || DOXYGEN */
 
} vl6180x_params_t;
 
typedef struct {
 
    vl6180x_params_t params;  
    bool cont_meas;           
#if IS_USED(MODULE_VL6180X_RNG) || DOXYGEN
    vl6180x_rng_status_t rng_status; 
#endif /* IS_USED(MODULE_VL6180X_RNG) || DOXYGEN */
#if IS_USED(MODULE_VL6180X_ALS) || DOXYGEN
    vl6180x_als_status_t als_status; 
#endif /* IS_USED(MODULE_VL6180X_ALS) || DOXYGEN */
} vl6180x_t;
 
int vl6180x_init(vl6180x_t *dev, const vl6180x_params_t *params);
 
int vl6180x_start_cont(vl6180x_t *dev);
 
int vl6180x_stop_cont(vl6180x_t *dev);
 
#if IS_USED(MODULE_VL6180X_RNG) || DOXYGEN
int vl6180x_rng_data_ready(const vl6180x_t *dev);
 
int vl6180x_rng_read(vl6180x_t *dev, uint8_t *mm);
 
vl6180x_rng_status_t vl6180x_rng_status(const vl6180x_t *dev);
 
int vl6180x_rng_start_single(const vl6180x_t *dev);
 
#if IS_USED(MODULE_VL6180X_CONFIG) || DOXYGEN
int vl6180x_rng_config(vl6180x_t *dev, uint8_t period, uint8_t max_time);
 
#endif /* IS_USED(MODULE_VL6180X_CONFIG) || DOXYGEN */
#endif /* IS_USED(MODULE_VL6180X_RNG) || DOXYGEN */
 
#if IS_USED(MODULE_VL6180X_ALS) || DOXYGEN
int vl6180x_als_data_ready(const vl6180x_t *dev);
 
int vl6180x_als_read(vl6180x_t *dev, uint16_t *raw, uint16_t *lux);
 
vl6180x_als_status_t vl6180x_als_status(const vl6180x_t *dev);
 
int vl6180x_als_start_single(const vl6180x_t *dev);
 
#if IS_USED(MODULE_VL6180X_CONFIG) || DOXYGEN
int vl6180x_als_config(vl6180x_t *dev, uint8_t period, uint8_t int_time,
                                       vl6180x_als_gain_t gain);
 
#endif /* IS_USED(MODULE_VL6180X_CONFIG) || DOXYGEN */
#endif /* IS_USED(MODULE_VL6180X_ALS) || DOXYGEN */
 
#if IS_USED(MODULE_VL6180X_SHUTDOWN) || DOXYGEN
int vl6180x_power_down(const vl6180x_t *dev);
 
int vl6180x_power_up(vl6180x_t *dev);
 
#endif /* IS_USED(MODULE_VL6180X_SHUTDOWN) || DOXYGEN  */
 
#if IS_USED(MODULE_VL6180X_IRQ) || DOXYGEN
 
int vl6180x_int_wait(const vl6180x_t *dev, vl6180x_int_config_t *src);
 
int vl6180x_int_enable(vl6180x_t *dev, vl6180x_int_config_t mode);
 
#if IS_USED(MODULE_VL6180X_CONFIG) || DOXYGEN
int vl6180x_int_config(vl6180x_t *dev, vl6180x_int_thresh_t thresh);
 
#endif /* IS_USED(MODULE_VL6180X_CONFIG) || DOXYGEN  */
#endif /* IS_USED(MODULE_VL6180X_IRQ) || DOXYGEN */
 
int vl6180x_reg_write(const vl6180x_t *dev,
                      uint16_t reg, const uint8_t *data, uint8_t len);
 
int vl6180x_reg_read(const vl6180x_t *dev,
                     uint16_t reg, uint8_t *data, uint8_t len);
#ifdef __cplusplus
}
#endif
 
#endif /* VL6180X_H */