color14.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef COLOR14_H
#define COLOR14_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define COLOR14_REG_MAIN_CTRL       0x00
#define COLOR14_REG_PS_VCSEL        0x01
#define COLOR14_REG_PS_PULSES       0x02
#define COLOR14_REG_PS_MEASRATE     0x03
#define COLOR14_REG_LS_MEAS_RATE    0x04
#define COLOR14_REG_LS_GAIN         0x05
#define COLOR14_REG_PART_ID         0x06
#define COLOR14_REG_MAIN_STATUS     0x07
#define COLOR14_REG_PS_DATA_0       0x08
#define COLOR14_REG_PS_DATA_1       0x09
#define COLOR14_REG_LS_DATA_IR_0    0x0A
#define COLOR14_REG_LS_DATA_IR_1    0x0B
#define COLOR14_REG_LS_DATA_IR_2    0x0C
#define COLOR14_REG_LS_DATA_GREEN_0 0x0D
#define COLOR14_REG_LS_DATA_GREEN_1 0x0E
#define COLOR14_REG_LS_DATA_GREEN_2 0x0F
#define COLOR14_REG_LS_DATA_BLUE_0  0x10
#define COLOR14_REG_LS_DATA_BLUE_1  0x11
#define COLOR14_REG_LS_DATA_BLUE_2  0x12
#define COLOR14_REG_LS_DATA_RED_0   0x13
#define COLOR14_REG_LS_DATA_RED_1   0x14
#define COLOR14_REG_LS_DATA_RED_2   0x15
#define COLOR14_REG_INT_CFG         0x19        
#define COLOR14_REG_INT_PST         0x1A
#define COLOR14_REG_PS_THRES_UP_0   0x1B
#define COLOR14_REG_PS_THRES_UP_1   0x1C
#define COLOR14_REG_PS_THRES_LOW_0  0x1D
#define COLOR14_REG_PS_THRES_LOW_1  0x1E
#define COLOR14_REG_PS_CAN_0        0x1F
#define COLOR14_REG_PS_CAN_1_ANA    0x20
#define COLOR14_REG_LS_THRES_UP_0   0x21
#define COLOR14_REG_LS_THRES_UP_1   0x22
#define COLOR14_REG_LS_THRES_UP_2   0x23
#define COLOR14_REG_LS_THRES_LOW_0  0x24
#define COLOR14_REG_LS_THRES_LOW_1  0x25
#define COLOR14_REG_LS_THRES_LOW_2  0x26
#define COLOR14_REG_LS_THRES_VAR    0x27
 
 // color14_reg
 
#define COLOR14_ID 0xC2
 
#define COLOR14_SET_DEV_ADDR  0x52
 
 // color14_set
 
#define COLOR14_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // color14_map
 // color14
 
typedef struct
{
    // Input pins
    digital_in_t  int_pin;  
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
    // ALS resolution
    float lux_resolution;
 
} color14_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  int_pin;    
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} color14_cfg_t;
 
typedef struct
{
    uint32_t red;
    uint32_t green;
    uint32_t blue;
    uint32_t ir;
 
} color14_color_t;
 
typedef enum
{
   COLOR14_OK = 0,
   COLOR14_ERROR = -1,
   COLOR14_ERROR_OVF = -2,
   COLOR14_ERROR_PARAM = -3,
   COLOR14_ERROR_CFG = -4
 
} color14_return_value_t;
 
void color14_cfg_setup ( color14_cfg_t *cfg );
 
err_t color14_init ( color14_t *ctx, color14_cfg_t *cfg );
 
err_t color14_generic_write ( color14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t color14_generic_read ( color14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
uint8_t color14_get_int ( color14_t *ctx );
 
err_t color14_get_proximity ( color14_t *ctx, uint16_t *ps_data );
 
err_t color14_get_als ( color14_t *ctx, float *als_data );
 
err_t color14_ls_color ( color14_t *ctx, uint8_t ls_reg, uint32_t *ls_data );
 
err_t color14_get_rgb_ir ( color14_t *ctx, color14_color_t *color_data );
 
float color14_get_als_resolution ( color14_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // COLOR14_H
 
 // color14
 
// ------------------------------------------------------------------------ END