Microchip_PAC193x.h

/***********************************************************

   This is a library for Microchip PAC193x
	
   © 2020 Microchip Technology Inc. and its subsidiaries.  
 
   Subject to your compliance with these terms, you may use Microchip
   software and any derivatives of this software. You must retain the above
   copyright notice with any redistribution of this software and the 
   following disclaimers. 
   It is your responsibility to comply with third party license terms 
   applicable to your use of third party software (including open source 
   software) that may accompany this Microchip software.
  
   THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS".  NO WARRANTIES, WHETHER 
   EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING 
   ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS
   FOR A PARTICULAR PURPOSE.  
  
   IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
   INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND 
   WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP
   HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. 
   TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL
   CLAIMS IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF
   FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
   
***********************************************************/

/***********************************************************

	Version 1.0.0

***********************************************************/

#ifndef Microchip_PAC193x_h
#define Microchip_PAC193x_h

#if (ARDUINO >= 100)
 #include "Arduino.h"
#else
 #include "WProgram.h"
#endif
#include "Wire.h"

#define RSENSE 24900000 //microohm
#define I2C_ADDRESS 0x10
#define CHANNEL 2

// PAC193x register addresses

#define PAC1934_REFRESH_CMD_ADDR            0x00
#define PAC1934_CTRL_ADDR                   0x01
#define PAC1934_ACC_COUNT_ADDR              0x02
#define PAC1934_VPOWER1_ACC_ADDR            0x03
#define PAC1934_VPOWER2_ACC_ADDR            0x04
#define PAC1934_VPOWER3_ACC_ADDR            0X05
#define PAC1934_VPOWER4_ACC_ADDR            0X06
#define PAC1934_VBUS1_ADDR                  0x07
#define PAC1934_VBUS2_ADDR                  0x08
#define PAC1934_VBUS3_ADDR                  0x09
#define PAC1934_VBUS4_ADDR                  0x0A
#define PAC1934_VSENSE1_ADDR                0x0B
#define PAC1934_VSENSE2_ADDR                0x0C
#define PAC1934_VSENSE3_ADDR                0X0D
#define PAC1934_VSENSE4_ADDR                0X0E
#define PAC1934_VBUS1_AVG_ADDR              0X0F
#define PAC1934_VBUS2_AVG_ADDR              0X10
#define PAC1934_VBUS3_AVG_ADDR              0X11
#define PAC1934_VBUS4_AVG_ADDR              0X12
#define PAC1934_VSENSE1_AVG_ADDR            0X13
#define PAC1934_VSENSE2_AVG_ADDR            0X14
#define PAC1934_VSENSE3_AVG_ADDR            0X15
#define PAC1934_VSENSE4_AVG_ADDR            0X16
#define PAC1934_VPOWER1_ADDR                0X17
#define PAC1934_VPOWER2_ADDR                0X18
#define PAC1934_VPOWER3_ADDR                0X19
#define PAC1934_VPOWER4_ADDR                0X1A
#define PAC1934_CHANNEL_DIS_ADDR            0X1C
#define PAC1934_NEG_PWR_ADDR                0X1D
#define PAC1934_REFRESH_G_CMD_ADDR          0x1E
#define PAC1934_REFRESH_V_CMD_ADDR          0x1F
#define PAC1934_SLOW_ADDR                   0X20
#define PAC1934_CTRL_ACT_ADDR               0X21
#define PAC1934_CHANNEL_DIS_ACT_ADDR        0X22 
#define PAC1934_NEG_PWR_ACT_ADDR            0X23
#define PAC1934_CTRL_LAT_ADDR               0X24
#define PAC1934_CHANNEL_DIS_LAT_ADDR        0X25
#define PAC1934_NEG_PWR_LAT_ADDR            0x26

#define PAC1934_PRODUCT_ID_ADDR             0xFD
#define PAC1934_MANUFACTURER_ID_ADDR        0xFE
#define PAC1934_REVISION_ID_ADDR            0xFF

class Microchip_PAC193x {  
		public:
//class constructors:
			Microchip_PAC193x();
			Microchip_PAC193x(uint32_t resistorValue);
			
//class public functions:
			void begin();
/*
    Function
		Refresh()
	Summary
        Executes a 'REFRESH' command.
    Description
        This method executes a 'REFRESH' command. In this case, the accumulator data, 
        accumulator count, Vbus, Vsense measurements are all refreshed 
        and the accumulators are reset. 
        The updated data is stable and can be read after 1ms.
	Input
		None.
	Output
		None.
    Returns
		None.
*/	
			void Refresh();


/*
    Function
		UpdateVoltageRaw()
	Summary
        Obtains the current Vbus register value.
    Description
        This method obtains the most recent register value of a bus voltage sample.
	Input
		None.
	Output
		The bus voltage register value is assigned to VoltageRaw property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/			
			int16_t UpdateVoltageRaw(); //vbus


/*
    Function
		UpdateVoltage()
	Summary
        Calculates the current real Vbus value.
    Description
        This method obtains the calculated value of a bus voltage sample.
        The value unit is milli-Volt.
	Input
		None.
	Output
		The bus voltage value is assigned to Voltage property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdateVoltage();


/*
    Function
		UpdateVsenseRaw()
	Summary
        Obtains the current Vsense register value.
    Description
        This method obtains the most recent register value of the sense voltage samples.
	Input
		None.
	Output
		The register value of current sense voltage is assigned to VsenseRaw property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdateVsenseRaw(); //vsense


/*
    Function
		UpdateVsense()
	Summary
        Calculates the current real Vsense value.
    Description
        This method obtains the most recent real value of the sense voltage samples.
        The value unit is milli-Volt.
	Input
		None.
	Output
		The calculated sense voltage value is assigned to Vsense property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdateVsense();


/*
    Function
		UpdateCurrent()
	Summary
        Calculates the current Isense value.
    Description
        This method obtains the most recent calculated value of the sense current samples.
        The value unit is milli-Amp.
	Input
		None.
	Output
		The current value is assigned to Current property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdateCurrent(); //isense


/*
    Function
		UpdatePowerRaw()
	Summary
        Obtains the current VPower register value.
    Description
        This method obtains the register value of the proportional power.
	Input
		None.
	Output
		The register value of power is assigned to PowerRaw property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/			
			int16_t UpdatePowerRaw();


/*
    Function
		UpdatePower()
	Summary
        Calculates the current real VPower value.
    Description
        This method obtains the real value of the power.
		The value unit is milli-Watt.
	Input
		None.
	Output
		The power value is assigned to Power property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdatePower();


/*
    Function
		UpdatePowerAccRaw()
	Summary
        Obtains the current register accumulated power.
    Description
        This method obtains the register value of the accumulator sum of Vpower samples.
	Input
		None.
	Output
		The power accumulator register value is assigned to PowerAccRaw property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdatePowerAccRaw();


/*
    Function
		UpdatePowerAcc()
	Summary
        Calculates the current real accumulated power.
    Description
        This method obtains the calculated value of the accumulator sum of Vpower samples.
		The value unit is milli-Watt.
	Input
		None.
	Output
		The power accumulated value is assigned to PowerAcc property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdatePowerAcc();


/*
    Function
		UpdateEnergy()
	Summary
        Calculates the current energy value.
    Description
        This method obtains the calculated energy value that corresponds with the accumulated power.
		The value unit is milli-Watt-hour.
	Input
		None.
	Output
		The energy value is assigned to Energy property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/			
			int16_t UpdateEnergy();


/*
    Function
		UpdateOverflowAlert()
	Summary
        Obtains the 'Overflow' bit value.
    Description
        This method obtains the 'Overflow' indication status bit value. This bit will be set to '1' if
		any of the accumulators or the accumulator counter overflows. This bit is cleared by Refresh.
	Input
		None.
	Output
		The 'Overflow' bit value is assigned to OverflowAlert property of Microchip_PAC193x class.
		Possible values are:
            0 - no accumulator or accumulator counter overflow has occured
            1 - accumulator or accumulator counter has overflowed
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdateOverflowAlert();


/*
    Function
		UpdateSlowStatus()
	Summary
        Obtains the 'Slow' bit value.
    Description
        This method obtains the 'Slow' bit value of the Slow register.
	Input
		None.
	Output
		The 'Slow' bit value is assigned to SlowStatus property of Microchip_PAC193x class.
		Possible values are:
            0 - The Slow pin is pulled low externally
            1 - The Slow pin is pulled high externally
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdateSlowStatus();


/*
    Function
		UpdatePowerOnStatus()
	Summary
        Obtains the 'POR' bit value.
    Description
        This method obtains the 'POR' bit value.
	Input
		None.
	Output
		The 'POR' bit value is assigned to PowerOnStatus property of Microchip_PAC193x class.
		Possible values are:
            0 - This bit has been creared over i2C since the last Power On occured
            1 - This bit has the POR default value of 1 and it hasn't been cleared since the last reset occured.
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdatePowerOnStatus();


/*
    Function
		UpdateSampleRateLat()
	Summary
        Obtains the 'SAMPLE_RATE_LAT' value
    Description
        This method obtains the sample rate value that was active before the
        most recent REFRESH command.
	Input
		None.
	Output
		The sample rate value that was active before the most recent REFRESH command is assigned to SampleRateLat property of Microchip_PAC193x class.
		Possible values are:
                1024 samples/s
                 256 samples/s
                  64 samples/s
                   8 samples/s
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdateSampleRateLat();


/*
    Function
		setSampleRate()
	Summary
        Sets the sample rate value.
    Description
        This method sets the current value of the sample rate.
	Input
		value - the sample rate value to be set. Accepted values are: 
                                                        1024 samples/s
                                                         256 samples/s
                                                          64 samples/s
                                                           8 samples/s
	Output
		None.
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t setSampleRate(uint16_t value);


/*
	Function
		UpdateProductID()
    Summary
        Obtains the Product ID value for the PAC193x.
    Description
        This method obtains the Product ID value for the PAC193x. This register is read-only.
	Input
		None
	Output
		The Product ID register value is assigned to ProductID property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdateProductID();


/*
    Function
		UpdateManufacturerID()
	Summary
        Obtains the Manufacturer ID value for the PAC193x.
    Description
        This method obtains the Manufacturer ID that identifies Microchip as 
        the manufacturer of the PAC193x. This register is read-only.
	Input
		None.
	Output
		The Manufacturer ID register value is assigned to ManufacturerID property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdateManufacturerID();


/*
    Function
		UpdateRevisionID()
	Summary
        Obtains the Revision ID value for the PAC193x.
    Description
        This method Obtains the die revision value. This register is read-only.
	Input
		None.
	Output
		The Revision ID register value is assigned to RevisionID property of Microchip_PAC193x class.
    Returns
		In case of execution error, the returned value is an error code.
*/
			int16_t UpdateRevisionID();

//class public properties:		
			uint16_t VoltageRaw1; //vbus
			float Voltage1;
			uint16_t VoltageRaw2; //vbus
			float Voltage2;
			uint16_t VoltageRaw3; //vbus
			float Voltage3;
			uint16_t VoltageRaw4; //vbus
			float Voltage4;
			uint16_t VsenseRaw; //vsense

			uint16_t VsenseRaw1; //vsense
			uint16_t VsenseRaw2; //vsense
			uint16_t VsenseRaw3; //vsense
			uint16_t VsenseRaw4; //vsense

			float Vsense;
			float Vsense1;
			float Vsense2;
			float Vsense3;
			float Vsense4;

			float Current; //isense
			float Current1; //isense
			float Current2; //isense
			float Current3; //isense
			float Current4; //isense

			uint32_t PowerRaw;
			uint32_t PowerRaw1;
			uint32_t PowerRaw2;
			uint32_t PowerRaw3;
			uint32_t PowerRaw4;

			double Power;
			double Power1;
			double Power2;
			double Power3;
			double Power4;

			uint64_t PowerAccRaw;
			uint64_t PowerAccRaw1;
			uint64_t PowerAccRaw2;
			uint64_t PowerAccRaw3;
			uint64_t PowerAccRaw4;

			double PowerAcc;
			double PowerAcc1;
			double PowerAcc2;
			double PowerAcc3;
			double PowerAcc4;

			float Energy;
			float Energy1;
			float Energy2;
			float Energy3;
			float Energy4;


			uint8_t OverflowAlert;
			uint8_t OverflowAlert1;
			uint8_t OverflowAlert2;
			uint8_t OverflowAlert3;
			uint8_t OverflowAlert4;

			uint8_t SlowStatus;
			uint8_t PowerOnStatus;
			uint16_t SampleRateLat;
			uint8_t ProductID;
			uint8_t ManufacturerID;
			uint8_t RevisionID;

			
		private:
//class private functions:		
			void Read(uint8_t reg_address, int Nbytes, uint8_t *pBuffer);
			uint8_t Read8(uint8_t reg_address);
			uint16_t Read16(uint8_t reg_address);
			uint32_t Read32(uint8_t reg_address);
			uint64_t Read64(uint8_t reg_address);
			void Write8(uint8_t reg_address, uint8_t data);
//class private properties:
			uint32_t rsense;
			
/*	Property
		errorCode
	Description
		In case of execution error of one of the functions called,
		the value of errorCode indicates wich type of error has occured.
		Possible values:	 0 - No error
							-1 - Read from device i2C communication error
							-2 - Write to device i2C communication error
							-3 - rsense resitor value choice error (0 or negative value)
							-4 - Sample Rate choice error (only the following values are possible: 8, 64, 256, 1024)
*/			
			int16_t errorCode;
			
};

#endif