color12.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 COLOR12_H
#define COLOR12_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 COLOR12_REG_SYSTEM_CONTROL         0x40
#define COLOR12_REG_MODE_CONTROL1          0x41
#define COLOR12_REG_MODE_CONTROL2          0x42
#define COLOR12_REG_MODE_CONTROL3          0x43
#define COLOR12_REG_RED_DATA_L             0x50
#define COLOR12_REG_RED_DATA_H             0x51
#define COLOR12_REG_GREEN_DATA_L           0x52
#define COLOR12_REG_GREEN_DATA_H           0x53
#define COLOR12_REG_BLUE_DATA_L            0x54
#define COLOR12_REG_BLUE_DATA_H            0x55
#define COLOR12_REG_IR_DATA_L              0x56
#define COLOR12_REG_IR_DATA_H              0x57
#define COLOR12_REG_FLICKER_DATA_L         0x58
#define COLOR12_REG_FLICKER_DATA_H         0x59
#define COLOR12_REG_FLICKER_COUNTER        0x5A
#define COLOR12_REG_FIFO_LEVEL             0x5B
#define COLOR12_REG_FIFO_DATA_L            0x5C
#define COLOR12_REG_FIFO_DATA_H            0x5D
#define COLOR12_REG_MANUFACTURER_ID        0x92
 
 // color12_reg
 
#define COLOR12_SET_SW_RESET               0x80
 
#define COLOR12_RGB_GAIN_X1                0x00
#define COLOR12_RGB_GAIN_X2                0x01
#define COLOR12_RGB_GAIN_X4                0x02
#define COLOR12_RGB_GAIN_X8                0x03
#define COLOR12_RGB_GAIN_X16               0x04
#define COLOR12_RGB_GAIN_X32               0x05
 
#define COLOR12_MEAS_MODE_55MS             0x01
#define COLOR12_MEAS_MODE_100MS            0x02
 
#define COLOR12_FLC_GAIN_X1                0x00
#define COLOR12_FLC_GAIN_X2                0x01
#define COLOR12_FLC_GAIN_X4                0x02
#define COLOR12_FLC_GAIN_X8                0x03
#define COLOR12_FLC_GAIN_X16               0x04
#define COLOR12_FLC_GAIN_X32               0x05
 
#define COLOR12_FLC_MODE_1KHZ              0x00
#define COLOR12_FLC_MODE_2KHZ              0x01
 
#define COLOR12_INT_SEL_DISABLE            0x00
#define COLOR12_INT_SEL_RDY_RGB_IR         0x01
#define COLOR12_INT_SEL_RDY_FLICKER        0x02
#define COLOR12_INT_SEL_RDY_FIFO           0x03
 
#define COLOR12_RGB_EN_DISABLE             0x00
#define COLOR12_RGB_EN_ENABLE              0x01
 
#define COLOR12_FLC_EN_DISABLE             0x00
#define COLOR12_FLC_EN_ENABLE              0x01
 
#define COLOR12_MANUFACTURER_ID            0xE0
 
#define COLOR12_DEVICE_ADDRESS             0x38
 
 // color12_set
 
#define COLOR12_MAP_MIKROBUS( cfg, mikrobus )     \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // color12_map
 // color12
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;     
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} color12_t;
 
typedef struct
{
    pin_name_t scl;            
    pin_name_t sda;            
    pin_name_t int_pin;        
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} color12_cfg_t;
 
typedef enum
{
    COLOR12_OK = 0,
    COLOR12_ERROR = -1
 
} color12_return_value_t;
 
typedef enum
{
    COLOR12_DATA_RED = 0,
    COLOR12_DATA_GREEN,
    COLOR12_DATA_BLUE,
    COLOR12_DATA_IR
 
} color12_color_sel_t;
 
typedef struct
{
    uint8_t rgb_gain;     
    uint8_t meas_mode;    
    uint8_t flc_gain;     
    uint8_t flc_mode;     
    uint8_t int_sel;      
    uint8_t rgb_en;       
    uint8_t flc_en;       
} color12_config_t;
 
void color12_cfg_setup ( color12_cfg_t *cfg );
 
err_t color12_init ( color12_t *ctx, color12_cfg_t *cfg );
 
err_t color12_default_cfg ( color12_t *ctx );
 
err_t color12_generic_write ( color12_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t color12_generic_read ( color12_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t color12_sw_reset ( color12_t *ctx );
 
err_t color12_set_config ( color12_t *ctx, color12_config_t config );
 
err_t color12_get_config ( color12_t *ctx, color12_config_t *config );
 
err_t color12_get_color_data ( color12_t *ctx, color12_color_sel_t color_sel, uint16_t *color_data );
 
err_t color12_get_device_id ( color12_t *ctx, uint8_t *device_id );
 
uint8_t color12_get_int_pin ( color12_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // COLOR12_H
 
 // color12
 
// ------------------------------------------------------------------------ END