spectral2.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 SPECTRAL2_H
#define SPECTRAL2_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 SPECTRAL2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define SPECTRAL2_RETVAL  uint8_t
 
#define SPECTRAL2_OK           0x00
#define SPECTRAL2_INIT_ERROR   0xFF
#define SPECTRAL2_SOFT_RESET          0x01 << 6
#define SPECTRAL2_NORMAL_OPERATION    0x00 << 6
#define SPECTRAL2_INT_ENABLE          0x01 << 5
#define SPECTRAL2_INT_DISABLE         0x00 << 5
#define SPECTRAL2_GAIN_1X             0x00 << 4
#define SPECTRAL2_GAIN_3_7X           0x01 << 4
#define SPECTRAL2_GAIN_16X            0x02 << 4
#define SPECTRAL2_GAIN_64X            0x03 << 4
#define SPECTRAL2_MODE_0              0x00 << 2
#define SPECTRAL2_MODE_1              0x01 << 2
#define SPECTRAL2_MODE_2              0x02 << 2
#define SPECTRAL2_MODE_3              0x03 << 2
#define SPECTRAL2_LED_DRV_CURRENT_12_5mA    0x00 << 4
#define SPECTRAL2_LED_DRV_CURRENT_25mA      0x01 << 4
#define SPECTRAL2_LED_DRV_CURRENT_50mA      0x02 << 4
#define SPECTRAL2_LED_DRV_CURRENT_100mA     0x03 << 4
#define SPECTRAL2_LED_DRV_ENABLE            0x01 << 2
#define SPECTRAL2_LED_DRV_DISABLE           0x00 << 2
#define SPECTRAL2_LED_IND_CURRENT_1mA       0x00 << 1
#define SPECTRAL2_LED_IND_CURRENT_2mA       0x01 << 1
#define SPECTRAL2_LED_IND_CURRENT_4mA       0x02 << 1
#define SPECTRAL2_LED_IND_CURRENT_8mA       0x03 << 1
#define SPECTRAL2_LED_IND_ENABLE            0x01
#define SPECTRAL2_LED_IND_DISABLE           0x00
#define SPECTRAL2_CALIBRATED_DATA_V      0x14
#define SPECTRAL2_CALIBRATED_DATA_B      0x18
#define SPECTRAL2_CALIBRATED_DATA_G      0x1C
#define SPECTRAL2_CALIBRATED_DATA_Y      0x20
#define SPECTRAL2_CALIBRATED_DATA_O      0x24
#define SPECTRAL2_CALIBRATED_DATA_R      0x28
// Sensor Data
#define SPECTRAL2_DATA_V       0x08
#define SPECTRAL2_DATA_B       0x0A
#define SPECTRAL2_DATA_G       0x0C
#define SPECTRAL2_DATA_Y       0x0E
#define SPECTRAL2_DATA_O       0x10
#define SPECTRAL2_DATA_R       0x12
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
 
    // Input pins 
 
    digital_in_t int_pin;
 
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} spectral2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
 
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} spectral2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void spectral2_cfg_setup ( spectral2_cfg_t *cfg );
 
SPECTRAL2_RETVAL spectral2_init ( spectral2_t *ctx, spectral2_cfg_t *cfg );
 
void spectral2_default_cfg ( spectral2_t *ctx );
 
void spectral2_generic_write ( spectral2_t *ctx, uint8_t reg, uint8_t data_buf );
 
uint8_t spectral2_generic_read ( spectral2_t *ctx, uint8_t reg );
 
void spectral2_reset ( spectral2_t *ctx );
 
void spectral2_set_integration_time ( spectral2_t *ctx, uint8_t cur_time );
 
uint8_t spectral2_get_temperature ( spectral2_t *ctx );
 
void spectral2_led_control ( spectral2_t *ctx, uint8_t led_data );
 
int16_t spectral2_get_data ( spectral2_t *ctx, uint8_t data_reg );
 
int32_t spectral2_get_calibrated_data ( spectral2_t *ctx, uint8_t data_reg );
 
#ifdef __cplusplus
}
#endif
#endif  // SPECTRAL2_H
 
 // End public_function group
 
// ------------------------------------------------------------------------ END