Paparazzi UAS v7.1_unstable
Paparazzi is a free software Unmanned Aircraft System.
Loading...
Searching...
No Matches
guidance_v.h File Reference

Vertical guidance for rotorcrafts. More...

Include dependency graph for guidance_v.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  VerticalGuidance

Macros

#define GUIDANCE_V_MODE_KILL   0
#define GUIDANCE_V_MODE_RC_DIRECT   1
#define GUIDANCE_V_MODE_RC_CLIMB   2
#define GUIDANCE_V_MODE_CLIMB   3
#define GUIDANCE_V_MODE_HOVER   4
#define GUIDANCE_V_MODE_NAV   5
#define GUIDANCE_V_MODE_GUIDED   6
#define GuidanceVSetRef   guidance_v_set_ref

Functions

void guidance_v_init (void)
void guidance_v_mode_changed (uint8_t new_mode)
void guidance_v_notify_in_flight (bool in_flight)
void guidance_v_thrust_adapt (bool in_flight)
void guidance_v_update_ref (void)
void guidance_v_z_enter (void)
void guidance_v_run_enter (void)
struct ThrustSetpoint guidance_v_run (bool in_flight)
 Guidance vertical run functions.
struct ThrustSetpoint guidance_v_run_pos (bool in_flight, struct VerticalGuidance *gv)
struct ThrustSetpoint guidance_v_run_speed (bool in_flight, struct VerticalGuidance *gv)
struct ThrustSetpoint guidance_v_run_accel (bool in_flight, struct VerticalGuidance *gv)
void guidance_v_set_ref (int32_t pos, int32_t speed, int32_t accel)
 Set guidance ref parameters.
struct ThrustSetpoint guidance_v_from_nav (bool in_flight)
 Set guidance setpoint from NAV and run hover loop.
void guidance_v_guided_enter (void)
 Enter GUIDED mode control.
struct ThrustSetpoint guidance_v_guided_run (bool in_flight)
 Run GUIDED mode control.
void guidance_v_set_z (float z)
 Set z position setpoint.
void guidance_v_set_vz (float vz)
 Set z velocity setpoint.
void guidance_v_set_th (float th)
 Set throttle setpoint.
void guidance_v_set_all (float z, float vz, float az)
 Set z position, velocity and acceleration setpoint.

Variables

struct VerticalGuidance guidance_v

Detailed Description

Vertical guidance for rotorcrafts.

Definition in file guidance_v.h.


Data Structure Documentation

◆ VerticalGuidance

struct VerticalGuidance

Definition at line 43 of file guidance_v.h.

Collaboration diagram for VerticalGuidance:
Data Fields
uint8_t mode
float nominal_throttle nominal throttle for hover.

This is only used if GUIDANCE_V_NOMINAL_HOVER_THROTTLE is defined! Unit: factor of MAX_PPRZ with range 0.1 : 0.9

int32_t rc_delta_t Direct throttle from radio control.

range 0:MAX_PPRZ

int32_t rc_zd_sp Vertical speed setpoint from radio control.

fixed point representation: Q12.19 accuracy 0.0000019, range +/-4096

int32_t th_sp input thrust setpoint.

valid range 0 : MAX_PPRZ

struct ThrustSetpoint thrust Final thrust setpoint summation of feed-forward and feed-back commands, can be a total thrust or increment, float or int.
int32_t thrust_coeff
int32_t z_ref altitude reference in meters.

fixed point representation: Q23.8 accuracy 0.0039, range 8388km

int32_t z_sp altitude setpoint in meters (input).

fixed point representation: Q23.8 accuracy 0.0039, range 8388km

int32_t zd_ref vertical speed reference in meter/s.

fixed point representation: Q12.19 accuracy 0.0000038, range 4096

int32_t zd_sp vertical speed setpoint in meter/s (input).

fixed point representation: Q12.19 accuracy 0.0000019, range +/-4096

int32_t zdd_ref vertical acceleration reference in meter/s^2.

fixed point representation: Q21.10 accuracy 0.0009766, range 2097152

int32_t zdd_sp vertical acceleration setpoint in meter/s^2.

fixed point representation: Q21.10 accuracy 0.0009766, range 2097152

Macro Definition Documentation

◆ GUIDANCE_V_MODE_CLIMB

#define GUIDANCE_V_MODE_CLIMB   3

Definition at line 38 of file guidance_v.h.

Referenced by autopilot_static_set_mode(), guidance_v_mode_changed(), and guidance_v_run().

◆ GUIDANCE_V_MODE_GUIDED

#define GUIDANCE_V_MODE_GUIDED   6

Definition at line 41 of file guidance_v.h.

Referenced by autopilot_static_set_mode(), guidance_v_mode_changed(), and guidance_v_run().

◆ GUIDANCE_V_MODE_HOVER

#define GUIDANCE_V_MODE_HOVER   4

◆ GUIDANCE_V_MODE_KILL

#define GUIDANCE_V_MODE_KILL   0

Definition at line 35 of file guidance_v.h.

Referenced by autopilot_static_set_mode(), and guidance_v_init().

◆ GUIDANCE_V_MODE_NAV

#define GUIDANCE_V_MODE_NAV   5

◆ GUIDANCE_V_MODE_RC_CLIMB

#define GUIDANCE_V_MODE_RC_CLIMB   2

Definition at line 37 of file guidance_v.h.

Referenced by autopilot_static_set_mode(), guidance_v_mode_changed(), and guidance_v_run().

◆ GUIDANCE_V_MODE_RC_DIRECT

◆ GuidanceVSetRef

Function Documentation

◆ guidance_v_from_nav()

◆ guidance_v_guided_enter()

void guidance_v_guided_enter ( void )
extern

Enter GUIDED mode control.

Definition at line 334 of file guidance_v.c.

References guidance_v_run_enter(), guidance_v_set_z(), GuidanceVSetRef, stateGetPositionNed_f(), stateGetPositionNed_i(), and stateGetSpeedNed_i().

Referenced by guidance_v_mode_changed().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ guidance_v_guided_run()

◆ guidance_v_init()

◆ guidance_v_mode_changed()

◆ guidance_v_notify_in_flight()

void guidance_v_notify_in_flight ( bool in_flight)
extern

Definition at line 165 of file guidance_v.c.

References gv_adapt_init().

Here is the call graph for this function:

◆ guidance_v_run()

◆ guidance_v_run_accel()

struct ThrustSetpoint guidance_v_run_accel ( bool in_flight,
struct VerticalGuidance * gv )
extern

Definition at line 77 of file guidance_oneloop.c.

References _gv, _v_mode, GUIDANCE_ONELOOP_V_ACCEL, guidance_v_run_accel(), thrust_sp, and UNUSED.

Referenced by guidance_v_run_accel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ guidance_v_run_enter()

void guidance_v_run_enter ( void )
extern

Definition at line 40 of file guidance_oneloop.c.

Referenced by guidance_v_from_nav(), guidance_v_guided_enter(), guidance_v_mode_changed(), and guidance_v_z_enter().

Here is the caller graph for this function:

◆ guidance_v_run_pos()

struct ThrustSetpoint guidance_v_run_pos ( bool in_flight,
struct VerticalGuidance * gv )
extern

Definition at line 63 of file guidance_oneloop.c.

References _gv, _v_mode, GUIDANCE_ONELOOP_V_POS, guidance_v_run_pos(), thrust_sp, and UNUSED.

Referenced by guidance_v_from_nav(), guidance_v_guided_run(), and guidance_v_run_pos().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ guidance_v_run_speed()

struct ThrustSetpoint guidance_v_run_speed ( bool in_flight,
struct VerticalGuidance * gv )
extern

Definition at line 70 of file guidance_oneloop.c.

References _gv, _v_mode, GUIDANCE_ONELOOP_V_SPEED, guidance_v_run_speed(), thrust_sp, and UNUSED.

Referenced by guidance_v_from_nav(), guidance_v_guided_run(), guidance_v_run(), and guidance_v_run_speed().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ guidance_v_set_all()

void guidance_v_set_all ( float z,
float vz,
float az )
extern

Set z position, velocity and acceleration setpoint.

Parameters
zSetpoint (down is positive) in meters.
vzSetpoint (down is positive) in meters/second.
azSetpoint (down is positive) in meters/second².

Definition at line 411 of file guidance_v.c.

References ACCEL_BFP_OF_REAL, guidance_v, guidance_v_guided_mode, GUIDANCE_V_GUIDED_MODE_ZHOLD, POS_BFP_OF_REAL, and SPEED_BFP_OF_REAL.

◆ guidance_v_set_ref()

void guidance_v_set_ref ( int32_t pos,
int32_t speed,
int32_t accel )
extern

Set guidance ref parameters.

Definition at line 283 of file guidance_v.c.

References guidance_v, and gv_set_ref().

Referenced by guidance_v_guided_run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ guidance_v_set_th()

void guidance_v_set_th ( float th)
extern

Set throttle setpoint.

Parameters
thThrottle setpoint between 0. and 1.

Definition at line 400 of file guidance_v.c.

References guidance_v, guidance_v_guided_mode, GUIDANCE_V_GUIDED_MODE_THROTTLE, GuidanceVSetRef, MAX_PPRZ, stateGetPositionNed_i(), and stateGetSpeedNed_i().

Here is the call graph for this function:

◆ guidance_v_set_vz()

void guidance_v_set_vz ( float vz)
extern

Set z velocity setpoint.

Parameters
vzSetpoint (down is positive) in meters/second.

Definition at line 390 of file guidance_v.c.

References guidance_v, guidance_v_guided_mode, GUIDANCE_V_GUIDED_MODE_CLIMB, and SPEED_BFP_OF_REAL.

Referenced by autopilot_static_set_mode().

Here is the caller graph for this function:

◆ guidance_v_set_z()

void guidance_v_set_z ( float z)
extern

Set z position setpoint.

Parameters
zSetpoint (down is positive) in meters.

Definition at line 379 of file guidance_v.c.

References guidance_v, guidance_v_guided_mode, GUIDANCE_V_GUIDED_MODE_ZHOLD, and POS_BFP_OF_REAL.

Referenced by guidance_v_guided_enter(), and wedgebug_periodic().

Here is the caller graph for this function:

◆ guidance_v_thrust_adapt()

void guidance_v_thrust_adapt ( bool in_flight)
extern

Definition at line 201 of file guidance_v.c.

References desired_zd_updated, get_vertical_thrust_coeff(), guidance_v, gv_adapt_init(), gv_adapt_run(), INT32_TRIG_FRAC, stabilization, and stateGetAccelNed_i().

Referenced by guidance_v_run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ guidance_v_update_ref()

void guidance_v_update_ref ( void )
extern

◆ guidance_v_z_enter()

void guidance_v_z_enter ( void )
extern

Definition at line 269 of file guidance_v.c.

References guidance_v, guidance_v_run_enter(), GuidanceVSetRef, stateGetPositionNed_i(), and NedCoor_i::z.

Here is the call graph for this function:

Variable Documentation

◆ guidance_v