player_power_data Struct Reference

Data: voltage (PLAYER_POWER_DATA_STATE) More...

#include <player_interfaces.h>

Collaboration diagram for player_power_data:
Collaboration graph

Detailed Description

Data: voltage (PLAYER_POWER_DATA_STATE)

The power interface returns data in this format.

Public Attributes

uint32_t valid
 Status bits. More...
 
float volts
 Battery voltage [V].
 
float percent
 Percent of full charge [%].
 
float joules
 energy stored [J]. More...
 
float watts
 estimated current energy consumption (negative values) or aquisition (positive values) [W]. More...
 
int32_t charging
 charge exchange status: if 1, the device is currently receiving charge from another energy device. More...
 

Member Data Documentation

◆ charging

int32_t player_power_data::charging

charge exchange status: if 1, the device is currently receiving charge from another energy device.

If -1 the device is currently providing charge to another energy device. If 0, the device is not exchanging charge with an another device.

◆ joules

float player_power_data::joules

energy stored [J].

◆ valid

uint32_t player_power_data::valid

Status bits.

The driver will set the bits to indicate which fields it is using. Bitwise-and with PLAYER_POWER_MASK_X values to see which fields are being set.

◆ watts

float player_power_data::watts

estimated current energy consumption (negative values) or aquisition (positive values) [W].


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