power_management_interface.hpp

// Copyright (C) 2024 Avular Holding B.V. - All Rights Reserved
// You may use this code under the terms of the Avular
// Software End-User License Agreement.
//
// You should have received a copy of the Avular
// Software End-User License Agreement license with
// this file, or download it from: avular.com/eula
//
/*****************************************************************************
 * Created on: 2024 July 23
 * Author: Bram Tertoolen
 *
 * Header file for power management interface
 ****************************************************************************/
#pragma once
 
#include <creos/client_global.hpp>
#include <creos/messages/enter_low_power_mode.hpp>
#include <creos/messages/interface_info.hpp>
#include <creos/robot_clock.hpp>
 
namespace creos {
 
class CREOS_CLIENT_API IPowerManagementInterface {
public:
    static constexpr char name[] = "power_management";
    static constexpr unsigned version = 1;
 
    virtual ~IPowerManagementInterface() = default;
 
    virtual void enterLowPowerMode(int timeout_ms = 5000) = 0;
 
    virtual void enterLowPowerMode(const creos::RobotClock::time_point& wake_up_time, int timeout_ms = 5000) = 0;
 
    virtual void exitLowPowerMode(int timeout_ms = 5000) = 0;
 
    virtual void shutdown(int timeout_ms = 5000) = 0;
 
    virtual void reboot(int timeout_ms = 10000) = 0;
};
 
}  // namespace creos