IBattery.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_DEV_IBATTERY_H
#define YARP_DEV_IBATTERY_H
 
#include <string>
 
#include <yarp/os/Vocab.h>
#include <yarp/dev/api.h>
 
constexpr yarp::conf::vocab32_t VOCAB_IBATTERY     = yarp::os::createVocab32('i','b','a','t');
constexpr yarp::conf::vocab32_t VOCAB_BATTERY_INFO = yarp::os::createVocab32('b','t','n','f');
 
namespace yarp::dev {
class IBattery;
}
 
class YARP_dev_API yarp::dev::IBattery
{
public:
    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
    };
 
    virtual ~IBattery();
 
    virtual bool getBatteryVoltage(double &voltage) = 0;
 
    virtual bool getBatteryCurrent(double &current) = 0;
 
    virtual bool getBatteryCharge(double &charge) = 0;
 
    virtual bool getBatteryStatus(Battery_status &status) = 0;
 
    virtual bool getBatteryTemperature(double &temperature) = 0;
 
    virtual bool getBatteryInfo(std::string &battery_info) = 0;
};
 
#endif // YARP_DEV_IBATTERY_H