color2.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 COLOR2_H
#define COLOR2_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 COLOR2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define COLOR2_OK                               0
#define COLOR2_ERROR                           -1
#define COLOR2_I2C_ADDR                         0x44
#define COLOR2_DEVICE_ID                        0x00
#define COLOR2_CONFIG_1                         0x01
#define COLOR2_CONFIG_2                         0x02
#define COLOR2_CONFIG_3                         0x03
#define COLOR2_THRESHOLD_LL                     0x04
#define COLOR2_THRESHOLD_LH                     0x05
#define COLOR2_THRESHOLD_HL                     0x06
#define COLOR2_THRESHOLD_HH                     0x07
#define COLOR2_STATUS                           0x08
#define COLOR2_GREEN_L                          0x09
#define COLOR2_GREEN_H                          0x0A
#define COLOR2_RED_L                            0x0B
#define COLOR2_RED_H                            0x0C
#define COLOR2_BLUE_L                           0x0D
#define COLOR2_BLUE_H                           0x0E
#define COLOR2_CFG_DEFAULT                      0x00
#define COLOR2_CFG1_MODE_POWERDOWN              0x00
#define COLOR2_CFG1_MODE_G                      0x01
#define COLOR2_CFG1_MODE_R                      0x02
#define COLOR2_CFG1_MODE_B                      0x03
#define COLOR2_CFG1_MODE_STANDBY                0x04
#define COLOR2_CFG1_MODE_RGB                    0x05
#define COLOR2_CFG1_MODE_RG                     0x06
#define COLOR2_CFG1_MODE_GB                     0x07
#define COLOR2_CFG1_375LUX                      0x00
#define COLOR2_CFG1_10KLUX                      0x08
#define COLOR2_CFG1_16BIT                       0x00
#define COLOR2_CFG1_12BIT                       0x10
#define COLOR2_CFG1_ADC_SYNC_NORMAL             0x00
#define COLOR2_CFG1_ADC_SYNC_TO_INT             0x20
#define COLOR2_CFG2_IR_OFFSET_OFF               0x00
#define COLOR2_CFG2_IR_OFFSET_ON                0x80
#define COLOR2_CFG2_IR_ADJUST_LOW               0x00
#define COLOR2_CFG2_IR_ADJUST_MID               0x20
#define COLOR2_CFG2_IR_ADJUST_HIGH              0x3F
#define COLOR2_CFG3_NO_INT                      0x00
#define COLOR2_CFG3_G_INT                       0x01
#define COLOR2_CFG3_R_INT                       0x02
#define COLOR2_CFG3_B_INT                       0x03
#define COLOR2_CFG3_INT_PRST1                   0x00
#define COLOR2_CFG3_INT_PRST2                   0x04
#define COLOR2_CFG3_INT_PRST4                   0x08
#define COLOR2_CFG3_INT_PRST8                   0x0C
#define COLOR2_CFG3_RGB_CONV_TO_INT_DISABLE     0x00
#define COLOR2_CFG3_RGB_CONV_TO_INT_ENABLE      0x10
#define COLOR2_FLAG_INT                         0x01
#define COLOR2_FLAG_CONV_DONE                   0x02
#define COLOR2_FLAG_BROWNOUT                    0x04
#define COLOR2_FLAG_CONV_G                      0x10
#define COLOR2_FLAG_CONV_R                      0x20
#define COLOR2_FLAG_CONV_B                      0x30
#define COLOR2_UNKNOWN_COLOR                    0
#define COLOR2_RED_COLOR                        1
#define COLOR2_YELLOW_COLOR                     2
#define COLOR2_GREEN_COLOR                      3
#define COLOR2_CYAN_COLOR                       4
#define COLOR2_BLUE_COLOR                       5
#define COLOR2_MAGENTA_COLOR                    6
#define COLOR2_WHITE_COLOR                      7
#define COLOR2_BLACK_COLOR                      8
 
#define COLOR2_WHITE_COLOR_LIGHTNESS            97
#define COLOR2_BLACK_COLOR_LIGHTNESS            3
#define COLOR2_YELLOW_COLOR_HUE_ANGLE           30
#define COLOR2_GREEN_COLOR_HUE_ANGLE            90
#define COLOR2_CYAN_COLOR_HUE_ANGLE             150
#define COLOR2_BLUE_COLOR_HUE_ANGLE             210
#define COLOR2_MAGENTA_COLOR_HUE_ANGLE          270
#define COLOR2_RED_COLOR_HUE_ANGLE              330
 
#define COLOR2_HSL_HUE_RESOLUTION               360
#define COLOR2_HSL_SATURATION_RESOLUTION        100
#define COLOR2_HSL_LIGHTNESS_RESOLUTION         100
 
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
    digital_in_t int_pin;
    
    // Modules 
    i2c_master_t i2c;
 
    // ctx variable 
    uint8_t slave_address;
 
} color2_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;
 
} color2_cfg_t;
 
typedef struct
{
    uint16_t red;
    uint16_t green;
    uint16_t blue;
 
} color2_rgb_t;
 
typedef struct
{
    float hue;
    float saturation;
    float lightness;
 
} color2_hsl_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void color2_cfg_setup ( color2_cfg_t *cfg );
 
err_t color2_init ( color2_t *ctx, color2_cfg_t *cfg );
 
err_t color2_default_cfg ( color2_t *ctx );
 
err_t color2_generic_write ( color2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t color2_generic_read ( color2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t color2_write_reg ( color2_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t color2_read_reg ( color2_t *ctx, uint8_t reg, uint8_t *data_out );
 
uint8_t color2_get_int_pin ( color2_t *ctx );
 
err_t color2_reset ( color2_t *ctx );
 
err_t color2_init_advanced ( color2_t *ctx, uint8_t config1, uint8_t config2, uint8_t config3 );
 
err_t color2_set_upper_threshold ( color2_t *ctx, uint16_t upper_threshold );
 
err_t color2_set_lower_hreshold ( color2_t *ctx, uint16_t lower_threshold );
 
err_t color2_read_upper_threshold ( color2_t *ctx, uint16_t *upper_threshold );
 
err_t color2_read_lower_threshold ( color2_t *ctx, uint16_t *lower_threshold );
 
err_t color2_read_rgb ( color2_t *ctx, color2_rgb_t *rgb );
 
err_t color2_read_status ( color2_t *ctx, uint8_t *status );
 
void color2_rgb_to_hsl ( color2_t *ctx, color2_rgb_t *rgb, color2_hsl_t *hsl );
 
uint8_t color2_get_color ( color2_hsl_t *hsl );
 
#ifdef __cplusplus
}
#endif
#endif  // _COLOR2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END