YARP
Yet Another Robot Platform

batteryClient: The client side of any IBattery capable device. More...

#include <batteryClient/BatteryClient.h>

+ Inheritance diagram for BatteryClient:

Public Member Functions

bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
yarp::os::Stamp getLastInputStamp () override
 Get the time stamp for the last read data. More...
 
bool getBatteryVoltage (double &voltage) override
 Get the instantaneous voltage measurement. More...
 
bool getBatteryCurrent (double &current) override
 Get the instantaneous current measurement. More...
 
bool getBatteryCharge (double &charge) override
 get the battery status of charge More...
 
bool getBatteryStatus (Battery_status &status) override
 get the battery status More...
 
bool getBatteryInfo (std::string &battery_info) override
 get the battery hardware charactestics (e.g. More...
 
bool getBatteryTemperature (double &temperature) override
 get the battery temperature More...
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 ~DeviceDriver () override=default
 Destructor. More...
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver. More...
 
virtual DeviceDrivergetImplementation ()
 Some drivers are bureaucrats, pointing at others. More...
 
- Public Member Functions inherited from yarp::os::IConfig
virtual ~IConfig ()
 Destructor. More...
 
virtual bool configure (Searchable &config)
 Change online parameters. More...
 
- Public Member Functions inherited from yarp::dev::IPreciselyTimed
virtual ~IPreciselyTimed ()
 
- Public Member Functions inherited from yarp::dev::IBattery
virtual ~IBattery ()
 

Protected Attributes

BatteryInputPortProcessor inputPort
 
yarp::os::Port rpcPort
 
std::string local
 
std::string remote
 
yarp::os::Stamp lastTs
 
std::string deviceId
 

Additional Inherited Members

- Public Types inherited from yarp::dev::IBattery
enum  Battery_status {
  BATTERY_OK_STANBY = 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

batteryClient: The client side of any IBattery capable device.

Still single thread! concurrent access is unsafe.

Definition at line 71 of file BatteryClient.h.

Member Function Documentation

◆ close()

bool BatteryClient::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 233 of file BatteryClient.cpp.

◆ getBatteryCharge()

bool BatteryClient::getBatteryCharge ( double &  charge)
overridevirtual

get the battery status of charge

Parameters
chargethe charge measurement (0-100%)
Returns
true/false.

Implements yarp::dev::IBattery.

Definition at line 252 of file BatteryClient.cpp.

◆ getBatteryCurrent()

bool BatteryClient::getBatteryCurrent ( double &  current)
overridevirtual

Get the instantaneous current measurement.

Parameters
currentthe current measurement
Returns
true/false.

Implements yarp::dev::IBattery.

Definition at line 246 of file BatteryClient.cpp.

◆ getBatteryInfo()

bool BatteryClient::getBatteryInfo ( std::string &  battery_info)
overridevirtual

get the battery hardware charactestics (e.g.

max voltage etc)

Parameters
astring containing the battery infos
Returns
true/false.

Implements yarp::dev::IBattery.

Definition at line 270 of file BatteryClient.cpp.

◆ getBatteryStatus()

bool BatteryClient::getBatteryStatus ( Battery_status status)
overridevirtual

get the battery status

Parameters
statusthe battery status
Returns
true/false.

Implements yarp::dev::IBattery.

Definition at line 258 of file BatteryClient.cpp.

◆ getBatteryTemperature()

bool BatteryClient::getBatteryTemperature ( double &  temperature)
overridevirtual

get the battery temperature

Parameters
tempraturethe battery temperature
Returns
true/false.

Implements yarp::dev::IBattery.

Definition at line 264 of file BatteryClient.cpp.

◆ getBatteryVoltage()

bool BatteryClient::getBatteryVoltage ( double &  voltage)
overridevirtual

Get the instantaneous voltage measurement.

Parameters
voltagethe voltage measurement
Returns
true/false.

Implements yarp::dev::IBattery.

Definition at line 240 of file BatteryClient.cpp.

◆ getLastInputStamp()

Stamp BatteryClient::getLastInputStamp ( )
overridevirtual

Get the time stamp for the last read data.

Returns
last time stamp.

Implements yarp::dev::IPreciselyTimed.

Definition at line 284 of file BatteryClient.cpp.

◆ open()

bool BatteryClient::open ( yarp::os::Searchable config)
overridevirtual

Open the DeviceDriver.

Parameters
configis 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 175 of file BatteryClient.cpp.

Member Data Documentation

◆ deviceId

std::string BatteryClient::deviceId
protected

Definition at line 82 of file BatteryClient.h.

◆ inputPort

BatteryInputPortProcessor BatteryClient::inputPort
protected

Definition at line 77 of file BatteryClient.h.

◆ lastTs

yarp::os::Stamp BatteryClient::lastTs
protected

Definition at line 81 of file BatteryClient.h.

◆ local

std::string BatteryClient::local
protected

Definition at line 79 of file BatteryClient.h.

◆ remote

std::string BatteryClient::remote
protected

Definition at line 80 of file BatteryClient.h.

◆ rpcPort

yarp::os::Port BatteryClient::rpcPort
protected

Definition at line 78 of file BatteryClient.h.


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