.. _pilot.BatteryState:

pilot.BatteryState
==================

.. cpp:namespace:: pilot::BatteryState

Class
-----

`BatteryState` contains information regarding the platform's batteries.

Inherits from :ref:`pilot.Sample`.


Fields
------

.. cpp:member:: float remaining

	Percentage of charge remaining, from 0 to 1.
	
.. cpp:member:: float voltage

	Battery voltage in [V].
	
.. cpp:member:: float current
	
	Battery current, positive = charging, in [A].

.. cpp:member:: float temperature

	Battery temperatue in [C].
	
.. cpp:member:: battery_type_e type
	
	Battery type, see :ref:`pilot.battery_type_e`.