vctmonitor.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2021 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 VCTMONITOR_H
#define VCTMONITOR_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 VCTMONITOR_REG_STATUS            0x00
#define VCTMONITOR_REG_CONTROL           0x01
#define VCTMONITOR_REG_TRIGGER           0x02
#define VCTMONITOR_REG_AMB_TEMP_MSB      0x04
#define VCTMONITOR_REG_AMB_TEMP_LSB      0x05
#define VCTMONITOR_REG_V1_MSB            0x06
#define VCTMONITOR_REG_V1_LSB            0x07
#define VCTMONITOR_REG_V2_MSB            0x08
#define VCTMONITOR_REG_V2_LSB            0x09
#define VCTMONITOR_REG_V3_MSB            0x0A
#define VCTMONITOR_REG_V3_LSB            0x0B
#define VCTMONITOR_REG_V4_MSB            0x0C
#define VCTMONITOR_REG_V4_LSB            0x0D
#define VCTMONITOR_REG_VCC_MSB           0x0E
#define VCTMONITOR_REG_VCC_LSB           0x0F
 
 // vctmonitor_reg
 
#define VCTMONITOR_CTRL_TEMP_FORMAT_C    0x00
#define VCTMONITOR_CTRL_TEMP_FORMAT_K    0x80
#define VCTMONITOR_CTRL_REPEATED_MEAS    0x00
#define VCTMONITOR_CTRL_SINGLE_MEAS      0x40
#define VCTMONITOR_CTRL_MODE1_INT_TEMP   0x00
#define VCTMONITOR_CTRL_MODE1_V12        0x08
#define VCTMONITOR_CTRL_MODE1_V34        0x10
#define VCTMONITOR_CTRL_MODE1_ALL        0x18
 
#define VCTMONITOR_CTRL_MODE2_V12_TR2    0x00
#define VCTMONITOR_CTRL_MODE2_V1_2_TR2   0x01
#define VCTMONITOR_CTRL_MODE2_V1_2_V34   0x02
#define VCTMONITOR_CTRL_MODE2_V34_TR1    0x03
#define VCTMONITOR_CTRL_MODE2_V3_4_TR1   0x04
#define VCTMONITOR_CTRL_MODE2_TR2_TR1    0x05
#define VCTMONITOR_CTRL_MODE2_V1_2_V3_4  0x06
#define VCTMONITOR_CTRL_MODE2_V1234      0x07
 
#define VCTMONITOR_STATUS_VCC_READY      0x40
#define VCTMONITOR_STATUS_V4_READY       0x20
#define VCTMONITOR_STATUS_V3_READY       0x10
#define VCTMONITOR_STATUS_V2_READY       0x08
#define VCTMONITOR_STATUS_V1_READY       0x04
#define VCTMONITOR_STATUS_TINT_READY     0x02
#define VCTMONITOR_STATUS_BUSY           0x01
 
 
#define VCTMONITOR_SLAVE_ADDR_GND_GND    0x4C
#define VCTMONITOR_SLAVE_ADDR_GND_VCC    0x4D
#define VCTMONITOR_SLAVE_ADDR_VCC_VCC    0x4F
#define VCTMONITOR_SLAVE_ADDR_VCC_GND    0x4E
 
 // vctmonitor_set
 
#define VCTMONITOR_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // vctmonitor_map
 // vctmonitor
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                                
    // I2C slave address
    uint8_t slave_address;                           
} vctmonitor_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} vctmonitor_cfg_t;
 
typedef enum
{
   VCTMONITOR_OK = 0,
   VCTMONITOR_ERROR = -1
 
} vctmonitor_return_value_t;
 
void vctmonitor_cfg_setup ( vctmonitor_cfg_t *cfg );
 
err_t vctmonitor_init ( vctmonitor_t *ctx, vctmonitor_cfg_t *cfg );
 
err_t vctmonitor_default_cfg ( vctmonitor_t *ctx );
 
err_t vctmonitor_generic_write ( vctmonitor_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t vctmonitor_generic_read ( vctmonitor_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
uint8_t vctmonitor_get_status ( vctmonitor_t *ctx );
 
void vctmonitor_configuration ( vctmonitor_t *ctx, uint8_t cfg );
 
float vctmonitor_read_temperature ( vctmonitor_t *ctx );
 
float vctmonitor_read_voltage_differential ( vctmonitor_t *ctx );
 
float vctmonitor_read_voltage_single ( vctmonitor_t *ctx, uint8_t channel );
 
float vctmonitor_read_current ( vctmonitor_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // VCTMONITOR_H
 
 // vctmonitor
 
// ------------------------------------------------------------------------ END