cfn_sal_dev_battery_api_s Struct Reference

Battery Monitor Virtual Method Table (VMT). More...

#include <cfn_sal_dev_battery.h>

Data Fields
cfn_hal_api_base_t	base
cfn_hal_error_code_t(*	get_voltage )(cfn_sal_dev_battery_t *driver, float *volts_out)
cfn_hal_error_code_t(*	get_percentage )(cfn_sal_dev_battery_t *driver, uint8_t *percent_out)
cfn_hal_error_code_t(*	get_current )(cfn_sal_dev_battery_t *driver, float *amps_out)
cfn_hal_error_code_t(*	get_remaining_capacity )(cfn_sal_dev_battery_t *driver, uint32_t *mah_out)
cfn_hal_error_code_t(*	read_current_ma )(cfn_sal_dev_battery_t *driver, float *current_out)
cfn_hal_error_code_t(*	read_capacity_mah )(cfn_sal_dev_battery_t *driver, float *cap_out)
cfn_hal_error_code_t(*	read_state_of_charge )(cfn_sal_dev_battery_t *driver, float *soc_percent_out)
cfn_hal_error_code_t(*	get_status )(cfn_sal_dev_battery_t *driver, cfn_sal_dev_battery_status_t *status_out)
cfn_hal_error_code_t(*	get_charge_state )(cfn_sal_dev_battery_t *driver, cfn_sal_dev_battery_charge_state_t *state_out)
cfn_hal_error_code_t(*	get_temperature )(cfn_sal_dev_battery_t *driver, float *temp_out)

Detailed Description

Battery Monitor Virtual Method Table (VMT).

Field Documentation

base

cfn_hal_api_base_t cfn_sal_dev_battery_api_s::base

get_charge_state

cfn_hal_error_code_t(* cfn_sal_dev_battery_api_s::get_charge_state) (cfn_sal_dev_battery_t *driver, cfn_sal_dev_battery_charge_state_t *state_out)

get_current

cfn_hal_error_code_t(* cfn_sal_dev_battery_api_s::get_current) (cfn_sal_dev_battery_t *driver, float *amps_out)

get_percentage

cfn_hal_error_code_t(* cfn_sal_dev_battery_api_s::get_percentage) (cfn_sal_dev_battery_t *driver, uint8_t *percent_out)

get_remaining_capacity

cfn_hal_error_code_t(* cfn_sal_dev_battery_api_s::get_remaining_capacity) (cfn_sal_dev_battery_t *driver, uint32_t *mah_out)

get_status

cfn_hal_error_code_t(* cfn_sal_dev_battery_api_s::get_status) (cfn_sal_dev_battery_t *driver, cfn_sal_dev_battery_status_t *status_out)

get_temperature

cfn_hal_error_code_t(* cfn_sal_dev_battery_api_s::get_temperature) (cfn_sal_dev_battery_t *driver, float *temp_out)

get_voltage

cfn_hal_error_code_t(* cfn_sal_dev_battery_api_s::get_voltage) (cfn_sal_dev_battery_t *driver, float *volts_out)

read_capacity_mah

cfn_hal_error_code_t(* cfn_sal_dev_battery_api_s::read_capacity_mah) (cfn_sal_dev_battery_t *driver, float *cap_out)

read_current_ma

cfn_hal_error_code_t(* cfn_sal_dev_battery_api_s::read_current_ma) (cfn_sal_dev_battery_t *driver, float *current_out)

read_state_of_charge

cfn_hal_error_code_t(* cfn_sal_dev_battery_api_s::read_state_of_charge) (cfn_sal_dev_battery_t *driver, float *soc_percent_out)

---

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

• include/devices/cfn_sal_dev_battery.h