Diff: MAX17043.h

Revision:

0:4287b7d9c9ca

diff -r 000000000000 -r 4287b7d9c9ca MAX17043.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MAX17043.h	Sun Jul 01 12:00:52 2018 +0000
@@ -0,0 +1,113 @@
+/* MAX17043.h
+ * Tested with mbed board: FRDM-KL46Z
+ * Author: Mark Gottscho
+ * mgottscho@ucla.edu
+ */
+ 
+#ifndef MAX17043_H
+#define MAX17043_H
+
+#include "mbed.h"
+ 
+/**
+* This class allows for easy control over a MAX17043 LiPo fuel gauge IC.
+*/
+class MAX17043 {
+    public:
+        /**
+         * @param sda the pin identifier for SDA I2C signal
+         * @param scl the pin identifier for SCL I2C signal
+         * @param i2c_addr the 8-bit I2C address for this device. Note that LSB is a don't care.
+         */
+        MAX17043(PinName sda, PinName scl, int i2c_addr=0x6c);
+        MAX17043(I2C &i2c, int i2c_addr=0x6c);
+        
+        /**
+         *
+         */
+        ~MAX17043();
+        
+        /**
+         * Initializes the device to some preferred state.
+         */
+        void selfInit();
+        
+        /**
+         * Performs a software reset of the device.
+         */
+        void reset();
+        
+        /**
+         * @returns the IC version code
+         */
+        uint16_t getVersion();
+        
+        /**
+         * @param sampleNow if true, queries the device for the sample and returns it. if false, gets the last queried value.
+         * The latter is preferred if this object is set up to sample using interrupts.
+         * @returns the battery voltage raw ADC value
+         */
+        uint16_t getVCell();
+        
+        /**
+         * @param sampleNow if true, queries the device for the sample and returns it. if false, gets the last queried value.
+         * The latter is preferred if this object is set up to sample using interrupts.
+         * @returns the battery voltage as floating point
+         */
+        float getFloatVCell();
+        
+        /**
+         * @param sampleNow if true, queries the device for the sample and returns it. if false, gets the last queried value.
+         * The latter is preferred if this object is set up to sample using interrupts.
+         * @returns the battery state of charge as computed by the ModelGauge algorithm. High byte: units of %. Low byte: units of 1/256%.
+         */
+        uint16_t getSOC();
+        
+        /**
+         * @param sampleNow if true, queries the device for the sample and returns it. if false, gets the last queried value.
+         * The latter is preferred if this object is set up to sample using interrupts.
+         * @returns the battery state of charge in %, as a floating point #
+         */
+        float getFloatSOC(); 
+        
+        uint8_t getRegister(const uint8_t reg_addr);
+        uint16_t getRegister16b(const uint8_t reg_addr);
+        void setRegister(const uint8_t reg_addr, const uint8_t data);
+        void setRegister16b(const uint8_t reg_addr, const uint16_t data);
+        int __writeReg(const uint8_t *data, int total_len);
+        int __readReg(const uint8_t reg_addr, uint8_t *data, int len);
+        
+    private:
+    
+        I2C &i2c_;
+        char i2cRaw[sizeof(I2C)];
+        
+        int __i2c_addr;
+        uint16_t __soc;
+        uint16_t __vcell;
+    
+        ///////////////// CONSTANTS /////////////////////
+        
+        //Device register addresses
+        static const uint8_t VCELL_MSB =            0x02; //Read only
+        static const uint8_t VCELL_LSB =            0x03; //Read only
+        static const uint8_t SOC_MSB =              0x04; //Read only
+        static const uint8_t SOC_LSB =              0x05; //Read only
+        static const uint8_t MODE_MSB =             0x06; //Write only
+        static const uint8_t MODE_LSB =             0x07; //Write only
+        static const uint8_t VERSION_MSB =          0x08; //Read only
+        static const uint8_t VERSION_LSB =          0x09; //Read only
+        static const uint8_t CONFIG_MSB =           0x0C; //Read/write
+        static const uint8_t CONFIG_LSB =           0x0D; //Read/write
+        static const uint8_t COMMAND_MSB =          0xFE; //Write only
+        static const uint8_t COMMAND_LSB =          0xFF; //Write only
+        
+        static const uint16_t RST_CODE =            0x5400; //reset code for COMMAND 16-bit register
+    
+        //Levels
+        static const float DIV_VCELL =              1.25e-3; //1.25 mV/level
+        static const float DIV_SOC =                0.00390625; //1/256% / level
+};
+
+ 
+ #endif
\ No newline at end of file