thermoj.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 THERMOJ_H
#define THERMOJ_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 THERMOJ_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.alert4 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.alert3 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.alert2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.alert1 = MIKROBUS( mikrobus, MIKROBUS_INT )
#define THERMOJ_RETVAL  uint8_t
 
#define THERMOJ_OK           0x00
#define THERMOJ_INIT_ERROR   0xFF
#define THERMOJ_I2C_ADDR_0                                         0x60
#define THERMOJ_I2C_ADDR_1                                         0x67
#define THERMOJ_TH                                                 0x00
#define THERMOJ_TD                                                 0x01
#define THERMOJ_TC                                                 0x02
#define THERMOJ_RAW_ADC_DATA                                       0x03
#define THERMOJ_STATUS                                             0x04
#define THERMOJ_SENSOR_CONFIG                                      0x05
#define THERMOJ_DEVICE_CONFIG                                      0x06
#define THERMOJ_ALERT1_CONFIG                                      0x08
#define THERMOJ_ALERT2_CONFIG                                      0x09
#define THERMOJ_ALERT3_CONFIG                                      0x0A
#define THERMOJ_Alert4_CONFIG                                      0x0B
#define THERMOJ_THYST1                                             0x0C
#define THERMOJ_THYST2                                             0x0D
#define THERMOJ_THYST3                                             0x0E
#define THERMOJ_THYST4                                             0x0F
#define THERMOJ_TALERT1                                            0x10
#define THERMOJ_TALERT2                                            0x11
#define THERMOJ_TALERT3                                            0x12
#define THERMOJ_TALERT4                                            0x13
#define THERMOJ_DEVICE_ID                                          0x20
#define THERMOJ_THERMOCOUPLE_TYPE_K                                0x00
#define THERMOJ_THERMOCOUPLE_TYPE_J                                0x01
#define THERMOJ_THERMOCOUPLE_TYPE_T                                0x02
#define THERMOJ_THERMOCOUPLE_TYPE_N                                0x03
#define THERMOJ_THERMOCOUPLE_TYPE_S                                0x04
#define THERMOJ_THERMOCOUPLE_TYPE_E                                0x05
#define THERMOJ_THERMOCOUPLE_TYPE_B                                0x06
#define THERMOJ_THERMOCOUPLE_TYPE_R                                0x07
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
 
    digital_in_t alert4;
    digital_in_t alert3;
    digital_in_t alert2;
    digital_in_t alert1;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} thermoj_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t alert4;
    pin_name_t alert3;
    pin_name_t alert2;
    pin_name_t alert1;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} thermoj_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void thermoj_cfg_setup ( thermoj_cfg_t *cfg );
 
THERMOJ_RETVAL thermoj_init ( thermoj_t *ctx, thermoj_cfg_t *cfg );
 
void thermoj_generic_write ( thermoj_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void thermoj_generic_read ( thermoj_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void thermoj_write_byte ( thermoj_t *ctx, uint8_t reg_address, uint8_t write_data );
 
uint8_t thermoj_read_byte ( thermoj_t *ctx, uint8_t reg_address );
 
uint8_t thermoj_get_status ( thermoj_t *ctx );
 
uint8_t thermoj_check_burst_complete ( thermoj_t *ctx );
 
uint8_t thermoj_check_data_ready ( thermoj_t *ctx );
 
uint8_t thermoj_check_over_voltage ( thermoj_t *ctx );
 
void thermoj_check_alert_status ( thermoj_t *ctx, uint8_t *alert_1, uint8_t *alert_2, uint8_t *alert_3, uint8_t *alert_4 );
 
void thermoj_set_sensor_config ( thermoj_t *ctx, uint8_t config_val );
 
void thermoj_set_thermocouple_type ( thermoj_t *ctx, uint8_t thermocouple_type );
 
void thermoj_set_filter_coefficient ( thermoj_t *ctx, uint8_t filter_coeff );
 
uint8_t thermoj_get_sensor_config ( thermoj_t *ctx );
 
void thermoj_set_config ( thermoj_t *ctx, uint8_t config_val );
 
void thermoj_set_cold_junction_resolution ( thermoj_t *ctx, uint8_t cj_res );
 
void thermoj_set_adc_resolution ( thermoj_t *ctx, uint8_t adc_res );
 
void thermoj_set_number_of_temperature_samples ( thermoj_t *ctx, uint8_t num_temp_samp );
 
void thermoj_set_shutdown_modes ( thermoj_t *ctx, uint8_t sd_mod );
 
void thermoj_write_data ( thermoj_t *ctx, uint8_t reg_address, uint16_t write_data );
 
uint16_t thermoj_read_data ( thermoj_t *ctx, uint8_t reg_address );
 
uint8_t thermoj_get_device_id ( thermoj_t *ctx );
 
float thermoj_get_temperature ( thermoj_t *ctx );
 
float thermoj_get_temperature_fahrenheit ( thermoj_t *ctx );
 
uint8_t thermoj_get_alert_1 ( thermoj_t *ctx );
 
uint8_t thermoj_get_alert_2 ( thermoj_t *ctx );
 
uint8_t thermoj_get_alert_3 ( thermoj_t *ctx );
 
uint8_t thermoj_get_alert_4 ( thermoj_t *ctx );
 
void thermoj_set_alerts_limits ( thermoj_t *ctx, uint8_t pos_alert, float temp_alert_limit );
 
void thermoj_set_alert_config ( thermoj_t *ctx, uint8_t pos_alert, uint8_t alert_config );
 
void thermoj_enable_alert ( thermoj_t *ctx, uint8_t pos_alert );
 
void thermoj_disable_alert ( thermoj_t *ctx, uint8_t pos_alert );
 
#ifdef __cplusplus
}
#endif
#endif  // _THERMOJ_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END