libkipr  1.0.0
Battery

Functions

int battery_charging ()
 
float power_level ()
 
float power_level_nimh ()
 
float power_level_lipo ()
 
float power_level_life ()
 

Detailed Description

The functions defined here allow for checking the wombat or wallaby's battery status.

Function Documentation

◆ battery_charging()

int battery_charging ( )

Whether or not the battery is charging

Returns
0: not charging 1: charging
Deprecated:
not applicable for the Wallaby controller

◆ power_level()

float power_level ( )

The device's power level

Returns
The device's current battery capacity 0: 0% 1: 100%
Note
defaults to LiFePO4 chemistry

◆ power_level_life()

float power_level_life ( )

The device's power level (LiFePO4 chemistry)

Returns
The device's current battery capacity 0: 0% 1: 100%
See also
power_level()

◆ power_level_lipo()

float power_level_lipo ( )

The device's power level (LiPo chemistry)

Returns
The device's current battery capacity 0: 0% 1: 100%

◆ power_level_nimh()

float power_level_nimh ( )

The device's power level (NiMH chemistry)

Returns
The device's current battery capacity 0: 0% 1: 100%