Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sebromero committed Jun 4, 2024
1 parent 5ca3c24 commit 4db9acd
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions src/MAX1726Driver.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,33 @@ class MAX1726Driver {
private:
TwoWire *wire;
uint8_t i2cAddress;
/**
* Enables or disables the hibernate mode.
*
* @param enabled - true to enable hibernate mode, false to disable it.
*/
void setHibernateModeEnabled(bool enabled);
public:
/**
* Checks if the charging process is complete.
*
* @return true if the charging process is complete, false otherwise.
*/
bool chargingComplete();
/**
* Sets the operation mode of the Fuel Gauge.
*
* @param mode The operation mode to set. Possible values are: hibernate, shutdown, active.
* @return True if the operation mode was set successfully, false otherwise.
*/
bool setOperationMode(FuelGaugeOperationMode mode);

/**
* @brief Constructs a new MAX1726Driver object.
*
* @param wire Pointer to the TwoWire object for I2C communication.
* @param i2cAddress The I2C address of the MAX1726 device. The default value is 0x36.
*/
MAX1726Driver(TwoWire *wire, uint8_t i2cAddress);
~MAX1726Driver();
};
Expand Down

0 comments on commit 4db9acd

Please sign in to comment.