#include <AP_BattMonitor_Params.h>

Collaboration diagram for AP_BattMonitor_Params:

Public Types
enum	BattMonitor_Type { BattMonitor_TYPE_NONE = 0, BattMonitor_TYPE_ANALOG_VOLTAGE_ONLY = 3, BattMonitor_TYPE_ANALOG_VOLTAGE_AND_CURRENT = 4, BattMonitor_TYPE_SOLO = 5, BattMonitor_TYPE_BEBOP = 6, BattMonitor_TYPE_MAXELL = 7, BattMonitor_TYPE_UAVCAN_BatteryInfo = 8 }

enum	BattMonitor_LowVoltage_Source { BattMonitor_LowVoltageSource_Raw = 0, BattMonitor_LowVoltageSource_SagCompensated = 1 }

Public Member Functions
	AP_BattMonitor_Params (void)

	AP_BattMonitor_Params (const AP_BattMonitor_Params &other)=delete

AP_BattMonitor_Params &	operator= (const AP_BattMonitor_Params &)=delete

BattMonitor_Type	type (void) const

BattMonitor_LowVoltage_Source	failsafe_voltage_source (void)

Public Attributes
AP_Int8	_type

AP_Int8	_volt_pin
	0=disabled, 3=voltage only, 4=voltage and current More...

AP_Int8	_curr_pin
	board pin used to measure battery voltage More...

AP_Float	_volt_multiplier
	board pin used to measure battery current More...

AP_Float	_curr_amp_per_volt
	voltage on volt pin multiplied by this to calculate battery voltage More...

AP_Float	_curr_amp_offset
	voltage on current pin multiplied by this to calculate current in amps More...

AP_Int32	_pack_capacity
	offset voltage that is subtracted from current pin before conversion to amps More...

AP_Int16	_watt_max
	battery pack capacity less reserve in mAh More...

AP_Int32	_serial_number
	max battery power allowed. Reduce max throttle to reduce current to satisfy t his limit More...

AP_Int8	_low_voltage_timeout
	battery serial number, automatically filled in on SMBus batteries More...

AP_Int8	_failsafe_voltage_source
	timeout in seconds before a low voltage event will be triggered More...

AP_Float	_low_voltage
	voltage type used for detection of low voltage event More...

AP_Float	_low_capacity
	voltage level used to trigger a low battery failsafe More...

AP_Float	_critical_voltage
	capacity level used to trigger a low battery failsafe More...

AP_Float	_critical_capacity
	voltage level used to trigger a critical battery failsafe More...

AP_Int8	_failsafe_low_action
	capacity level used to trigger a critical battery failsafe More...

AP_Int8	_failsafe_critical_action
	action to preform on a low battery failsafe More...

Static Public Attributes
static const struct AP_Param::GroupInfo	var_info []

Detailed Description

Definition at line 5 of file AP_BattMonitor_Params.h.

Member Enumeration Documentation

◆ BattMonitor_LowVoltage_Source

enum AP_BattMonitor_Params::BattMonitor_LowVoltage_Source

Enumerator
BattMonitor_LowVoltageSource_Raw
BattMonitor_LowVoltageSource_SagCompensated

Definition at line 27 of file AP_BattMonitor_Params.h.

◆ BattMonitor_Type

enum AP_BattMonitor_Params::BattMonitor_Type

Enumerator
BattMonitor_TYPE_NONE
BattMonitor_TYPE_ANALOG_VOLTAGE_ONLY
BattMonitor_TYPE_ANALOG_VOLTAGE_AND_CURRENT
BattMonitor_TYPE_SOLO
BattMonitor_TYPE_BEBOP
BattMonitor_TYPE_MAXELL
BattMonitor_TYPE_UAVCAN_BatteryInfo

Definition at line 16 of file AP_BattMonitor_Params.h.

Constructor & Destructor Documentation

◆ AP_BattMonitor_Params() [1/2]

AP_BattMonitor_Params::AP_BattMonitor_Params ( void )

Definition at line 153 of file AP_BattMonitor_Params.cpp.

Here is the call graph for this function:

◆ AP_BattMonitor_Params() [2/2]

AP_BattMonitor_Params::AP_BattMonitor_Params ( const AP_BattMonitor_Params & other )

delete

Member Function Documentation

◆ failsafe_voltage_source()

BattMonitor_LowVoltage_Source AP_BattMonitor_Params::failsafe_voltage_source ( void )

inline

Definition at line 33 of file AP_BattMonitor_Params.h.

◆ operator=()

AP_BattMonitor_Params& AP_BattMonitor_Params::operator= ( const AP_BattMonitor_Params & )

delete

◆ type()

BattMonitor_Type AP_BattMonitor_Params::type ( void ) const

inline

Definition at line 32 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor::get_type(), and AP_BattMonitor_Analog::has_current().

Here is the caller graph for this function:

Member Data Documentation

◆ _critical_capacity

AP_Float AP_BattMonitor_Params::_critical_capacity

voltage level used to trigger a critical battery failsafe

Definition at line 49 of file AP_BattMonitor_Params.h.

◆ _critical_voltage

AP_Float AP_BattMonitor_Params::_critical_voltage

capacity level used to trigger a low battery failsafe

Definition at line 48 of file AP_BattMonitor_Params.h.

◆ _curr_amp_offset

AP_Float AP_BattMonitor_Params::_curr_amp_offset

voltage on current pin multiplied by this to calculate current in amps

Definition at line 40 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor_Analog::read().

◆ _curr_amp_per_volt

AP_Float AP_BattMonitor_Params::_curr_amp_per_volt

voltage on volt pin multiplied by this to calculate battery voltage

Definition at line 39 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor_Analog::read().

◆ _curr_pin

AP_Int8 AP_BattMonitor_Params::_curr_pin

board pin used to measure battery voltage

Definition at line 37 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor_Analog::AP_BattMonitor_Analog(), and AP_BattMonitor_Analog::read().

◆ _failsafe_critical_action

AP_Int8 AP_BattMonitor_Params::_failsafe_critical_action

action to preform on a low battery failsafe

Definition at line 51 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor::check_failsafes().

◆ _failsafe_low_action

AP_Int8 AP_BattMonitor_Params::_failsafe_low_action

capacity level used to trigger a critical battery failsafe

Definition at line 50 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor::check_failsafes().

◆ _failsafe_voltage_source

AP_Int8 AP_BattMonitor_Params::_failsafe_voltage_source

timeout in seconds before a low voltage event will be triggered

Definition at line 45 of file AP_BattMonitor_Params.h.

Referenced by failsafe_voltage_source().

◆ _low_capacity

AP_Float AP_BattMonitor_Params::_low_capacity

voltage level used to trigger a low battery failsafe

Definition at line 47 of file AP_BattMonitor_Params.h.

◆ _low_voltage

AP_Float AP_BattMonitor_Params::_low_voltage

voltage type used for detection of low voltage event

Definition at line 46 of file AP_BattMonitor_Params.h.

◆ _low_voltage_timeout

AP_Int8 AP_BattMonitor_Params::_low_voltage_timeout

battery serial number, automatically filled in on SMBus batteries

Definition at line 44 of file AP_BattMonitor_Params.h.

◆ _pack_capacity

AP_Int32 AP_BattMonitor_Params::_pack_capacity

offset voltage that is subtracted from current pin before conversion to amps

Definition at line 41 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor_SMBus::AP_BattMonitor_SMBus(), AP_BattMonitor_Backend::capacity_remaining_pct(), AP_BattMonitor::pack_capacity_mah(), AP_BattMonitor_SMBus::read(), and AP_BattMonitor_SMBus::read_remaining_capacity().

◆ _serial_number

AP_Int32 AP_BattMonitor_Params::_serial_number

max battery power allowed. Reduce max throttle to reduce current to satisfy t his limit

Definition at line 43 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor_SMBus::AP_BattMonitor_SMBus(), and AP_BattMonitor_SMBus::read().

◆ _type

AP_Int8 AP_BattMonitor_Params::_type

Definition at line 35 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor::convert_params(), AP_BattMonitor::init(), AP_BattMonitor::set_monitoring(), and type().

◆ _volt_multiplier

AP_Float AP_BattMonitor_Params::_volt_multiplier

board pin used to measure battery current

Definition at line 38 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor_Analog::read().

◆ _volt_pin

AP_Int8 AP_BattMonitor_Params::_volt_pin

0=disabled, 3=voltage only, 4=voltage and current

Definition at line 36 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor_Analog::AP_BattMonitor_Analog(), and AP_BattMonitor_Analog::read().

◆ _watt_max

AP_Int16 AP_BattMonitor_Params::_watt_max

battery pack capacity less reserve in mAh

Definition at line 42 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor::overpower_detected().

◆ var_info

const AP_Param::GroupInfo AP_BattMonitor_Params::var_info

static

Definition at line 7 of file AP_BattMonitor_Params.h.

Referenced by AP_BattMonitor_Params(), and AP_BattMonitor::convert_params().

The documentation for this class was generated from the following files:

libraries/AP_BattMonitor/AP_BattMonitor_Params.h
libraries/AP_BattMonitor/AP_BattMonitor_Params.cpp

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ BattMonitor_LowVoltage_Source

◆ BattMonitor_Type

Constructor & Destructor Documentation

◆ AP_BattMonitor_Params() [1/2]

◆ AP_BattMonitor_Params() [2/2]

Member Function Documentation

◆ failsafe_voltage_source()

◆ operator=()

◆ type()

Member Data Documentation

◆ _critical_capacity

◆ _critical_voltage

◆ _curr_amp_offset

◆ _curr_amp_per_volt

◆ _curr_pin

◆ _failsafe_critical_action

◆ _failsafe_low_action

◆ _failsafe_voltage_source

◆ _low_capacity

◆ _low_voltage

◆ _low_voltage_timeout

◆ _pack_capacity

◆ _serial_number

◆ _type

◆ _volt_multiplier

◆ _volt_pin

◆ _watt_max

◆ var_info