thermo8.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 THERMO8_H
#define THERMO8_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 THERMO8_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.ale = MIKROBUS( mikrobus, MIKROBUS_INT )
#define THERMO8_RETVAL  uint8_t
 
#define THERMO8_OK           0x00
#define THERMO8_INIT_ERROR   0xFF
#define THERMO8_ADDR0                            0x18
#define THERMO8_ADDR1                           (0x18 | 0x01)
#define THERMO8_ADDR2                           (0x18 | 0x02)
#define THERMO8_ADDR3                           (0x18 | 0x03)
#define THERMO8_ADDR4                           (0x18 | 0x04)
#define THERMO8_ADDR5                           (0x18 | 0x05)
#define THERMO8_ADDR6                           (0x18 | 0x06)
#define THERMO8_ADDR7                           (0x18 | 0x07)
#define THERMO8_CONFIG                           0x01
#define THERMO8_TUPPER                           0x02
#define THERMO8_TLOWER                           0x03
#define THERMO8_TCRIT                            0x04
#define THERMO8_TUPPER_REACHED                   0x03
#define THERMO8_TLOWER_REACHED                   0x0C
#define THERMO8_TCRIT_REACHED                    0x30
#define THERMO8_TCRIT_ONLY_ALERT                 1
#define THERMO8_ALERT_ON_ALL                     0
#define THERMO8_THYS_0C                          0x00
#define THERMO8_THYS_1C5                         0x01
#define THERMO8_THYS_3C                          0x02
#define THERMO8_THYS_6C                          0x03
#define THERMO8_TA                               0x05
#define THERMO8_MANID                            0x06
#define THERMO8_DEVID                            0x07
#define THERMO8_RESOLUTION_REG                   0x08
#define THERMO8_R05C_30MS                        0x00
#define THERMO8_R025C_65MS                       0x01
#define THERMO8_R0125C_130MS                     0x02
#define THERMO8_R00625C_250MS                    0x03
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
 
    digital_in_t ale;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
    uint16_t limit_status;
 
} thermo8_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t ale;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} thermo8_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void thermo8_cfg_setup ( thermo8_cfg_t *cfg );
 
THERMO8_RETVAL thermo8_init ( thermo8_t *ctx, thermo8_cfg_t *cfg );
 
void thermo8_default_cfg ( thermo8_t *ctx );
 
void thermo8_generic_write ( thermo8_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void thermo8_generic_read ( thermo8_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint8_t thermo8_ale_get ( thermo8_t *ctx );
 
void thermo8_write_reg ( thermo8_t *ctx, uint8_t r_addr, uint16_t r_data );
 
uint16_t thermo8_read_reg ( thermo8_t *ctx, uint8_t r_addr );
 
void thermo8_write_reg_8 ( thermo8_t *ctx, uint8_t r_addr, uint8_t r_data);
 
uint8_t thermo8_read_reg_8 ( thermo8_t *ctx, uint8_t r_addr );
 
float thermo8_get_temperature ( thermo8_t *ctx );
 
void thermo8_set_resolution ( thermo8_t *ctx, uint8_t r_cfg );
 
uint16_t thermo8_get_dev_id ( thermo8_t *ctx );
 
uint16_t thermo8_get_man_id ( thermo8_t *ctx );
 
void thermo8_sleep ( thermo8_t *ctx );
 
void thermo8_wake_up ( thermo8_t *ctx );
 
void thermo8_limit_set ( thermo8_t *ctx, uint8_t limit_reg_addr, float limit );
 
uint8_t thermo8_get_alert_stat ( thermo8_t *ctx );
 
void thermo8_alert_enable ( thermo8_t *ctx, uint8_t thys, uint8_t alert_cfg );
 
void thermo8_tcrit_lock ( thermo8_t *ctx );
 
void thermo8_tcrit_unlock ( thermo8_t *ctx );
 
void thermo8_win_lock ( thermo8_t *ctx );
 
void thermo8_win_unlock ( thermo8_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _THERMO8_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END