balancer2.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 BALANCER2_H
#define BALANCER2_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_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define BALANCER2_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.miso  = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi  = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck   = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs    = MIKROBUS( mikrobus, MIKROBUS_CS ); \
   cfg.cell2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
   cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.cell1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
   cfg.stat = MIKROBUS( mikrobus, MIKROBUS_INT )
#define BALANCER2_RETVAL  uint8_t
 
#define BALANCER2_OK           0x00
#define BALANCER2_INIT_ERROR   0xFF
#define BALANCER2_VREF_5V                         5000
#define BALANCER2_VREF_3V3                        3300
#define BALANCER2_CMD_START                        0x01
#define BALANCER2_CMD_MSBF_LSB                     0x20
#define BALANCER2_CMD_MSBF_MSB                     0x00
#define BALANCER2_CMD_SINGLE_MODE_CH0              0x80
#define BALANCER2_CMD_SINGLE_MODE_CH1              0xC0
#define BALANCER2_CMD_DIFF_MODE_CH0M_CH1P          0x40
#define BALANCER2_CMD_DIFF_MODE_CH0P_CH1M          0x00
#define BALANCER2_CMD_DUMMY                        0x00
#define BALANCER2_MASK                             0x0F
#define BALANCER2_BATT1                            0xAA
#define BALANCER2_BATT2                            0xBB
#define BALANCER2_BATT_BOTH                        0xCC
#define BALANCER2_PIN_STATE_HIGH                   1
#define BALANCER2_PIN_STATE_LOW                    0
#define BALANCER2_MODE_CHARGING                    0x10
#define BALANCER2_MODE_BALANCING_P                 0x20
#define BALANCER2_MODE_BALANCING_NP                0x30
#define BALANCER2_MODE_BALANCING_PP                0x40
#define BALANCER2_MODE_BALANCING_NPP               0x50
#define BALANCER2_MODE_BALANCING_P1                0x60
#define BALANCER2_MODE_BALANCING_NP1               0x70
#define BALANCER2_MODE_BALANCING_P2                0x80
#define BALANCER2_MODE_BALANCING_NP2               0x90
#define CHN_0_MV_MULT                              3.0
#define CHN_1_MV_MULT                              1.5
#define ADC_RESOLUTION                             4096.0
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t  cs;
    digital_out_t  cell2;
    digital_out_t  int_pin;
    digital_out_t  cell1;
    digital_out_t  stat;
 
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} balancer2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins 
 
    pin_name_t  cell2;
    pin_name_t  int_pin;
    pin_name_t  cell1;
    pin_name_t  stat;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} balancer2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void balancer2_cfg_setup ( balancer2_cfg_t *cfg );
 
BALANCER2_RETVAL balancer2_init ( balancer2_t *ctx, balancer2_cfg_t *cfg );
 
void balancer2_default_cfg ( balancer2_t *ctx );
 
void balancer2_cell_1_state ( balancer2_t *ctx, uint8_t state );
 
void balancer2_cell_2_state ( balancer2_t *ctx, uint8_t state );
 
void balancer2_supply_state ( balancer2_t *ctx, uint8_t state );
 
void balancer2_status_led_state ( balancer2_t *ctx, uint8_t state );
 
uint16_t balancer2_read_adc ( balancer2_t *ctx, uint8_t cmd_byte );
 
void balancer2_set_vref ( balancer2_t *ctx, uint16_t vref );
 
float balancer2_get_batttery_lvl ( balancer2_t *ctx, uint8_t bat_num );
 
float balancer2_adc_to_mv ( balancer2_t *ctx, uint16_t adc_val );
 
#ifdef __cplusplus
}
#endif
#endif  // _BALANCER2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END