creos::IPowerManagementInterface Class Reference

The interface for querying and managing the power state of an Avular robot. More...

#include <creos/power_management_interface.hpp>

Public Member Functions
virtual void	enterLowPowerMode (int timeout_ms=5000)=0
	Enter low power mode.
virtual void	enterLowPowerMode (const creos::RobotClock::time_point &wake_up_time, int timeout_ms=5000)=0
	Enter low power mode.
virtual void	exitLowPowerMode (int timeout_ms=5000)=0
	Exit low power mode.
virtual void	shutdown (int timeout_ms=5000)=0
	Shutdown the robot.
virtual void	reboot (int timeout_ms=10000)=0
	Reboot the robot.

Static Public Attributes
static constexpr char	name [] = "power_management"
static constexpr unsigned	version = 1

Detailed Description

The interface for querying and managing the power state of an Avular robot.

Member Function Documentation

enterLowPowerMode() [1/2]

virtual void creos::IPowerManagementInterface::enterLowPowerMode ( const creos::RobotClock::time_point & wake_up_time, int timeout_ms = 5000 )

pure virtualOrigin

Enter low power mode.

This function will put the robot in a low power mode which will wake up after a certain time.

Parameters

wake_up_time	The time at which the robot should exit low power mode.
timeout_ms	The time in milliseconds to wait for the robot to enter low power mode.

Exceptions

creos::TimeoutError	if the robot does not enter low power mode within the timeout.
creos::UnsupportedError	if the robot does not support entering low power mode.
creos::Exception	if any error occurred while sending the command.

enterLowPowerMode() [2/2]

virtual void creos::IPowerManagementInterface::enterLowPowerMode ( int timeout_ms = 5000 )

pure virtualOrigin

Enter low power mode.

This function will put the robot in a low power mode.

Parameters

timeout_ms

The time in milliseconds to wait for the robot to enter low power mode.

Exceptions

creos::TimeoutError	if the robot does not enter low power mode within the timeout.
creos::UnsupportedError	if the robot does not support entering low power mode.
creos::Exception	if any error occurred while sending the command.

exitLowPowerMode()

virtual void creos::IPowerManagementInterface::exitLowPowerMode ( int timeout_ms = 5000 )

pure virtualOrigin

Exit low power mode.

This function will exit the robot from low power mode.

Parameters

timeout_ms

The time in milliseconds to wait for the robot to respond to the command.

Exceptions

creos::TimeoutError	if the robot does not respond within the timeout.
creos::UnsupportedError	if the robot does not support exiting low power mode.
creos::Exception	if any other error occurred while sending the command.

reboot()

virtual void creos::IPowerManagementInterface::reboot ( int timeout_ms = 10000 )

pure virtualOriginVertex

Reboot the robot.

This function will reboot the robot.

Parameters

timeout_ms

The time in milliseconds to wait for the robot to respond to the command.

Exceptions

creos::TimeoutError	if the robot does not respond within the timeout.
creos::UnsupportedError	if the robot does not support rebooting.
creos::Exception	if any other error occurred while sending the command.

shutdown()

virtual void creos::IPowerManagementInterface::shutdown ( int timeout_ms = 5000 )

pure virtualOrigin

Shutdown the robot.

This function will shutdown the robot.

Parameters

timeout_ms

The time in milliseconds to wait for the robot to respond to the command.

Exceptions

creos::TimeoutError	if the robot does not respond within the timeout.
creos::UnsupportedError	if the robot does not support shutting down.
creos::Exception	if any other error occurred while sending the command.

---

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

• creos/power_management_interface.hpp