Battery voltage monitor. More...

#include <battery.hpp>

Public Member Functions
	Battery (Adc &adc, battery_conf_t config=battery_default_config())
	Constructor.
bool	update (void)
	Updates the battery voltage level.
const float &	voltage (void) const
	Returns the level of the battery in volts.
const float &	level (void) const
	Returns the level of the battery in percents (from 0 to 100)
bool	is_low (void) const
	Indicates if the battery is low.

Detailed Description

Battery voltage monitor.

Constructor & Destructor Documentation

Battery::Battery	(	Adc &	adc,
		battery_conf_t	config = `battery_default_config()`
	)

Constructor.

Parameters:

adc	Reference to analog to digital converter
config	Configuration

bool Battery::is_low ( void ) const

Indicates if the battery is low.

Here is the caller graph for this function:

const float & Battery::level ( void ) const

Returns the level of the battery in percents (from 0 to 100)

bool Battery::update ( void )

Updates the battery voltage level.

Parameters:

battery	Pointer to the battery structure
voltage	Update measured battery voltage

Here is the call graph for this function:

Here is the caller graph for this function:

const float & Battery::voltage ( void ) const

Returns the level of the battery in volts.

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