Battery.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Hardware
File: Battery
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/Device.h>
#include <QObject>
namespace NDEVR
{
    class Log;
    class JSONNode;
    /**--------------------------------------------------------------------------------------------------
    \brief An indication of what state a Battery object is in.
     *-----------------------------------------------------------------------------------------------**/
    enum class BatteryState
    {
          e_no_battery
        , e_normal
        , e_low_voltage
        , e_critical_voltage
        , e_shutdown_voltage
        , e_invalid
    };
    /**--------------------------------------------------------------------------------------------------
    \brief The various types of capacity information a Battery may have.
     *-----------------------------------------------------------------------------------------------**/
    enum class BatteryCapacityType
    {
          e_percentage
        , e_watt_hours
        , e_voltage
    };
    /**--------------------------------------------------------------------------------------------------
    \brief For a given BatteryCapacityType, the limits that define the state of the battery.
     *-----------------------------------------------------------------------------------------------**/
    struct HARDWARE_API BatteryCapacityInfo
    {
        fltp04 current_level  = Constant<fltp04>::Invalid;
        fltp04 max_level      = Constant<fltp04>::Invalid;
        fltp04 discharge_rate = Constant<fltp04>::Invalid;
        fltp04 warning_level  = Constant<fltp04>::Invalid;
        fltp04 critical_level = Constant<fltp04>::Invalid;
        fltp04 shutdown_level = Constant<fltp04>::Invalid;
 
        void toJSONNode(JSONNode& node) const;
        void fromJSONNode(const JSONNode& node);
        bool operator!=(const BatteryCapacityInfo& info) const;
        bool canChangeBatteryState() const;
        fltp04 percent() const;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A device which has an accociated voltage or percent that changes. Can have set upper and lower
        limits.
     *-----------------------------------------------------------------------------------------------**/
    class HARDWARE_API Battery : public Device
    {
        Q_OBJECT
    public:
        Battery(const Model& name, ProgressInfo* log, QObject* parent = nullptr);
        [[nodiscard]] fltp04 percent() const;
        BatteryCapacityInfo capacityInfo(BatteryCapacityType type) const;
        void setCapacityInfo(BatteryCapacityType type, const BatteryCapacityInfo& info);
        virtual void autoUpdateBatteryState(BatteryCapacityType mode);
        virtual void setBatteryLevel(BatteryCapacityType type, fltp04 value);
        virtual fltp04 batteryLevel(BatteryCapacityType type) const;
        void showWarning(const TranslatedString& warning) const override;
        bool isCharging() const;
        void setIsCharging(bool is_charging);
        void addBatteryGroupMember(Battery* battery);
        virtual void forceBatteryState(const BatteryState& state);
        [[nodiscard]] virtual BatteryState batteryState() const;
        [[nodiscard]] virtual BatteryState batteryGroupState() const;
    signals:
        void batteryStateChangedSignal();
        void batteryGroupStateChangedSignal(bool originator);
    protected:
        Buffer<Battery*> m_battery_group_members;
        Vector<3, BatteryCapacityInfo> m_capacity_info;
        Time m_last_state_stable_time;
        BatteryState m_bat_state;
        BatteryState m_bat_group_state;
        BatteryState m_forced_bat_state;
        bool m_is_charging;
    };
}