spectrometer2.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 SPECTROMETER2_H
#define SPECTROMETER2_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 SPECTROMETER2_REG_DEVICE_ID             0x00
#define SPECTROMETER2_REG_REVISION_ID           0x01
#define SPECTROMETER2_REG_INTERRUPT_CTRL        0x02
#define SPECTROMETER2_REG_ALS_CTRL              0x03
#define SPECTROMETER2_REG_ALS_PERIOD            0x04
#define SPECTROMETER2_REG_ALS_CH1_DATA_H        0x06
#define SPECTROMETER2_REG_ALS_CH1_DATA_M        0x07
#define SPECTROMETER2_REG_ALS_CH1_DATA_L        0x08
#define SPECTROMETER2_REG_ALS_CH2_DATA_H        0x0A
#define SPECTROMETER2_REG_ALS_CH2_DATA_M        0x0B
#define SPECTROMETER2_REG_ALS_CH2_DATA_L        0x0C
#define SPECTROMETER2_REG_ALS_CH3_DATA_H        0x0E
#define SPECTROMETER2_REG_ALS_CH3_DATA_M        0x0F
#define SPECTROMETER2_REG_ALS_CH3_DATA_L        0x10
#define SPECTROMETER2_REG_ALS_CH4_DATA_H        0x12
#define SPECTROMETER2_REG_ALS_CH4_DATA_M        0x13
#define SPECTROMETER2_REG_ALS_CH4_DATA_L        0x14
#define SPECTROMETER2_REG_ALS_CH5_DATA_H        0x16
#define SPECTROMETER2_REG_ALS_CH5_DATA_M        0x17
#define SPECTROMETER2_REG_ALS_CH5_DATA_L        0x18
#define SPECTROMETER2_REG_ALS_CH6_DATA_H        0x1A
#define SPECTROMETER2_REG_ALS_CH6_DATA_M        0x1B
#define SPECTROMETER2_REG_ALS_CH6_DATA_L        0x1C
#define SPECTROMETER2_REG_ALS_EXPOSURE_M        0x1D
#define SPECTROMETER2_REG_ALS_EXPOSURE_L        0x1E
#define SPECTROMETER2_REG_ALS_GAIN_CH1          0x25
#define SPECTROMETER2_REG_ALS_GAIN_CH2          0x26
#define SPECTROMETER2_REG_ALS_GAIN_CH3          0x27
#define SPECTROMETER2_REG_ALS_GAIN_CH4          0x28
#define SPECTROMETER2_REG_ALS_GAIN_CH5          0x29
#define SPECTROMETER2_REG_ALS_GAIN_CH6          0x2A
#define SPECTROMETER2_REG_CHANNEL6_ENABLE       0x2D
#define SPECTROMETER2_REG_ALS_CHANNEL_ENABLE    0x2E
#define SPECTROMETER2_REG_AC_MODE_CTRL          0x31
#define SPECTROMETER2_REG_PEDESTAL_VALUE        0x32
#define SPECTROMETER2_REG_SDA_DRV_CFG           0x3C
#define SPECTROMETER2_REG_GPIO1_DRV_CFG         0x41
 
 // spectrometer2_reg
 
#define SPECTROMETER2_INTR_STATUS               0x02
#define SPECTROMETER2_CLR_INTR_SET              0x01
#define SPECTROMETER2_CLR_INTR_CLEAR            0x00
 
#define SPECTROMETER2_EXPOSURE_TIME_MS_MAX      1638.4
#define SPECTROMETER2_EXPOSURE_TIME_MS_DEFAULT  160.0
#define SPECTROMETER2_EXPOSURE_TIME_MS_MIN      1.6
#define SPECTROMETER2_EXPOSURE_TIME_MS_LSB      1.6
#define SPECTROMETER2_EXPOSURE_TIME_RES         0x03FF
 
#define SPECTROMETER2_IM_PERIOD_MS_MAX          5227.5
#define SPECTROMETER2_IM_PERIOD_MS_DEFAULT      200.0
#define SPECTROMETER2_IM_PERIOD_MS_MIN          0.0
#define SPECTROMETER2_IM_PERIOD_MS_LSB          20.5
#define SPECTROMETER2_IM_PERIOD_RES             0xFF
 
#define SPECTROMETER2_AGAIN_66p6X               0x01
#define SPECTROMETER2_AGAIN_50X                 0x02
#define SPECTROMETER2_AGAIN_33X                 0x03
#define SPECTROMETER2_AGAIN_25X                 0x04
#define SPECTROMETER2_AGAIN_16X                 0x05
#define SPECTROMETER2_AGAIN_10X                 0x06
#define SPECTROMETER2_AGAIN_7p1X                0x07
#define SPECTROMETER2_AGAIN_5X                  0x08
#define SPECTROMETER2_AGAIN_3p33X               0x09
#define SPECTROMETER2_AGAIN_2p5X                0x0A
#define SPECTROMETER2_AGAIN_1p67X               0x0B
#define SPECTROMETER2_AGAIN_1p25X               0x0C
#define SPECTROMETER2_AGAIN_1X                  0x0D
#define SPECTROMETER2_AGAIN_0p83X               0x0E
#define SPECTROMETER2_AGAIN_0p71X               0x0F
#define SPECTROMETER2_AGAIN_BIT_MASK            0x0F
 
#define SPECTROMETER2_CHANNEL6_DISABLE          0x00
#define SPECTROMETER2_CHANNEL6_ENABLE           0x01
 
#define SPECTROMETER2_NO_CHANNEL_ENABLED        0x00
#define SPECTROMETER2_CHANNEL1_ENABLE           0x01
#define SPECTROMETER2_CHANNEL2_ENABLE           0x02
#define SPECTROMETER2_CHANNEL3_ENABLE           0x04
#define SPECTROMETER2_CHANNEL4_ENABLE           0x08
#define SPECTROMETER2_CHANNEL5_ENABLE           0x10
#define SPECTROMETER2_ALL_CHANNELS_ENABLE       0x1F
 
#define SPECTROMETER2_ALS_MODE_SINGLE           0x00
#define SPECTROMETER2_ALS_MODE_CONTINUOUS       0x06
#define SPECTROMETER2_ALS_STOP                  0x00
#define SPECTROMETER2_ALS_START                 0x01
 
#define SPECTROMETER2_UNKNOWN_COLOR             0
#define SPECTROMETER2_RED_COLOR                 1
#define SPECTROMETER2_YELLOW_COLOR              2
#define SPECTROMETER2_GREEN_COLOR               3
#define SPECTROMETER2_CYAN_COLOR                4
#define SPECTROMETER2_BLUE_COLOR                5
#define SPECTROMETER2_MAGENTA_COLOR             6
#define SPECTROMETER2_WHITE_COLOR               7
#define SPECTROMETER2_BLACK_COLOR               8
 
#define SPECTROMETER2_WHITE_COLOR_LIGHTNESS     95
#define SPECTROMETER2_BLACK_COLOR_LIGHTNESS     5
#define SPECTROMETER2_YELLOW_COLOR_HUE_ANGLE    30
#define SPECTROMETER2_GREEN_COLOR_HUE_ANGLE     90
#define SPECTROMETER2_CYAN_COLOR_HUE_ANGLE      150
#define SPECTROMETER2_BLUE_COLOR_HUE_ANGLE      210
#define SPECTROMETER2_MAGENTA_COLOR_HUE_ANGLE   270
#define SPECTROMETER2_RED_COLOR_HUE_ANGLE       330
 
#define SPECTROMETER2_HSL_HUE_RESOLUTION        360
#define SPECTROMETER2_HSL_SATURATION_RESOLUTION 100
#define SPECTROMETER2_HSL_LIGHTNESS_RESOLUTION  100
 
#define SPECTROMETER2_DEVICE_ID                 0x70
 
#define SPECTROMETER2_DEVICE_ADDRESS            0x20
 
 // spectrometer2_set
 
#define SPECTROMETER2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // spectrometer2_map
 // spectrometer2
 
typedef struct
{
    // Input pins
    digital_in_t  an;           
    digital_in_t  int_pin;      
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} spectrometer2_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  an;             
    pin_name_t  int_pin;        
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} spectrometer2_cfg_t;
 
typedef struct
{
    uint32_t red;
    uint32_t visible;
    uint32_t blue;
    uint32_t green;
    uint32_t ir;
    uint32_t clear;
 
} spectrometer2_als_channels_t;
 
typedef struct
{
    float hue;
    float saturation;
    float lightness;
 
} spectrometer2_hsl_t;
 
typedef enum
{
    SPECTROMETER2_OK = 0,
    SPECTROMETER2_ERROR = -1
 
} spectrometer2_return_value_t;
 
void spectrometer2_cfg_setup ( spectrometer2_cfg_t *cfg );
 
err_t spectrometer2_init ( spectrometer2_t *ctx, spectrometer2_cfg_t *cfg );
 
err_t spectrometer2_default_cfg ( spectrometer2_t *ctx );
 
err_t spectrometer2_generic_write ( spectrometer2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t spectrometer2_generic_read ( spectrometer2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t spectrometer2_write_register ( spectrometer2_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t spectrometer2_read_register ( spectrometer2_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t spectrometer2_check_communication ( spectrometer2_t *ctx );
 
uint8_t spectrometer2_get_int_pin ( spectrometer2_t *ctx );
 
uint8_t spectrometer2_get_an_pin ( spectrometer2_t *ctx );
 
err_t spectrometer2_get_data ( spectrometer2_t *ctx, spectrometer2_als_channels_t *als_channels );
 
err_t spectrometer2_clear_interrupt ( spectrometer2_t *ctx );
 
err_t spectrometer2_set_exposure_time ( spectrometer2_t *ctx, float exp_time );
 
err_t spectrometer2_set_inter_measurement_period ( spectrometer2_t *ctx, float im_period );
 
uint8_t spectrometer2_get_color ( spectrometer2_hsl_t *hsl );
 
void spectrometer2_rgbc_to_hsl ( spectrometer2_als_channels_t *rgbc, spectrometer2_hsl_t *hsl );
 
#ifdef __cplusplus
}
#endif
#endif // SPECTROMETER2_H
 
 // spectrometer2
 
// ------------------------------------------------------------------------ END