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@1:a031f0c6a71e, 2017-09-21 (annotated)

Committer:
fneirab
Date:
Thu Sep 21 22:35:39 2017 +0000
Revision:
1:a031f0c6a71e
Parent:
0:80c39eb8f3ba
Child:
2:ff7db397b70f
working test of writ, read and write verify functions. Removed from private for access from main.cpp

Who changed what in which revision?

UserRevisionLine numberNew contents of line
fneirab 0:80c39eb8f3ba 1 /*******************************************************************************
fneirab 0:80c39eb8f3ba 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
fneirab 0:80c39eb8f3ba 3 *
fneirab 0:80c39eb8f3ba 4 * Permission is hereby granted, free of charge, to any person obtaining a
fneirab 0:80c39eb8f3ba 5 * copy of this software and associated documentation files (the "Software"),
fneirab 0:80c39eb8f3ba 6 * to deal in the Software without restriction, including without limitation
fneirab 0:80c39eb8f3ba 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
fneirab 0:80c39eb8f3ba 8 * and/or sell copies of the Software, and to permit persons to whom the
fneirab 0:80c39eb8f3ba 9 * Software is furnished to do so, subject to the following conditions:
fneirab 0:80c39eb8f3ba 10 *
fneirab 0:80c39eb8f3ba 11 * The above copyright notice and this permission notice shall be included
fneirab 0:80c39eb8f3ba 12 * in all copies or substantial portions of the Software.
fneirab 0:80c39eb8f3ba 13 *
fneirab 0:80c39eb8f3ba 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
fneirab 0:80c39eb8f3ba 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
fneirab 0:80c39eb8f3ba 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
fneirab 0:80c39eb8f3ba 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
fneirab 0:80c39eb8f3ba 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
fneirab 0:80c39eb8f3ba 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
fneirab 0:80c39eb8f3ba 20 * OTHER DEALINGS IN THE SOFTWARE.
fneirab 0:80c39eb8f3ba 21 *
fneirab 0:80c39eb8f3ba 22 * Except as contained in this notice, the name of Maxim Integrated
fneirab 0:80c39eb8f3ba 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
fneirab 0:80c39eb8f3ba 24 * Products, Inc. Branding Policy.
fneirab 0:80c39eb8f3ba 25 *
fneirab 0:80c39eb8f3ba 26 * The mere transfer of this software does not imply any licenses
fneirab 0:80c39eb8f3ba 27 * of trade secrets, proprietary technology, copyrights, patents,
fneirab 0:80c39eb8f3ba 28 * trademarks, maskwork rights, or any other form of intellectual
fneirab 0:80c39eb8f3ba 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
fneirab 0:80c39eb8f3ba 30 * ownership rights.
fneirab 0:80c39eb8f3ba 31 ********************************************************************************/
fneirab 0:80c39eb8f3ba 32
fneirab 0:80c39eb8f3ba 33 #ifndef __MAX17055_H_
fneirab 0:80c39eb8f3ba 34 #define __MAX17055_H_
fneirab 0:80c39eb8f3ba 35
fneirab 0:80c39eb8f3ba 36 // Include
fneirab 0:80c39eb8f3ba 37 #include "mbed.h"
fneirab 0:80c39eb8f3ba 38
fneirab 0:80c39eb8f3ba 39
fneirab 0:80c39eb8f3ba 40 /**
fneirab 0:80c39eb8f3ba 41 * @brief Library for the MAX17055\n
fneirab 0:80c39eb8f3ba 42 * The MAX17055 is a low 7μA operating current fuel gauge
fneirab 0:80c39eb8f3ba 43 * which implements Maxim ModelGauge™ m5 EZ algorithm.
fneirab 0:80c39eb8f3ba 44 * ModelGauge m5 EZ makes fuel gauge implementation easy
fneirab 0:80c39eb8f3ba 45 * by eliminating battery characterization requirements
fneirab 0:80c39eb8f3ba 46 * and simplifying host software interaction.
fneirab 0:80c39eb8f3ba 47 * The ModelGauge m5 EZ robust algorithm provides tolerance against
fneirab 0:80c39eb8f3ba 48 * battery diversity for most lithium batteries and applications.
fneirab 0:80c39eb8f3ba 49 * Communication is through an SPI-compatible interface.
fneirab 0:80c39eb8f3ba 50 *
fneirab 0:80c39eb8f3ba 51 * @code
fneirab 0:80c39eb8f3ba 52 * #include "mbed.h"
fneirab 0:80c39eb8f3ba 53 * #include "MAX170155.h"
fneirab 0:80c39eb8f3ba 54 *
fneirab 0:80c39eb8f3ba 55 *
fneirab 0:80c39eb8f3ba 56 * // Hardware serial port
fneirab 0:80c39eb8f3ba 57 * Serial serial(USBTX, USBRX);
fneirab 0:80c39eb8f3ba 58 *
fneirab 0:80c39eb8f3ba 59 * //SPI communications
fneirab 0:80c39eb8f3ba 60 * I2C i2c(SCL, SDA);
fneirab 0:80c39eb8f3ba 61 *
fneirab 0:80c39eb8f3ba 62 * //Fuel Gauge
fneirab 0:80c39eb8f3ba 63 * MAX17055 max17055(i2C, Sutff );//To be completed
fneirab 0:80c39eb8f3ba 64 *
fneirab 0:80c39eb8f3ba 65 *
fneirab 0:80c39eb8f3ba 66 * int main(void)
fneirab 0:80c39eb8f3ba 67 * {
fneirab 0:80c39eb8f3ba 68 * CODE CODE
fneirab 0:80c39eb8f3ba 69 * while(true)
fneirab 0:80c39eb8f3ba 70 * {
fneirab 0:80c39eb8f3ba 71 * CODE CODE
fneirab 0:80c39eb8f3ba 72 * }
fneirab 0:80c39eb8f3ba 73 * }
fneirab 0:80c39eb8f3ba 74 * @endcode
fneirab 0:80c39eb8f3ba 75 */
fneirab 0:80c39eb8f3ba 76
fneirab 0:80c39eb8f3ba 77
fneirab 0:80c39eb8f3ba 78 // Battery struct for all the parameters
fneirab 0:80c39eb8f3ba 79 /******************************************************/
fneirab 0:80c39eb8f3ba 80 // NOTE:: I PERSONALL THINK BATTERY SHOULD BE A CLASS JUST SO THAT WE CAN KEEP ALL THE PARAMETERS
fneirab 0:80c39eb8f3ba 81 // AS PRIVATE AND PROVIDE USERS WITH CLASS FUNCTIOS TO MODIFY THE PRIVATE VALUE INSIDE
fneirab 0:80c39eb8f3ba 82 /*****************************************************/
fneirab 0:80c39eb8f3ba 83 typedef struct {
fneirab 0:80c39eb8f3ba 84 int capacity; //!< The rated capacity in mAh of the battery
fneirab 0:80c39eb8f3ba 85 int voltageMax; //!< The maximum voltage in mV that should be used for charging
fneirab 0:80c39eb8f3ba 86 int voltageNom; //!< The normal voltage in mV of the battery near mid charge
fneirab 0:80c39eb8f3ba 87 int voltageMin; //!< The minimum voltage in mV that the battery should be discharged
fneirab 0:80c39eb8f3ba 88 int temperatureMax; //!< The maximum temperature in degrees C where charging is allowed
fneirab 0:80c39eb8f3ba 89 int temperatureMin; //!< The minimum temperature in degrees C where charging is allowed
fneirab 0:80c39eb8f3ba 90 int currentCharge; //!< The current as a percentage of capicity used for charging
fneirab 0:80c39eb8f3ba 91 int currentTerm; //!< The current as a percentage of capacity to stop charging
fneirab 0:80c39eb8f3ba 92 int currentPre; //!< The current as a percentage of capacity for pre-charging
fneirab 0:80c39eb8f3ba 93 } battery_cfg_t;
fneirab 0:80c39eb8f3ba 94
fneirab 0:80c39eb8f3ba 95
fneirab 0:80c39eb8f3ba 96 //From Linux driver
fneirab 0:80c39eb8f3ba 97 typedef struct {
fneirab 0:80c39eb8f3ba 98 uint16_t designcap;
fneirab 0:80c39eb8f3ba 99 uint16_t ichgterm;
fneirab 0:80c39eb8f3ba 100 uint16_t vempty;
fneirab 0:80c39eb8f3ba 101 int vcharge;
fneirab 0:80c39eb8f3ba 102
fneirab 0:80c39eb8f3ba 103 uint16_t learncfg;
fneirab 0:80c39eb8f3ba 104 uint16_t relaxcfg;
fneirab 0:80c39eb8f3ba 105 uint16_t config;
fneirab 0:80c39eb8f3ba 106 uint16_t config2;
fneirab 0:80c39eb8f3ba 107 uint16_t fullsocthr;
fneirab 0:80c39eb8f3ba 108 uint16_t tgain;
fneirab 0:80c39eb8f3ba 109 uint16_t toff;
fneirab 0:80c39eb8f3ba 110 uint16_t curve;
fneirab 0:80c39eb8f3ba 111 uint16_t rcomp0;
fneirab 0:80c39eb8f3ba 112 uint16_t tempco;
fneirab 0:80c39eb8f3ba 113 uint16_t qrtable00;
fneirab 0:80c39eb8f3ba 114 uint16_t qrtable10;
fneirab 0:80c39eb8f3ba 115 uint16_t qrtable20;
fneirab 0:80c39eb8f3ba 116 uint16_t qrtable30;
fneirab 0:80c39eb8f3ba 117
fneirab 0:80c39eb8f3ba 118 uint16_t dpacc;
fneirab 0:80c39eb8f3ba 119 uint16_t modelcfg;
fneirab 0:80c39eb8f3ba 120
fneirab 0:80c39eb8f3ba 121 //uint16_t model_data[MAX17055_TABLE_SIZE];
fneirab 0:80c39eb8f3ba 122 int (*get_charging_status)(void);
fneirab 0:80c39eb8f3ba 123 int model_option;
fneirab 0:80c39eb8f3ba 124
fneirab 0:80c39eb8f3ba 125 /*
fneirab 0:80c39eb8f3ba 126 * rsense in miliOhms.
fneirab 0:80c39eb8f3ba 127 * default 10 (if rsense = 0) as it is the recommended value by
fneirab 0:80c39eb8f3ba 128 * the datasheet although it can be changed by board designers.
fneirab 0:80c39eb8f3ba 129 */
fneirab 0:80c39eb8f3ba 130 unsigned int rsense;
fneirab 0:80c39eb8f3ba 131 int volt_min; /* in mV */
fneirab 0:80c39eb8f3ba 132 int volt_max; /* in mV */
fneirab 0:80c39eb8f3ba 133 int temp_min; /* in DegreC */
fneirab 0:80c39eb8f3ba 134 int temp_max; /* in DegreeC */
fneirab 0:80c39eb8f3ba 135 int soc_max; /* in percent */
fneirab 0:80c39eb8f3ba 136 int soc_min; /* in percent */
fneirab 0:80c39eb8f3ba 137 int curr_max; /* in mA */
fneirab 0:80c39eb8f3ba 138 int curr_min; /* in mA */
fneirab 0:80c39eb8f3ba 139 } max17055_platform_data;
fneirab 0:80c39eb8f3ba 140
fneirab 0:80c39eb8f3ba 141 typedef struct {
fneirab 0:80c39eb8f3ba 142 int rcomp0;
fneirab 0:80c39eb8f3ba 143 int temp_co;
fneirab 0:80c39eb8f3ba 144 int full_cap_rep;
fneirab 0:80c39eb8f3ba 145 int cycles;
fneirab 0:80c39eb8f3ba 146 int full_cap_nom;
fneirab 0:80c39eb8f3ba 147 } saved_fuel_gauge_params_t;
fneirab 0:80c39eb8f3ba 148
fneirab 0:80c39eb8f3ba 149 /// Battery Fuel Gauge Class (MAX17055)
fneirab 0:80c39eb8f3ba 150 /** Generic API for a battery fuel gauge
fneirab 0:80c39eb8f3ba 151 */
fneirab 0:80c39eb8f3ba 152 class MAX17055
fneirab 0:80c39eb8f3ba 153 {
fneirab 0:80c39eb8f3ba 154
fneirab 0:80c39eb8f3ba 155 public:
fneirab 0:80c39eb8f3ba 156
fneirab 0:80c39eb8f3ba 157 ///7-bit slave address
fneirab 0:80c39eb8f3ba 158 static const uint8_t I2C_ADRS = 0x36; //Slave address 0x6C or 0x36 for 7 MSbit Addres
fneirab 0:80c39eb8f3ba 159 ///8-bit write address
fneirab 0:80c39eb8f3ba 160 static const uint8_t I2C_W_ADRS = 0x6C;
fneirab 0:80c39eb8f3ba 161 ///8-bit read address
fneirab 0:80c39eb8f3ba 162 static const uint8_t I2C_R_ADRS = 0x6D;
fneirab 0:80c39eb8f3ba 163 /////Max # Bytes in FIFO
fneirab 0:80c39eb8f3ba 164 // static const uint16_t MAX_FIFO_BYTES = 288;
fneirab 0:80c39eb8f3ba 165 // ///# of bytes per LED channel
fneirab 0:80c39eb8f3ba 166 // static const uint8_t BYTES_PER_CH = 3;
fneirab 0:80c39eb8f3ba 167
fneirab 0:80c39eb8f3ba 168
fneirab 0:80c39eb8f3ba 169
fneirab 0:80c39eb8f3ba 170
fneirab 0:80c39eb8f3ba 171 /**
fneirab 0:80c39eb8f3ba 172 * @brief Register Addresses
fneirab 0:80c39eb8f3ba 173 * @details Enumerated max17055 (MAX17055 max17055)
fneirab 0:80c39eb8f3ba 174 */
fneirab 0:80c39eb8f3ba 175 enum Registers_e {
fneirab 0:80c39eb8f3ba 176 MAX17055_STATUS_REG = 0x00,
fneirab 0:80c39eb8f3ba 177 MAX17055_VALRTTH_REG = 0x01,
fneirab 0:80c39eb8f3ba 178 MAX17055_TALRTTH_REG = 0x02,
fneirab 0:80c39eb8f3ba 179 MAX17055_SALRTTH_REG = 0x03,
fneirab 0:80c39eb8f3ba 180 MAX17055_REPCAP_REG = 0x05,
fneirab 0:80c39eb8f3ba 181 MAX17055_REPSOC_REG = 0x06,
fneirab 0:80c39eb8f3ba 182 MAX17055_TEMP_REG = 0x08,
fneirab 0:80c39eb8f3ba 183 MAX17055_VCELL_REG = 0x09,
fneirab 0:80c39eb8f3ba 184 MAX17055_CURRENT_REG = 0x0A,
fneirab 0:80c39eb8f3ba 185 MAX17055_AVGCURRENT_REG = 0x0B,
fneirab 0:80c39eb8f3ba 186 MAX17055_REMCAP_REG = 0x0F,
fneirab 0:80c39eb8f3ba 187
fneirab 0:80c39eb8f3ba 188 MAX17055_FULLCAPREP_REG = 0x10,
fneirab 0:80c39eb8f3ba 189 MAX17055_TTE_REG = 0X11,
fneirab 0:80c39eb8f3ba 190 MAX17055_QRTABLE00_REG = 0x12,
fneirab 0:80c39eb8f3ba 191 MAX17055_FULLSOCTHR_REG = 0x13,
fneirab 0:80c39eb8f3ba 192 MAX17055_CYCLES_REG = 0x17,
fneirab 0:80c39eb8f3ba 193 MAX17055_DESIGNCAP_REG = 0x18,
fneirab 0:80c39eb8f3ba 194 MAX17055_AVGVCELL_REG = 0x19,
fneirab 0:80c39eb8f3ba 195 MAX17055_MAXMINVOLT_REG = 0x1B,
fneirab 0:80c39eb8f3ba 196 MAX17055_CONFIG_REG = 0x1D,
fneirab 0:80c39eb8f3ba 197 MAX17055_ICHGTERM_REG = 0x1E,
fneirab 0:80c39eb8f3ba 198
fneirab 0:80c39eb8f3ba 199 MAX17055_VERSION_REG = 0x21,
fneirab 0:80c39eb8f3ba 200 MAX17055_QRTABLE10_REG = 0x22,
fneirab 0:80c39eb8f3ba 201 MAX17055_FULLCAPNOM_REG = 0x23,
fneirab 0:80c39eb8f3ba 202 MAX17055_LEARNCFG_REG = 0x28,
fneirab 0:80c39eb8f3ba 203 MAX17055_RELAXCFG_REG = 0x2A,
fneirab 0:80c39eb8f3ba 204 MAX17055_TGAIN_REG = 0x2C,
fneirab 0:80c39eb8f3ba 205 MAX17055_TOFF_REG = 0x2D,
fneirab 0:80c39eb8f3ba 206
fneirab 0:80c39eb8f3ba 207 MAX17055_QRTABLE20_REG = 0x32,
fneirab 0:80c39eb8f3ba 208 MAX17055_RCOMP0_REG = 0x38,
fneirab 0:80c39eb8f3ba 209 MAX17055_TEMPCO_REG = 0x39,
fneirab 0:80c39eb8f3ba 210 MAX17055_VEMPTY_REG = 0x3A,
fneirab 0:80c39eb8f3ba 211 MAX17055_FSTAT_REG = 0x3D,
fneirab 0:80c39eb8f3ba 212
fneirab 0:80c39eb8f3ba 213 MAX17055_QRTABLE30_REG = 0x42,
fneirab 0:80c39eb8f3ba 214 MAX17055_DQACC_REG = 0x45,
fneirab 0:80c39eb8f3ba 215 MAX17055_DPACC_REG = 0x46,
fneirab 0:80c39eb8f3ba 216 MAX17055_VFSOC0_REG = 0x48,
fneirab 0:80c39eb8f3ba 217 MAX17055_QH0_REG = 0x4C,
fneirab 0:80c39eb8f3ba 218 MAX17055_QH_REG = 0x4D,
fneirab 0:80c39eb8f3ba 219
fneirab 0:80c39eb8f3ba 220 MAX17055_VFSOC0_QH0_LOCK_REG = 0x60,
fneirab 0:80c39eb8f3ba 221 MAX17055_LOCK1_REG = 0x62,
fneirab 0:80c39eb8f3ba 222 MAX17055_LOCK2_REG = 0x63,
fneirab 0:80c39eb8f3ba 223
fneirab 0:80c39eb8f3ba 224 MAX17055_MODELDATA_START_REG = 0x80,
fneirab 0:80c39eb8f3ba 225
fneirab 0:80c39eb8f3ba 226 MAX17055_IALRTTH_REG = 0xB4,
fneirab 0:80c39eb8f3ba 227 MAX17055_CURVE_REG = 0xB9,
fneirab 0:80c39eb8f3ba 228 MAX17055_HIBCFG_REG = 0xBA,
fneirab 0:80c39eb8f3ba 229 MAX17055_CONFIG2_REG = 0xBB,
fneirab 0:80c39eb8f3ba 230
fneirab 0:80c39eb8f3ba 231 MAX17055_MODELCFG_REG = 0xDB,
fneirab 0:80c39eb8f3ba 232
fneirab 0:80c39eb8f3ba 233 MAX17055_OCV_REG = 0xFB,
fneirab 0:80c39eb8f3ba 234 MAX17055_VFSOC_REG = 0xFF,
fneirab 0:80c39eb8f3ba 235 } ;
fneirab 0:80c39eb8f3ba 236
fneirab 0:80c39eb8f3ba 237 /**
fneirab 0:80c39eb8f3ba 238 * @brief max17055 Constructor
fneirab 0:80c39eb8f3ba 239 * @details max17055 Constructor with battery and i2c as parameters
fneirab 0:80c39eb8f3ba 240 */
fneirab 0:80c39eb8f3ba 241 MAX17055(I2C &i2c);
fneirab 0:80c39eb8f3ba 242
fneirab 0:80c39eb8f3ba 243 /**
fneirab 0:80c39eb8f3ba 244 * @brief Fuel Gauge Destructor
fneirab 0:80c39eb8f3ba 245 */
fneirab 0:80c39eb8f3ba 246 ~MAX17055();
fneirab 0:80c39eb8f3ba 247
fneirab 0:80c39eb8f3ba 248
fneirab 0:80c39eb8f3ba 249
fneirab 1:a031f0c6a71e 250 //protected:
fneirab 0:80c39eb8f3ba 251 /**
fneirab 0:80c39eb8f3ba 252 * @brief Write Register
fneirab 0:80c39eb8f3ba 253 * @details Writes data to max17055 Register
fneirab 0:80c39eb8f3ba 254 *
fneirab 0:80c39eb8f3ba 255 * @parameters reg_addr Registers to write
fneirab 0:80c39eb8f3ba 256 * reg_data Data to write
fneirab 0:80c39eb8f3ba 257 */
fneirab 0:80c39eb8f3ba 258 int writeReg(const Registers_e reg_addr, uint16_t reg_data);
fneirab 0:80c39eb8f3ba 259
fneirab 0:80c39eb8f3ba 260 /**
fneirab 0:80c39eb8f3ba 261 * @brief Read Register
fneirab 0:80c39eb8f3ba 262 * @details Reads data from max17055 register
fneirab 0:80c39eb8f3ba 263 *
fneirab 0:80c39eb8f3ba 264 * @parameters reg_addr Register to read
fneirab 0:80c39eb8f3ba 265 */
fneirab 1:a031f0c6a71e 266 int32_t readReg(Registers_e reg_addr, uint16_t &value);
fneirab 1:a031f0c6a71e 267
fneirab 1:a031f0c6a71e 268 /**
fneirab 1:a031f0c6a71e 269 * \brief Write and Verify a MAX17055 register
fneirab 1:a031f0c6a71e 270 * \par Details
fneirab 1:a031f0c6a71e 271 * This function wites and verifies if the writing process was successful
fneirab 1:a031f0c6a71e 272 *
fneirab 1:a031f0c6a71e 273 * \param[in] reg_addr - register address
fneirab 1:a031f0c6a71e 274 * \param[out] reg_data - the variable that contains the data to write
fneirab 1:a031f0c6a71e 275 * to the register address
fneirab 1:a031f0c6a71e 276 *
fneirab 1:a031f0c6a71e 277 * \retval 1 on success
fneirab 1:a031f0c6a71e 278 * -1 if errors exist
fneirab 1:a031f0c6a71e 279 */
fneirab 1:a031f0c6a71e 280
fneirab 1:a031f0c6a71e 281
fneirab 1:a031f0c6a71e 282 int write_and_verify_reg(Registers_e reg_addr, uint16_t reg_data);
fneirab 0:80c39eb8f3ba 283
fneirab 0:80c39eb8f3ba 284
fneirab 0:80c39eb8f3ba 285
fneirab 0:80c39eb8f3ba 286 private:
fneirab 0:80c39eb8f3ba 287
fneirab 0:80c39eb8f3ba 288 I2C &m_i2cBus; // I2C object
fneirab 0:80c39eb8f3ba 289
fneirab 0:80c39eb8f3ba 290 };
fneirab 0:80c39eb8f3ba 291
fneirab 0:80c39eb8f3ba 292 //extern saved_fuel_gauge_params_t default_param;
fneirab 0:80c39eb8f3ba 293
fneirab 0:80c39eb8f3ba 294 #endif /* _MAX17055_H_ */