APM:Libraries: RangeFinder::RangeFinder_State Struct Reference

APM:Libraries

#include <RangeFinder.h>

Collaboration diagram for RangeFinder::RangeFinder_State:

Public Attributes
uint16_t	distance_cm

uint16_t	voltage_mv

enum RangeFinder_Status	status

uint8_t	range_valid_count

bool	pre_arm_check

uint16_t	pre_arm_distance_min

uint16_t	pre_arm_distance_max

AP_Int8	type

AP_Int8	pin

AP_Int8	ratiometric

AP_Int8	stop_pin

AP_Int16	settle_time_ms

AP_Float	scaling

AP_Float	offset

AP_Int8	function

AP_Int16	min_distance_cm

AP_Int16	max_distance_cm

AP_Int8	ground_clearance_cm

AP_Int8	address

AP_Vector3f	pos_offset

AP_Int8	orientation

const struct AP_Param::GroupInfo *	var_info

Detailed Description

Definition at line 82 of file RangeFinder.h.

Member Data Documentation

◆ address

AP_Int8 RangeFinder::RangeFinder_State::address

Definition at line 103 of file RangeFinder.h.

Referenced by RangeFinder::detect_instance(), and AP_RangeFinder_LightWareI2C::get_reading().

◆ distance_cm

uint16_t RangeFinder::RangeFinder_State::distance_cm

◆ function

AP_Int8 RangeFinder::RangeFinder_State::function

Definition at line 99 of file RangeFinder.h.

Referenced by AP_RangeFinder_analog::update().

◆ ground_clearance_cm

AP_Int8 RangeFinder::RangeFinder_State::ground_clearance_cm

Definition at line 102 of file RangeFinder.h.

Referenced by AP_RangeFinder_Backend::ground_clearance_cm(), and AP_RangeFinder_Backend::update_pre_arm_check().

◆ max_distance_cm

AP_Int16 RangeFinder::RangeFinder_State::max_distance_cm

Definition at line 101 of file RangeFinder.h.

Referenced by AP_RangeFinder_Backend::max_distance_cm(), AP_RangeFinder_analog::update(), and AP_RangeFinder_Backend::update_status().

◆ min_distance_cm

AP_Int16 RangeFinder::RangeFinder_State::min_distance_cm

Definition at line 100 of file RangeFinder.h.

Referenced by AP_RangeFinder_Backend::min_distance_cm(), AP_RangeFinder_Backend::update_pre_arm_check(), and AP_RangeFinder_Backend::update_status().

◆ offset

AP_Float RangeFinder::RangeFinder_State::offset

Definition at line 98 of file RangeFinder.h.

Referenced by AP_RangeFinder_analog::update(), and AP_RangeFinder_PX4_PWM::update().

◆ orientation

AP_Int8 RangeFinder::RangeFinder_State::orientation

Definition at line 105 of file RangeFinder.h.

Referenced by RangeFinder::num_sensors(), AP_RangeFinder_Backend::orientation(), and RangeFinder::RangeFinder().

◆ pin

AP_Int8 RangeFinder::RangeFinder_State::pin

Definition at line 93 of file RangeFinder.h.

Referenced by AP_RangeFinder_analog::AP_RangeFinder_analog(), AP_RangeFinder_analog::detect(), and AP_RangeFinder_analog::update_voltage().

◆ pos_offset

AP_Vector3f RangeFinder::RangeFinder_State::pos_offset

Definition at line 104 of file RangeFinder.h.

Referenced by AP_RangeFinder_Backend::get_pos_offset().

◆ pre_arm_check

bool RangeFinder::RangeFinder_State::pre_arm_check

Definition at line 88 of file RangeFinder.h.

Referenced by RangeFinder::init(), RangeFinder::set_estimated_terrain_height(), and AP_RangeFinder_Backend::update_pre_arm_check().

◆ pre_arm_distance_max

uint16_t RangeFinder::RangeFinder_State::pre_arm_distance_max

Definition at line 90 of file RangeFinder.h.

Referenced by RangeFinder::init(), and AP_RangeFinder_Backend::update_pre_arm_check().

◆ pre_arm_distance_min

uint16_t RangeFinder::RangeFinder_State::pre_arm_distance_min

Definition at line 89 of file RangeFinder.h.

Referenced by RangeFinder::init(), and AP_RangeFinder_Backend::update_pre_arm_check().

◆ range_valid_count

uint8_t RangeFinder::RangeFinder_State::range_valid_count

Definition at line 87 of file RangeFinder.h.

Referenced by RangeFinder::init(), AP_RangeFinder_Backend::range_valid_count(), AP_RangeFinder_Backend::set_status(), and RangeFinder::update().

◆ ratiometric

AP_Int8 RangeFinder::RangeFinder_State::ratiometric

Definition at line 94 of file RangeFinder.h.

Referenced by AP_RangeFinder_analog::update_voltage().

◆ scaling

AP_Float RangeFinder::RangeFinder_State::scaling

Definition at line 97 of file RangeFinder.h.

Referenced by AP_RangeFinder_analog::update(), and AP_RangeFinder_PX4_PWM::update().

◆ settle_time_ms

AP_Int16 RangeFinder::RangeFinder_State::settle_time_ms

Definition at line 96 of file RangeFinder.h.

Referenced by AP_RangeFinder_analog::AP_RangeFinder_analog(), AP_RangeFinder_PX4_PWM::update(), and AP_RangeFinder_analog::update_voltage().

◆ status

enum RangeFinder_Status RangeFinder::RangeFinder_State::status

Definition at line 86 of file RangeFinder.h.

Referenced by AP_RangeFinder_Backend::has_data(), RangeFinder::init(), AP_RangeFinder_Backend::set_status(), AP_RangeFinder_Backend::status(), AP_RangeFinder_BBB_PRU::update(), RangeFinder::update(), and AP_RangeFinder_Backend::update_pre_arm_check().

◆ stop_pin

AP_Int8 RangeFinder::RangeFinder_State::stop_pin

Definition at line 95 of file RangeFinder.h.

Referenced by AP_RangeFinder_analog::AP_RangeFinder_analog(), AP_RangeFinder_PX4_PWM::update(), and AP_RangeFinder_analog::update_voltage().

◆ type

AP_Int8 RangeFinder::RangeFinder_State::type

Definition at line 92 of file RangeFinder.h.

Referenced by AP_RangeFinder_Backend::get_mav_distance_sensor_type(), AP_RangeFinder_Backend::status(), and AP_RangeFinder_Backend::type().

◆ var_info

const struct AP_Param::GroupInfo* RangeFinder::RangeFinder_State::var_info

Definition at line 106 of file RangeFinder.h.

Referenced by AP_RangeFinder_Wasp::AP_RangeFinder_Wasp(), and RangeFinder::detect_instance().

◆ voltage_mv

uint16_t RangeFinder::RangeFinder_State::voltage_mv

Definition at line 84 of file RangeFinder.h.

Referenced by AP_RangeFinder_analog::update(), AP_RangeFinder_PX4_PWM::update(), AP_RangeFinder_analog::update_voltage(), and AP_RangeFinder_Backend::voltage_mv().

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

libraries/AP_RangeFinder/RangeFinder.h