irsense.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 IRSENSE_H
#define IRSENSE_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 IRSENSE_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.pdn = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT ) 
#define IRSENSE_RETVAL  uint8_t
 
#define IRSENSE_OK           0x00
#define IRSENSE_INIT_ERROR   0xFF
#define IRSENSE_I2C_ADDRESS_0                                       0x64
#define IRSENSE_I2C_ADDRESS_1                                       0x65
#define IRSENSE_I2C_ADDRESS_2                                       0x66
#define IRSENSE_REG_WIA1                                            0x00
#define IRSENSE_REG_WIA2                                            0x01
#define IRSENSE_REG_INFO1                                           0x02
#define IRSENSE_REG_INFO2                                           0x03
#define IRSENSE_REG_INTST                                           0x04
#define IRSENSE_REG_ST1                                             0x05
#define IRSENSE_REG_IR1_LOW                                         0x06
#define IRSENSE_REG_IR1_HIGH                                        0x07
#define IRSENSE_REG_IR2_LOW                                         0x08
#define IRSENSE_REG_IR2_HIGH                                        0x09
#define IRSENSE_REG_IR3_LOW                                         0x0A
#define IRSENSE_REG_IR3_HIGH                                        0x0B
#define IRSENSE_REG_IR4_LOW                                         0x0C
#define IRSENSE_REG_IR4_HIGH                                        0x0D
#define IRSENSE_REG_TMP_LOW                                         0x0E
#define IRSENSE_REG_TMP_HIGH                                        0x0F
#define IRSENSE_REG_ST2                                             0x10
#define IRSENSE_REG_ETH13H_LOW                                      0x11
#define IRSENSE_REG_ETH13H_HIGH                                     0x12
#define IRSENSE_REG_ETH13L_LOW                                      0x13
#define IRSENSE_REG_ETH13L_HIGH                                     0x14
#define IRSENSE_REG_ETH24H_LOW                                      0x15
#define IRSENSE_REG_ETH24H_HIGH                                     0x16
#define IRSENSE_REG_ETH24L_LOW                                      0x17
#define IRSENSE_REG_ETH24L_HIGH                                     0x18
#define IRSENSE_REG_EHYS13                                          0x19
#define IRSENSE_REG_EHYS24                                          0x1A
#define IRSENSE_REG_EINTEN                                          0x1B
#define IRSENSE_REG_ECNTL1                                          0x1C
#define IRSENSE_REG_CNTL2                                           0x1D
#define IRSENSE_EEPROM_MAP_EKEY                                     0x50
#define IRSENSE_EEPROM_MAP_ETH13H_LOW                               0x51
#define IRSENSE_EEPROM_MAP_ETH13H_HIGH                              0x52
#define IRSENSE_EEPROM_MAP_ETH13L_LOW                               0x53
#define IRSENSE_EEPROM_MAP_ETH13L_HIGH                              0x54
#define IRSENSE_EEPROM_MAP_ETH24H_LOW                               0x55
#define IRSENSE_EEPROM_MAP_ETH24H_HIGH                              0x56
#define IRSENSE_EEPROM_MAP_ETH24L_LOW                               0x57
#define IRSENSE_EEPROM_MAP_ETH24L_HIGH                              0x58
#define IRSENSE_EEPROM_MAP_EHYS13                                   0x59
#define IRSENSE_EEPROM_MAP_EHYS24                                   0x5A
#define IRSENSE_EEPROM_MAP_EINTEN                                   0x5B
#define IRSENSE_EEPROM_MAP_ECNTL1                                   0x5C
#define IRSENSE_ECNTL1_MODE_STAND_BY                                0x00
#define IRSENSE_ECNTL1_MODE_EEPROM_ACCESS                           0x01
#define IRSENSE_ECNTL1_MODE_SINGLE_SHOT                             0x02
#define IRSENSE_ECNTL1_MODE_BE_PROHIBITED                           0x03
#define IRSENSE_ECNTL1_MODE_CONTINUOUS_0                            0x04
#define IRSENSE_ECNTL1_MODE_CONTINUOUS_1                            0x05
#define IRSENSE_ECNTL1_MODE_CONTINUOUS_2                            0x06
#define IRSENSE_ECNTL1_MODE_CONTINUOUS_3                            0x07
#define IRSENSE_ECNTL1_CUTOFF_FREQUENCY_0_3_Hz                      0x00
#define IRSENSE_ECNTL1_CUTOFF_FREQUENCY_0_6_Hz                      0x08
#define IRSENSE_ECNTL1_CUTOFF_FREQUENCY_1_1_Hz                      0x10
#define IRSENSE_ECNTL1_CUTOFF_FREQUENCY_2_2_Hz                      0x18
#define IRSENSE_ECNTL1_CUTOFF_FREQUENCY_4_4_Hz                      0x20
#define IRSENSE_ECNTL1_CUTOFF_FREQUENCY_8_8_Hz                      0x28
#define IRSENSE_EINTEN_IR13_HIGH_INT_DISABLE                        0x00
#define IRSENSE_EINTEN_IR13_HIGH_INT_ENABLE                         0x01
#define IRSENSE_EINTEN_IR13_LOW_INT_DISABLE                         0x00
#define IRSENSE_EINTEN_IR13_LOW_INT_ENABLE                          0x01
#define IRSENSE_EINTEN_IR24_HIGH_INT_DISABLE                        0x00
#define IRSENSE_EINTEN_IR24_HIGH_INT_ENABLE                         0x01
#define IRSENSE_EINTEN_IR24_LOW_INT_DISABLE                         0x00
#define IRSENSE_EINTEN_IR24_LOW_INT_ENABLE                          0x01
#define IRSENSE_EINTEN_DRI_INT_DISABLE                              0x00
#define IRSENSE_EINTEN_DRI_INT_ENABLE                               0x01
 
#define IRSENSE_CNTL2_SOFT_RESET                                    0x01
#define IRSENSE_EEPROM_MAP_VAL_EKEY                                 0xA5
#define IRSENSE_ENABLE_SETTINGS_EEPROM_MODE                         0x38
#define IRSENSE_ENABLE_EEPROM_MODE                                  0xC1
#define IRSENSE_EINTEN_RESET_VALUE                                  0xC0
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t pdn;
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} irsense_t;
 
typedef struct
{
    int16_t bottom_area;
    int16_t left_area;
    int16_t right_area;
    int16_t top_area;
 
} irsense_ir_data_t;
 
typedef struct
{
    uint8_t ir13h;
    uint8_t ir13l;
    uint8_t ir24h;
    uint8_t ir24l;
    uint8_t dr;
} irsense_eint_t;
 
 typedef struct
{
    uint16_t eth24h;
    uint16_t eth24l;
    uint16_t eth13h;
    uint16_t eth13l;
} irsense_reg_t;
 
 typedef struct
{   
    uint16_t eeth24h;
    uint16_t eeth24l;
    uint16_t eeth13h;
    uint16_t eeth13l;
} irsense_eeprom_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t pdn;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} irsense_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void irsense_cfg_setup ( irsense_cfg_t *cfg );
 
IRSENSE_RETVAL irsense_init ( irsense_t *ctx, irsense_cfg_t *cfg );
 
void irsense_generic_write ( irsense_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void irsense_generic_read ( irsense_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
 void irsense_write_byte ( irsense_t *ctx, uint8_t reg_address, uint8_t write_data );
 
 uint8_t irsense_read_byte ( irsense_t *ctx, uint8_t reg_address );
 
 uint16_t irsense_read_data ( irsense_t *ctx, uint8_t reg_address_low );
 
void irsense_power_on ( irsense_t *ctx );
 
 void irsense_power_off ( irsense_t *ctx );
 
 uint8_t irsense_get_company_code ( irsense_t *ctx );
 
 uint8_t irsense_get_device_id ( irsense_t *ctx );
 
 uint8_t irsense_read_interrupt_status ( irsense_t *ctx );
 
 uint8_t irsense_get_status ( irsense_t *ctx );
 
 void irsense_set_configuration ( irsense_t *ctx, uint8_t register_value );
 
 void irsense_set_mode ( irsense_t *ctx, uint8_t mode );
 
 void irsense_set_cutoff_frequency ( irsense_t *ctx, uint8_t frequency );
 
 uint8_t irsense_check_available ( irsense_t *ctx );
 
 uint8_t irsense_check_overrun ( irsense_t *ctx );
 
 void irsense_soft_reset ( irsense_t *ctx );
 
 void irsense_refresh ( irsense_t *ctx );
 
 int16_t irsense_get_ir1 ( irsense_t *ctx );
 
 int16_t irsense_get_ir2 ( irsense_t *ctx );
 
 int16_t irsense_get_ir3 ( irsense_t *ctx );
 
 int16_t irsense_get_ir4 ( irsense_t *ctx );
 
 void irsense_get_ir_sense ( irsense_t *ctx, irsense_ir_data_t *ir_data );
 
 float irsense_get_temperature ( irsense_t *ctx );
 
 float irsense_get_temperature_f ( irsense_t *ctx );
 
 void irsense_set_threshold_ir2_ir4 ( irsense_t *ctx, uint8_t value );
 
 uint16_t irsense_get_threshold_ir2_ir4 ( irsense_t *ctx );
 
 void irsense_set_threshold_eeprom_ir2_ir4 ( irsense_t *ctx, uint8_t value );
 
 void irsense_set_threshold_ir1_ir3 ( irsense_t *ctx, uint8_t value );
 
 uint16_t irsense_get_threshold_ir1_ir3 ( irsense_t *ctx );
 
 void irsense_set_threshold_eeprom_ir1_ir3( irsense_t *ctx, uint8_t value );
 
 void irsense_read_threshold ( irsense_t *ctx, irsense_reg_t *reg );
 
 void irsense_read_threshold_eeprom ( irsense_t *ctx, irsense_eeprom_t *eeprom );
 
 void irsense_set_hysteresis_ir2_ir4 ( irsense_t *ctx, uint8_t value );
 
 void irsense_set_hysteresis_eeprom_ir2_ir4 ( irsense_t *ctx, uint8_t value );
 
 void irsense_set_hysteresis_ir1_ir3 ( irsense_t *ctx, uint8_t value );
 
 void irsense_set_hysteresis_eeprom_ir1_ir3 (irsense_t *ctx, uint8_t value );
 
 void irsense_read_hysteresis ( irsense_t *ctx, uint8_t *ehys24, uint8_t *ehys13 );
 
 void irsense_read_hysteresis_eeprom ( irsense_t *ctx, uint8_t *eehys24, uint8_t *eehys13 );
 
 void irsense_set_interrupts_reg ( irsense_t *ctx, irsense_eint_t *eint );
 
 void irsense_enable_data_ready_interrupt ( irsense_t *ctx );  
 
 uint8_t irsense_check_int_states ( irsense_t *ctx );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _IRSENSE_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END