oximeter.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 OXIMETER_H
#define OXIMETER_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 OXIMETER_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.io0  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.io1  = MIKROBUS( mikrobus, MIKROBUS_INT )
#define OXIMETER_OK                         0
#define OXIMETER_ERROR                     -1
#define OXIMETER_REG_STATUS                 0x00
#define OXIMETER_REG_INT_MASK               0x01
#define OXIMETER_REG_GPIO_DRV               0x02
#define OXIMETER_REG_FIFO_THRESH            0x06
#define OXIMETER_REG_DEVID                  0x08
#define OXIMETER_REG_I2CS_ID                0x09
#define OXIMETER_REG_CLK_RATIO              0x0A
#define OXIMETER_REG_GPIO_CTRL              0x0B
#define OXIMETER_REG_SLAVE_ADDRESS_KEY      0x0D
#define OXIMETER_REG_SW_RESET               0x0F
#define OXIMETER_REG_MODE                   0x10
#define OXIMETER_REG_SLOT_EN                0x11
#define OXIMETER_REG_FSAMPLE                0x12
#define OXIMETER_REG_PD_LED_SELECT          0x14
#define OXIMETER_REG_NUM_AVG                0x15
#define OXIMETER_REG_SLOTA_CH1_OFFSET       0x18
#define OXIMETER_REG_SLOTA_CH2_OFFSET       0x19
#define OXIMETER_REG_SLOTA_CH3_OFFSET       0x1A
#define OXIMETER_REG_SLOTA_CH4_OFFSET       0x1B
#define OXIMETER_REG_SLOTB_CH1_OFFSET       0x1E
#define OXIMETER_REG_SLOTB_CH2_OFFSET       0x1F
#define OXIMETER_REG_SLOTB_CH3_OFFSET       0x20
#define OXIMETER_REG_SLOTB_CH4_OFFSET       0x21
#define OXIMETER_REG_ILED3_COARSE           0x22
#define OXIMETER_REG_ILED1_COARSE           0x23
#define OXIMETER_REG_ILED2_COARSE           0x24
#define OXIMETER_REG_ILED_FINE              0x25
#define OXIMETER_REG_SLOTA_LED_PULSE        0x30
#define OXIMETER_REG_SLOTA_NUMPULSES        0x31
#define OXIMETER_REG_LED_DISABLE            0x34
#define OXIMETER_REG_SLOTB_LED_PULSE        0x35
#define OXIMETER_REG_SLOTB_NUMPULSES        0x36
#define OXIMETER_REG_ALT_PWR_DN             0x37
#define OXIMETER_REG_EXT_SYNC_STARTUP       0x38
#define OXIMETER_REG_SLOTA_AFE_WINDOW       0x39
#define OXIMETER_REG_SLOTB_AFE_WINDOW       0x3B
#define OXIMETER_REG_AFE_PWR_CFG1           0x3C
#define OXIMETER_REG_SLOTA_TIA_CFG          0x42
#define OXIMETER_REG_SLOTA_AFE_CFG          0x43
#define OXIMETER_REG_SLOTB_TIA_CFG          0x44
#define OXIMETER_REG_SLOTB_AFE_CFG          0x45
#define OXIMETER_REG_SAMPLE_CLK             0x4B
#define OXIMETER_REG_CLK32M_ADJUST          0x4D
#define OXIMETER_REG_ADC_CLOCK              0x4E
#define OXIMETER_REG_EXT_SYNC_SEL           0x4F
#define OXIMETER_REG_CLK32M_CAL_EN          0x50
#define OXIMETER_REG_AFE_PWR_CFG2           0x54
#define OXIMETER_REG_TIA_INDEP_GAIN         0x55
#define OXIMETER_REG_DIGITAL_INT_EN         0x58
#define OXIMETER_REG_DIG_INT_CFG            0x5A
#define OXIMETER_REG_DATA_ACCESS_CTL        0x5F
#define OXIMETER_REG_FIFO_ACCESS            0x60
#define OXIMETER_REG_SLOTA_PD1_16BIT        0x64
#define OXIMETER_REG_SLOTA_PD2_16BIT        0x65
#define OXIMETER_REG_SLOTA_PD3_16BIT        0x66
#define OXIMETER_REG_SLOTA_PD4_16BIT        0x67
#define OXIMETER_REG_SLOTB_PD1_16BIT        0x68
#define OXIMETER_REG_SLOTB_PD2_16BIT        0x69
#define OXIMETER_REG_SLOTB_PD3_16BIT        0x6A
#define OXIMETER_REG_SLOTB_PD4_16BIT        0x6B
#define OXIMETER_REG_A_PD1_LOW              0x70
#define OXIMETER_REG_A_PD2_LOW              0x71
#define OXIMETER_REG_A_PD3_LOW              0x72
#define OXIMETER_REG_A_PD4_LOW              0x73
#define OXIMETER_REG_A_PD1_HIGH             0x74
#define OXIMETER_REG_A_PD2_HIGH             0x75
#define OXIMETER_REG_A_PD3_HIGH             0x76
#define OXIMETER_REG_A_PD4_HIGH             0x77
#define OXIMETER_REG_B_PD1_LOW              0x78
#define OXIMETER_REG_B_PD2_LOW              0x79
#define OXIMETER_REG_B_PD3_LOW              0x7A
#define OXIMETER_REG_B_PD4_LOW              0x7B
#define OXIMETER_REG_B_PD1_HIGH             0x7C
#define OXIMETER_REG_B_PD2_HIGH             0x7D
#define OXIMETER_REG_B_PD3_HIGH             0x7E
#define OXIMETER_REG_B_PD4_HIGH             0x7F
#define OXIMETER_DIS_SLOT                   0x00
#define OXIMETER_EN_SLOT                    0x01
#define OXIMETER_NO_PHOTODIODE_CONN         0x00
#define OXIMETER_ALL_PHOTODIODE_CONN        0x01
#define OXIMETER_PD5_PD6_PD7_PD8_CONN       0x02
#define OXIMETER_PD1_PD2_PD3_PD4_CONN       0x03
#define OXIMETER_PDX_TO_AFE                 0x00
#define OXIMETER_LEDX1_EN                   0x01
#define OXIMETER_LEDX2_EN                   0x02
#define OXIMETER_LEDX3_EN                   0x03
#define OXIMETER_DIS_LED                    0x04
#define OXIMETER_SLOT_NORM_OP_MODE          0x00
#define OXIMETER_SLOT_DIG_INT_OP_MODE       0x01
#define OXIMETER_CH1_EN                     0x00
#define OXIMETER_CH2_EN                     0x01
#define OXIMETER_CH1_CH2_EN                 0x02
#define OXIMETER_CH3_CH4_EN                 0x03
#define OXIMETER_CH2_CH3_CH4_EN             0x04
#define OXIMETER_ALL_CHANN_EN               0x05
#define OXIMETER_AVERAGE_RES_MODE           0x00
#define OXIMETER_SUM_RES_MODE               0x01
#define OXIMETER_DEV_STANDBY_OP_MODE        0x0000
#define OXIMETER_DEV_PROGRAM_OP_MODE        0x0001
#define OXIMETER_DEV_NORMAL_OP_MODE         0x0002
#define OXIMETER_DEVICE_ADDRESS             0x64
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    digital_in_t io0;
    digital_in_t io1;
    
    // Modules 
    i2c_master_t i2c;
 
    // ctx variable 
    uint8_t slave_address;
 
    uint8_t enabled_chann;
    uint8_t enabled_slot_a;
    uint8_t enabled_slot_b;
    uint8_t result_mode_check;
 
} oximeter_t;
 
typedef struct
{
    // Communication gpio pins 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
    pin_name_t io0;
    pin_name_t io1;
 
    // static variable 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
    uint8_t dev_enabled_chann;
    uint8_t dev_enabled_slot_a;
    uint8_t dev_enabled_slot_b;
    uint8_t dev_result_mode_check;
 
} oximeter_cfg_t;
 
typedef struct
{
    uint8_t enable_slot;
    uint8_t enable_photodiode;
    uint8_t enable_led;
    
} oximeter_enable_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void oximeter_cfg_setup ( oximeter_cfg_t *cfg );
 
err_t oximeter_init ( oximeter_t *ctx, oximeter_cfg_t *cfg );
 
void oximeter_default_cfg ( oximeter_t *ctx );
 
err_t oximeter_write_reg ( oximeter_t* ctx, uint8_t reg, uint16_t data_in );
 
err_t oximeter_read_reg ( oximeter_t* ctx, uint8_t reg, uint16_t* data_out, uint8_t len );
 
err_t oximeter_set_time_slot_a ( oximeter_t* ctx, oximeter_enable_t* dev_enable, uint8_t set_mode );
 
err_t oximeter_set_time_slot_b ( oximeter_t* ctx, oximeter_enable_t* dev_enable, uint8_t set_mode );
 
err_t oximeter_enable_channels ( oximeter_t* ctx, uint8_t select_channel );
 
void oximeter_read_data ( oximeter_t* ctx, uint32_t* chann_results, uint8_t result_mode );
 
uint8_t oximeter_get_int_gpio0 ( oximeter_t* ctx );
 
uint8_t oximeter_get_int_gpio1 ( oximeter_t* ctx );
 
void oximeter_reset ( oximeter_t* ctx );
 
err_t oximeter_set_mode ( oximeter_t* ctx, uint16_t select_mode );
 
#ifdef __cplusplus
}
#endif
#endif  // _OXIMETER_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END