color17.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 COLOR17_H
#define COLOR17_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 COLOR17_REG_CH0_EXP_RESMSB             0x00
#define COLOR17_REG_CH0_RESMSB_CNT_CRC         0x01
#define COLOR17_REG_CH1_EXP_RES_MSB            0x02
#define COLOR17_REG_CH1_RESMSB_CNT_CRC         0x03
#define COLOR17_REG_CH2_EXP_RES_MSB            0x04
#define COLOR17_REG_CH2_RESMSB_CNT_CRC         0x05
#define COLOR17_REG_CH3_EXP_RES_MSB            0x06
#define COLOR17_REG_CH4_RESMSB_CNT_CRC         0x07
#define COLOR17_REG_THLD_EXP_RES_L             0x08
#define COLOR17_REG_THLD_EXP_RES_H             0x09
#define COLOR17_REG_CONFIG_0                   0x0A
#define COLOR17_REG_CONFIG_1                   0x0B
#define COLOR17_REG_CONFIG_2                   0x0C
#define COLOR17_REG_DEVICE_ID                  0x11
 
 // color17_reg
 
#define COLOR17_DEVICE_ID                      0x0821u
 
#define COLOR17_CONFIG_0_QWAKE_DIS             0x00
#define COLOR17_CONFIG_0_QWAKE_EN              0x01
#define COLOR17_CONFIG_0_RANGE_2_2KLUX         0x00
#define COLOR17_CONFIG_0_RANGE_4_5KLUX         0x01
#define COLOR17_CONFIG_0_RANGE_9KLUX           0x02
#define COLOR17_CONFIG_0_RANGE_18KLUX          0x03
#define COLOR17_CONFIG_0_RANGE_36KLUX          0x04
#define COLOR17_CONFIG_0_RANGE_72KLUX          0x05
#define COLOR17_CONFIG_0_RANGE_144KLUX         0x06
#define COLOR17_CONFIG_0_RANGE_AUTO            0x0C
#define COLOR17_CONFIG_0_CONV_600US            0x00
#define COLOR17_CONFIG_0_CONV_1_MS             0x01
#define COLOR17_CONFIG_0_CONV_1_8MS            0x02
#define COLOR17_CONFIG_0_CONV_3_4MS            0x03
#define COLOR17_CONFIG_0_CONV_6_5MS            0x04
#define COLOR17_CONFIG_0_CONV_12_7MS           0x05
#define COLOR17_CONFIG_0_CONV_25MS             0x06
#define COLOR17_CONFIG_0_CONV_50MS             0x07
#define COLOR17_CONFIG_0_CONV_100MS            0x08
#define COLOR17_CONFIG_0_CONV_200MS            0x09
#define COLOR17_CONFIG_0_CONV_400MS            0x0A
#define COLOR17_CONFIG_0_CONV_800MS            0x0B
#define COLOR17_CONFIG_0_OP_MODE_PD            0x00
#define COLOR17_CONFIG_0_OP_MODE_F_ONESHOT     0x01
#define COLOR17_CONFIG_0_OP_MODE_ONESHOT       0x02
#define COLOR17_CONFIG_0_OP_MODE_CONTINUOUS    0x03
#define COLOR17_CONFIG_0_LATCH_DIS             0x00
#define COLOR17_CONFIG_0_LATCH_EN              0x01
#define COLOR17_CONFIG_0_INT_POL_LOW           0x00
#define COLOR17_CONFIG_0_INT_POL_HIGH          0x01
#define COLOR17_CONFIG_0_FAULT_COUNT_0         0x00
#define COLOR17_CONFIG_0_FAULT_COUNT_2         0x01
#define COLOR17_CONFIG_0_FAULT_COUNT_4         0x02
#define COLOR17_CONFIG_0_FAULT_COUNT_8         0x03
 
#define COLOR17_CONFIG_1_MUST_READ_WRITE       0x8000u
#define COLOR17_CONFIG_1_THRESHOLD_CH0         0x00
#define COLOR17_CONFIG_1_THRESHOLD_CH1         0x01
#define COLOR17_CONFIG_1_THRESHOLD_CH2         0x02
#define COLOR17_CONFIG_1_THRESHOLD_CH3         0x03
#define COLOR17_CONFIG_1_INT_DIR_INPUT         0x00
#define COLOR17_CONFIG_1_INT_DIR_OUTPUT        0x01
#define COLOR17_CONFIG_1_INT_CFG_SMBUS_ALR     0x00
#define COLOR17_CONFIG_1_INT_CFG_NEXT_CH       0x01
#define COLOR17_CONFIG_1_INT_CFG_ALL_CH        0x03
#define COLOR17_CONFIG_1_I2C_BURST_DISABLE     0x00
#define COLOR17_CONFIG_1_I2C_BURST_ENABLE      0x01
 
#define COLOR17_CONFIG_2_FLAG_DISABLE          0x00
#define COLOR17_CONFIG_2_FLAG_ENABLE           0x01
 
#define COLOR17_SEL_CHANNEL_0                  0x00
#define COLOR17_SEL_CHANNEL_1                  0x01
#define COLOR17_SEL_CHANNEL_2                  0x02
#define COLOR17_SEL_CHANNEL_3                  0x03
 
#define COLOR17_DEVICE_ADDRESS_GND             0x44
#define COLOR17_DEVICE_ADDRESS_VCC             0x45
 
 // color17_set
 
#define COLOR17_MAP_MIKROBUS( cfg, mikrobus )     \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // color17_map
 // color17
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;     
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} color17_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t int_pin;         
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} color17_cfg_t;
 
typedef struct
{
    uint8_t qwake;          
    uint8_t range;          
    uint8_t conv_time;      
    uint8_t op_mode;        
    uint8_t latch;          
    uint8_t int_pol;        
    uint8_t fault_cnt;      
    uint8_t thld_ch_sel;    
    uint8_t int_dir;        
    uint8_t int_cfg;        
    uint8_t i2c_burst;      
} color17_config_t;
 
typedef struct
{
    uint8_t ovld_flag;          
    uint8_t conv_ready_flag;    
    uint8_t flag_h;             
    uint8_t flag_l;             
} color17_status_flag_t;
 
typedef enum
{
    COLOR17_OK = 0,
    COLOR17_ERROR = -1
 
} color17_return_value_t;
 
void color17_cfg_setup ( color17_cfg_t *cfg );
 
err_t color17_init ( color17_t *ctx, color17_cfg_t *cfg );
 
err_t color17_default_cfg ( color17_t *ctx );
 
err_t color17_generic_write ( color17_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t color17_generic_read ( color17_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t color17_write_reg ( color17_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t color17_read_reg ( color17_t *ctx, uint8_t reg, uint16_t *data_out );
 
err_t color17_get_device_id ( color17_t *ctx, uint16_t *device_id );
 
err_t color17_set_config ( color17_t *ctx, color17_config_t config );
 
err_t color17_get_status_flag ( color17_t *ctx, color17_status_flag_t *status_flag );
 
err_t color17_get_ch_measurement ( color17_t *ctx, uint8_t ch, uint32_t *adc_codes );
 
err_t color17_get_measurement ( color17_t *ctx, uint32_t *adc_codes );
 
err_t color17_get_cct ( color17_t *ctx, float *cct, float *light_intensity );
 
uint8_t color17_get_int_pin ( color17_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // COLOR17_H
 
 // color17
 
// ------------------------------------------------------------------------ END