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

General stabilization interface for rotorcrafts. More...

#include "std.h"
#include "generated/airframe.h"
#include "math/pprz_algebra_int.h"
#include "math/pprz_algebra_float.h"
#include "firmwares/rotorcraft/stabilization/stabilization_attitude_rc_setpoint.h"
Include dependency graph for stabilization.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  StabilizationSetpoint
 Stabilization setpoint. More...
struct  ThrustSetpoint
 Thrust setpoint // TODO to a setpoint header Structure to store the desired thrust vector with different format. More...
struct  Stabilization
 Stabilization structure. More...
union  StabilizationSetpoint.sp
struct  StabilizationSetpoint.sp.ltp_i
struct  StabilizationSetpoint.sp.ltp_f
union  StabilizationSetpoint.r_sp
union  ThrustSetpoint.sp

Macros

#define STABILIZATION_MODE_NONE   0
 Stabilization modes.
#define STABILIZATION_MODE_DIRECT   1
#define STABILIZATION_MODE_RATE   2
#define STABILIZATION_MODE_ATTITUDE   3
#define STABILIZATION_ATT_SUBMODE_HEADING   0
 Stabilization sub-modes for attitude.
#define STABILIZATION_ATT_SUBMODE_CARE_FREE   1
#define STABILIZATION_ATT_SUBMODE_FORWARD   2
#define THRUST_AXIS_X   0
#define THRUST_AXIS_Y   1
#define THRUST_AXIS_Z   2
#define STAB_SP_SET_EULERS_ZERO(_sp)
#define THRUST_SP_SET_ZERO(_sp)

Functions

void stabilization_init (void)
 Init function.
void stabilization_mode_changed (uint8_t new_mode, uint8_t submode)
 Check mode change.
void stabilization_run (bool in_flight, struct StabilizationSetpoint *sp, struct ThrustSetpoint *thrust, int32_t *cmd)
 Call default stabilization control.
struct StabilizationSetpoint stabilization_get_failsafe_sp (void)
 Get stabilization setpoint for failsafe.
void stabilization_filter_commands (void)
 Command filter for vibrating airframes.
struct Int32Quat stab_sp_to_quat_i (struct StabilizationSetpoint *sp)
struct FloatQuat stab_sp_to_quat_f (struct StabilizationSetpoint *sp)
struct Int32Eulers stab_sp_to_eulers_i (struct StabilizationSetpoint *sp)
struct FloatEulers stab_sp_to_eulers_f (struct StabilizationSetpoint *sp)
struct Int32Rates stab_sp_to_rates_i (struct StabilizationSetpoint *sp)
struct FloatRates stab_sp_to_rates_f (struct StabilizationSetpoint *sp)
int32_t th_sp_to_thrust_i (struct ThrustSetpoint *th, int32_t thrust, uint8_t axis)
float th_sp_to_thrust_f (struct ThrustSetpoint *th, int32_t thrust, uint8_t axis)
int32_t th_sp_to_incr_i (struct ThrustSetpoint *th, int32_t thrust, uint8_t axis)
float th_sp_to_incr_f (struct ThrustSetpoint *th, int32_t thrust, uint8_t axis)
struct StabilizationSetpoint stab_sp_from_quat_i (struct Int32Quat *quat)
struct StabilizationSetpoint stab_sp_from_quat_f (struct FloatQuat *quat)
struct StabilizationSetpoint stab_sp_from_quat_ff_rates_f (struct FloatQuat *quat, struct FloatRates *rates)
struct StabilizationSetpoint stab_sp_from_eulers_i (struct Int32Eulers *eulers)
struct StabilizationSetpoint stab_sp_from_eulers_f (struct FloatEulers *eulers)
struct StabilizationSetpoint stab_sp_from_ltp_i (struct Int32Vect2 *vect, int32_t heading)
struct StabilizationSetpoint stab_sp_from_ltp_f (struct FloatVect2 *vect, float heading)
struct StabilizationSetpoint stab_sp_from_rates_i (struct Int32Rates *rates)
struct StabilizationSetpoint stab_sp_from_rates_f (struct FloatRates *rates)
struct ThrustSetpoint th_sp_from_thrust_i (int32_t thrust, uint8_t axis)
struct ThrustSetpoint th_sp_from_thrust_f (float thrust, uint8_t axis)
struct ThrustSetpoint th_sp_from_incr_i (int32_t th_increment, uint8_t axis)
struct ThrustSetpoint th_sp_from_incr_f (float th_increment, uint8_t axis)
struct ThrustSetpoint th_sp_from_thrust_vect_i (int32_t thrust[3])
struct ThrustSetpoint th_sp_from_thrust_vect_f (float thrust[3])
struct ThrustSetpoint th_sp_from_incr_vect_i (int32_t th_increment[3])
struct ThrustSetpoint th_sp_from_incr_vect_f (float th_increment[3])

Variables

struct Stabilization stabilization

Detailed Description

General stabilization interface for rotorcrafts.

Definition in file stabilization.h.


Data Structure Documentation

◆ Stabilization

struct Stabilization

Stabilization structure.

Definition at line 102 of file stabilization.h.

Collaboration diagram for Stabilization:
Data Fields
uint8_t att_submode current attitude sub-mode
int32_t cmd[COMMANDS_NB] output command vector, range from [-MAX_PPRZ:MAX_PPRZ] (store for messages)
uint8_t mode current mode
struct AttitudeRCInput rc_in RC input.
struct StabilizationSetpoint rc_sp Keep it ? FIXME.
struct StabilizationSetpoint sp current attitude setpoint (store for messages)
float transition_ratio transition percentage for hybrids (0.: hover; 1.: forward)

◆ StabilizationSetpoint.sp

union StabilizationSetpoint.sp

Definition at line 65 of file stabilization.h.

Data Fields
struct FloatEulers eulers_f
struct Int32Eulers eulers_i
struct StabilizationSetpoint.sp.ltp_f ltp_f
struct StabilizationSetpoint.sp.ltp_i ltp_i
struct FloatQuat quat_f
struct Int32Quat quat_i

◆ StabilizationSetpoint.sp.ltp_i

struct StabilizationSetpoint.sp.ltp_i

Definition at line 70 of file stabilization.h.

Data Fields
int32_t heading
struct Int32Vect2 vect

◆ StabilizationSetpoint.sp.ltp_f

struct StabilizationSetpoint.sp.ltp_f

Definition at line 71 of file stabilization.h.

Data Fields
float heading
struct FloatVect2 vect

◆ StabilizationSetpoint.r_sp

union StabilizationSetpoint.r_sp

Definition at line 73 of file stabilization.h.

Data Fields
struct FloatRates rates_f
struct Int32Rates rates_i

◆ ThrustSetpoint.sp

union ThrustSetpoint.sp

Definition at line 91 of file stabilization.h.

Data Fields
float th_incr_f[3]
int32_t th_incr_i[3]
float thrust_f[3]
int32_t thrust_i[3]

Macro Definition Documentation

◆ STAB_SP_SET_EULERS_ZERO

#define STAB_SP_SET_EULERS_ZERO ( _sp)
Value:
{ \
_sp.type = STAB_SP_EULERS; \
_sp.format = STAB_SP_INT; \
_sp.sp.eulers_i.phi = 0; \
_sp.sp.eulers_i.theta = 0; \
_sp.sp.eulers_i.psi = 0; \
}

Definition at line 176 of file stabilization.h.

Referenced by guidance_h_run(), and stabilization_init().

◆ STABILIZATION_ATT_SUBMODE_CARE_FREE

#define STABILIZATION_ATT_SUBMODE_CARE_FREE   1

Definition at line 46 of file stabilization.h.

Referenced by autopilot_static_set_mode(), rc_cb(), and stabilization_mode_changed().

◆ STABILIZATION_ATT_SUBMODE_FORWARD

#define STABILIZATION_ATT_SUBMODE_FORWARD   2

◆ STABILIZATION_ATT_SUBMODE_HEADING

◆ STABILIZATION_MODE_ATTITUDE

◆ STABILIZATION_MODE_DIRECT

#define STABILIZATION_MODE_DIRECT   1

◆ STABILIZATION_MODE_NONE

◆ STABILIZATION_MODE_RATE

#define STABILIZATION_MODE_RATE   2

◆ THRUST_AXIS_X

#define THRUST_AXIS_X   0

◆ THRUST_AXIS_Y

#define THRUST_AXIS_Y   1

Definition at line 173 of file stabilization.h.

Referenced by stabilization_indi_rate_run().

◆ THRUST_AXIS_Z

◆ THRUST_SP_SET_ZERO

#define THRUST_SP_SET_ZERO ( _sp)
Value:
{ \
_sp.type = THRUST_SP; \
_sp.format = THRUST_SP_INT; \
_sp.sp.thrust_i[0] = 0; \
_sp.sp.thrust_i[1] = 0; \
_sp.sp.thrust_i[2] = 0; \
}

Definition at line 184 of file stabilization.h.

Referenced by guidance_indi_init(), guidance_pid_v_run_accel(), guidance_v_from_nav(), guidance_v_guided_run(), and guidance_v_run().

Function Documentation

◆ stab_sp_from_eulers_f()

struct StabilizationSetpoint stab_sp_from_eulers_f ( struct FloatEulers * eulers)
extern

◆ stab_sp_from_eulers_i()

struct StabilizationSetpoint stab_sp_from_eulers_i ( struct Int32Eulers * eulers)
extern

Definition at line 628 of file stabilization.c.

References StabilizationSetpoint::sp, StabilizationSetpoint::STAB_SP_EULERS, stab_sp_from_eulers_i(), and StabilizationSetpoint::STAB_SP_INT.

Referenced by guidance_module_run(), stab_sp_from_eulers_i(), and vertical_ctrl_module_run().

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

◆ stab_sp_from_ltp_f()

struct StabilizationSetpoint stab_sp_from_ltp_f ( struct FloatVect2 * vect,
float heading )
extern

Definition at line 659 of file stabilization.c.

References heading, StabilizationSetpoint::sp, StabilizationSetpoint::STAB_SP_FLOAT, stab_sp_from_ltp_f(), and StabilizationSetpoint::STAB_SP_LTP.

Referenced by stab_sp_from_ltp_f().

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

◆ stab_sp_from_ltp_i()

struct StabilizationSetpoint stab_sp_from_ltp_i ( struct Int32Vect2 * vect,
int32_t heading )
extern

Definition at line 648 of file stabilization.c.

References heading, StabilizationSetpoint::sp, stab_sp_from_ltp_i(), StabilizationSetpoint::STAB_SP_INT, and StabilizationSetpoint::STAB_SP_LTP.

Referenced by guidance_pid_h_run(), and stab_sp_from_ltp_i().

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

◆ stab_sp_from_quat_f()

struct StabilizationSetpoint stab_sp_from_quat_f ( struct FloatQuat * quat)
extern

Definition at line 607 of file stabilization.c.

References StabilizationSetpoint::sp, StabilizationSetpoint::STAB_SP_FLOAT, stab_sp_from_quat_f(), and StabilizationSetpoint::STAB_SP_QUAT.

Referenced by guidance_indi_run(), stab_sp_from_quat_f(), stabilization_attitude_read_rc(), and stabilization_attitude_reset_rc().

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

◆ stab_sp_from_quat_ff_rates_f()

struct StabilizationSetpoint stab_sp_from_quat_ff_rates_f ( struct FloatQuat * quat,
struct FloatRates * rates )
extern

Definition at line 617 of file stabilization.c.

References StabilizationSetpoint::r_sp, StabilizationSetpoint::sp, StabilizationSetpoint::STAB_SP_FLOAT, stab_sp_from_quat_ff_rates_f(), and StabilizationSetpoint::STAB_SP_QUAT_FF_RATE.

Referenced by guidance_indi_run(), and stab_sp_from_quat_ff_rates_f().

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

◆ stab_sp_from_quat_i()

struct StabilizationSetpoint stab_sp_from_quat_i ( struct Int32Quat * quat)
extern

Definition at line 597 of file stabilization.c.

References StabilizationSetpoint::sp, stab_sp_from_quat_i(), StabilizationSetpoint::STAB_SP_INT, and StabilizationSetpoint::STAB_SP_QUAT.

Referenced by guidance_hybrid_set_cmd_i(), and stab_sp_from_quat_i().

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

◆ stab_sp_from_rates_f()

struct StabilizationSetpoint stab_sp_from_rates_f ( struct FloatRates * rates)
extern

Definition at line 680 of file stabilization.c.

References StabilizationSetpoint::sp, StabilizationSetpoint::STAB_SP_FLOAT, stab_sp_from_rates_f(), and StabilizationSetpoint::STAB_SP_RATES.

Referenced by stab_sp_from_rates_f(), stabilization_indi_attitude_run(), and stabilization_rate_read_rc().

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

◆ stab_sp_from_rates_i()

struct StabilizationSetpoint stab_sp_from_rates_i ( struct Int32Rates * rates)
extern

Definition at line 670 of file stabilization.c.

References StabilizationSetpoint::sp, stab_sp_from_rates_i(), StabilizationSetpoint::STAB_SP_INT, and StabilizationSetpoint::STAB_SP_RATES.

Referenced by stab_sp_from_rates_i().

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

◆ stab_sp_to_eulers_f()

struct FloatEulers stab_sp_to_eulers_f ( struct StabilizationSetpoint * sp)
extern

◆ stab_sp_to_eulers_i()

struct Int32Eulers stab_sp_to_eulers_i ( struct StabilizationSetpoint * sp)
extern

◆ stab_sp_to_quat_f()

struct FloatQuat stab_sp_to_quat_f ( struct StabilizationSetpoint * sp)
extern

◆ stab_sp_to_quat_i()

struct Int32Quat stab_sp_to_quat_i ( struct StabilizationSetpoint * sp)
extern

◆ stab_sp_to_rates_f()

struct FloatRates stab_sp_to_rates_f ( struct StabilizationSetpoint * sp)
extern

Definition at line 510 of file stabilization.c.

References RATES_FLOAT_OF_BFP, and stab_sp_to_rates_f().

Referenced by stab_sp_to_rates_f(), stabilization_andi_run(), stabilization_indi_attitude_run(), stabilization_indi_rate_run(), and stabilization_rate_run().

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

◆ stab_sp_to_rates_i()

struct Int32Rates stab_sp_to_rates_i ( struct StabilizationSetpoint * sp)
extern

Definition at line 493 of file stabilization.c.

References RATES_BFP_OF_REAL, and stab_sp_to_rates_i().

Referenced by stab_sp_to_rates_i().

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

◆ stabilization_filter_commands()

void stabilization_filter_commands ( void )
extern

Command filter for vibrating airframes.

Definition at line 314 of file stabilization.c.

References COMMAND_PITCH, COMMAND_ROLL, MAX_PPRZ, stabilization, and update_second_order_low_pass_int().

Referenced by stabilization_run().

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

◆ stabilization_get_failsafe_sp()

struct StabilizationSetpoint stabilization_get_failsafe_sp ( void )
extern

Get stabilization setpoint for failsafe.

Definition at line 275 of file stabilization.c.

References FloatEulers::psi, stab_sp_from_eulers_f(), stabilization_get_failsafe_sp(), and stateGetNedToBodyEulers_f().

Referenced by autopilot_static_periodic(), and stabilization_get_failsafe_sp().

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

◆ stabilization_init()

◆ stabilization_mode_changed()

◆ stabilization_run()

void stabilization_run ( bool in_flight,
struct StabilizationSetpoint * sp,
struct ThrustSetpoint * thrust,
int32_t * cmd )
extern

Call default stabilization control.

Parameters
[in]in_flighttrue if rotorcraft is flying
[in]sppointer to the stabilization setpoint, computed in guidance or from RC
[in]thrustpointer to thrust setpoint computed by vertical guidance
[out]cmdpointer to the output command vector

Definition at line 242 of file stabilization.c.

References StabilizationSetpoint::sp, stabilization, STABILIZATION_ATT_SUBMODE_FORWARD, stabilization_attitude_run(), stabilization_direct_run(), stabilization_filter_commands(), STABILIZATION_MODE_ATTITUDE, STABILIZATION_MODE_DIRECT, STABILIZATION_MODE_RATE, stabilization_rate_run(), transition_run(), TRANSITION_TO_FORWARD, and TRANSITION_TO_HOVER.

Referenced by autopilot_static_periodic(), control_mixing_heewing_attitude_direct(), control_mixing_heewing_attitude_plane(), control_mixing_heewing_nav_run(), and guidance_module_run().

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

◆ th_sp_from_incr_f()

struct ThrustSetpoint th_sp_from_incr_f ( float th_increment,
uint8_t axis )
extern

Definition at line 720 of file stabilization.c.

References ThrustSetpoint::sp, th_sp_from_incr_f(), ThrustSetpoint::THRUST_INCR_SP, and ThrustSetpoint::THRUST_SP_FLOAT.

Referenced by th_sp_from_incr_f().

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

◆ th_sp_from_incr_i()

struct ThrustSetpoint th_sp_from_incr_i ( int32_t th_increment,
uint8_t axis )
extern

Definition at line 710 of file stabilization.c.

References ThrustSetpoint::sp, th_sp_from_incr_i(), ThrustSetpoint::THRUST_INCR_SP, and ThrustSetpoint::THRUST_SP_INT.

Referenced by th_sp_from_incr_i().

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

◆ th_sp_from_incr_vect_f()

struct ThrustSetpoint th_sp_from_incr_vect_f ( float th_increment[3])
extern

Definition at line 766 of file stabilization.c.

References ThrustSetpoint::sp, th_sp_from_incr_vect_f(), ThrustSetpoint::THRUST_INCR_SP, and ThrustSetpoint::THRUST_SP_FLOAT.

Referenced by guidance_indi_run(), and th_sp_from_incr_vect_f().

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

◆ th_sp_from_incr_vect_i()

struct ThrustSetpoint th_sp_from_incr_vect_i ( int32_t th_increment[3])
extern

Definition at line 754 of file stabilization.c.

References ThrustSetpoint::sp, th_sp_from_incr_vect_i(), ThrustSetpoint::THRUST_INCR_SP, and ThrustSetpoint::THRUST_SP_INT.

Referenced by th_sp_from_incr_vect_i().

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

◆ th_sp_from_thrust_f()

struct ThrustSetpoint th_sp_from_thrust_f ( float thrust,
uint8_t axis )
extern

Definition at line 700 of file stabilization.c.

References ThrustSetpoint::sp, th_sp_from_thrust_f(), ThrustSetpoint::THRUST_SP, and ThrustSetpoint::THRUST_SP_FLOAT.

Referenced by th_sp_from_thrust_f().

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

◆ th_sp_from_thrust_i()

◆ th_sp_from_thrust_vect_f()

struct ThrustSetpoint th_sp_from_thrust_vect_f ( float thrust[3])
extern

Definition at line 742 of file stabilization.c.

References ThrustSetpoint::sp, th_sp_from_thrust_vect_f(), ThrustSetpoint::THRUST_SP, and ThrustSetpoint::THRUST_SP_FLOAT.

Referenced by guidance_set_rc_h_thrust(), and th_sp_from_thrust_vect_f().

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

◆ th_sp_from_thrust_vect_i()

struct ThrustSetpoint th_sp_from_thrust_vect_i ( int32_t thrust[3])
extern

Definition at line 730 of file stabilization.c.

References ThrustSetpoint::sp, th_sp_from_thrust_vect_i(), ThrustSetpoint::THRUST_SP, and ThrustSetpoint::THRUST_SP_INT.

Referenced by th_sp_from_thrust_vect_i().

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

◆ th_sp_to_incr_f()

float th_sp_to_incr_f ( struct ThrustSetpoint * th,
int32_t thrust,
uint8_t axis )
extern

Definition at line 579 of file stabilization.c.

References ThrustSetpoint::format, MAX_PPRZ, ThrustSetpoint::sp, and ThrustSetpoint::type.

Referenced by stabilization_indi_rate_run().

Here is the caller graph for this function:

◆ th_sp_to_incr_i()

int32_t th_sp_to_incr_i ( struct ThrustSetpoint * th,
int32_t thrust,
uint8_t axis )
extern

◆ th_sp_to_thrust_f()

float th_sp_to_thrust_f ( struct ThrustSetpoint * th,
int32_t thrust,
uint8_t axis )
extern

Definition at line 544 of file stabilization.c.

References ThrustSetpoint::format, MAX_PPRZ, ThrustSetpoint::sp, and ThrustSetpoint::type.

Referenced by guidance_set_rc_h_thrust(), and stabilization_andi_run().

Here is the caller graph for this function:

◆ th_sp_to_thrust_i()

Variable Documentation

◆ stabilization