color4.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 COLOR4_H
#define COLOR4_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 COLOR4_CMD_CODE_CONF                    0x00
#define COLOR4_CMD_CODE_RED                     0x08
#define COLOR4_CMD_CODE_GREEN                   0x09
#define COLOR4_CMD_CODE_BLUE                    0x0A
#define COLOR4_CMD_CODE_WHITE                   0x0B
 
 // color4_reg
 
#define COLOR4_INTEGRATION_TIME_40MS            0x00
#define COLOR4_INTEGRATION_TIME_80MS            0x10
#define COLOR4_INTEGRATION_TIME_160MS           0x20
#define COLOR4_INTEGRATION_TIME_320MS           0x30
#define COLOR4_INTEGRATION_TIME_640MS           0x40
#define COLOR4_INTEGRATION_TIME_1280MS          0x50
#define COLOR4_INTEGRATION_BIT_MASK             0x70
 
#define COLOR4_TRIG_DISABLE                     0x00
#define COLOR4_TRIG_ENABLE                      0x04
#define COLOR4_TRIG_BIT_MASK                    0x04
 
#define COLOR4_AF_AUTO                          0x00
#define COLOR4_AF_FORCE                         0x02
#define COLOR4_AF_BIT_MASK                      0x02
 
#define COLOR4_SD_ENABLE                        0x00
#define COLOR4_SD_DISABLE                       0x01
#define COLOR4_SD_BIT_MASK                      0x01
 
 
#define COLOR4_DEVICE_ADDRESS                   0x10
 
 // color4_set
 
#define COLOR4_MAP_MIKROBUS( cfg, mikrobus )      \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // color4_map
 // color4
 
typedef struct
{
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
    float offset;             
} color4_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} color4_cfg_t;
 
typedef enum
{
    COLOR4_OK = 0,
    COLOR4_ERROR = -1
 
} color4_return_value_t;
 
typedef enum
{
    COLOR4_RED = 0,
    COLOR4_GREEN,
    COLOR4_BLUE,
    COLOR4_WHITE
 
} color4_ch_color_t;
 
typedef struct
{
    uint8_t    integration_time;    
    uint8_t    trig;                
    uint8_t    mode;                
    uint8_t    chip_shutdown;       
} color4_config_t;
 
void color4_cfg_setup ( color4_cfg_t *cfg );
 
err_t color4_init ( color4_t *ctx, color4_cfg_t *cfg );
 
err_t color4_default_cfg ( color4_t *ctx );
 
err_t color4_generic_write ( color4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t color4_generic_read ( color4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t color4_set_config ( color4_t *ctx, color4_config_t config );
 
err_t color4_get_config ( color4_t *ctx, color4_config_t *config );
 
err_t color4_get_color_data ( color4_t *ctx, color4_ch_color_t ch_color, uint16_t *color_data );
 
err_t color4_get_ambient_light ( color4_t *ctx, float *ambient_light );
 
err_t color4_get_cct ( color4_t *ctx, float *cct );
 
#ifdef __cplusplus
}
#endif
#endif // COLOR4_H
 
 // color4
 
// ------------------------------------------------------------------------ END