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
max17055.h@8:ca8765c30ed2, 2017-11-02 (annotated)
- Committer:
- fneirab
- Date:
- Thu Nov 02 18:11:16 2017 +0000
- Revision:
- 8:ca8765c30ed2
- Parent:
- 7:479a36909ced
- Child:
- 9:f29d5e49b190
latest library update from Mobility Demo work
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
fneirab | 4:a4d6ae2182c2 | 1 | /******************************************************************//** |
fneirab | 4:a4d6ae2182c2 | 2 | * @file max17055.h |
fneirab | 4:a4d6ae2182c2 | 3 | * |
fneirab | 5:a18a189588dc | 4 | * @author Felipe Neira - Maxim Integrated - TTS |
fneirab | 4:a4d6ae2182c2 | 5 | * |
fneirab | 4:a4d6ae2182c2 | 6 | * @version 1.0 |
fneirab | 4:a4d6ae2182c2 | 7 | * |
fneirab | 4:a4d6ae2182c2 | 8 | * Started: 11SEP17 |
fneirab | 4:a4d6ae2182c2 | 9 | * |
fneirab | 4:a4d6ae2182c2 | 10 | * Updated: |
fneirab | 4:a4d6ae2182c2 | 11 | * |
fneirab | 4:a4d6ae2182c2 | 12 | * @brief Source file for MAX31855 class |
fneirab | 4:a4d6ae2182c2 | 13 | * |
fneirab | 4:a4d6ae2182c2 | 14 | ******************************************************************************** |
fneirab | 4:a4d6ae2182c2 | 15 | * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved. |
fneirab | 4:a4d6ae2182c2 | 16 | * |
fneirab | 4:a4d6ae2182c2 | 17 | * Permission is hereby granted, free of charge, to any person obtaining a |
fneirab | 4:a4d6ae2182c2 | 18 | * copy of this software and associated documentation files (the "Software"), |
fneirab | 4:a4d6ae2182c2 | 19 | * to deal in the Software without restriction, including without limitation |
fneirab | 4:a4d6ae2182c2 | 20 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
fneirab | 4:a4d6ae2182c2 | 21 | * and/or sell copies of the Software, and to permit persons to whom the |
fneirab | 4:a4d6ae2182c2 | 22 | * Software is furnished to do so, subject to the following conditions: |
fneirab | 4:a4d6ae2182c2 | 23 | * |
fneirab | 4:a4d6ae2182c2 | 24 | * The above copyright notice and this permission notice shall be included |
fneirab | 4:a4d6ae2182c2 | 25 | * in all copies or substantial portions of the Software. |
fneirab | 4:a4d6ae2182c2 | 26 | * |
fneirab | 4:a4d6ae2182c2 | 27 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
fneirab | 4:a4d6ae2182c2 | 28 | * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
fneirab | 4:a4d6ae2182c2 | 29 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
fneirab | 4:a4d6ae2182c2 | 30 | * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES |
fneirab | 4:a4d6ae2182c2 | 31 | * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
fneirab | 4:a4d6ae2182c2 | 32 | * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
fneirab | 4:a4d6ae2182c2 | 33 | * OTHER DEALINGS IN THE SOFTWARE. |
fneirab | 4:a4d6ae2182c2 | 34 | * |
fneirab | 4:a4d6ae2182c2 | 35 | * Except as contained in this notice, the name of Maxim Integrated |
fneirab | 4:a4d6ae2182c2 | 36 | * Products, Inc. shall not be used except as stated in the Maxim Integrated |
fneirab | 4:a4d6ae2182c2 | 37 | * Products, Inc. Branding Policy. |
fneirab | 4:a4d6ae2182c2 | 38 | * |
fneirab | 4:a4d6ae2182c2 | 39 | * The mere transfer of this software does not imply any licenses |
fneirab | 4:a4d6ae2182c2 | 40 | * of trade secrets, proprietary technology, copyrights, patents, |
fneirab | 4:a4d6ae2182c2 | 41 | * trademarks, maskwork rights, or any other form of intellectual |
fneirab | 4:a4d6ae2182c2 | 42 | * property whatsoever. Maxim Integrated Products, Inc. retains all |
fneirab | 4:a4d6ae2182c2 | 43 | * ownership rights. |
fneirab | 4:a4d6ae2182c2 | 44 | * |
fneirab | 4:a4d6ae2182c2 | 45 | ******************************************************************************/ |
fneirab | 0:80c39eb8f3ba | 46 | |
fneirab | 0:80c39eb8f3ba | 47 | #ifndef __MAX17055_H_ |
fneirab | 0:80c39eb8f3ba | 48 | #define __MAX17055_H_ |
fneirab | 0:80c39eb8f3ba | 49 | |
fneirab | 0:80c39eb8f3ba | 50 | // Include |
fneirab | 0:80c39eb8f3ba | 51 | #include "mbed.h" |
fneirab | 0:80c39eb8f3ba | 52 | |
fneirab | 2:ff7db397b70f | 53 | /* STATUS register bits */ |
fneirab | 2:ff7db397b70f | 54 | #define MAX17055_STATUS_BST (1 << 3) |
fneirab | 2:ff7db397b70f | 55 | #define MAX17055_STATUS_POR (1 << 1) |
fneirab | 2:ff7db397b70f | 56 | |
fneirab | 5:a18a189588dc | 57 | /// Model loading options |
fneirab | 7:479a36909ced | 58 | #define MODEL_LOADING_OPTION1 1 //may need to move thisa to class definition |
fneirab | 4:a4d6ae2182c2 | 59 | #define MODEL_LOADING_OPTION2 2 |
fneirab | 4:a4d6ae2182c2 | 60 | #define MODEL_LOADING_OPTION3 3 |
fneirab | 4:a4d6ae2182c2 | 61 | |
fneirab | 0:80c39eb8f3ba | 62 | |
fneirab | 0:80c39eb8f3ba | 63 | /** |
fneirab | 0:80c39eb8f3ba | 64 | * @brief Library for the MAX17055\n |
fneirab | 0:80c39eb8f3ba | 65 | * The MAX17055 is a low 7μA operating current fuel gauge |
fneirab | 0:80c39eb8f3ba | 66 | * which implements Maxim ModelGauge™ m5 EZ algorithm. |
fneirab | 0:80c39eb8f3ba | 67 | * ModelGauge m5 EZ makes fuel gauge implementation easy |
fneirab | 0:80c39eb8f3ba | 68 | * by eliminating battery characterization requirements |
fneirab | 0:80c39eb8f3ba | 69 | * and simplifying host software interaction. |
fneirab | 0:80c39eb8f3ba | 70 | * The ModelGauge m5 EZ robust algorithm provides tolerance against |
fneirab | 0:80c39eb8f3ba | 71 | * battery diversity for most lithium batteries and applications. |
fneirab | 0:80c39eb8f3ba | 72 | * Communication is through an SPI-compatible interface. |
fneirab | 0:80c39eb8f3ba | 73 | * |
fneirab | 0:80c39eb8f3ba | 74 | * @code |
fneirab | 0:80c39eb8f3ba | 75 | * #include "mbed.h" |
fneirab | 0:80c39eb8f3ba | 76 | * #include "MAX170155.h" |
fneirab | 0:80c39eb8f3ba | 77 | * |
fneirab | 0:80c39eb8f3ba | 78 | * |
fneirab | 0:80c39eb8f3ba | 79 | * // Hardware serial port |
fneirab | 0:80c39eb8f3ba | 80 | * Serial serial(USBTX, USBRX); |
fneirab | 0:80c39eb8f3ba | 81 | * |
fneirab | 0:80c39eb8f3ba | 82 | * //SPI communications |
fneirab | 0:80c39eb8f3ba | 83 | * I2C i2c(SCL, SDA); |
fneirab | 0:80c39eb8f3ba | 84 | * |
fneirab | 0:80c39eb8f3ba | 85 | * //Fuel Gauge |
fneirab | 0:80c39eb8f3ba | 86 | * MAX17055 max17055(i2C, Sutff );//To be completed |
fneirab | 0:80c39eb8f3ba | 87 | * |
fneirab | 0:80c39eb8f3ba | 88 | * |
fneirab | 0:80c39eb8f3ba | 89 | * int main(void) |
fneirab | 0:80c39eb8f3ba | 90 | * { |
fneirab | 0:80c39eb8f3ba | 91 | * CODE CODE |
fneirab | 0:80c39eb8f3ba | 92 | * while(true) |
fneirab | 0:80c39eb8f3ba | 93 | * { |
fneirab | 0:80c39eb8f3ba | 94 | * CODE CODE |
fneirab | 0:80c39eb8f3ba | 95 | * } |
fneirab | 0:80c39eb8f3ba | 96 | * } |
fneirab | 0:80c39eb8f3ba | 97 | * @endcode |
fneirab | 0:80c39eb8f3ba | 98 | */ |
fneirab | 0:80c39eb8f3ba | 99 | |
fneirab | 0:80c39eb8f3ba | 100 | |
fneirab | 4:a4d6ae2182c2 | 101 | |
fneirab | 4:a4d6ae2182c2 | 102 | |
fneirab | 5:a18a189588dc | 103 | |
fneirab | 5:a18a189588dc | 104 | |
fneirab | 4:a4d6ae2182c2 | 105 | |
fneirab | 5:a18a189588dc | 106 | //! BATTERY Battery Parameters Class |
fneirab | 5:a18a189588dc | 107 | /*! |
fneirab | 5:a18a189588dc | 108 | Generic API for battery parameters |
fneirab | 5:a18a189588dc | 109 | */ |
fneirab | 5:a18a189588dc | 110 | class BATTERY |
fneirab | 5:a18a189588dc | 111 | { |
fneirab | 5:a18a189588dc | 112 | |
fneirab | 5:a18a189588dc | 113 | public: |
fneirab | 5:a18a189588dc | 114 | |
fneirab | 0:80c39eb8f3ba | 115 | |
fneirab | 5:a18a189588dc | 116 | struct battery_cfg_t{ |
fneirab | 5:a18a189588dc | 117 | int capacity; //!< The rated capacity in mAh of the battery |
fneirab | 5:a18a189588dc | 118 | int voltageMax; //!< The maximum voltage in mV that should be used for charging |
fneirab | 5:a18a189588dc | 119 | int voltageNom; //!< The normal voltage in mV of the battery near mid charge |
fneirab | 5:a18a189588dc | 120 | int voltageMin; //!< The minimum voltage in mV that the battery should be discharged |
fneirab | 5:a18a189588dc | 121 | int temperatureMax; //!< The maximum temperature in degrees C where charging is allowed |
fneirab | 5:a18a189588dc | 122 | int temperatureMin; //!< The minimum temperature in degrees C where charging is allowed |
fneirab | 5:a18a189588dc | 123 | int currentCharge; //!< The current as a percentage of capicity used for charging |
fneirab | 5:a18a189588dc | 124 | int currentTerm; //!< The current as a percentage of capacity to stop charging |
fneirab | 5:a18a189588dc | 125 | int currentPre; //!< The current as a percentage of capacity for pre-charging |
fneirab | 5:a18a189588dc | 126 | } ; |
fneirab | 5:a18a189588dc | 127 | |
fneirab | 5:a18a189588dc | 128 | |
fneirab | 5:a18a189588dc | 129 | |
fneirab | 0:80c39eb8f3ba | 130 | |
fneirab | 4:a4d6ae2182c2 | 131 | }; |
fneirab | 0:80c39eb8f3ba | 132 | |
fneirab | 4:a4d6ae2182c2 | 133 | /******************************************************************//** |
fneirab | 4:a4d6ae2182c2 | 134 | * MAX17055 Class |
fneirab | 4:a4d6ae2182c2 | 135 | **********************************************************************/ |
fneirab | 4:a4d6ae2182c2 | 136 | /// MAX17055 Battery Fuel Gauge Class |
fneirab | 0:80c39eb8f3ba | 137 | /** Generic API for a battery fuel gauge |
fneirab | 0:80c39eb8f3ba | 138 | */ |
fneirab | 0:80c39eb8f3ba | 139 | class MAX17055 |
fneirab | 0:80c39eb8f3ba | 140 | { |
fneirab | 0:80c39eb8f3ba | 141 | |
fneirab | 0:80c39eb8f3ba | 142 | public: |
fneirab | 0:80c39eb8f3ba | 143 | |
fneirab | 0:80c39eb8f3ba | 144 | ///7-bit slave address |
fneirab | 0:80c39eb8f3ba | 145 | static const uint8_t I2C_ADRS = 0x36; //Slave address 0x6C or 0x36 for 7 MSbit Addres |
fneirab | 0:80c39eb8f3ba | 146 | ///8-bit write address |
fneirab | 0:80c39eb8f3ba | 147 | static const uint8_t I2C_W_ADRS = 0x6C; |
fneirab | 0:80c39eb8f3ba | 148 | ///8-bit read address |
fneirab | 0:80c39eb8f3ba | 149 | static const uint8_t I2C_R_ADRS = 0x6D; |
fneirab | 6:5ced10109ebf | 150 | |
fneirab | 6:5ced10109ebf | 151 | |
fneirab | 0:80c39eb8f3ba | 152 | /////Max # Bytes in FIFO |
fneirab | 0:80c39eb8f3ba | 153 | // static const uint16_t MAX_FIFO_BYTES = 288; |
fneirab | 0:80c39eb8f3ba | 154 | // ///# of bytes per LED channel |
fneirab | 0:80c39eb8f3ba | 155 | // static const uint8_t BYTES_PER_CH = 3; |
fneirab | 0:80c39eb8f3ba | 156 | |
fneirab | 6:5ced10109ebf | 157 | |
fneirab | 6:5ced10109ebf | 158 | //Defined instance for external structs |
fneirab | 5:a18a189588dc | 159 | struct BATTERY::battery_cfg_t batt_con; |
fneirab | 7:479a36909ced | 160 | |
fneirab | 0:80c39eb8f3ba | 161 | |
fneirab | 0:80c39eb8f3ba | 162 | |
fneirab | 0:80c39eb8f3ba | 163 | |
fneirab | 0:80c39eb8f3ba | 164 | /** |
fneirab | 4:a4d6ae2182c2 | 165 | * @brief Register Addresses for the MAX17055 |
fneirab | 5:a18a189588dc | 166 | * @details Enumerated register addresses |
fneirab | 0:80c39eb8f3ba | 167 | */ |
fneirab | 0:80c39eb8f3ba | 168 | enum Registers_e { |
fneirab | 7:479a36909ced | 169 | STATUS_REG = 0x00, /**< 0x00 */ |
fneirab | 7:479a36909ced | 170 | VALRTTH_REG = 0x01, /**< 0x01 */ |
fneirab | 7:479a36909ced | 171 | TALRTTH_REG = 0x02, /**< 0x02 */ |
fneirab | 7:479a36909ced | 172 | SALRTTH_REG = 0x03, /**< 0x04 */ |
fneirab | 7:479a36909ced | 173 | REPCAP_REG = 0x05, /**< 0x05 */ |
fneirab | 7:479a36909ced | 174 | REPSOC_REG = 0x06, /**< 0x06 */ |
fneirab | 7:479a36909ced | 175 | TEMP_REG = 0x08, /**< 0x07 */ |
fneirab | 7:479a36909ced | 176 | VCELL_REG = 0x09, /**< 0x08 */ |
fneirab | 7:479a36909ced | 177 | CURRENT_REG = 0x0A, /**< 0x0A */ |
fneirab | 7:479a36909ced | 178 | AVGCURRENT_REG = 0x0B, /**< 0x0B */ |
fneirab | 8:ca8765c30ed2 | 179 | AVSOC_REG = 0x0E, |
fneirab | 8:ca8765c30ed2 | 180 | MIXCAP_REG = 0x0F, /**< 0x0F */ |
fneirab | 7:479a36909ced | 181 | |
fneirab | 7:479a36909ced | 182 | FULLCAPREP_REG = 0x10, /**< 0x10 */ |
fneirab | 7:479a36909ced | 183 | TTE_REG = 0X11, /**< 0x11 */ |
fneirab | 7:479a36909ced | 184 | QRTABLE00_REG = 0x12, /**< 0x12 */ |
fneirab | 7:479a36909ced | 185 | FULLSOCTHR_REG = 0x13, /**< 0x13 */ |
fneirab | 7:479a36909ced | 186 | CYCLES_REG = 0x17, /**< 0x17 */ |
fneirab | 7:479a36909ced | 187 | DESIGNCAP_REG = 0x18, /**< 0x18 */ |
fneirab | 7:479a36909ced | 188 | AVGVCELL_REG = 0x19, /**< 0x19 */ |
fneirab | 7:479a36909ced | 189 | MAXMINVOLT_REG = 0x1B, /**< 0x1B */ |
fneirab | 7:479a36909ced | 190 | CONFIG_REG = 0x1D, /**< 0x1D */ |
fneirab | 7:479a36909ced | 191 | ICHGTERM_REG = 0x1E, /**< 0x1E */ |
fneirab | 0:80c39eb8f3ba | 192 | |
fneirab | 8:ca8765c30ed2 | 193 | TTF_REG = 0x20, |
fneirab | 7:479a36909ced | 194 | VERSION_REG = 0x21, /**< 0x21 */ |
fneirab | 7:479a36909ced | 195 | QRTABLE10_REG = 0x22, |
fneirab | 7:479a36909ced | 196 | FULLCAPNOM_REG = 0x23, |
fneirab | 7:479a36909ced | 197 | LEARNCFG_REG = 0x28, |
fneirab | 7:479a36909ced | 198 | RELAXCFG_REG = 0x2A, |
fneirab | 7:479a36909ced | 199 | TGAIN_REG = 0x2C, |
fneirab | 7:479a36909ced | 200 | TOFF_REG = 0x2D, |
fneirab | 7:479a36909ced | 201 | |
fneirab | 7:479a36909ced | 202 | QRTABLE20_REG = 0x32, |
fneirab | 7:479a36909ced | 203 | RCOMP0_REG = 0x38, |
fneirab | 7:479a36909ced | 204 | TEMPCO_REG = 0x39, |
fneirab | 7:479a36909ced | 205 | VEMPTY_REG = 0x3A, |
fneirab | 7:479a36909ced | 206 | FSTAT_REG = 0x3D, |
fneirab | 0:80c39eb8f3ba | 207 | |
fneirab | 7:479a36909ced | 208 | QRTABLE30_REG = 0x42, |
fneirab | 7:479a36909ced | 209 | DQACC_REG = 0x45, |
fneirab | 7:479a36909ced | 210 | DPACC_REG = 0x46, |
fneirab | 7:479a36909ced | 211 | VFSOC0_REG = 0x48, |
fneirab | 7:479a36909ced | 212 | QH0_REG = 0x4C, |
fneirab | 7:479a36909ced | 213 | QH_REG = 0x4D, |
fneirab | 7:479a36909ced | 214 | |
fneirab | 7:479a36909ced | 215 | VFSOC0_QH0_LOCK_REG = 0x60, |
fneirab | 7:479a36909ced | 216 | LOCK1_REG = 0x62, |
fneirab | 7:479a36909ced | 217 | LOCK2_REG = 0x63, |
fneirab | 7:479a36909ced | 218 | |
fneirab | 7:479a36909ced | 219 | MODELDATA_START_REG = 0x80, |
fneirab | 7:479a36909ced | 220 | |
fneirab | 7:479a36909ced | 221 | IALRTTH_REG = 0xB4, |
fneirab | 7:479a36909ced | 222 | CURVE_REG = 0xB9, |
fneirab | 7:479a36909ced | 223 | HIBCFG_REG = 0xBA, |
fneirab | 7:479a36909ced | 224 | CONFIG2_REG = 0xBB, |
fneirab | 7:479a36909ced | 225 | |
fneirab | 7:479a36909ced | 226 | MODELCFG_REG = 0xDB, |
fneirab | 0:80c39eb8f3ba | 227 | |
fneirab | 7:479a36909ced | 228 | OCV_REG = 0xFB, |
fneirab | 7:479a36909ced | 229 | VFSOC_REG = 0xFF, |
fneirab | 7:479a36909ced | 230 | } ; |
fneirab | 7:479a36909ced | 231 | |
fneirab | 7:479a36909ced | 232 | |
fneirab | 7:479a36909ced | 233 | /** |
fneirab | 7:479a36909ced | 234 | * @brief Saved Fuel Gauge Parameters |
fneirab | 7:479a36909ced | 235 | * @details Struct with saved fuel Gauge Parametrs |
fneirab | 7:479a36909ced | 236 | */ |
fneirab | 7:479a36909ced | 237 | |
fneirab | 7:479a36909ced | 238 | struct platform_data{ //to clarify if Part of the class |
fneirab | 7:479a36909ced | 239 | uint16_t designcap;/**< struct value 1 */ |
fneirab | 7:479a36909ced | 240 | uint16_t ichgterm; /**< struct value 2 */ |
fneirab | 7:479a36909ced | 241 | uint16_t vempty; /**< struct value 3 */ |
fneirab | 7:479a36909ced | 242 | int vcharge; /**< struct value 1 */ |
fneirab | 0:80c39eb8f3ba | 243 | |
fneirab | 7:479a36909ced | 244 | uint16_t learncfg; /**< struct value 1 */ |
fneirab | 7:479a36909ced | 245 | uint16_t relaxcfg; /**< struct value 1 */ |
fneirab | 7:479a36909ced | 246 | uint16_t config; /**< struct value 1 */ |
fneirab | 7:479a36909ced | 247 | uint16_t config2; /**< struct value 1 */ |
fneirab | 7:479a36909ced | 248 | uint16_t fullsocthr;/**< struct value 1 */ |
fneirab | 7:479a36909ced | 249 | uint16_t tgain; /**< struct value 1 */ |
fneirab | 7:479a36909ced | 250 | uint16_t toff; /**< struct value 1 */ |
fneirab | 7:479a36909ced | 251 | uint16_t curve; /**< struct value 1 */ |
fneirab | 7:479a36909ced | 252 | uint16_t rcomp0; /**< struct value 1 */ |
fneirab | 7:479a36909ced | 253 | uint16_t tempco; /**< struct value 1 */ |
fneirab | 7:479a36909ced | 254 | uint16_t qrtable00; |
fneirab | 7:479a36909ced | 255 | uint16_t qrtable10; |
fneirab | 7:479a36909ced | 256 | uint16_t qrtable20; |
fneirab | 7:479a36909ced | 257 | uint16_t qrtable30; |
fneirab | 7:479a36909ced | 258 | |
fneirab | 7:479a36909ced | 259 | uint16_t dpacc; |
fneirab | 7:479a36909ced | 260 | uint16_t modelcfg; |
fneirab | 0:80c39eb8f3ba | 261 | |
fneirab | 7:479a36909ced | 262 | //uint16_t model_data[MAX17055_TABLE_SIZE]; |
fneirab | 7:479a36909ced | 263 | int (*get_charging_status)(void); |
fneirab | 7:479a36909ced | 264 | int model_option; |
fneirab | 7:479a36909ced | 265 | /** |
fneirab | 7:479a36909ced | 266 | * rsense in miliOhms. |
fneirab | 7:479a36909ced | 267 | * default 10 (if rsense = 0) as it is the recommended value by |
fneirab | 7:479a36909ced | 268 | * the datasheet although it can be changed by board designers. |
fneirab | 7:479a36909ced | 269 | */ |
fneirab | 7:479a36909ced | 270 | unsigned int rsense; |
fneirab | 7:479a36909ced | 271 | int volt_min; /**< in mV */ |
fneirab | 7:479a36909ced | 272 | int volt_max; /**< in mV */ |
fneirab | 7:479a36909ced | 273 | int temp_min; /**< in DegreC */ |
fneirab | 7:479a36909ced | 274 | int temp_max; /**< in DegreeC */ |
fneirab | 7:479a36909ced | 275 | int soc_max; /**< in percent */ |
fneirab | 7:479a36909ced | 276 | int soc_min; /**< in percent */ |
fneirab | 7:479a36909ced | 277 | int curr_max; /**< in mA */ |
fneirab | 7:479a36909ced | 278 | int curr_min; /**< in mA */ |
fneirab | 7:479a36909ced | 279 | } ; |
fneirab | 7:479a36909ced | 280 | |
fneirab | 7:479a36909ced | 281 | |
fneirab | 7:479a36909ced | 282 | /** |
fneirab | 7:479a36909ced | 283 | * @brief Saved Fuel Gauge Parameters |
fneirab | 7:479a36909ced | 284 | * @details It is recommended to save the learned capacity parameters |
fneirab | 7:479a36909ced | 285 | * every time bit 2 of the Cycles register toggles |
fneirab | 7:479a36909ced | 286 | * (so that it is saved every 64% change in the battery) |
fneirab | 7:479a36909ced | 287 | * so that if power is lost the values can easily be restored. |
fneirab | 7:479a36909ced | 288 | */ |
fneirab | 0:80c39eb8f3ba | 289 | |
fneirab | 7:479a36909ced | 290 | struct saved_FG_params_t{ |
fneirab | 7:479a36909ced | 291 | int rcomp0; /**< Explain */ |
fneirab | 7:479a36909ced | 292 | int temp_co; /**< Explain */ |
fneirab | 7:479a36909ced | 293 | int full_cap_rep; /**< Explain */ |
fneirab | 7:479a36909ced | 294 | int cycles; /**< Explain */ |
fneirab | 7:479a36909ced | 295 | int full_cap_nom; /**< Explain */ |
fneirab | 7:479a36909ced | 296 | } ; |
fneirab | 4:a4d6ae2182c2 | 297 | |
fneirab | 4:a4d6ae2182c2 | 298 | |
fneirab | 4:a4d6ae2182c2 | 299 | |
fneirab | 0:80c39eb8f3ba | 300 | /** |
fneirab | 0:80c39eb8f3ba | 301 | * @brief max17055 Constructor |
fneirab | 0:80c39eb8f3ba | 302 | * @details max17055 Constructor with battery and i2c as parameters |
fneirab | 0:80c39eb8f3ba | 303 | */ |
fneirab | 0:80c39eb8f3ba | 304 | MAX17055(I2C &i2c); |
fneirab | 0:80c39eb8f3ba | 305 | |
fneirab | 0:80c39eb8f3ba | 306 | /** |
fneirab | 0:80c39eb8f3ba | 307 | * @brief Fuel Gauge Destructor |
fneirab | 0:80c39eb8f3ba | 308 | */ |
fneirab | 0:80c39eb8f3ba | 309 | ~MAX17055(); |
fneirab | 4:a4d6ae2182c2 | 310 | |
fneirab | 5:a18a189588dc | 311 | //////////////////////////////////////////////////////////////////////////// |
fneirab | 5:a18a189588dc | 312 | |
fneirab | 5:a18a189588dc | 313 | /** |
fneirab | 5:a18a189588dc | 314 | * \brief Poll Flag clear |
fneirab | 5:a18a189588dc | 315 | * \par Details |
fneirab | 5:a18a189588dc | 316 | * This function clears status flags for the MAX17055 |
fneirab | 5:a18a189588dc | 317 | * |
fneirab | 5:a18a189588dc | 318 | * \param[in] reg_addr - register address |
fneirab | 5:a18a189588dc | 319 | * \param[in] mask - register address |
fneirab | 5:a18a189588dc | 320 | * \param[in] timeout - register data |
fneirab | 5:a18a189588dc | 321 | * |
fneirab | 5:a18a189588dc | 322 | * \retval 1 on success |
fneirab | 5:a18a189588dc | 323 | * -1 on Failure |
fneirab | 5:a18a189588dc | 324 | */ |
fneirab | 5:a18a189588dc | 325 | |
fneirab | 7:479a36909ced | 326 | int poll_flag_clear(Registers_e reg_addr, int mask, int timeout); |
fneirab | 5:a18a189588dc | 327 | |
fneirab | 4:a4d6ae2182c2 | 328 | |
fneirab | 2:ff7db397b70f | 329 | /** |
fneirab | 2:ff7db397b70f | 330 | * \brief Write and Verify a MAX17055 register |
fneirab | 2:ff7db397b70f | 331 | * \par Details |
fneirab | 2:ff7db397b70f | 332 | * This function wites and verifies if the writing process was successful |
fneirab | 2:ff7db397b70f | 333 | * |
fneirab | 2:ff7db397b70f | 334 | * \param[in] reg_addr - register address |
fneirab | 4:a4d6ae2182c2 | 335 | * \param[out] reg_data - the variable that contains the data to write |
fneirab | 5:a18a189588dc | 336 | * to the register address |
fneirab | 2:ff7db397b70f | 337 | * |
fneirab | 4:a4d6ae2182c2 | 338 | * \retval 1 on success |
fneirab | 2:ff7db397b70f | 339 | * -1 if write errors |
fneirab | 2:ff7db397b70f | 340 | * -2 if read errors |
fneirab | 2:ff7db397b70f | 341 | * -3 if data curruption |
fneirab | 4:a4d6ae2182c2 | 342 | * |
fneirab | 2:ff7db397b70f | 343 | */ |
fneirab | 4:a4d6ae2182c2 | 344 | |
fneirab | 4:a4d6ae2182c2 | 345 | |
fneirab | 2:ff7db397b70f | 346 | int write_and_verify_reg(Registers_e reg_addr, uint16_t reg_data); |
fneirab | 4:a4d6ae2182c2 | 347 | |
fneirab | 4:a4d6ae2182c2 | 348 | |
fneirab | 3:f77a8345b0e3 | 349 | /////////////////////////////////////////////////////////////////////////// |
fneirab | 4:a4d6ae2182c2 | 350 | |
fneirab | 2:ff7db397b70f | 351 | /** |
fneirab | 2:ff7db397b70f | 352 | * \brief Initialise Function for MAX17055 |
fneirab | 2:ff7db397b70f | 353 | * \par Details |
fneirab | 2:ff7db397b70f | 354 | * This function intitializes the MAX17055 |
fneirab | 2:ff7db397b70f | 355 | * |
fneirab | 4:a4d6ae2182c2 | 356 | * \retval 1 on success |
fneirab | 2:ff7db397b70f | 357 | * -1 if errors exist |
fneirab | 2:ff7db397b70f | 358 | */ |
fneirab | 4:a4d6ae2182c2 | 359 | |
fneirab | 4:a4d6ae2182c2 | 360 | |
fneirab | 7:479a36909ced | 361 | int init(platform_data des_data); |
fneirab | 4:a4d6ae2182c2 | 362 | |
fneirab | 4:a4d6ae2182c2 | 363 | |
fneirab | 3:f77a8345b0e3 | 364 | //////////////////////////////////////////////////////////////////////////// |
fneirab | 0:80c39eb8f3ba | 365 | |
fneirab | 3:f77a8345b0e3 | 366 | /** |
fneirab | 2:ff7db397b70f | 367 | * \brief Get Internal Temperature Function for MAX17055 |
fneirab | 2:ff7db397b70f | 368 | * \par Details |
fneirab | 2:ff7db397b70f | 369 | * This function sends a request to access the internal |
fneirab | 2:ff7db397b70f | 370 | * of the MAX17055 |
fneirab | 2:ff7db397b70f | 371 | * |
fneirab | 7:479a36909ced | 372 | * |
fneirab | 7:479a36909ced | 373 | * \retval temperature value |
fneirab | 2:ff7db397b70f | 374 | * -1 if errors exist |
fneirab | 2:ff7db397b70f | 375 | */ |
fneirab | 4:a4d6ae2182c2 | 376 | |
fneirab | 4:a4d6ae2182c2 | 377 | |
fneirab | 7:479a36909ced | 378 | int get_temperature(); |
fneirab | 4:a4d6ae2182c2 | 379 | |
fneirab | 4:a4d6ae2182c2 | 380 | |
fneirab | 4:a4d6ae2182c2 | 381 | //////////////////////////////////////////////////////////////////////////// |
fneirab | 4:a4d6ae2182c2 | 382 | |
fneirab | 3:f77a8345b0e3 | 383 | /** |
fneirab | 3:f77a8345b0e3 | 384 | * \brief Forced Exit Hibernate Mode Function for MAX17055 |
fneirab | 3:f77a8345b0e3 | 385 | * \par Details |
fneirab | 4:a4d6ae2182c2 | 386 | * This function executes a force exit from hibernate mode. |
fneirab | 3:f77a8345b0e3 | 387 | * |
fneirab | 3:f77a8345b0e3 | 388 | * \retval returns HibCFG original value before forced Exit Hybernate mode |
fneirab | 3:f77a8345b0e3 | 389 | * |
fneirab | 3:f77a8345b0e3 | 390 | */ |
fneirab | 4:a4d6ae2182c2 | 391 | |
fneirab | 4:a4d6ae2182c2 | 392 | |
fneirab | 3:f77a8345b0e3 | 393 | uint16_t forcedExitHyberMode(); |
fneirab | 7:479a36909ced | 394 | |
fneirab | 7:479a36909ced | 395 | /** |
fneirab | 7:479a36909ced | 396 | * \brief EZ COnfing Init function |
fneirab | 7:479a36909ced | 397 | * \par Details |
fneirab | 7:479a36909ced | 398 | * This function implements the steps for the EZ confing m5 FuelGauge |
fneirab | 7:479a36909ced | 399 | * |
fneirab | 7:479a36909ced | 400 | * \retval returns TBD |
fneirab | 7:479a36909ced | 401 | * |
fneirab | 7:479a36909ced | 402 | */ |
fneirab | 7:479a36909ced | 403 | |
fneirab | 7:479a36909ced | 404 | |
fneirab | 7:479a36909ced | 405 | uint16_t EZconfig_init(platform_data des_data); |
fneirab | 7:479a36909ced | 406 | |
fneirab | 7:479a36909ced | 407 | /////////////////////////////////////////////////////////////////////////// |
fneirab | 7:479a36909ced | 408 | |
fneirab | 7:479a36909ced | 409 | /** |
fneirab | 7:479a36909ced | 410 | * \brief Get State Of Charge(SOC) Function for MAX17055 |
fneirab | 7:479a36909ced | 411 | * \par Details |
fneirab | 7:479a36909ced | 412 | * This function sends a request to access the internal |
fneirab | 7:479a36909ced | 413 | * of the MAX17055 |
fneirab | 7:479a36909ced | 414 | * |
fneirab | 7:479a36909ced | 415 | * \param[in] reg_addr - register address |
fneirab | 7:479a36909ced | 416 | * \param[out] reg_data - SOC data from the REPSOC_REG register |
fneirab | 7:479a36909ced | 417 | * \retval 1 on success |
fneirab | 7:479a36909ced | 418 | * |
fneirab | 7:479a36909ced | 419 | * -1 if errors exist |
fneirab | 7:479a36909ced | 420 | */ |
fneirab | 7:479a36909ced | 421 | |
fneirab | 7:479a36909ced | 422 | |
fneirab | 7:479a36909ced | 423 | int get_SOC(); |
fneirab | 8:ca8765c30ed2 | 424 | |
fneirab | 8:ca8765c30ed2 | 425 | /////////////////////////////////////////////////////////////////////////// |
fneirab | 8:ca8765c30ed2 | 426 | |
fneirab | 8:ca8765c30ed2 | 427 | /** |
fneirab | 8:ca8765c30ed2 | 428 | * \brief Get Average State Of Charge(SOC) Function for MAX17055 |
fneirab | 8:ca8765c30ed2 | 429 | * \par Details |
fneirab | 8:ca8765c30ed2 | 430 | * This function sends a request to access the internal |
fneirab | 8:ca8765c30ed2 | 431 | * of the MAX17055 |
fneirab | 8:ca8765c30ed2 | 432 | * |
fneirab | 8:ca8765c30ed2 | 433 | * \param[in] reg_addr - register address |
fneirab | 8:ca8765c30ed2 | 434 | * \param[out] reg_data - SOC data from the REPSOC_REG register |
fneirab | 8:ca8765c30ed2 | 435 | * \retval 1 on success |
fneirab | 8:ca8765c30ed2 | 436 | * |
fneirab | 8:ca8765c30ed2 | 437 | * -1 if errors exist |
fneirab | 8:ca8765c30ed2 | 438 | */ |
fneirab | 8:ca8765c30ed2 | 439 | |
fneirab | 8:ca8765c30ed2 | 440 | |
fneirab | 8:ca8765c30ed2 | 441 | int get_avSOC(); |
fneirab | 7:479a36909ced | 442 | |
fneirab | 7:479a36909ced | 443 | //////////////////////////////////////////////////////////////////////////// |
fneirab | 7:479a36909ced | 444 | |
fneirab | 7:479a36909ced | 445 | /** |
fneirab | 7:479a36909ced | 446 | * \brief Get the remaining Time to Empty(TTE) Function for MAX17055 |
fneirab | 7:479a36909ced | 447 | * \par Details |
fneirab | 7:479a36909ced | 448 | * This function sends a request to access the internal register |
fneirab | 7:479a36909ced | 449 | * of the MAX17055 |
fneirab | 7:479a36909ced | 450 | * |
fneirab | 7:479a36909ced | 451 | * \retval tte_data - Time to Empty data from the TTE_REG register |
fneirab | 7:479a36909ced | 452 | * |
fneirab | 7:479a36909ced | 453 | * -1 if errors exist |
fneirab | 7:479a36909ced | 454 | */ |
fneirab | 7:479a36909ced | 455 | |
fneirab | 7:479a36909ced | 456 | |
fneirab | 7:479a36909ced | 457 | int get_TTE(); |
fneirab | 8:ca8765c30ed2 | 458 | |
fneirab | 8:ca8765c30ed2 | 459 | //////////////////////////////////////////////////////////////////////////// |
fneirab | 8:ca8765c30ed2 | 460 | |
fneirab | 8:ca8765c30ed2 | 461 | /** |
fneirab | 8:ca8765c30ed2 | 462 | * \brief Get the remaining Time to Full(TTE) Function for MAX17055 |
fneirab | 8:ca8765c30ed2 | 463 | * \par Details |
fneirab | 8:ca8765c30ed2 | 464 | * This function sends a request to access the internal register |
fneirab | 8:ca8765c30ed2 | 465 | * of the MAX17055 |
fneirab | 8:ca8765c30ed2 | 466 | * |
fneirab | 8:ca8765c30ed2 | 467 | * \retval ttf_data - Time to Empty data from the TTF_REG register |
fneirab | 8:ca8765c30ed2 | 468 | * |
fneirab | 8:ca8765c30ed2 | 469 | * -1 if errors exist |
fneirab | 8:ca8765c30ed2 | 470 | */ |
fneirab | 8:ca8765c30ed2 | 471 | |
fneirab | 8:ca8765c30ed2 | 472 | |
fneirab | 8:ca8765c30ed2 | 473 | int get_TTF(); |
fneirab | 7:479a36909ced | 474 | |
fneirab | 7:479a36909ced | 475 | |
fneirab | 7:479a36909ced | 476 | //////////////////////////////////////////////////////////////////////////// |
fneirab | 7:479a36909ced | 477 | |
fneirab | 7:479a36909ced | 478 | /** |
fneirab | 7:479a36909ced | 479 | * \brief Get voltage of the cell Function for MAX17055 |
fneirab | 7:479a36909ced | 480 | * \par Details |
fneirab | 7:479a36909ced | 481 | * This function sends a request to access the internal register |
fneirab | 7:479a36909ced | 482 | * of the MAX17055 to read the voltage of the cell |
fneirab | 7:479a36909ced | 483 | * |
fneirab | 7:479a36909ced | 484 | * \retval vcell_data - vcell data from the VCELL_REG register |
fneirab | 7:479a36909ced | 485 | * |
fneirab | 7:479a36909ced | 486 | * -1 if errors exist |
fneirab | 7:479a36909ced | 487 | */ |
fneirab | 7:479a36909ced | 488 | |
fneirab | 7:479a36909ced | 489 | |
fneirab | 7:479a36909ced | 490 | int get_Vcell(); |
fneirab | 7:479a36909ced | 491 | |
fneirab | 7:479a36909ced | 492 | //////////////////////////////////////////////////////////////////////////// |
fneirab | 7:479a36909ced | 493 | |
fneirab | 7:479a36909ced | 494 | /** |
fneirab | 7:479a36909ced | 495 | * \brief Get current Function for MAX17055 |
fneirab | 7:479a36909ced | 496 | * \par Details |
fneirab | 7:479a36909ced | 497 | * This function sends a request to access the internal register |
fneirab | 7:479a36909ced | 498 | * of the MAX17055 to read the current register. |
fneirab | 7:479a36909ced | 499 | * |
fneirab | 7:479a36909ced | 500 | * \retval curr_data - vcell data from the VCELL_REG register |
fneirab | 7:479a36909ced | 501 | * |
fneirab | 7:479a36909ced | 502 | * -1 if errors exist |
fneirab | 7:479a36909ced | 503 | */ |
fneirab | 7:479a36909ced | 504 | |
fneirab | 7:479a36909ced | 505 | |
fneirab | 7:479a36909ced | 506 | int get_Current(platform_data des_data); |
fneirab | 7:479a36909ced | 507 | |
fneirab | 7:479a36909ced | 508 | //////////////////////////////////////////////////////////////////////////// |
fneirab | 7:479a36909ced | 509 | |
fneirab | 7:479a36909ced | 510 | /** |
fneirab | 7:479a36909ced | 511 | * \brief Get Average Current Function for MAX17055 |
fneirab | 7:479a36909ced | 512 | * \par Details |
fneirab | 7:479a36909ced | 513 | * This function sends a request to access the internal register |
fneirab | 7:479a36909ced | 514 | * of the MAX17055 to read the average current register. |
fneirab | 7:479a36909ced | 515 | * |
fneirab | 7:479a36909ced | 516 | * \retval curr_data - vcell data from the AVGCURRENT_REG register |
fneirab | 7:479a36909ced | 517 | * |
fneirab | 7:479a36909ced | 518 | * -1 if errors exist |
fneirab | 7:479a36909ced | 519 | */ |
fneirab | 7:479a36909ced | 520 | |
fneirab | 7:479a36909ced | 521 | |
fneirab | 7:479a36909ced | 522 | int get_AvgCurrent(platform_data des_data); |
fneirab | 7:479a36909ced | 523 | |
fneirab | 7:479a36909ced | 524 | //////////////////////////////////////////////////////////////////////////// |
fneirab | 7:479a36909ced | 525 | |
fneirab | 7:479a36909ced | 526 | /** |
fneirab | 7:479a36909ced | 527 | * \brief lsb_to_uvolts Converssion Function |
fneirab | 7:479a36909ced | 528 | * \par Details |
fneirab | 7:479a36909ced | 529 | * This function takes the lsb value of the register and convert it |
fneirab | 7:479a36909ced | 530 | * to uvolts |
fneirab | 7:479a36909ced | 531 | * |
fneirab | 7:479a36909ced | 532 | * \param[in] lsb - value of register lsb |
fneirab | 7:479a36909ced | 533 | * \retval lsb - converted lsb to uvolts |
fneirab | 7:479a36909ced | 534 | * |
fneirab | 7:479a36909ced | 535 | */ |
fneirab | 7:479a36909ced | 536 | |
fneirab | 7:479a36909ced | 537 | int lsb_to_uvolts(uint16_t lsb); |
fneirab | 7:479a36909ced | 538 | |
fneirab | 7:479a36909ced | 539 | |
fneirab | 7:479a36909ced | 540 | /////////////////////////////////////////////////////////////////////////////// |
fneirab | 7:479a36909ced | 541 | |
fneirab | 7:479a36909ced | 542 | /** |
fneirab | 7:479a36909ced | 543 | * \brief raw_current_to_uamp Converssion Function |
fneirab | 7:479a36909ced | 544 | * \par Details |
fneirab | 7:479a36909ced | 545 | * This function takes the raw current value of the register and |
fneirab | 7:479a36909ced | 546 | * converts it to uamps |
fneirab | 7:479a36909ced | 547 | * |
fneirab | 7:479a36909ced | 548 | * \param[in] curr - raw current value of register |
fneirab | 7:479a36909ced | 549 | * \retval res - converted raw current to uamps - Signed 2's complement |
fneirab | 7:479a36909ced | 550 | * |
fneirab | 7:479a36909ced | 551 | */ |
fneirab | 7:479a36909ced | 552 | |
fneirab | 7:479a36909ced | 553 | int raw_current_to_uamps(uint32_t curr, int rsense_value); |
fneirab | 3:f77a8345b0e3 | 554 | |
fneirab | 4:a4d6ae2182c2 | 555 | |
fneirab | 2:ff7db397b70f | 556 | |
fneirab | 2:ff7db397b70f | 557 | protected: |
fneirab | 0:80c39eb8f3ba | 558 | /** |
fneirab | 0:80c39eb8f3ba | 559 | * @brief Write Register |
fneirab | 0:80c39eb8f3ba | 560 | * @details Writes data to max17055 Register |
fneirab | 0:80c39eb8f3ba | 561 | * |
fneirab | 0:80c39eb8f3ba | 562 | * @parameters reg_addr Registers to write |
fneirab | 0:80c39eb8f3ba | 563 | * reg_data Data to write |
fneirab | 0:80c39eb8f3ba | 564 | */ |
fneirab | 0:80c39eb8f3ba | 565 | int writeReg(const Registers_e reg_addr, uint16_t reg_data); |
fneirab | 0:80c39eb8f3ba | 566 | |
fneirab | 0:80c39eb8f3ba | 567 | /** |
fneirab | 0:80c39eb8f3ba | 568 | * @brief Read Register |
fneirab | 0:80c39eb8f3ba | 569 | * @details Reads data from max17055 register |
fneirab | 0:80c39eb8f3ba | 570 | * |
fneirab | 0:80c39eb8f3ba | 571 | * @parameters reg_addr Register to read |
fneirab | 0:80c39eb8f3ba | 572 | */ |
fneirab | 1:a031f0c6a71e | 573 | int32_t readReg(Registers_e reg_addr, uint16_t &value); |
fneirab | 4:a4d6ae2182c2 | 574 | |
fneirab | 2:ff7db397b70f | 575 | |
fneirab | 0:80c39eb8f3ba | 576 | |
fneirab | 2:ff7db397b70f | 577 | |
fneirab | 0:80c39eb8f3ba | 578 | |
fneirab | 0:80c39eb8f3ba | 579 | private: |
fneirab | 0:80c39eb8f3ba | 580 | |
fneirab | 0:80c39eb8f3ba | 581 | I2C &m_i2cBus; // I2C object |
fneirab | 0:80c39eb8f3ba | 582 | |
fneirab | 0:80c39eb8f3ba | 583 | }; |
fneirab | 0:80c39eb8f3ba | 584 | |
fneirab | 0:80c39eb8f3ba | 585 | #endif /* _MAX17055_H_ */ |