UpowerBattery Class Reference

upowerBattery: A device to view the battery of a linux laptop in YARP using the yarp::dev::IBattery interface. More...

#include <upowerBattery/upowerBattery.h>

Inheritance diagram for UpowerBattery:

Public Member Functions
	UpowerBattery ()=default
	UpowerBattery (const UpowerBattery &)=delete
	UpowerBattery (UpowerBattery &&)=delete
UpowerBattery &	operator= (const UpowerBattery &)=delete
UpowerBattery &	operator= (UpowerBattery &&)=delete
	~UpowerBattery () override=default
bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.
bool	close () override
	Close the DeviceDriver.
bool	getBatteryVoltage (double &voltage) override
	Get the instantaneous voltage measurement.
bool	getBatteryCurrent (double &current) override
	Get the instantaneous current measurement.
bool	getBatteryCharge (double &charge) override
	get the battery status of charge
bool	getBatteryStatus (Battery_status &status) override
	get the battery status
bool	getBatteryInfo (std::string &info) override
	get the battery hardware characteristics (e.g.
bool	getBatteryTemperature (double &temperature) override
	get the battery temperature
Public Member Functions inherited from yarp::dev::DeviceDriver
	DeviceDriver ()
	DeviceDriver (const DeviceDriver &other)=delete
	DeviceDriver (DeviceDriver &&other) noexcept=delete
DeviceDriver &	operator= (const DeviceDriver &other)=delete
DeviceDriver &	operator= (DeviceDriver &&other) noexcept=delete
	~DeviceDriver () override
virtual std::string	id () const
	Return the id assigned to the PolyDriver.
virtual void	setId (const std::string &id)
	Set the id for this device.
template<class T >
bool	view (T *&x)
	Get an interface to the device driver.
virtual DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others.
Public Member Functions inherited from yarp::os::IConfig
virtual	~IConfig ()
	Destructor.
virtual bool	configure (Searchable &config)
	Change online parameters.
Public Member Functions inherited from yarp::dev::IBattery
virtual	~IBattery ()

Additional Inherited Members
Public Types inherited from yarp::dev::IBattery
enum	Battery_status {   BATTERY_OK_STANDBY = 0 ,   BATTERY_OK_IN_CHARGE = 1 ,   BATTERY_OK_IN_USE = 2 ,   BATTERY_GENERAL_ERROR = 3 ,   BATTERY_TIMEOUT = 4 ,   BATTERY_LOW_WARNING = 5 ,   BATTERY_CRITICAL_WARNING = 6 }

Detailed Description

upowerBattery: A device to view the battery of a linux laptop in YARP using the yarp::dev::IBattery interface.

Documentation to be added

Definition at line 22 of file upowerBattery.h.

Constructor & Destructor Documentation

UpowerBattery() [1/3]

UpowerBattery::UpowerBattery ( )

default

UpowerBattery() [2/3]

UpowerBattery::UpowerBattery ( const UpowerBattery &  )

delete

UpowerBattery() [3/3]

UpowerBattery::UpowerBattery ( UpowerBattery &&  )

delete

~UpowerBattery()

UpowerBattery::~UpowerBattery ( )

overridedefault

Member Function Documentation

close()

bool UpowerBattery::close ( )

overridevirtual

Close the DeviceDriver.

Returns

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 45 of file upowerBattery.cpp.

getBatteryCharge()

bool UpowerBattery::getBatteryCharge ( double &  charge )

overridevirtual

get the battery status of charge

Parameters

charge

the charge measurement (0-100%)

Returns

true/false.

Implements yarp::dev::IBattery.

Definition at line 69 of file upowerBattery.cpp.

getBatteryCurrent()

bool UpowerBattery::getBatteryCurrent ( double &  current )

overridevirtual

Get the instantaneous current measurement.

Parameters

current

the current measurement

Returns

true/false.

Implements yarp::dev::IBattery.

Definition at line 57 of file upowerBattery.cpp.

getBatteryInfo()

bool UpowerBattery::getBatteryInfo ( std::string &  battery_info )

overridevirtual

get the battery hardware characteristics (e.g.

max voltage etc)

Parameters

a	string containing the battery infos

Returns

true/false.

Implements yarp::dev::IBattery.

Definition at line 126 of file upowerBattery.cpp.

getBatteryStatus()

bool UpowerBattery::getBatteryStatus ( Battery_status &  status )

overridevirtual

get the battery status

Parameters

status

the battery status

Returns

true/false.

Implements yarp::dev::IBattery.

Definition at line 75 of file upowerBattery.cpp.

getBatteryTemperature()

bool UpowerBattery::getBatteryTemperature ( double &  temperature )

overridevirtual

get the battery temperature

Parameters

temperature

the battery temperature

Returns

true/false.

Implements yarp::dev::IBattery.

Definition at line 120 of file upowerBattery.cpp.

getBatteryVoltage()

bool UpowerBattery::getBatteryVoltage ( double &  voltage )

overridevirtual

Get the instantaneous voltage measurement.

Parameters

voltage

the voltage measurement

Returns

true/false.

Implements yarp::dev::IBattery.

Definition at line 51 of file upowerBattery.cpp.

open()

bool UpowerBattery::open ( yarp::os::Searchable &  config )

overridevirtual

Open the DeviceDriver.

Parameters

config

is a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).

Returns

true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 29 of file upowerBattery.cpp.

operator=() [1/2]

UpowerBattery & UpowerBattery::operator= ( const UpowerBattery &  )

delete

operator=() [2/2]

UpowerBattery & UpowerBattery::operator= ( UpowerBattery &&  )

delete

---

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

• src/devices/upowerBattery/upowerBattery.h
• src/devices/upowerBattery/upowerBattery.cpp