FakeBatteryMonitor Class Reference

Fake battery monitor for testing. More...

#include <BatteryMonitorHardware.hpp>

Public Member Functions
	FakeBatteryMonitor (BatteryStatus *fakeStatus)
	Construct a new Fake Battery Monitor object.
virtual void	getStatus (BatteryStatus &currentStatus) override
	Get the battery status.
virtual bool	read_soc (uint8_t &soc) override
	Retrieve the current state of charge.
Public Member Functions inherited from BatteryMonitorInterface
virtual void	onStart ()
	Called once when the battery monitor daemon is started.

Public Attributes
BatteryStatus *	status = nullptr
	Pointer to variable that holds fake battery status.

Additional Inherited Members

Protected Member Functions inherited from BatteryMonitorInterface

Detailed Description

Fake battery monitor for testing.

Definition at line 122 of file BatteryMonitorHardware.hpp.

Constructor & Destructor Documentation

FakeBatteryMonitor()

FakeBatteryMonitor::FakeBatteryMonitor ( BatteryStatus * fakeStatus )

inline

Construct a new Fake Battery Monitor object.

Parameters

fakeStatus

Pointer to variable that holds fake battery status

Definition at line 134 of file BatteryMonitorHardware.hpp.

Member Function Documentation

getStatus()

virtual void FakeBatteryMonitor::getStatus ( BatteryStatus & currentStatus )

inlineoverridevirtual

Get the battery status.

Note

May be called before onStart()

Parameters

[out]

currentStatus

Current battery status

Reimplemented from BatteryMonitorInterface.

Definition at line 139 of file BatteryMonitorHardware.hpp.

read_soc()

virtual bool FakeBatteryMonitor::read_soc ( uint8_t & soc )

inlineoverridevirtual

Retrieve the current state of charge.

Parameters

[out]

soc

State of charge. Higher than 101 if the battery is charging at constant voltage.

Returns

true If soc was retrieved with success

false If there is no battery or soc is unknown

Implements BatteryMonitorInterface.

Definition at line 145 of file BatteryMonitorHardware.hpp.

Member Data Documentation

status

BatteryStatus* FakeBatteryMonitor::status = nullptr

Pointer to variable that holds fake battery status.

Definition at line 126 of file BatteryMonitorHardware.hpp.

---

The documentation for this class was generated from the following file:

• /github/workspace/src/include/BatteryMonitorHardware.hpp