Maxim Integrated / MAX17055_EZconfig

This is a library for the MAX17055 Li+ Battery Fuel Gauge.

Dependents:   Low_Power_Long_Distance_IR_Vision_Robot MAX17055_EZconfig MAX17055_EZconfig_Sample Low_Power_Long_Distance_IR_Vision_Robot

Fork of max17055 by Maxim Integrated

max17055.h@23:2ec07d0239be, 2018-10-23 (annotated)

Committer:
fneirab
Date:
Tue Oct 23 23:15:10 2018 +0000
Revision:
23:2ec07d0239be
Parent:
22:607f6917832a 
Change read and write function to protected. Tested get_regInfo function for access to all available registers in the MAX17055 from main.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
fneirab 9:f29d5e49b190 1 /*******************************************************************************
fneirab 9:f29d5e49b190 2 * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
fneirab 4:a4d6ae2182c2 3 *
fneirab 4:a4d6ae2182c2 4 * Permission is hereby granted, free of charge, to any person obtaining a
fneirab 4:a4d6ae2182c2 5 * copy of this software and associated documentation files (the "Software"),
fneirab 4:a4d6ae2182c2 6 * to deal in the Software without restriction, including without limitation
fneirab 4:a4d6ae2182c2 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
fneirab 4:a4d6ae2182c2 8 * and/or sell copies of the Software, and to permit persons to whom the
fneirab 4:a4d6ae2182c2 9 * Software is furnished to do so, subject to the following conditions:
fneirab 4:a4d6ae2182c2 10 *
fneirab 4:a4d6ae2182c2 11 * The above copyright notice and this permission notice shall be included
fneirab 4:a4d6ae2182c2 12 * in all copies or substantial portions of the Software.
fneirab 4:a4d6ae2182c2 13 *
fneirab 4:a4d6ae2182c2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
fneirab 4:a4d6ae2182c2 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
fneirab 4:a4d6ae2182c2 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
fneirab 4:a4d6ae2182c2 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
fneirab 4:a4d6ae2182c2 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
fneirab 4:a4d6ae2182c2 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
fneirab 4:a4d6ae2182c2 20 * OTHER DEALINGS IN THE SOFTWARE.
fneirab 4:a4d6ae2182c2 21 *
fneirab 4:a4d6ae2182c2 22 * Except as contained in this notice, the name of Maxim Integrated
fneirab 4:a4d6ae2182c2 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
fneirab 4:a4d6ae2182c2 24 * Products, Inc. Branding Policy.
fneirab 4:a4d6ae2182c2 25 *
fneirab 4:a4d6ae2182c2 26 * The mere transfer of this software does not imply any licenses
fneirab 4:a4d6ae2182c2 27 * of trade secrets, proprietary technology, copyrights, patents,
fneirab 4:a4d6ae2182c2 28 * trademarks, maskwork rights, or any other form of intellectual
fneirab 4:a4d6ae2182c2 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
fneirab 4:a4d6ae2182c2 30 * ownership rights.
fneirab 9:f29d5e49b190 31 *******************************************************************************
fneirab 9:f29d5e49b190 32 */
fneirab 0:80c39eb8f3ba 33
fneirab 0:80c39eb8f3ba 34 #ifndef __MAX17055_H_
fneirab 0:80c39eb8f3ba 35 #define __MAX17055_H_
fneirab 0:80c39eb8f3ba 36
fneirab 0:80c39eb8f3ba 37 // Include
fneirab 0:80c39eb8f3ba 38 #include "mbed.h"
fneirab 0:80c39eb8f3ba 39
fneirab 2:ff7db397b70f 40 /* STATUS register bits */
fneirab 2:ff7db397b70f 41 #define MAX17055_STATUS_BST (1 << 3)
fneirab 2:ff7db397b70f 42 #define MAX17055_STATUS_POR (1 << 1)
fneirab 2:ff7db397b70f 43
fneirab 5:a18a189588dc 44 /// Model loading options
fneirab 9:f29d5e49b190 45 #define MODEL_LOADING_OPTION1 1 //EZ Config
fneirab 13:fc91b283e689 46
fneirab 17:7447aaa9c121 47 //Remove this and leave it
fneirab 0:80c39eb8f3ba 48
fneirab 0:80c39eb8f3ba 49 /**
fneirab 11:bdbd3104995b 50 * @brief MBED Library for the MAX17055\n
fneirab 11:bdbd3104995b 51 * The MAX17055 is a low 7μA operating current fuel gauge which \n
fneirab 17:7447aaa9c121 52 * implements Maxim ModelGauge™ m5 EZ algorithm. \n
fneirab 11:bdbd3104995b 53 * <a href="https://www.maximintegrated.com/en/design/partners-and-technology/design-technology/modelgauge-battery-fuel-gauge-technology.html">ModelGauge</a>
fneirab 11:bdbd3104995b 54 * m5 EZ makes fuel gauge implementation easy by eliminating \n
fneirab 11:bdbd3104995b 55 * battery characterization requirements and simplifying host \n
fneirab 11:bdbd3104995b 56 * software interaction. The ModelGauge m5 EZ robust algorithm \n
fneirab 11:bdbd3104995b 57 * provides tolerance against battery diversity for most lithium \n
fneirab 17:7447aaa9c121 58 * batteries and applications. Communication is through a \n
fneirab 17:7447aaa9c121 59 * I2C interface. The MAX17055 comes as part of the \n
fneirab 17:7447aaa9c121 60 * MAX32620FTHR MBED enable development board.\n
fneirab 11:bdbd3104995b 61 * \n
fneirab 11:bdbd3104995b 62 * Visit the product page for more information:
fneirab 11:bdbd3104995b 63 * <a href="https://www.maximintegrated.com/MAX17055.html">MAX17055 Product Page</a>\n
fneirab 11:bdbd3104995b 64 * <a href="https://www.maximintegrated.com/MAX17055.pdf">MAX17055 Data Sheet</a>\n
fneirab 11:bdbd3104995b 65 * <a href="https://www.maximintegrated.com/MAX32620FTHR.html">MAX32620FTHR Product Page</a>\n
fneirab 11:bdbd3104995b 66 * <a href="https://www.maximintegrated.com/MAX32620FTHR.pdf">MAX32620FTHR Data Sheet</a>\n
fneirab 17:7447aaa9c121 67 *
fneirab 22:607f6917832a 68 * Battery Recommendations based on sense Resistor Values (MAX32620FTHR comes with a 5 mOhm rsense resistor)\n
fneirab 19:20590e00feab 69 *
fneirab 19:20590e00feab 70 * | BATTERY FULL CAPACITY(mAh) | Sense Resistor | Current Register Resolution(uA) | Current Register Range(A) | Capacity Resolution(mAh) |\n
fneirab 19:20590e00feab 71 * |----------------------------|----------------|---------------------------------|---------------------------|--------------------------|\n
fneirab 19:20590e00feab 72 * | 1600 - 24576 | 5 | 312.5 | +/- 10.24 | 1 |\n
fneirab 19:20590e00feab 73 * | 8000 - 12288 | 10 | 156.25 | +/- 5.12 | 0.5 |\n
fneirab 19:20590e00feab 74 * | 400-6144 | 20 | 78.125 | +/- 2.56 | 0.25 |\n
fneirab 19:20590e00feab 75 * | 160-2458 | 50 | 31.25 | +/- 1.024 | 0.1 |\n
fneirab 19:20590e00feab 76 * | 40-614 | 200 | 7.8125 | +/- 0.256 | 0.025 |\n
fneirab 19:20590e00feab 77 *
fneirab 19:20590e00feab 78 *
fneirab 0:80c39eb8f3ba 79 * @code
fneirab 0:80c39eb8f3ba 80 * #include "mbed.h"
fneirab 17:7447aaa9c121 81 * #include "max17055.h"
fneirab 0:80c39eb8f3ba 82 *
fneirab 0:80c39eb8f3ba 83 *
fneirab 17:7447aaa9c121 84 * //LED indication
fneirab 17:7447aaa9c121 85 * DigitalOut rled(LED1);
fneirab 17:7447aaa9c121 86 *
fneirab 17:7447aaa9c121 87 * //I2C communications
fneirab 17:7447aaa9c121 88 * I2C i2cBus(P5_7, P6_0);
fneirab 17:7447aaa9c121 89 *
fneirab 17:7447aaa9c121 90 * //Fuel Gauge
fneirab 17:7447aaa9c121 91 * MAX17055 fuelGauge(i2cBus);
fneirab 17:7447aaa9c121 92 * MAX17055::platform_data design_param;
fneirab 17:7447aaa9c121 93 * MAX17055::saved_FG_params_t saved_param;
fneirab 17:7447aaa9c121 94 *
fneirab 17:7447aaa9c121 95 * //MAX77650 PMIC
fneirab 17:7447aaa9c121 96 * #define POWER_HOLD_ON 1
fneirab 17:7447aaa9c121 97 * #define POWER_HOLD_OFF 0
fneirab 17:7447aaa9c121 98 *
fneirab 17:7447aaa9c121 99 * DigitalOut pw_Hold(P2_2, POWER_HOLD_ON); //To enable battery operation from the PMIC
fneirab 17:7447aaa9c121 100 *
fneirab 17:7447aaa9c121 101 * //Battery Parameters Storage from the Fuel Gauge MAX17055
fneirab 17:7447aaa9c121 102 * union max17055_u {
fneirab 17:7447aaa9c121 103 * struct battery {
fneirab 17:7447aaa9c121 104 * uint8_t avg_soc_FG; // in Battery Percent
fneirab 21:441840cc7423 105 * float tte_FG; // in seconds
fneirab 17:7447aaa9c121 106 * float ttf_FG; // in seconds
fneirab 17:7447aaa9c121 107 * int avg_vcell_FG; // in 78.125uV per bit
fneirab 17:7447aaa9c121 108 * float avg_curr_FG; // in uAmps
fneirab 21:441840cc7423 109 * float curr_FG; // in uAmps
fneirab 17:7447aaa9c121 110 * int rep_cap; // in mAh
fneirab 17:7447aaa9c121 111 * int rep_SOC; // in %
fneirab 17:7447aaa9c121 112 * } battery;
fneirab 17:7447aaa9c121 113 * } max17055_u;
fneirab 17:7447aaa9c121 114 *
fneirab 17:7447aaa9c121 115 *
fneirab 17:7447aaa9c121 116 * int main(void)
fneirab 17:7447aaa9c121 117 * {
fneirab 17:7447aaa9c121 118 * rled = true;
fneirab 22:607f6917832a 119 * //These are the calculated parameters for rsense 5mOhm found in the MAX32620FTHR and a 350mAh Li+ Cell.
fneirab 22:607f6917832a 120 * design_param.designcap = 0x015E; //Design Battery Capacity mAh this can change depending on the batteries implemented see battery data sheet for details.
fneirab 17:7447aaa9c121 121 * design_param.ichgterm = 0x0070; // Charge Termination Current for the Battery This is specified by the manufacturer.
fneirab 22:607f6917832a 122 * design_param.vempty = 0x9600; // Battery Empty Voltage This is specified by design, but manufacturer has a min Empty voltage specification.
fneirab 17:7447aaa9c121 123 * design_param.vcharge = 4200; // Battery Charge Voltage can be obtained from MAX77650 configuration
fneirab 17:7447aaa9c121 124 * design_param.rsense = 5; //5mOhms for MAX32620, keep in mind the MAX17055EVKIT has a 10mOhm resistor. This is a design specific value. Used for calculation results.
fneirab 0:80c39eb8f3ba 125 *
fneirab 17:7447aaa9c121 126 * //Saved Parameters
fneirab 17:7447aaa9c121 127 * //saved_param.cycles = 0; //This value is used for the save parameters function
fneirab 17:7447aaa9c121 128 *
fneirab 17:7447aaa9c121 129 * status = fuelGauge.init(design_param);
fneirab 17:7447aaa9c121 130 * // printf("Init FuelGauge Function Status= %X \r\n",status);
fneirab 17:7447aaa9c121 131 *
fneirab 17:7447aaa9c121 132 * if (status == 0)
fneirab 17:7447aaa9c121 133 * fuelGauge.save_Params(saved_param);
fneirab 17:7447aaa9c121 134 *
fneirab 17:7447aaa9c121 135 * while (1) {
fneirab 22:607f6917832a 136 * //This code is an example to illustrate the performance or the Fuel Gauge. This can change with the design requirements. Use this as a way to troubleshoot the FuelGauge.
fneirab 17:7447aaa9c121 137 * rled = !rled;
fneirab 17:7447aaa9c121 138 *
fneirab 17:7447aaa9c121 139 * max17055_u.battery.avg_vcell_FG = fuelGauge.get_avgVcell();
fneirab 17:7447aaa9c121 140 * max17055_u.battery.avg_curr_FG = fuelGauge.get_AvgCurrent(design_param);
fneirab 21:441840cc7423 141 * max17055_u.battery.curr_FG = fuelGauge.get_Current(design_param);
fneirab 21:441840cc7423 142 * max17055_u.battery.rep_cap = fuelGauge.get_battCAP(design_param);
fneirab 21:441840cc7423 143 * max17055_u.battery.rep_SOC = fuelGauge.get_SOC();
fneirab 17:7447aaa9c121 144 *
fneirab 17:7447aaa9c121 145 * //This code works with Arduino Serial Plotter to visualize data
fneirab 21:441840cc7423 146 * printf("%f " ,(max17055_u.battery.avg_vcell_FG/1000000.0)); //V
fneirab 21:441840cc7423 147 * printf("%f " ,max17055_u.battery.avg_curr_FG); //uA
fneirab 21:441840cc7423 148 * printf("%f " ,max17055_u.battery.curr_FG); //uA
fneirab 21:441840cc7423 149 * printf("%d " ,max17055_u.battery.rep_cap); //mAh
fneirab 21:441840cc7423 150 * printf("%d " ,max17055_u.battery.rep_SOC); //%
fneirab 17:7447aaa9c121 151 * printf("\n");
fneirab 17:7447aaa9c121 152 * wait(1);
fneirab 17:7447aaa9c121 153 * }
fneirab 0:80c39eb8f3ba 154 * }
fneirab 0:80c39eb8f3ba 155 * @endcode
fneirab 0:80c39eb8f3ba 156 */
fneirab 0:80c39eb8f3ba 157
fneirab 11:bdbd3104995b 158
fneirab 17:7447aaa9c121 159
fneirab 11:bdbd3104995b 160 /*-------------------------------------------------------------------------*//**
fneirab 11:bdbd3104995b 161 * MAX17055 Class
fneirab 11:bdbd3104995b 162 * @brief Class for MAX17055 Battery Fuel Gauge
fneirab 11:bdbd3104995b 163 * - Generic API for Implementing the Battery Fuel Gauge
fneirab 0:80c39eb8f3ba 164 */
fneirab 0:80c39eb8f3ba 165 class MAX17055
fneirab 0:80c39eb8f3ba 166 {
fneirab 0:80c39eb8f3ba 167
fneirab 0:80c39eb8f3ba 168 public:
fneirab 0:80c39eb8f3ba 169
fneirab 0:80c39eb8f3ba 170 ///8-bit write address
fneirab 0:80c39eb8f3ba 171 static const uint8_t I2C_W_ADRS = 0x6C;
fneirab 0:80c39eb8f3ba 172 ///8-bit read address
fneirab 0:80c39eb8f3ba 173 static const uint8_t I2C_R_ADRS = 0x6D;
fneirab 6:5ced10109ebf 174
fneirab 0:80c39eb8f3ba 175 /**
fneirab 11:bdbd3104995b 176 * @brief Register Addresses for the MAX17055
fneirab 11:bdbd3104995b 177 * @details Enumerated register addresses
fneirab 0:80c39eb8f3ba 178 */
fneirab 17:7447aaa9c121 179 enum Registers_e {
fneirab 11:bdbd3104995b 180 STATUS_REG = 0x00, /*!< 0x00 default value = 0x0002 */
fneirab 11:bdbd3104995b 181 VALRTTH_REG = 0x01, /*!< 0x01 */
fneirab 17:7447aaa9c121 182 TALRTTH_REG = 0x02, /*!< 0x02 */
fneirab 17:7447aaa9c121 183 SALRTTH_REG = 0x03, /*!< 0x03 */
fneirab 12:519a18fc3b28 184 ATRATE_REG = 0x04, /*!< 0x04 write negative 2s comp of a 16-bit theoretical load */
fneirab 17:7447aaa9c121 185 REPCAP_REG = 0x05, /*!< 0x05 */
fneirab 11:bdbd3104995b 186 REPSOC_REG = 0x06, /*!< 0x06 */
fneirab 11:bdbd3104995b 187 TEMP_REG = 0x08, /*!< 0x08 */
fneirab 11:bdbd3104995b 188 VCELL_REG = 0x09, /*!< 0x09 */
fneirab 17:7447aaa9c121 189 CURRENT_REG = 0x0A, /*!< 0x0A */
fneirab 11:bdbd3104995b 190 AVGCURRENT_REG = 0x0B, /*!< 0x0B */
fneirab 11:bdbd3104995b 191 MIXSOC_REG = 0x0D, /*!< 0x0D */
fneirab 11:bdbd3104995b 192 AVSOC_REG = 0x0E, /*!< 0x0E */
fneirab 11:bdbd3104995b 193 MIXCAP_REG = 0x0F, /*!< 0x0F */
fneirab 7:479a36909ced 194
fneirab 11:bdbd3104995b 195 FULLCAPREP_REG = 0x10, /*!< 0x10 */
fneirab 11:bdbd3104995b 196 TTE_REG = 0X11, /*!< 0x11 */
fneirab 11:bdbd3104995b 197 QRTABLE00_REG = 0x12, /*!< 0x12 */
fneirab 11:bdbd3104995b 198 FULLSOCTHR_REG = 0x13, /*!< 0x13 */
fneirab 11:bdbd3104995b 199 CYCLES_REG = 0x17, /*!< 0x17 */
fneirab 11:bdbd3104995b 200 DESIGNCAP_REG = 0x18, /*!< 0x18 */
fneirab 11:bdbd3104995b 201 AVGVCELL_REG = 0x19, /*!< 0x19 */
fneirab 11:bdbd3104995b 202 MAXMINVOLT_REG = 0x1B, /*!< 0x1B */
fneirab 11:bdbd3104995b 203 CONFIG_REG = 0x1D, /*!< 0x1D default = 0x2210 */
fneirab 11:bdbd3104995b 204 ICHGTERM_REG = 0x1E, /*!< 0x1E */
fneirab 0:80c39eb8f3ba 205
fneirab 11:bdbd3104995b 206 TTF_REG = 0x20, /*!< 0x20 */
fneirab 11:bdbd3104995b 207 VERSION_REG = 0x21, /*!< 0x21 */
fneirab 11:bdbd3104995b 208 QRTABLE10_REG = 0x22, /*!< 0x22 */
fneirab 11:bdbd3104995b 209 FULLCAPNOM_REG = 0x23, /*!< 0x23 */
fneirab 11:bdbd3104995b 210 LEARNCFG_REG = 0x28, /*!< 0x28 */
fneirab 11:bdbd3104995b 211 RELAXCFG_REG = 0x2A, /*!< 0x2A */
fneirab 11:bdbd3104995b 212 TGAIN_REG = 0x2C, /*!< 0x2C */
fneirab 11:bdbd3104995b 213 TOFF_REG = 0x2D, /*!< 0x2D */
fneirab 11:bdbd3104995b 214
fneirab 11:bdbd3104995b 215 QRTABLE20_REG = 0x32, /*!< 0x32 */
fneirab 11:bdbd3104995b 216 RCOMP0_REG = 0x38, /*!< 0x38 */
fneirab 11:bdbd3104995b 217 TEMPCO_REG = 0x39, /*!< 0x39 */
fneirab 11:bdbd3104995b 218 VEMPTY_REG = 0x3A, /*!< 0x39 */
fneirab 11:bdbd3104995b 219 FSTAT_REG = 0x3D, /*!< 0x39 */
fneirab 7:479a36909ced 220
fneirab 11:bdbd3104995b 221 QRTABLE30_REG = 0x42, /*!< 0x39 */
fneirab 11:bdbd3104995b 222 DQACC_REG = 0x45, /*!< 0x39 */
fneirab 11:bdbd3104995b 223 DPACC_REG = 0x46, /*!< 0x39 */
fneirab 11:bdbd3104995b 224 VFSOC0_REG = 0x48, /*!< 0x39 */
fneirab 11:bdbd3104995b 225 QH0_REG = 0x4C, /*!< 0x39 */
fneirab 11:bdbd3104995b 226 QH_REG = 0x4D, /*!< 0x39 */
fneirab 7:479a36909ced 227
fneirab 11:bdbd3104995b 228 VFSOC0_QH0_LOCK_REG = 0x60, /*!< 0x39 */
fneirab 11:bdbd3104995b 229 LOCK1_REG = 0x62, /*!< 0x39 */
fneirab 11:bdbd3104995b 230 LOCK2_REG = 0x63, /*!< 0x39 */
fneirab 7:479a36909ced 231
fneirab 11:bdbd3104995b 232 MODELDATA_START_REG = 0x80, /*!< 0x39 */
fneirab 7:479a36909ced 233
fneirab 11:bdbd3104995b 234 IALRTTH_REG = 0xB4, /*!< 0x39 */
fneirab 11:bdbd3104995b 235 CURVE_REG = 0xB9, /*!< 0x39 */
fneirab 12:519a18fc3b28 236 HIBCFG_REG = 0xBA, /*!< 0x39 default = 0x870C (0x890C)*/
fneirab 11:bdbd3104995b 237 CONFIG2_REG = 0xBB, /*!< 0xBB default = 0x3658 */
fneirab 7:479a36909ced 238
fneirab 12:519a18fc3b28 239 MODELCFG_REG = 0xDB, /*!< 0xDB */
fneirab 12:519a18fc3b28 240 ATTTE_REG = 0xDD, /*!< 0xDD */
fneirab 12:519a18fc3b28 241 ATAVSOC_REG = 0xDE, /*!< 0xDE */
fneirab 12:519a18fc3b28 242 ATAVCAP_REG = 0xDF, /*!< 0xDF */
fneirab 0:80c39eb8f3ba 243
fneirab 11:bdbd3104995b 244 OCV_REG = 0xFB, /*!< 0x39 */
fneirab 11:bdbd3104995b 245 VFSOC_REG = 0xFF /*!< 0x39 */
fneirab 11:bdbd3104995b 246 };
fneirab 17:7447aaa9c121 247
fneirab 7:479a36909ced 248 /**
fneirab 12:519a18fc3b28 249 * @brief Saved Platform Data for Fuel Gauge Model
fneirab 12:519a18fc3b28 250 * @details Struct with fuel Gauge Platform Data for Fuel Gauge Model based on the final design.
fneirab 11:bdbd3104995b 251 */
fneirab 17:7447aaa9c121 252 struct platform_data { //to clarify if Part of the class
fneirab 11:bdbd3104995b 253 uint16_t designcap;/*!< struct value 1 */
fneirab 11:bdbd3104995b 254 uint16_t ichgterm; /*!< struct value 2 */
fneirab 11:bdbd3104995b 255 uint16_t vempty; /*!< struct value 3 */
fneirab 11:bdbd3104995b 256 int vcharge; /*!< struct value 1 */
fneirab 7:479a36909ced 257
fneirab 7:479a36909ced 258 /**
fneirab 7:479a36909ced 259 * rsense in miliOhms.
fneirab 7:479a36909ced 260 * default 10 (if rsense = 0) as it is the recommended value by
fneirab 7:479a36909ced 261 * the datasheet although it can be changed by board designers.
fneirab 17:7447aaa9c121 262 * MAX32620FTHR has a 5mOhm sense resitor installed.
fneirab 7:479a36909ced 263 */
fneirab 17:7447aaa9c121 264 unsigned int rsense;
fneirab 17:7447aaa9c121 265 } ;
fneirab 17:7447aaa9c121 266
fneirab 7:479a36909ced 267 /**
fneirab 11:bdbd3104995b 268 * @brief Saved Fuel Gauge Parameters
fneirab 11:bdbd3104995b 269 * @details It is recommended to save the learned capacity parameters
fneirab 11:bdbd3104995b 270 * every time bit 2 of the Cycles register toggles (so that it
fneirab 11:bdbd3104995b 271 * is saved every 64% change in the battery) so that if power is
fneirab 11:bdbd3104995b 272 * lost the values can easily be restored.
fneirab 11:bdbd3104995b 273 */
fneirab 17:7447aaa9c121 274 struct saved_FG_params_t {
fneirab 11:bdbd3104995b 275 int rcomp0; /**< The RComp0 is the characterization information critical to computing the open-circuit voltage of a cell under loaded conditions. */
fneirab 11:bdbd3104995b 276 int temp_co; /**< The TempCo value is the temperature compensation information based on the RComp0 value*/
fneirab 11:bdbd3104995b 277 int full_cap_rep; /**< The full capacity in relation with RepCap for reporting to the GUI. A new full-capacity value is calculated at the end of every charge cycle in the application. */
fneirab 11:bdbd3104995b 278 int cycles; /**< The Cycles value maintains a total count of the number of charge/discharge cycles of the cell that have occurred */
fneirab 11:bdbd3104995b 279 int full_cap_nom; /**< This is the calculated full capacity of the cell, not including temperature and empty compensation. A new full-capacity nominal value
fneirab 11:bdbd3104995b 280 is calculated each time a cell relaxation event is detected. This values is used to generate other outputs of the ModelGauge m5 algorithm. */
fneirab 17:7447aaa9c121 281 } ;
fneirab 9:f29d5e49b190 282
fneirab 0:80c39eb8f3ba 283 /**
fneirab 0:80c39eb8f3ba 284 * @brief max17055 Constructor
fneirab 0:80c39eb8f3ba 285 */
fneirab 0:80c39eb8f3ba 286 MAX17055(I2C &i2c);
fneirab 0:80c39eb8f3ba 287
fneirab 0:80c39eb8f3ba 288 /**
fneirab 0:80c39eb8f3ba 289 * @brief Fuel Gauge Destructor
fneirab 0:80c39eb8f3ba 290 */
fneirab 0:80c39eb8f3ba 291 ~MAX17055();
fneirab 17:7447aaa9c121 292
fneirab 5:a18a189588dc 293 /**
fneirab 11:bdbd3104995b 294 * @brief Poll Flag clear Function.
fneirab 11:bdbd3104995b 295 */
fneirab 7:479a36909ced 296 int poll_flag_clear(Registers_e reg_addr, int mask, int timeout);
fneirab 5:a18a189588dc 297
fneirab 11:bdbd3104995b 298 /**
fneirab 11:bdbd3104995b 299 * @brief Check POR function
fneirab 11:bdbd3104995b 300 */
fneirab 11:bdbd3104995b 301 int check_POR_func();
fneirab 9:f29d5e49b190 302
fneirab 9:f29d5e49b190 303 /**
fneirab 11:bdbd3104995b 304 * @brief clear POR bit function
fneirab 11:bdbd3104995b 305 */
fneirab 9:f29d5e49b190 306 int clear_POR_bit();
fneirab 4:a4d6ae2182c2 307
fneirab 2:ff7db397b70f 308 /**
fneirab 12:519a18fc3b28 309 * @brief Write and Verify a MAX17055 register
fneirab 11:bdbd3104995b 310 */
fneirab 2:ff7db397b70f 311 int write_and_verify_reg(Registers_e reg_addr, uint16_t reg_data);
fneirab 4:a4d6ae2182c2 312
fneirab 2:ff7db397b70f 313 /**
fneirab 11:bdbd3104995b 314 * @brief Initialization Function for MAX17055.
fneirab 11:bdbd3104995b 315 */
fneirab 7:479a36909ced 316 int init(platform_data des_data);
fneirab 4:a4d6ae2182c2 317
fneirab 3:f77a8345b0e3 318 /**
fneirab 12:519a18fc3b28 319 * @brief Get Temperature Function from the MAX17055 TEMP register.
fneirab 11:bdbd3104995b 320 */
fneirab 7:479a36909ced 321 int get_temperature();
fneirab 4:a4d6ae2182c2 322
fneirab 3:f77a8345b0e3 323 /**
fneirab 12:519a18fc3b28 324 * @brief Forced Exit Hibernate Mode Function for MAX17055
fneirab 11:bdbd3104995b 325 */
fneirab 17:7447aaa9c121 326 uint16_t forcedExitHiberMode();// Hibernate spelling
fneirab 17:7447aaa9c121 327
fneirab 7:479a36909ced 328 /**
fneirab 14:519754351400 329 * @brief EZ Config function
fneirab 11:bdbd3104995b 330 */
fneirab 13:fc91b283e689 331 uint16_t EZconfig(platform_data des_data);
fneirab 17:7447aaa9c121 332
fneirab 17:7447aaa9c121 333 /**
fneirab 17:7447aaa9c121 334 * @brief Get reported Battery Capacity Function from MAX17055 Fuel Gauge
fneirab 17:7447aaa9c121 335 */
fneirab 17:7447aaa9c121 336 int get_battCAP(platform_data des_data);
fneirab 17:7447aaa9c121 337
fneirab 7:479a36909ced 338 /**
fneirab 11:bdbd3104995b 339 * @brief Get reported State Of Charge(SOC) Function from MAX17055 Fuel Gauge
fneirab 11:bdbd3104995b 340 */
fneirab 7:479a36909ced 341 int get_SOC();
fneirab 8:ca8765c30ed2 342
fneirab 11:bdbd3104995b 343 /**
fneirab 12:519a18fc3b28 344 * @brief Get at rate Average State Of Charge(SOC) Function from MAX17055 Fuel Gauge.
fneirab 11:bdbd3104995b 345 */
fneirab 12:519a18fc3b28 346 int get_atAvSOC();
fneirab 8:ca8765c30ed2 347
fneirab 8:ca8765c30ed2 348 /**
fneirab 11:bdbd3104995b 349 * @brief Get the Time to Empty(TTE) Function form MAX17055 Fuel Gauge.
fneirab 17:7447aaa9c121 350 */
fneirab 12:519a18fc3b28 351 float get_TTE();
fneirab 7:479a36909ced 352
fneirab 7:479a36909ced 353 /**
fneirab 11:bdbd3104995b 354 * @brief Get the at Time to Empty(atTTE) value Function for MAX17055 Fuel Gauge.
fneirab 17:7447aaa9c121 355 */
fneirab 12:519a18fc3b28 356 float get_atTTE();
fneirab 9:f29d5e49b190 357
fneirab 9:f29d5e49b190 358 /**
fneirab 11:bdbd3104995b 359 * @brief Get mix State Of Charge(SOC) Function for MAX17055 Fuel Gauge.
fneirab 11:bdbd3104995b 360 */
fneirab 9:f29d5e49b190 361 int get_mixSOC();
fneirab 8:ca8765c30ed2 362
fneirab 8:ca8765c30ed2 363 /**
fneirab 11:bdbd3104995b 364 * @brief Get the Time to Full(TTE) values Function for MAX17055 Fuel Gauge.
fneirab 11:bdbd3104995b 365 */
fneirab 12:519a18fc3b28 366 float get_TTF();
fneirab 17:7447aaa9c121 367
fneirab 11:bdbd3104995b 368 /**
fneirab 11:bdbd3104995b 369 * @brief Get voltage of the cell Function for MAX17055 Fuel Gauge.
fneirab 11:bdbd3104995b 370 */
fneirab 11:bdbd3104995b 371 int get_Vcell();
fneirab 7:479a36909ced 372
fneirab 7:479a36909ced 373 /**
fneirab 17:7447aaa9c121 374 * @brief Get average voltage of the cell Function for MAX17055 Fuel Gauge.
fneirab 17:7447aaa9c121 375 */
fneirab 17:7447aaa9c121 376 int get_avgVcell();
fneirab 17:7447aaa9c121 377
fneirab 17:7447aaa9c121 378 /**
fneirab 11:bdbd3104995b 379 * @brief Get current Function for MAX17055 Fuel Gauge.
fneirab 11:bdbd3104995b 380 */
fneirab 17:7447aaa9c121 381 float get_Current(platform_data des_data);
fneirab 17:7447aaa9c121 382
fneirab 7:479a36909ced 383 /**
fneirab 11:bdbd3104995b 384 * @brief Get average current Function for MAX17055 Fuel Gauge.
fneirab 17:7447aaa9c121 385 */
fneirab 17:7447aaa9c121 386 float get_AvgCurrent(platform_data des_data);
fneirab 17:7447aaa9c121 387
fneirab 7:479a36909ced 388 /**
fneirab 17:7447aaa9c121 389 * @brief lsb_to_uvolts Conversion Function
fneirab 11:bdbd3104995b 390 */
fneirab 7:479a36909ced 391 int lsb_to_uvolts(uint16_t lsb);
fneirab 17:7447aaa9c121 392
fneirab 7:479a36909ced 393 /**
fneirab 17:7447aaa9c121 394 * @brief raw_current_to_uamp Conversion Function
fneirab 11:bdbd3104995b 395 */
fneirab 17:7447aaa9c121 396 float raw_current_to_uamps(uint32_t curr, int rsense_value);
fneirab 17:7447aaa9c121 397
fneirab 17:7447aaa9c121 398 /**
fneirab 17:7447aaa9c121 399 * @brief raw_cap_to_uAh Conversion Function
fneirab 17:7447aaa9c121 400 */
fneirab 17:7447aaa9c121 401 int raw_cap_to_uAh(uint32_t raw_cap, int rsense_value);
fneirab 3:f77a8345b0e3 402
fneirab 11:bdbd3104995b 403 /**
fneirab 11:bdbd3104995b 404 * @brief Save Learned Parameters Function for battery Fuel Gauge model.
fneirab 11:bdbd3104995b 405 */
fneirab 11:bdbd3104995b 406 int save_Params(saved_FG_params_t FG_params);
fneirab 4:a4d6ae2182c2 407
fneirab 9:f29d5e49b190 408 /**
fneirab 12:519a18fc3b28 409 * @brief Restore Parameters Function for battery Fuel Gauge model.
fneirab 11:bdbd3104995b 410 */
fneirab 11:bdbd3104995b 411 int restore_Params(saved_FG_params_t FG_params);
fneirab 9:f29d5e49b190 412
fneirab 9:f29d5e49b190 413 /**
fneirab 11:bdbd3104995b 414 * @brief Function to Save Average Current to At Rate register.
fneirab 11:bdbd3104995b 415 */
fneirab 11:bdbd3104995b 416 int avCurr_2_atRate();
fneirab 2:ff7db397b70f 417
fneirab 17:7447aaa9c121 418 /**
fneirab 17:7447aaa9c121 419 * @brief Get specified register info Function for MAX17055 Fuel Gauge.
fneirab 17:7447aaa9c121 420 */
fneirab 17:7447aaa9c121 421 int16_t get_regInfo(Registers_e reg_addr);
fneirab 17:7447aaa9c121 422
fneirab 23:2ec07d0239be 423 protected:
fneirab 11:bdbd3104995b 424
fneirab 0:80c39eb8f3ba 425 /**
fneirab 11:bdbd3104995b 426 * @brief Writes to MAX17055 register.
fneirab 0:80c39eb8f3ba 427 */
fneirab 0:80c39eb8f3ba 428 int writeReg(const Registers_e reg_addr, uint16_t reg_data);
fneirab 0:80c39eb8f3ba 429
fneirab 11:bdbd3104995b 430
fneirab 0:80c39eb8f3ba 431 /**
fneirab 11:bdbd3104995b 432 * @brief Reads from MAX17055 register.
fneirab 0:80c39eb8f3ba 433 */
fneirab 1:a031f0c6a71e 434 int32_t readReg(Registers_e reg_addr, uint16_t &value);
fneirab 4:a4d6ae2182c2 435
fneirab 2:ff7db397b70f 436
fneirab 0:80c39eb8f3ba 437
fneirab 2:ff7db397b70f 438
fneirab 0:80c39eb8f3ba 439 private:
fneirab 0:80c39eb8f3ba 440
fneirab 11:bdbd3104995b 441 I2C &m_i2cBus; // I2C object
fneirab 0:80c39eb8f3ba 442
fneirab 0:80c39eb8f3ba 443 };
fneirab 0:80c39eb8f3ba 444
fneirab 0:80c39eb8f3ba 445 #endif /* _MAX17055_H_ */