color9.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 COLOR9_H
#define COLOR9_H
 
#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"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define COLOR9_SLAVE_ADDR          0x52
#define COLOR9_MAIN_CTRL           0x00
#define COLOR9_LS_MEAS_RATE        0x04
#define COLOR9_LS_GAIN             0x05
#define COLOR9_PART_ID             0x06
#define COLOR9_MAIN_STATUS         0x07
#define COLOR9_LS_DATA_IR_0        0x0A
#define COLOR9_LS_DATA_IR_1        0x0B
#define COLOR9_LS_DATA_IR_2        0x0C
#define COLOR9_LS_DATA_GREEN_0     0x0D
#define COLOR9_LS_DATA_GREEN_1     0x0E
#define COLOR9_LS_DATA_GREEN_2     0x0F
#define COLOR9_LS_DATA_BLUE_0      0x10
#define COLOR9_LS_DATA_BLUE_1      0x11
#define COLOR9_LS_DATA_BLUE_2      0x12
#define COLOR9_LS_DATA_RED_0       0x13
#define COLOR9_LS_DATA_RED_1       0x14
#define COLOR9_LS_DATA_RED_2       0x15
#define COLOR9_INT_CFG             0x19
#define COLOR9_INT_PERSISTENCE     0x1A
#define COLOR9_LS_THRES_UP_0       0x21
#define COLOR9_LS_THRES_UP_1       0x22
#define COLOR9_LS_THRES_UP_2       0x23
#define COLOR9_LS_THRES_LOW_0      0x24
#define COLOR9_LS_THRES_LOW_1      0x25
#define COLOR9_LS_THRES_LOW_2      0x26
#define COLOR9_LS_THRES_VAR        0x27
 
 
#define COLOR9_MAIN_CTRL_SW_RESET  0x10
#define COLOR9_MAIN_CTRL_CS_MODE   0x04
#define COLOR9_MAIN_CTRL_LS_EN     0x02
 // End group main_ctrl 
 
 
#define COLOR9_LS_MEAS_BITWIDTH_20    0x00
#define COLOR9_LS_MEAS_BITWIDTH_19    0x01
#define COLOR9_LS_MEAS_BITWIDTH_18    0x02
#define COLOR9_LS_MEAS_BITWIDTH_17    0x03
#define COLOR9_LS_MEAS_BITWIDTH_16    0x04
#define COLOR9_LS_MEAS_BITWIDTH_13    0x05
 
#define COLOR9_LS_MEAS_RATE_25ms      0x00
#define COLOR9_LS_MEAS_RATE_50ms      0x01
#define COLOR9_LS_MEAS_RATE_100ms     0x02
#define COLOR9_LS_MEAS_RATE_200ms     0x03
#define COLOR9_LS_MEAS_RATE_500ms     0x04
#define COLOR9_LS_MEAS_RATE_1000ms    0x05
#define COLOR9_LS_MEAS_RATE_2000ms    0x06
 // End group ls_meas_rate 
 
#define COLOR9_LS_GAIN_1              0x00
#define COLOR9_LS_GAIN_3              0x01
#define COLOR9_LS_GAIN_6              0x02
#define COLOR9_LS_GAIN_9              0x03
#define COLOR9_LS_GAIN_18             0x04
 // End group ls_gain
 
#define COLOR9_INT_CFG_IR_CH                   0x00
#define COLOR9_INT_CFG_ALS_GREEN_CH            0x01
#define COLOR9_INT_CFG_RED_CH                  0x02
#define COLOR9_INT_CFG_BLUE_CH                 0x03
#define COLOR9_INT_CFG_LS_THRESHOLD_INT_MODE   0x00
#define COLOR9_INT_CFG_LS_VARIATION_INT_MODE   0x01 
#define COLOR9_INT_CFG_LS_INT_ENABLE           0x01
#define COLOR9_INT_CFG_LS_INT_DISABLE          0x00
 // End group int_cfg
 
#define COLOR9_INT_PERSISTENCE_ANYVAL_TRIGGER          0x00
#define COLOR9_INT_PERSISTENCE_SECOND_COUNT_TRIGGER    0x01
#define COLOR9_INT_PERSISTENCE_SIXTEEN_COUNT_TRIGGER   0x0F
 // End group int_persistence
 
#define COLOR9_LS_THRES_VAR_COUNT_8                    0x00
#define COLOR9_LS_THRES_VAR_COUNT_16                   0x01
#define COLOR9_LS_THRES_VAR_COUNT_32                   0x02
#define COLOR9_LS_THRES_VAR_COUNT_64                   0x03
#define COLOR9_LS_THRES_VAR_COUNT_1024                 0x07
 // End group ls_thres_var
 
#define COLOR9_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define COLOR9_RETVAL  uint8_t
 
#define COLOR9_OK           0x00
#define COLOR9_INIT_ERROR   0xFF
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} color9_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} color9_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void color9_cfg_setup ( color9_cfg_t *cfg );
 
COLOR9_RETVAL color9_init ( color9_t *ctx, color9_cfg_t *cfg );
 
 
 
void color9_write ( color9_t* ctx, uint8_t reg_addr, uint8_t r_data );
 
uint8_t color9_read ( color9_t* ctx, uint8_t reg_addr );
 
void color9_sw_reset ( color9_t* ctx );
 
uint32_t color9_get_Ir ( color9_t* ctx );
 
uint32_t color9_get_green ( color9_t* ctx );
 
uint32_t color9_get_blue ( color9_t* ctx );
 
uint32_t color9_get_red ( color9_t* ctx );
 
uint8_t color9_get_status_reg ( color9_t* ctx );
 
void color9_meas_rate ( color9_t* ctx, uint8_t resolution, uint8_t meas_rate );
 
void color9_reg_ctrl ( color9_t* ctx, uint8_t cfg );
 
void color9_set_gain ( color9_t* ctx, uint8_t g_setting );
 
void color9_int_config ( color9_t* ctx, uint8_t int_select, uint8_t int_mode,
                         uint8_t cfg_setting );
 
void color9_sample_compare ( color9_t* ctx, uint8_t num_of_compares );
 
uint32_t color9_read_32 ( color9_t* ctx, uint8_t reg_addr );
 
void color9_write_32 ( color9_t* ctx, uint8_t reg_addr, uint32_t treas_val );
 
void color9_similarity_count ( color9_t* ctx, uint8_t sim_set );
 
void color9_upper_tresset ( color9_t* ctx, uint32_t set_val );
 
void color9_lower_tresset ( color9_t* ctx, uint32_t set_val );
 
#ifdef __cplusplus
}
#endif
#endif  // _COLOR9_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END