Skip to content

Commit 4db9acd

Browse files
committed
Add documentation
1 parent 5ca3c24 commit 4db9acd

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

src/MAX1726Driver.h

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,33 @@ class MAX1726Driver {
1313
private:
1414
TwoWire *wire;
1515
uint8_t i2cAddress;
16+
/**
17+
* Enables or disables the hibernate mode.
18+
*
19+
* @param enabled - true to enable hibernate mode, false to disable it.
20+
*/
1621
void setHibernateModeEnabled(bool enabled);
1722
public:
23+
/**
24+
* Checks if the charging process is complete.
25+
*
26+
* @return true if the charging process is complete, false otherwise.
27+
*/
1828
bool chargingComplete();
29+
/**
30+
* Sets the operation mode of the Fuel Gauge.
31+
*
32+
* @param mode The operation mode to set. Possible values are: hibernate, shutdown, active.
33+
* @return True if the operation mode was set successfully, false otherwise.
34+
*/
1935
bool setOperationMode(FuelGaugeOperationMode mode);
36+
37+
/**
38+
* @brief Constructs a new MAX1726Driver object.
39+
*
40+
* @param wire Pointer to the TwoWire object for I2C communication.
41+
* @param i2cAddress The I2C address of the MAX1726 device. The default value is 0x36.
42+
*/
2043
MAX1726Driver(TwoWire *wire, uint8_t i2cAddress);
2144
~MAX1726Driver();
2245
};

0 commit comments

Comments
 (0)