Paparazzi UAS  v5.15_devel-81-gd13dafb
Paparazzi is a free software Unmanned Aircraft System.
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
guidance_h.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2008-2009 Antoine Drouin <poinix@gmail.com>
3  *
4  * This file is part of paparazzi.
5  *
6  * paparazzi is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2, or (at your option)
9  * any later version.
10  *
11  * paparazzi is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with paparazzi; see the file COPYING. If not, write to
18  * the Free Software Foundation, 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21 
27 #ifndef GUIDANCE_H_H
28 #define GUIDANCE_H_H
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 #include "math/pprz_algebra_int.h"
36 
38 #include "generated/airframe.h"
39 #include "std.h"
40 
44 #ifndef GUIDANCE_H_USE_REF
45 #define GUIDANCE_H_USE_REF TRUE
46 #endif
47 
52 #ifndef GUIDANCE_H_USE_SPEED_REF
53 #define GUIDANCE_H_USE_SPEED_REF TRUE
54 #endif
55 
56 #define GUIDANCE_H_MODE_KILL 0
57 #define GUIDANCE_H_MODE_RATE 1
58 #define GUIDANCE_H_MODE_ATTITUDE 2
59 #define GUIDANCE_H_MODE_HOVER 3
60 #define GUIDANCE_H_MODE_NAV 4
61 #define GUIDANCE_H_MODE_RC_DIRECT 5
62 #define GUIDANCE_H_MODE_CARE_FREE 6
63 #define GUIDANCE_H_MODE_FORWARD 7
64 #define GUIDANCE_H_MODE_MODULE 8
65 #define GUIDANCE_H_MODE_FLIP 9
66 #define GUIDANCE_H_MODE_GUIDED 10
67 
68 
74  struct Int32Vect2 pos;
75  struct Int32Vect2 speed;
76  float heading;
77  float heading_rate;
79 };
80 
82  struct Int32Vect2 pos;
83  struct Int32Vect2 speed;
84  struct Int32Vect2 accel;
85 };
86 
93 };
94 
97  /* configuration options */
98  bool use_ref;
100  /* gains */
102 
105 
107 };
108 
109 extern struct HorizontalGuidance guidance_h;
110 
112 
113 extern void guidance_h_init(void);
114 extern void guidance_h_mode_changed(uint8_t new_mode);
115 extern void guidance_h_read_rc(bool in_flight);
116 extern void guidance_h_run(bool in_flight);
117 
118 extern void guidance_h_hover_enter(void);
119 extern void guidance_h_nav_enter(void);
120 
123 extern void guidance_h_from_nav(bool in_flight);
124 
125 extern void guidance_h_set_igain(uint32_t igain);
126 
129 extern void guidance_h_guided_run(bool in_flight);
130 
136 extern bool guidance_h_set_guided_pos(float x, float y);
137 
142 extern bool guidance_h_set_guided_heading(float heading);
143 
149 extern bool guidance_h_set_guided_body_vel(float vx, float vy);
150 
156 extern bool guidance_h_set_guided_vel(float vx, float vy);
157 
162 extern bool guidance_h_set_guided_heading_rate(float rate);
163 
168 extern const struct Int32Vect2 *guidance_h_get_pos_err(void);
169 
170 /* Make sure that ref can only be temporarily disabled for testing,
171  * but not enabled if GUIDANCE_H_USE_REF was defined to FALSE.
172  */
173 #define guidance_h_SetUseRef(_val) { \
174  guidance_h.use_ref = _val && GUIDANCE_H_USE_REF; \
175  }
176 
177 static inline void guidance_h_SetMaxSpeed(float speed)
178 {
179  gh_set_max_speed(speed);
180 }
181 
182 static inline void guidance_h_SetOmega(float omega)
183 {
184  gh_set_omega(omega);
185 }
186 
187 static inline void guidance_h_SetZeta(float zeta)
188 {
189  gh_set_zeta(zeta);
190 }
191 
192 static inline void guidance_h_SetTau(float tau)
193 {
194  gh_set_tau(tau);
195 }
196 
197 #ifdef __cplusplus
198 }
199 #endif
200 
201 #endif /* GUIDANCE_H_H */
Reference generation for horizontal guidance.
struct Int32Vect2 pos
horizontal position setpoint in NED.
Definition: guidance_h.h:74
bool guidance_h_set_guided_vel(float vx, float vy)
Set horizontal velocity setpoint in GUIDED mode.
Definition: guidance_h.c:727
float gh_set_max_speed(float max_speed)
Set a new maximum speed for waypoint navigation.
void guidance_h_mode_changed(uint8_t new_mode)
Definition: guidance_h.c:212
bool approx_force_by_thrust
Definition: guidance_h.h:99
bool guidance_h_set_guided_pos(float x, float y)
Set horizontal position setpoint in GUIDED mode.
Definition: guidance_h.c:697
static void guidance_h_SetZeta(float zeta)
Definition: guidance_h.h:187
struct HorizontalGuidanceReference ref
reference calculated from setpoints
Definition: guidance_h.h:104
struct HorizontalGuidanceGains gains
Definition: guidance_h.h:101
void guidance_h_set_igain(uint32_t igain)
Definition: guidance_h.c:669
euler angles
bool guidance_h_set_guided_body_vel(float vx, float vy)
Set body relative horizontal velocity setpoint in GUIDED mode.
Definition: guidance_h.c:719
uint8_t mask
bit 5: vx & vy, bit 6: vz, bit 7: vyaw
Definition: guidance_h.h:78
float gh_set_omega(float omega)
static float heading
Definition: ahrs_infrared.c:45
struct Int32Vect2 speed
with INT32_SPEED_FRAC
Definition: guidance_h.h:83
float gh_set_tau(float tau)
static void guidance_h_SetMaxSpeed(float speed)
Definition: guidance_h.h:177
Paparazzi floating point algebra.
struct Int32Vect2 speed
only used in HOVER mode if GUIDANCE_H_USE_SPEED_REF or in GUIDED mode
Definition: guidance_h.h:75
unsigned long uint32_t
Definition: types.h:18
struct HorizontalGuidance guidance_h
Definition: guidance_h.c:80
void guidance_h_run(bool in_flight)
Definition: guidance_h.c:351
signed long int32_t
Definition: types.h:19
void guidance_h_read_rc(bool in_flight)
Definition: guidance_h.c:292
bool guidance_h_set_guided_heading_rate(float rate)
Set heading rate setpoint in GUIDED mode.
Definition: guidance_h.c:738
struct Int32Vect2 pos
with INT32_POS_FRAC
Definition: guidance_h.h:82
unsigned char uint8_t
Definition: types.h:14
void guidance_h_hover_enter(void)
Definition: guidance_h.c:532
void guidance_h_guided_run(bool in_flight)
Run GUIDED mode control.
Definition: guidance_h.c:676
struct Int32Vect2 accel
with INT32_ACCEL_FRAC
Definition: guidance_h.h:84
void guidance_h_init(void)
Definition: guidance_h.c:166
struct FloatEulers rc_sp
Definition: guidance_h.h:106
void guidance_h_nav_enter(void)
Definition: guidance_h.c:555
int32_t transition_percentage
Definition: guidance_h.c:82
float gh_set_zeta(float zeta)
bool guidance_h_set_guided_heading(float heading)
Set heading setpoint in GUIDED mode.
Definition: guidance_h.c:708
const struct Int32Vect2 * guidance_h_get_pos_err(void)
Gets the position error.
Definition: guidance_h.c:748
void guidance_h_from_nav(bool in_flight)
Set horizontal guidance from NAV and run control loop.
Definition: guidance_h.c:569
static void guidance_h_SetTau(float tau)
Definition: guidance_h.h:192
struct HorizontalGuidanceSetpoint sp
setpoints
Definition: guidance_h.h:103
Paparazzi fixed point algebra.
static void guidance_h_SetOmega(float omega)
Definition: guidance_h.h:182