irthermo2.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 IRTHERMO2_H
#define IRTHERMO2_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 IRTHERMO2_SENSOR_VOLTAGE                                0x00
#define IRTHERMO2_LOCAL_TEMPERATURE                             0x01
#define IRTHERMO2_CONFIGURATION                                 0x02
#define IRTHERMO2_OBJECT_TEMPERATURE                            0x03
#define IRTHERMO2_STATUS                                        0x04
#define IRTHERMO2_STATUS_MASK_AND_ENABLE                        0x05
#define IRTHERMO2_OBJECT_HIGH_LIMIT_TEMP                        0x06
#define IRTHERMO2_OBJECT_LOW_LIMIT_TEMP                         0x07
#define IRTHERMO2_LOCAL_HIGH_LIMIT_TEMP                         0x08
#define IRTHERMO2_LOCAL_LOW_LIMIT_TEMP                          0x09
#define IRTHERMO2_S0_COEFFICIENT                                0x0A
#define IRTHERMO2_A0_COEFFICIENT                                0x0B
#define IRTHERMO2_A1_COEFFICIENT                                0x0C
#define IRTHERMO2_B0_COEFFICIENT                                0x0D
#define IRTHERMO2_B1_COEFFICIENT                                0x0E
#define IRTHERMO2_B2_COEFFICIENT                                0x0F
#define IRTHERMO2_C_COEFFICIENT                                 0x10
#define IRTHERMO2_TC0_COEFFICIENT                               0X11
#define IRTHERMO2_TC1_COEFFICIENT                               0x12
#define IRTHERMO2_DEVICE_ID                                     0x1F
#define IRTHERMO2_MEMORY_ACCESS                                 0x2A
 
 // irthermo2_reg
 
#define IRTHERMO2_RESULT_OK                                     1
#define IRTHERMO2_RESULT_ERROR                                  0
#define IRTHERMO2_CFG_MODEON                                    0x1000
#define IRTHERMO2_CFG_RESET                                     0x8000
#define IRTHERMO2_CFG_1SAMPLE                                   0x0000
#define IRTHERMO2_CFG_2SAMPLE                                   0x0200
#define IRTHERMO2_CFG_4SAMPLE                                   0x0400
#define IRTHERMO2_CFG_8SAMPLE                                   0x0600
#define IRTHERMO2_CFG_16SAMPLE                                  0x0800
#define IRTHERMO2_CFG_ALERTEN                                   0x0100
#define IRTHERMO2_CFG_ALERTF                                    0x0080
#define IRTHERMO2_CFG_TRANSC                                    0x0040
#define IRTHERMO2_STAT_ALERTEN                                  0x8000
#define IRTHERMO2_STAT_CRTEN                                    0x4000
#define IRTHERMO2_DEVICE_ID_VALUE                               0x0078
 
#define IRTHERMO2_I2C_ADDRESS_0                                 0x40
#define IRTHERMO2_I2C_ADDRESS_1                                 0x41
#define IRTHERMO2_I2C_ADDRESS_2                                 0x44
#define IRTHERMO2_I2C_ADDRESS_3                                 0x45
 
 // irthermo2_set
 
#define IRTHERMO2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.al = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // irthermo2_map
 // irthermo2
 
 
 
 
typedef struct
{
    // Input pins 
    digital_in_t al;        
    // Modules 
    i2c_master_t i2c;       
    // ctx variable 
 
    uint8_t slave_address;  
} irthermo2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;         
    pin_name_t sda;         
    // Additional gpio pins 
 
    pin_name_t al;          
    // static variable 
 
    uint32_t i2c_speed;     
    uint8_t i2c_address;    
} irthermo2_cfg_t;
 
typedef enum
{
   IRTHERMO2_OK = 0,
   IRTHERMO2_ERROR = -1
 
} irthermo2_return_value_t;
 
void irthermo2_cfg_setup ( irthermo2_cfg_t *cfg );
 
err_t irthermo2_init ( irthermo2_t *ctx, irthermo2_cfg_t *cfg );
 
void irthermo2_default_cfg ( irthermo2_t *ctx );
 
void irthermo2_generic_write ( irthermo2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
void irthermo2_generic_read ( irthermo2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void irthermo2_write_data ( irthermo2_t *ctx, uint8_t address, uint16_t write_data );
 
uint16_t irthermo2_read_data ( irthermo2_t *ctx, uint8_t address );
 
err_t irthermo2_check_id ( irthermo2_t *ctx );
 
float irthermo2_get_object_temperature_c ( irthermo2_t *ctx );
 
float irthermo2_get_object_temperature_f ( irthermo2_t *ctx );
 
float irthermo2_get_raw_temperature ( irthermo2_t *ctx );
 
uint8_t irhhermo2_get_alert ( irthermo2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _IRTHERMO2_H_
 
// ------------------------------------------------------------------------- END