adbms.h

Go to the documentation of this file.

 
#ifndef ADBMS_H
#define ADBMS_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "adbms6380.h"
#include "common/phal/spi.h"
#include "common/strbuf/strbuf.h"
 
// Number of ADBMS modules in the daisy chain.
#define ADBMS_MODULE_COUNT (8)
 
// Number of attempts to retry a read if a PEC failure is detected before continuing.
#define ADBMS_PEC_FAIL_MAX_RETRIES (3)
 
// 10kOhm voltage divider on the thermistor input
#define ADBMS_GPIO_R1 (10000.0f)
// VREF2 = 3.0v and is the input to the thermistor voltage divider
#define ADBMS_GPIO_VIN (3.0f)
 
// Max SPI TX is a command + all the data packets for all the modules.
#define ADBMS_SPI_TX_BUFFER_SIZE \
    (ADBMS6380_COMMAND_PKT_SIZE + (ADBMS_MODULE_COUNT * ADBMS6380_SINGLE_DATA_PKT_SIZE))
// MAX SPI RX is all the data packets for all the modules.
#define ADBMS_SPI_RX_BUFFER_SIZE (ADBMS6380_SINGLE_DATA_PKT_SIZE * ADBMS_MODULE_COUNT)
 
#define ADBMS_REGA_REFON        (true)
#define ADBMS_REGA_CTH          (0b110) // 25.05 mV
#define ADBMS_REGB_OV_THRESHOLD (4.2f)  // Volts
#define ADBMS_REGB_UV_THRESHOLD (3.0f)  // Volts
#define ADBMS_ADCV_RD           (false)
#define ADBMS_ADCV_CONT         (true) // Continuous
#define ADBMS_ADCV_DCP          (false)
#define ADBMS_ADCV_RSTF         (true)
#define ADBMS_ADCV_OW           (0b00)
#define ADBMS_ADAX_OW           (false)
#define ADBMS_ADAX_PUP          (false)
#define ADBMS_ADAX_CH           (0b00000)
 
typedef enum {
    ADBMS_STATE_IDLE       = 0, // Not connected or awaiting re-connection.
    ADBMS_STATE_CONNECTED  = 1, // Actively connected and reading/controlling
    ADBMS_STATE_RECOVERING = 2, // Detected an error and attempting to recover
} adbms_state_t;
 
typedef struct {
    float cell_voltages[ADBMS6380_CELL_COUNT];
    int16_t cell_voltages_raw[ADBMS6380_CELL_COUNT];
    float min_voltage;
    float max_voltage;
    float avg_voltage;
    float sum_voltage;
 
    float therms_voltages[ADBMS6380_GPIO_COUNT];
    float therms_temps[ADBMS6380_GPIO_COUNT];
 
    float min_therm_temp;
    float max_therm_temp;
    float avg_therm_temp;
 
    bool is_discharging[ADBMS6380_CELL_COUNT];
 
    uint8_t rega[ADBMS6380_SINGLE_DATA_RAW_SIZE];
    uint8_t regb[ADBMS6380_SINGLE_DATA_RAW_SIZE];
 
    bool err_rega_mismatch;
    bool err_regb_mismatch;
} adbms_module_t;
 
typedef struct {
    adbms_state_t state;
 
    adbms_module_t modules[ADBMS_MODULE_COUNT];
 
    float min_voltage;
    float max_voltage;
    float avg_voltage;
    float sum_voltage;
 
    float min_therm_temp;
    float max_therm_temp;
    float avg_therm_temp;
 
    bool is_balancing_enabled;
 
    SPI_InitConfig_t *spi;
    strbuf_t tx_strbuf;
    uint8_t rx_buf[ADBMS_SPI_RX_BUFFER_SIZE];
 
    bool err_spi;
    bool err_connect;
    bool err_rega_mismatch;
    bool err_regb_mismatch;
 
    bool err_rega_pec;
    bool err_regb_pec;
    bool err_cell_voltage_pecs[ADBMS6380_RDCV_CMD_COUNT];
    bool err_gpio_voltage_pecs[ADBMS6380_RDAUX_CMD_COUNT];
} adbms_bms_t;
 
void adbms_init(adbms_bms_t *bms, SPI_InitConfig_t *spi, uint8_t *tx_buf);
 
bool adbms_write_rega(adbms_bms_t *bms);
bool adbms_write_regb(adbms_bms_t *bms);
bool adbms_read_and_check_rega(adbms_bms_t *bms);
bool adbms_read_and_check_regb(adbms_bms_t *bms);
 
void adbms_connect(adbms_bms_t *bms);
 
void adbms_read_cells(adbms_bms_t *bms);
void adbms_read_therms(adbms_bms_t *bms);
 
void adbms_calculate_balance_cells(adbms_bms_t *bms, float min_voltage, float min_delta);
void adbms_balance_and_update_regb(adbms_bms_t *bms, float min_voltage, float min_delta);
 
void adbms_periodic(adbms_bms_t *bms, float min_voltage_for_balance, float min_delta_for_balance);
 
#endif // ADBMS_H