Functions in battery.h
Functions for working with the battery service on the device.
battery_event_get_info()
Retrieve the battery information structure from a
BATTERY_INFO
event.
battery_free_info()
Free the memory that is used by a battery information structure.
battery_get_domain()
Retrieve the unique domain ID for the battery service.
battery_get_info()
Retrieve the current the battery information.
battery_info_get_battery_alert()
Determine whether the battery alert is triggered.
battery_info_get_battery_available_energy()
Retrieve the available energy remaining in the battery.
battery_info_get_battery_average_current()
Retrieve the battery average current.
battery_info_get_battery_average_power()
Retrieve the battery average power.
battery_info_get_battery_cycle_count()
Retrieve the battery cycle count.
battery_info_get_battery_design_capacity()
Retrieve the battery design capacity.
battery_info_get_battery_full_available_capacity()
Retrieve the battery full available capacity.
battery_info_get_battery_full_charge_capacity()
Retrieve the battery full charge capacity.
battery_info_get_battery_id()
Retrieve the battery ID.
battery_info_get_battery_max_load_current()
Retrieve the battery maximum load current.
battery_info_get_battery_max_load_time_to_empty()
Retrieve the battery maximum load time to empty.
battery_info_get_battery_name()
Retrieve the battery name.
battery_info_get_battery_nominal_available_capacity()
Retrieve the battery nominal available capacity.
battery_info_get_battery_temperature()
Retrieve the battery temperature.
battery_info_get_battery_time_to_empty_at_constant_power()
Retrieve the battery time to empty at constant power.
battery_info_get_battery_voltage()
Retrieve the battery voltage.
battery_info_get_charger_info()
Retrieve the state of the charger.
battery_info_get_charger_max_charge_current()
Retrieve the charger maximum charge current.
battery_info_get_charger_max_input_current()
Retrieve the charger maximum input current.
battery_info_get_charger_name()
Retrieve the charger name.
battery_info_get_device_name()
Retrieve the device name.
battery_info_get_state_of_charge()
Retrieve the state of charge from a battery information structure.
battery_info_get_state_of_health()
Retrieve the state of health from a battery information structure.
battery_info_get_system_charge_current()
Retrieve the system charge current.
battery_info_get_system_charging_state()
Retrieve the system charging state.
battery_info_get_system_input_current_monitor()
Retrieve the system input current monitor.
battery_info_get_system_max_voltage()
Retrieve the system maximum voltage.
battery_info_get_system_min_voltage()
Retrieve the system minimum voltage.
battery_info_get_system_voltage()
Retrieve the system voltage.
battery_info_get_time_to_empty()
Retrieve the amount of time before the battery is fully discharged (empty).
battery_info_get_time_to_full()
Retrieve the amount of time to fully charge the battery.
battery_info_get_version()
Retrieve the Battery API version.
battery_info_is_battery_ok()
Retrieve status of the battery.
battery_info_is_battery_present()
Determine whether the battery is present.
battery_info_is_battery_ready()
Determine whether the battery is ready.
battery_info_is_charger_ready()
Determine whether the charger is ready.
battery_info_is_system_ready()
Determine whether the system is ready.
battery_request_events()
Start receiving battery events.
battery_stop_events()
Stop receiving battery events.
Parent topic:
Battery (battery.h)
Related concepts
Data types in battery.h