solarenergy2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 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 SOLARENERGY2_H
#define SOLARENERGY2_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 SOLARENERGY2_REG_T_HRV_PERIOD              0x00
#define SOLARENERGY2_REG_T_HRV_MEAS                0x01
#define SOLARENERGY2_REG_T_STS_PERIOD              0x02
#define SOLARENERGY2_REG_T_LTS_PERIOD              0x03
#define SOLARENERGY2_REG_V_HRV_CFG                 0x04
#define SOLARENERGY2_REG_HRV_CHECK_LVL             0x05
#define SOLARENERGY2_REG_LTS_CFG                   0x06
#define SOLARENERGY2_REG_V_BAT_MAX_HI              0x07
#define SOLARENERGY2_REG_V_BAT_MAX_LO              0x08
#define SOLARENERGY2_REG_V_BAT_MIN_HI_DIS          0x09
#define SOLARENERGY2_REG_V_BAT_MIN_HI_CON          0x0A
#define SOLARENERGY2_REG_V_BAT_MIN_LO              0x0B
#define SOLARENERGY2_REG_V_APL_MAX_HI              0x0C
#define SOLARENERGY2_REG_V_APL_MAX_LO              0x0D
#define SOLARENERGY2_REG_LDO_CFG                   0x0E
#define SOLARENERGY2_REG_PWR_CFG                   0x0F
#define SOLARENERGY2_REG_VAUX_CFG                  0x10
#define SOLARENERGY2_REG_VAUX_GND_CFG              0x11
#define SOLARENERGY2_REG_MPPT_RATIO                0x12
#define SOLARENERGY2_REG_EXT_CFG                   0x13
#define SOLARENERGY2_REG_T_SLEEP_VSUP_LO           0x14
#define SOLARENERGY2_REG_T_SLEEP_VSUP_MID          0x15
#define SOLARENERGY2_REG_T_SLEEP_VSUP_HI           0x16
#define SOLARENERGY2_REG_T_HRV_LOW_CFG             0x17
#define SOLARENERGY2_REG_SPI_I2C_CFG               0x18
#define SOLARENERGY2_REG_PWR_MGT                   0x19
 
#define SOLARENERGY2_REG_SOFT_RES_WORD             0x1A
#define SOLARENERGY2_REG_PROTECT_KEY               0x1B
#define SOLARENERGY2_REG_LUX_METER_CFG             0x1C
#define SOLARENERGY2_REG_LUX_METER_RESULT          0x1D
#define SOLARENERGY2_REG_STATUS                    0x22
#define SOLARENERGY2_REG_VLD_STATUS                0x23
 
#define SOLARENERGY2_REG_EEPROM_0                  0x40
 
 // solarenergy2_reg
 
#define SOLARENERGY2_SET_T_HRV_PERIOD_256ms        0x00
#define SOLARENERGY2_SET_T_HRV_PERIOD_512ms        0x01
#define SOLARENERGY2_SET_T_HRV_PERIOD_1sec         0x02
#define SOLARENERGY2_SET_T_HRV_PERIOD_2sec         0x03
#define SOLARENERGY2_SET_T_HRV_PERIOD_4sec         0x04
#define SOLARENERGY2_SET_T_HRV_PERIOD_8sec         0x05
#define SOLARENERGY2_SET_T_HRV_PERIOD_16sec        0x06
#define SOLARENERGY2_SET_T_HRV_PERIOD_32sec        0x07
 
#define SOLARENERGY2_SET_T_HRV_MEAS_16ms           0x00
#define SOLARENERGY2_SET_T_HRV_MEAS_32ms           0x01
#define SOLARENERGY2_SET_T_HRV_MEAS_64ms           0x02
#define SOLARENERGY2_SET_T_HRV_MEAS_128ms          0x03
#define SOLARENERGY2_SET_T_HRV_MEAS_256ms          0x04
#define SOLARENERGY2_SET_T_HRV_MEAS_512ms          0x05
#define SOLARENERGY2_SET_T_HRV_MEAS_1sec           0x06
#define SOLARENERGY2_SET_T_HRV_MEAS_2sec           0x07
 
#define SOLARENERGY2_SET_T_STS_PERIOD_1ms          0x00
#define SOLARENERGY2_SET_T_STS_PERIOD_2ms          0x01
#define SOLARENERGY2_SET_T_STS_PERIOD_8ms          0x02
#define SOLARENERGY2_SET_T_STS_PERIOD_16ms         0x03
#define SOLARENERGY2_SET_T_STS_PERIOD_32ms         0x04
#define SOLARENERGY2_SET_T_STS_PERIOD_64ms         0x05
#define SOLARENERGY2_SET_T_STS_PERIOD_128ms        0x06
#define SOLARENERGY2_SET_T_STS_PERIOD_256ms        0x07
 
#define SOLARENERGY2_SET_T_LTS_PERIOD_1ms          0x00
#define SOLARENERGY2_SET_T_LTS_PERIOD_4ms          0x01
#define SOLARENERGY2_SET_T_LTS_PERIOD_16ms         0x02
#define SOLARENERGY2_SET_T_LTS_PERIOD_64ms         0x03
#define SOLARENERGY2_SET_T_LTS_PERIOD_256ms        0x04
#define SOLARENERGY2_SET_T_LTS_PERIOD_1sec         0x05
#define SOLARENERGY2_SET_T_LTS_PERIOD_4sec         0x06
#define SOLARENERGY2_SET_T_LTS_PERIOD_16sec        0x07
 
#define SOLARENERGY2_SET_T_HRV_LOW_PERIOD_256ms    0x00
#define SOLARENERGY2_SET_T_HRV_LOW_PERIOD_512ms    0x01
#define SOLARENERGY2_SET_T_HRV_LOW_PERIOD_1sec     0x02
#define SOLARENERGY2_SET_T_HRV_LOW_PERIOD_2sec     0x03
#define SOLARENERGY2_SET_T_HRV_LOW_PERIOD_4sec     0x04
#define SOLARENERGY2_SET_T_HRV_LOW_PERIOD_8sec     0x05
#define SOLARENERGY2_SET_T_HRV_LOW_PERIOD_16sec    0x06
#define SOLARENERGY2_SET_T_HRV_LOW_PERIOD_32sec    0x07
 
#define SOLARENERGY2_SET_T_LTS_LOW_PERIOD_2ms      0x00
#define SOLARENERGY2_SET_T_LTS_LOW_PERIOD_8ms      0x01
#define SOLARENERGY2_SET_T_LTS_LOW_PERIOD_32ms     0x02
#define SOLARENERGY2_SET_T_LTS_LOW_PERIOD_128ms    0x03
#define SOLARENERGY2_SET_T_LTS_LOW_PERIOD_512ms    0x04
#define SOLARENERGY2_SET_T_LTS_LOW_PERIOD_2sec     0x05
#define SOLARENERGY2_SET_T_LTS_LOW_PERIOD_8sec     0x06
#define SOLARENERGY2_SET_T_LTS_LOW_PERIOD_32sec    0x07
 
#define SOLARENERGY2_PROTECT_KEY_SOFT_RESET        0xE2
#define SOLARENERGY2_PROTECT_KEY_PROTECTED_REG     0x4B
#define SOLARENERGY2_PROTECT_KEY_EEPROM            0xA5
 
#define SOLARENERGY2_SET_VAUX_LDO_CFG_1_2V         0x00
#define SOLARENERGY2_SET_VAUX_LDO_CFG_1_55V        0x10
#define SOLARENERGY2_SET_VAUX_LDO_CFG_1_65V        0x20
#define SOLARENERGY2_SET_VAUX_LDO_CFG_1_8V         0x30
#define SOLARENERGY2_SET_VAUX_LDO_CFG_2_0V         0x40
#define SOLARENERGY2_SET_VAUX_LDO_CFG_2_2V         0x50
#define SOLARENERGY2_SET_VAUX_LDO_CFG_2_4V         0x60
#define SOLARENERGY2_SET_VAUX_LDO_CFG_2_6V         0x70
#define SOLARENERGY2_SET_VAUX_LDO_CFG_BIT_MASK     0x70
 
#define SOLARENERGY2_SET_ULP_LDO_CFG_1_2V          0x00
#define SOLARENERGY2_SET_ULP_LDO_CFG_1_55V         0x01
#define SOLARENERGY2_SET_ULP_LDO_CFG_1_65V         0x02
#define SOLARENERGY2_SET_ULP_LDO_CFG_1_8V          0x03
#define SOLARENERGY2_SET_ULP_LDO_CFG_2_0V          0x04
#define SOLARENERGY2_SET_ULP_LDO_CFG_2_2V          0x05
#define SOLARENERGY2_SET_ULP_LDO_CFG_2_4V          0x06
#define SOLARENERGY2_SET_ULP_LDO_CFG_2_6V          0x07
#define SOLARENERGY2_SET_ULP_LDO_CFG_BIT_MASK      0x07
 
#define SOLARENERGY2_SET_MPPT_RATIO_50             0x00
#define SOLARENERGY2_SET_MPPT_RATIO_60             0x01
#define SOLARENERGY2_SET_MPPT_RATIO_67             0x02
#define SOLARENERGY2_SET_MPPT_RATIO_71             0x03
#define SOLARENERGY2_SET_MPPT_RATIO_75             0x04
#define SOLARENERGY2_SET_MPPT_RATIO_78             0x05
#define SOLARENERGY2_SET_MPPT_RATIO_80             0x06
#define SOLARENERGY2_SET_MPPT_RATIO_82             0x07
#define SOLARENERGY2_SET_MPPT_RATIO_83             0x08
#define SOLARENERGY2_SET_MPPT_RATIO_85             0x09
#define SOLARENERGY2_SET_MPPT_RATIO_86             0x0A
#define SOLARENERGY2_SET_MPPT_RATIO_87             0x0B
#define SOLARENERGY2_SET_MPPT_RATIO_88             0x0C
#define SOLARENERGY2_SET_MPPT_BIT_MASK             0x0F
 
#define SOLARENERGY2_SET_HRV_CHECK_VLD_VTG         0x00
#define SOLARENERGY2_SET_HRV_CHECK_VLD_CUR         0x40
#define SOLARENERGY2_SET_HRV_MIN_VTG_GEN           0x01
 
#define SOLARENERGY2_SET_CRT_SRC_SEL_0mA           0x00
#define SOLARENERGY2_SET_CRT_SRC_SEL_5mA           0x01
#define SOLARENERGY2_SET_CRT_SRC_SEL_10mA          0x02
#define SOLARENERGY2_SET_CRT_SRC_SEL_15mA          0x03
#define SOLARENERGY2_CRT_SRC_SEL_BIT_MASK          0x03
 
#define SOLARENERGY2_V_BATT_APP_VTG_BIT_MASK       0x3F
 
#define SOLARENERGY2_SET_LTS_CFG_CONN_LTS_STS      0x04
#define SOLARENERGY2_SET_LTS_CFG_NORMAL_MODE       0x00
#define SOLARENERGY2_SET_LTS_CFG_NEVER_CHARGE      0x02
#define SOLARENERGY2_SET_LTS_CFG_RECHARGEABLE      0x00
#define SOLARENERGY2_SET_LTS_CFG_BATT_PROT_DIS     0x01
#define SOLARENERGY2_SET_LTS_CFG_BATT_PROT_EN      0x00
 
#define SOLARENERGY2_SET_VAUX0_CFG_STS             0x00
#define SOLARENERGY2_SET_VAUX0_CFG_LDO             0x01
#define SOLARENERGY2_SET_VAUX0_CFG_AUTO_FLT        0x02
#define SOLARENERGY2_SET_VAUX0_CFG_AUTO_GND        0x03
#define SOLARENERGY2_SET_VAUX1_CFG_STS             0x00
#define SOLARENERGY2_SET_VAUX1_CFG_LDO             0x04
#define SOLARENERGY2_SET_VAUX1_CFG_AUTO_FLT        0x08
#define SOLARENERGY2_SET_VAUX1_CFG_AUTO_GND        0x0C
#define SOLARENERGY2_SET_VAUX2_CFG_STS             0x00
#define SOLARENERGY2_SET_VAUX2_CFG_LDO             0x10
#define SOLARENERGY2_SET_VAUX2_CFG_AUTO_FLT        0x20
#define SOLARENERGY2_SET_VAUX2_CFG_AUTO_GND        0x30
#define SOLARENERGY2_SET_LDO_CFG_ULP_BIT_MASK      0x08
#define SOLARENERGY2_SET_LDO_CFG_VSUP_BIT_MASK     0x80
 
#define SOLARENERGY2_LUX_METER_BUSY_BIT_MASK       0x10
#define SOLARENERGY2_LUX_METER_BIT_MASK            0x0F
 
#define SOLARENERGY2_SET_HRV_CURRENT_LVL_15uA      0x0E
 
 
#define SOLARENERGY2_DEVICE_ADDRESS                0x77
 
 // solarenergy2_set
 
#define SOLARENERGY2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );  \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );  \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );    \
    cfg.wup = MIKROBUS( mikrobus, MIKROBUS_AN );   \
    cfg.blv = MIKROBUS( mikrobus, MIKROBUS_PWM );  \
    cfg.hlv = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // solarenergy2_map
 // solarenergy2
 
typedef struct
{
    // Output pins
    digital_out_t cs;         
    digital_out_t wup;        
    // Input pins
    digital_in_t blv;         
    digital_in_t hlv;         
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} solarenergy2_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t cs;              
    pin_name_t wup;             
    pin_name_t blv;             
    pin_name_t hlv;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} solarenergy2_cfg_t;
 
typedef enum
{
    SOLARENERGY2_OK = 0,
    SOLARENERGY2_ERROR = -1
 
} solarenergy2_return_value_t;
 
typedef struct
{
    uint8_t    eeprom_data_busy;     
    uint8_t    hrv_lux_busy;         
    uint8_t    hrv_low;              
    uint8_t    bat_low;              
    uint8_t    sw_vdcdc_lts_nsts;    
    uint8_t    sw_lts_sts;           
    uint8_t    usb_on;               
    uint8_t    lts_protect;          
} solarenergy2_status_t;
 
typedef struct
{
    uint8_t    lts_bat_min_hi;    
    uint8_t    lts_bat_min_lo;    
    uint8_t    sts_bat_max_hi;    
    uint8_t    sts_bat_max_lo;    
    uint8_t    sts_apl_max_hi;    
    uint8_t    sts_apl_max_lo;    
    uint8_t    sts_bat_min_hi;    
    uint8_t    sts_bat_min_lo;    
} solarenergy2_bat_vtg_status_t;
 
typedef struct
{
    float    v_bat_max_hi;        
    float    v_bat_max_lo;        
    float    v_bat_min_hi_dis;    
    float    v_bat_min_hi_con;    
    float    v_bat_min_lo;        
    float    v_apl_max_hi;        
    float    v_apl_max_lo;        
} solarenergy2_abs_vtg_v_t;
 
void solarenergy2_cfg_setup ( solarenergy2_cfg_t *cfg );
 
err_t solarenergy2_init ( solarenergy2_t *ctx, solarenergy2_cfg_t *cfg );
 
err_t solarenergy2_default_cfg ( solarenergy2_t *ctx );
 
err_t solarenergy2_generic_write ( solarenergy2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t solarenergy2_generic_read ( solarenergy2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t solarenergy2_write_reg ( solarenergy2_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t solarenergy2_write_eeprom ( solarenergy2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t solarenergy2_soft_reset ( solarenergy2_t *ctx );
 
err_t solarenergy2_get_status ( solarenergy2_t *ctx, solarenergy2_status_t *status );
 
err_t solarenergy2_get_bat_vtg_status ( solarenergy2_t *ctx, solarenergy2_bat_vtg_status_t *bat_vtg_status );
 
err_t solarenergy2_set_sleep_vsup ( solarenergy2_t *ctx, float sleep_vsup_sec );
 
err_t solarenergy2_set_mppt_ratio ( solarenergy2_t *ctx, uint8_t mppt_ratio );
 
err_t solarenergy2_set_ldo_cfg ( solarenergy2_t *ctx, uint8_t vaux_ldo, uint8_t ulp_ldo );
 
err_t solarenergy2_config_abs_voltage ( solarenergy2_t *ctx, solarenergy2_abs_vtg_v_t abs_vtg );
 
err_t solarenergy2_set_pwr_current_source ( solarenergy2_t *ctx, uint8_t crt_src_sel );
 
err_t solarenergy2_store_config ( solarenergy2_t *ctx );
 
void solarenergy2_set_wup_pin ( solarenergy2_t *ctx, uint8_t state );
 
uint8_t solarenergy2_get_en_hv_cell_low_state ( solarenergy2_t *ctx );
 
uint8_t solarenergy2_get_battery_low_state ( solarenergy2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // SOLARENERGY2_H
 
 // solarenergy2
 
// ------------------------------------------------------------------------ END