thermo7.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 THERMO7_H
#define THERMO7_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 THERMO7_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT ) 
#define THERMO7_RETVAL  uint8_t
 
#define THERMO7_OK           0x00
#define THERMO7_INIT_ERROR   0xFF
#define THERMO7_REG_AMBIENT_TEMPERATURE             0x00
#define THERMO7_REG_CONFIGURATION                   0x01
#define THERMO7_REG_HYSTERESIS_TEMPERATURE          0x02
#define THERMO7_REG_TEMPERATURE_LIMIT_SET           0x03
#define THERMO7_CONFIG_ONE_SHOT_ENABLE             (0x01 << 7)
#define THERMO7_CONFIG_ONE_SHOT_DISABLE            (0x00 << 7)
#define THERMO7_CONFIG_ADC_RESOLUTION_9bit         (0x00 << 5)
#define THERMO7_CONFIG_ADC_RESOLUTION_10bit        (0x01 << 5)
#define THERMO7_CONFIG_ADC_RESOLUTION_11bit        (0x02 << 5)
#define THERMO7_CONFIG_ADC_RESOLUTION_12bit        (0x03 << 5)
#define THERMO7_CONFIG_FAULT_QUEUE_MODE_1          (0x00 << 3)
#define THERMO7_CONFIG_FAULT_QUEUE_MODE_2          (0x01 << 3)
#define THERMO7_CONFIG_FAULT_QUEUE_MODE_4          (0x02 << 3)
#define THERMO7_CONFIG_FAULT_QUEUE_MODE_6          (0x03 << 3)
#define THERMO7_CONFIG_ALERT_POLARITY_ACTIVE_HIGH  (0x01 << 2)
#define THERMO7_CONFIG_ALERT_POLARITY_ACTIVE_LOW   (0x00 << 2)
#define THERMO7_CONFIG_COMPARATOR_MODE             (0x00 << 1)
#define THERMO7_CONFIG_INTERRUPT_MODE              (0x01 << 1)
#define THERMO7_CONFIG_SHUTDOWN_ENABLE              0x01
#define THERMO7_CONFIG_SHUTDOWN_DISABLE             0x00
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} thermo7_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} thermo7_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void thermo7_cfg_setup ( thermo7_cfg_t *cfg );
 
THERMO7_RETVAL thermo7_init ( thermo7_t *ctx, thermo7_cfg_t *cfg );
 
void thermo7_generic_write ( thermo7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void thermo7_generic_read ( thermo7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
float thermo7_read_ambient_temperature ( thermo7_t *ctx );
 
void thermo7_set_configuration ( thermo7_t *ctx, uint8_t configuration );
 
int16_t thermo7_get_hysteresis_temperature ( thermo7_t *ctx );
 
void thermo7_set_hysteresis_temperature ( thermo7_t *ctx, int8_t temperature );
 
int16_t thermo7_get_limit_temperature ( thermo7_t *ctx );
 
void thermo7_set_limit_temperature ( thermo7_t *ctx, int16_t temperature );
 
uint8_t thermo7_get_interrupt ( thermo7_t *ctx );
 
void thermo7_set_resolution ( thermo7_t *ctx, uint8_t resolution );
 
#ifdef __cplusplus
}
#endif
#endif  // _THERMO7_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END