creos_messages::BatteryStatus Struct Reference

BatteryStatus message contains the current battery state. More...

#include <creos/messages/battery_status.hpp>

Collaboration diagram for creos_messages::BatteryStatus:

Classes
struct	Alerts

Public Types
enum	State {   kUnknown , kOffline , kCharging , kDischarging ,   kBalancing , kError }

Public Member Functions
auto	operator<=> (const BatteryStatus &other) const =default
	Compare two BatteryStatus messages.

Public Attributes
float	voltage = 0.0f
	The current voltage of the battery pack [V], NaN if not available.
float	state_of_charge
	The current state of charge of the battery pack (0.0 - 1.0), NaN if not available.
float	state_of_health = 0.0f
	How healthy is the battery pack (0.0 - 1.0), NaN if not available.
float	temperature = 0.0f
	The current temperature of the battery pack [°C], NaN if not available.
State	state = kUnknown
	The current state of the battery pack.
Alerts	alerts
	The current alerts of the battery pack.

Detailed Description

BatteryStatus message contains the current battery state.

Member Enumeration Documentation

State

enum creos_messages::BatteryStatus::State

Enumerator
kUnknown	The state is unknown.
kOffline	The battery is offline or not connected.
kCharging	The battery is charging.
kDischarging	The battery is discharging.
kBalancing	The battery is balancing between cells.
kError	The battery is in an error state.

Member Data Documentation

state_of_charge

float creos_messages::BatteryStatus::state_of_charge

Initial value:

=
        0.0f

The current state of charge of the battery pack (0.0 - 1.0), NaN if not available.

---

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

• creos_msgs/include/creos/messages/battery_status.hpp