/*! Analog Devices DC2515 Demonstration Board. * LTC6810: 6-Channel Battery Stack Monitors * *@verbatim *NOTES * Setup: * Set the terminal baud rate to 115200 and select the newline terminator. * Ensure all jumpers on the demo board are installed in their default positions from the factory. * Refer to Demo Manual. * *USER INPUT DATA FORMAT: * decimal : 1024 * hex : 0x400 * octal : 02000 (leading 0) * binary : B10000000000 * float : 1024.0 *@endverbatim * * https://www.analog.com/en/products/ltc6810-1.html * ********************************************************************************* * Copyright 2019(c) Analog Devices, Inc. * * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * - Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * - Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * - Neither the name of Analog Devices, Inc. nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * - The use of this software may or may not infringe the patent rights * of one or more patent holders. This license does not release you * from the requirement that you obtain separate licenses from these * patent holders to use this software. * - Use of the software either in source or binary form, must be run * on or directly connected to an Analog Devices Inc. component. * * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ********************************************************************************/ /*! @file @ingroup LTC6810-1 */ /************************************* Read me ******************************************* In this sketch book: -All Global Variables are in Upper casing -All Local Variables are in lower casing -The Function wakeup_sleep(TOTAL_IC) : is used to wake the LTC681x from sleep state. It is defined in LTC681x.cpp -The Function wakeup_idle(TOTAL_IC) : is used to wake the ICs connected in daisy chain via the LTC6820 by initiating a dummy SPI communication. It is defined in LTC681x.cpp *******************************************************************************************/ /************************* Includes ***************************/ #include #include #include #include "Linduino.h" #include "LT_SPI.h" #include "UserInterface.h" #include "LTC681x.h" #include "LTC6810.h" /************************* Defines *****************************/ #define ENABLED 1 #define DISABLED 0 #define DATALOG_ENABLED 1 #define DATALOG_DISABLED 0 /**************** Local Function Declaration *******************/ void measurement_loop(uint8_t datalog_en); void print_menu(void); void print_wrconfig(void); void print_rxconfig(void); void print_cells(uint8_t datalog_en); void print_aux(uint8_t datalog_en); void print_stat(void); void print_sumofcells(void); void print_svolt(uint8_t datalog_en); void check_mux_fail(void); void print_selftest_errors(uint8_t adc_reg ,int8_t error); void print_digital_redundancy_errors(uint8_t adc_reg ,int8_t error); void print_open_wires(void); void print_pec_error_count(void); int8_t select_s_pin(void); void print_wrpwm(void); void print_rxpwm(void); void print_wrcomm(void); void print_rxcomm(void); void print_sid(void); void reverse_isospi_direction(void); void check_mute_bit(void); void print_conv_time(uint32_t conv_time); void check_error(int error); void serial_print_text(char data[]); void serial_print_hex(uint8_t data); char read_hex(void); char get_char(void); /******************************************************************** Setup Variables The following variables can be modified to configure the software. *********************************************************************/ const uint8_t TOTAL_IC = 2;//!< Number of ICs in the daisy chain //ADC Command Configurations. See LTC681x.h for options. const uint8_t ADC_OPT = ADC_OPT_DISABLED; //!< ADC Mode option bit const uint8_t ADC_CONVERSION_MODE = MD_7KHZ_3KHZ; //!< ADC Mode const uint8_t ADC_DCP = DCP_DISABLED; //!< Discharge Permitted const uint8_t CELL_CH_TO_CONVERT = CELL_CH_ALL; //!< Channel Selection for ADC conversion const uint8_t AUX_CH_TO_CONVERT = AUX_CH_ALL; //!< Channel Selection for ADC conversion const uint8_t STAT_CH_TO_CONVERT = STAT_CH_ALL; //!< Channel Selection for ADC conversion const uint8_t SEL_ALL_REG = REG_ALL; //!< Register Selection const uint8_t SEL_REG_A = REG_1; //!< Register Selection const uint8_t SEL_REG_B = REG_2; //!< Register Selection //Under Voltage and Over Voltage Thresholds const uint16_t OV_THRESHOLD = 41000; //!< Over voltage threshold ADC Code. LSB = 0.0001 ---(4.1V) const uint16_t UV_THRESHOLD = 30000; //!< Under voltage threshold ADC Code. LSB = 0.0001 ---(1V) const uint16_t MEASUREMENT_LOOP_TIME = 500; //!< Loop Time in milliseconds(ms) //Loop Measurement Setup. These Variables are ENABLED or DISABLED Remember ALL CAPS const uint8_t WRITE_CONFIG = DISABLED; //!< This is to ENABLED or DISABLED writing into to configuration registers in a continuous loop const uint8_t READ_CONFIG = DISABLED; //!< This is to ENABLED or DISABLED reading the configuration registers in a continuous loop const uint8_t MEASURE_CELL = ENABLED; //!< This is to ENABLED or DISABLED measuring the cell voltages in a continuous loop const uint8_t MEASURE_AUX = DISABLED; //!< This is to ENABLED or DISABLED reading the auxiliary registers in a continuous loop const uint8_t MEASURE_STAT = DISABLED; //!< This is to ENABLED or DISABLED reading the status registers in a continuous loop const uint8_t PRINT_PEC = DISABLED; //!< This is to ENABLED or DISABLED printing the PEC Error Count in a continuous loop /************************************ END SETUP *************************************/ /****************************************************** Global Battery Variables received from 681x commands These variables store the results from the LTC6810 register reads and the array lengths must be based on the number of ICs on the stack ******************************************************/ cell_asic BMS_IC[TOTAL_IC];//!< Global Battery Variable bool ISOSPI_DIR=BMS_IC[0].isospi_reverse; /************************************************************************* Set configuration register. Refer to the data sheet **************************************************************************/ bool ADCOPT = false; //!< ADC Mode option bit bool REFON = true; //!< Reference Powered Up Bit bool GPIOBITS[4] = {false,true,true,true}; //!< GPIO Pin Control // Gpio 1,2,3,4 uint16_t UV=UV_THRESHOLD; //!< Under voltage Comparison Voltage uint16_t OV=OV_THRESHOLD; //!< Over voltage Comparison Voltage bool DCCBITS[6] = {false,false,false,false,false,false}; //!< Discharge cell switch //Dcc 1,2,3,4,5,6 bool DCCBIT_0= false; //!< Discharge cell switch //Dcc 0 // For discharging optional 7th cell bool MCAL = false; //!< Enable Multi-Calibration bool EN_DTMEN = true; //!< Enable Discharge timer monitor bool DIS_RED = false; //!< Disable Digital Redundancy Check bool FDRF = false; //!< Force digital Redundancy Failure bool SCONV = true; //!< Enable Cell Measurement Redundancy using S Pin bool DCTOBITS[4] = {true,false,true,false}; //!< Discharge Time Out Value //Dcto 0,1,2,3 // Programed for 4 min /*Ensure that Dcto bits are set according to the required discharge time. Refer to the data sheet */ /*!********************************************************************** \brief Initializes hardware and variables @return void ***********************************************************************/ void setup() { Serial.begin(115200); quikeval_SPI_connect(); spi_enable(SPI_CLOCK_DIV16); // This will set the Linduino to have a 1MHz Clock LTC6810_init_cfg(TOTAL_IC, BMS_IC); for (uint8_t current_ic = 0; current_ic 0) { input = read_char(); } if (WRITE_CONFIG == ENABLED) { wakeup_idle(TOTAL_IC); LTC6810_wrcfg(TOTAL_IC,BMS_IC); print_wrconfig(); } if (READ_CONFIG == ENABLED) { wakeup_idle(TOTAL_IC); error = LTC6810_rdcfg(TOTAL_IC,BMS_IC); check_error(error); print_rxconfig(); } if (MEASURE_CELL == ENABLED) { wakeup_idle(TOTAL_IC); LTC6810_adcv(ADC_CONVERSION_MODE,ADC_DCP,CELL_CH_TO_CONVERT); LTC6810_pollAdc(); wakeup_idle(TOTAL_IC); error = LTC6810_rdcv(SEL_ALL_REG, TOTAL_IC,BMS_IC); check_error(error); print_cells(datalog_en); } if (MEASURE_AUX == ENABLED) { wakeup_idle(TOTAL_IC); LTC6810_adax(ADC_CONVERSION_MODE , AUX_CH_ALL); LTC6810_pollAdc(); wakeup_idle(TOTAL_IC); error = LTC6810_rdaux(SEL_ALL_REG,TOTAL_IC,BMS_IC); // Set to read back all aux registers check_error(error); print_aux(datalog_en); } if (MEASURE_STAT == ENABLED) { wakeup_idle(TOTAL_IC); LTC6810_adstat(ADC_CONVERSION_MODE, STAT_CH_ALL); LTC6810_pollAdc(); wakeup_idle(TOTAL_IC); error = LTC6810_rdstat(SEL_ALL_REG,TOTAL_IC,BMS_IC); // Set to read back all stat registers check_error(error); print_stat(); } if(PRINT_PEC == ENABLED) { print_pec_error_count(); } delay(MEASUREMENT_LOOP_TIME); } } /*!********************************* \brief Prints the main menu @return void ***********************************/ void print_menu(void) { Serial.println(F("Please enter LTC6810 Command")); Serial.println(F("Write and Read Configuration: 1 |Loop Measurements: 12 |Set Discharge: 23")); Serial.println(F("Read Configuration: 2 |Loop Measurements with Data Log output : 13 |Clear Discharge: 24")); Serial.println(F("Start Cell Voltage Conversion: 3 |Clear all ADC Measurement Registers: 14 |Write and Read of PWM : 25")); Serial.println(F("Read Cell Voltages: 4 |Run Mux Self Test: 15 |SPI Communication : 26")); Serial.println(F("Start Aux Voltage Conversion: 5 |Run ADC Self Test: 16 |I2C Communication Write to Slave :27")); Serial.println(F("Read Aux Voltages: 6 |Run Digital Redundancy Test: 17 |I2C Communication Read from Slave :28")); Serial.println(F("Start Stat Voltage Conversion: 7 |Open Wire Test for single cell detection: 18 |Reverse ISOSPI : 29")); Serial.println(F("Read Stat Voltages: 8 |Open Wire Test for multiple cell or two consecutive cells detection: 19|Read Serial ID : 30")); Serial.println(F("Start Combined Cell Voltage and Cell 0, GPIO2 Conversion: 9|Open wire for Auxiliary Measurement: 20 |Enable MUTE : 31")); Serial.println(F("Start Cell Voltage and Sum of cells: 10 |Print PEC Counter: 21 |Disable MUTE : 32")); Serial.println(F("Read S Voltage Registers: 11 |Reset PEC Counter: 22 |Set or reset the gpio pins: 33 \n")); Serial.println(F("Print 'm' for menu")); Serial.println(F("Please enter command: \n")); } /*!****************************************************************************** \brief Prints the configuration data that is going to be written to the LTC6810 to the serial port. @return void ********************************************************************************/ void print_wrconfig(void) { int cfg_pec; Serial.println(F("Written Configuration: ")); for (int current_ic = 0; current_ic>8)); Serial.print(F(", 0x")); serial_print_hex((uint8_t)(cfg_pec)); Serial.println("\n"); } } /*!***************************************************************** \brief Prints the configuration data that was read back from the LTC6810 to the serial port. @return void *******************************************************************/ void print_rxconfig(void) { Serial.println(F("Received Configuration ")); for (int current_ic=0; current_ic>8)); Serial.print(F(", 0x")); serial_print_hex((uint8_t)(pwm_pec)); Serial.println("\n"); } } /*!***************************************************************** \brief Prints the PWM configuration data that was read back from the LTC6810 to the serial port. @return void *******************************************************************/ void print_rxpwm(void) { Serial.println(F("Received pwm Configuration:")); for (uint8_t current_ic=0; current_ic>8)); Serial.print(F(", 0x")); serial_print_hex((uint8_t)(comm_pec)); Serial.println("\n"); } } /*!**************************************************************************** \brief Prints received data from COMM register onto the serial port @return void *****************************************************************************/ void print_rxcomm(void) { Serial.println(F("Received Data in COMM register:")); for (int current_ic=0; current_ic>8)); Serial.print(F(", 0x")); serial_print_hex((uint8_t)(sid_pec)); Serial.println("\n"); } } /*!**************************************************************** \brief Function to reverse the direction of ISOSPI communication when the ICs are connected in daisy chain @return void *******************************************************************/ void reverse_isospi_direction(void) { Serial.print(F("ISOSPI: ")); Serial.println(ISOSPI_DIR); BMS_IC[0].isospi_reverse =(bool)(!( ISOSPI_DIR)); ISOSPI_DIR=BMS_IC[0].isospi_reverse; Serial.print(F("Current ISOSPI Direction: ")); Serial.println(BMS_IC[0].isospi_reverse); Serial.println("\n"); } /*!**************************************************************** \brief Function to check the Mute bit in the Status Register @return void *******************************************************************/ void check_mute_bit(void) { for (int current_ic = 0 ; current_ic < TOTAL_IC; current_ic++) { Serial.print(F(" Mute bit in Status Register B: 0x")); serial_print_hex((BMS_IC[current_ic].stat.flags[1])&(0x10)); Serial.println("\n"); } } /*!**************************************************************************** \brief Function to print the Conversion Time @return void *****************************************************************************/ void print_conv_time(uint32_t conv_time) { uint16_t m_factor=1000; // to print in ms Serial.print(F("Conversion completed in:")); Serial.print(((float)conv_time/m_factor), 1); Serial.println(F("ms \n")); } /*!**************************************************************************** \brief Function to check error flag and print PEC error message @return void *****************************************************************************/ void check_error(int error) { if (error == -1) { Serial.println(F("A PEC error was detected in the received data")); } } /*!************************************************************ \brief Function to print text on serial monitor @return void *************************************************************/ void serial_print_text(char data[]) { Serial.println(data); } /*!************************************************************ \brief Function to print in HEX form @return void *************************************************************/ void serial_print_hex(uint8_t data) { if (data< 16) { Serial.print("0"); Serial.print((byte)data,HEX); } else Serial.print((byte)data,HEX); } /*!************************************************************ \brief Hex conversion constants *************************************************************/ char hex_digits[16]= { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F' }; /*!************************************************************ \brief Global Variables *************************************************************/ char hex_to_byte_buffer[5]= { '0', 'x', '0', '0', '\0' }; /*!************************************************************ \brief Buffer for ASCII hex to byte conversion *************************************************************/ char byte_to_hex_buffer[3]= { '\0','\0','\0' }; /*!**************************************************************************** \brief Read 2 hex characters from the serial buffer and convert them to a byte @return char data Read Data *****************************************************************************/ char read_hex(void) { byte data; hex_to_byte_buffer[2]=get_char(); hex_to_byte_buffer[3]=get_char(); get_char(); get_char(); data = strtol(hex_to_byte_buffer, NULL, 0); return(data); } /*!************************************************************ \brief Read a command from the serial port @return char *************************************************************/ char get_char(void) { // read a command from the serial port while (Serial.available() <= 0); return(Serial.read()); }