Paparazzi UAS  v6.1.0_stable
Paparazzi is a free software Unmanned Aircraft System.
main_ap.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2008-2021 The Paparazzi Team
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  */
22 
29 #define MODULES_C
30 
31 #define ABI_C
32 
33 #include <inttypes.h>
34 #include "led.h"
35 
37 
39 
40 #ifdef SITL
41 #include "nps_autopilot.h"
42 #endif
43 
44 #include "generated/modules.h"
45 #include "modules/core/abi.h"
46 
47 /* if PRINT_CONFIG is defined, print some config options */
48 PRINT_CONFIG_VAR(PERIODIC_FREQUENCY)
49 /* SYS_TIME_FREQUENCY/PERIODIC_FREQUENCY should be an integer, otherwise the timer will not be correct */
50 #if !(SYS_TIME_FREQUENCY/PERIODIC_FREQUENCY*PERIODIC_FREQUENCY == SYS_TIME_FREQUENCY)
51 #warning "The SYS_TIME_FREQUENCY can not be divided by PERIODIC_FREQUENCY. Make sure this is the case for correct timing."
52 #endif
53 
54 /* TELEMETRY_FREQUENCY is defined in generated/periodic_telemetry.h
55  * defaults to 60Hz or set by TELEMETRY_FREQUENCY configure option in airframe file
56  */
57 PRINT_CONFIG_VAR(TELEMETRY_FREQUENCY)
58 
59 #if USE_AHRS && USE_IMU && (defined AHRS_PROPAGATE_FREQUENCY)
60 #if (AHRS_PROPAGATE_FREQUENCY > PERIODIC_FREQUENCY)
61 #warning "PERIODIC_FREQUENCY should be least equal or greater than AHRS_PROPAGATE_FREQUENCY"
62 INFO_VALUE("it is recommended to configure in your airframe PERIODIC_FREQUENCY to at least ", AHRS_PROPAGATE_FREQUENCY)
63 #endif
64 #endif
65 
69 tid_t modules_mcu_core_tid; // single step
72 tid_t modules_gnc_tid; // estimation, control, actuators, default in a single step
75 
76 #define SYS_PERIOD (1.f / PERIODIC_FREQUENCY)
77 #define SENSORS_PERIOD (1.f / PERIODIC_FREQUENCY)
78 #define DATALINK_PERIOD (1.f / TELEMETRY_FREQUENCY)
79 
80 void main_init(void)
81 {
82  modules_mcu_init();
83  modules_core_init();
84  modules_sensors_init();
85  modules_estimation_init();
86 #ifndef INTER_MCU_AP
88  // modules_radio_control_init(); FIXME
89 #endif
90  modules_control_init();
91  modules_actuators_init();
92  modules_datalink_init();
93  modules_default_init();
94 
95  // register timers with temporal dependencies
97 
98  // common GNC group (estimation, control, actuators, default)
99  // is called with an offset of half the main period (1/PERIODIC_FREQUENCY)
100  // which is the default resolution of SYS_TIME_FREQUENCY,
101  // hence the resolution of the virtual timers.
102  // In practice, this is the best compromised between having enough time between
103  // the sensor readings (triggerd in sensors task group) and the lag between
104  // the state update and control/actuators update
105  //
106  // | PERIODIC_FREQ |
107  // | | |
108  // read gnc
109  //
110  modules_gnc_tid = sys_time_register_timer_offset(modules_sensors_tid, 1.f / (2.f * PERIODIC_FREQUENCY), NULL);
111 
112  // register the timers for the periodic functions
114  modules_radio_control_tid = sys_time_register_timer((1. / 60.), NULL); // FIXME
116  failsafe_tid = sys_time_register_timer(0.05, NULL); // FIXME
117 
118 #if USE_IMU
119  // send body_to_imu from here for now
120  AbiSendMsgBODY_TO_IMU_QUAT(1, orientationGetQuat_f(&imu.body_to_imu));
121 #endif
122 
123  // Do a failsafe check first
124  failsafe_check();
125 
126 }
127 
129 {
131  modules_sensors_periodic_task();
132  }
133 
136  modules_radio_control_periodic_task(); // FIXME integrate above
137  }
138 
140  modules_estimation_periodic_task();
141  modules_control_periodic_task();
142  modules_default_periodic_task();
143 #if USE_THROTTLE_CURVES
145 #endif
146 #ifndef INTER_MCU_AP
147  SetActuatorsFromCommands(commands, autopilot_get_mode());
148 #else
150 #endif
151  modules_actuators_periodic_task(); // FIXME integrate above in actuators periodic
152  if (autopilot_in_flight()) {
153  RunOnceEvery(PERIODIC_FREQUENCY, autopilot.flight_time++); // TODO make it 1Hz periodic ?
154  }
155  }
156 
158  modules_mcu_periodic_task();
159  modules_core_periodic_task();
160  RunOnceEvery(10, LED_PERIODIC()); // FIXME periodic in led module
161  }
162 
165  modules_datalink_periodic_task(); // FIXME integrate above
166 #if defined DATALINK || defined SITL
167  RunOnceEvery(TELEMETRY_FREQUENCY, datalink_time++);
168 #endif
169  }
170 
172  failsafe_check(); // FIXME integrate somewhere else
173  }
174 
175 }
176 
178 {
179  static uint8_t boot = true;
180 
181  /* initialisation phase during boot */
182  if (boot) {
183 #if DOWNLINK
185 #endif
186  boot = false;
187  }
188  /* then report periodicly */
189  else {
190 #if PERIODIC_TELEMETRY
191  periodic_telemetry_send_Main(DefaultPeriodic, &(DefaultChannel).trans_tx, &(DefaultDevice).device);
192 #endif
193  }
194 }
195 
197 #ifndef RC_LOST_MODE
198 #define RC_LOST_MODE AP_MODE_FAILSAFE
199 #endif
200 
201 void failsafe_check(void)
202 {
203 #if !USE_GENERATED_AUTOPILOT
213  }
214 
215 #if FAILSAFE_ON_BAT_CRITICAL
216  if (autopilot_get_mode() != AP_MODE_KILL &&
219  }
220 #endif
221 
222 #if USE_GPS
223  if (autopilot_get_mode() == AP_MODE_NAV &&
225 #if NO_GPS_LOST_WITH_RC_VALID
227 #endif
228 #ifdef NO_GPS_LOST_WITH_DATALINK_TIME
229  datalink_time > NO_GPS_LOST_WITH_DATALINK_TIME &&
230 #endif
231  GpsIsLost()) {
233  }
234 
235  if (autopilot_get_mode() == AP_MODE_HOME &&
238  }
239 #endif
240 
241 #endif // !USE_GENERATED_AUTOPILOT
242 
244 }
245 
246 void main_event(void)
247 {
248  modules_mcu_event_task();
249  modules_core_event_task();
250  modules_sensors_event_task();
251  modules_estimation_event_task();
252  modules_radio_control_event_task(); // FIXME
253  if (autopilot.use_rc) {
255  }
256  modules_control_event_task();
257  modules_actuators_event_task();
258  modules_datalink_event_task();
259  modules_default_event_task();
260 }
main_init
void main_init(void)
Definition: main_ap.c:80
autopilot_get_motors_on
bool autopilot_get_motors_on(void)
get motors status
Definition: autopilot.c:239
radio_control.h
uint8_t
unsigned char uint8_t
Typedef defining 8 bit unsigned char type.
Definition: vl53l1_types.h:98
radio_control_periodic_task
void radio_control_periodic_task(void)
Definition: radio_control.c:46
modules_gnc_tid
tid_t modules_gnc_tid
Definition: main_ap.c:97
sys_time_register_timer_offset
tid_t sys_time_register_timer_offset(tid_t timer, float offset, sys_time_cb cb)
Register a new system timer with an fixed offset from another one.
Definition: sys_time.c:59
AP_MODE_MODULE
#define AP_MODE_MODULE
Definition: autopilot_static.h:52
abi.h
main_event
void main_event(void)
Definition: main_ap.c:246
pprz_autopilot::flight_time
uint16_t flight_time
flight time in seconds
Definition: autopilot.h:65
AP_MODE_FAILSAFE
#define AP_MODE_FAILSAFE
Definition: autopilot_static.h:36
Imu::body_to_imu
struct OrientationReps body_to_imu
rotation from body to imu frame
Definition: imu.h:49
pprz_autopilot::use_rc
bool use_rc
enable/disable RC input
Definition: autopilot.h:72
GpsIsLost
#define GpsIsLost()
Definition: gps.h:45
RC_LOST_MODE
#define RC_LOST_MODE
mode to enter when RC is lost while using a mode with RC input (not AP_MODE_NAV)
Definition: main_ap.c:198
nps_autopilot.h
AP_MODE_KILL
#define AP_MODE_KILL
Static autopilot modes.
Definition: autopilot_static.h:35
modules_radio_control_tid
tid_t modules_radio_control_tid
Definition: main_ap.c:71
AP_MODE_GUIDED
#define AP_MODE_GUIDED
Definition: autopilot_static.h:54
autopilot_in_flight
bool autopilot_in_flight(void)
get in_flight flag
Definition: autopilot.c:284
AP_MODE_NAV
#define AP_MODE_NAV
Definition: autopilot_static.h:48
autopilot_send_version
void autopilot_send_version(void)
send autopilot version
Definition: autopilot.c:325
autopilot
struct pprz_autopilot autopilot
Global autopilot structure.
Definition: autopilot.c:50
orientationGetQuat_f
static struct FloatQuat * orientationGetQuat_f(struct OrientationReps *orientation)
Get vehicle body attitude quaternion (float).
Definition: pprz_orientation_conversion.h:225
LED_PERIODIC
#define LED_PERIODIC()
Definition: led_hw.h:55
RadioControl::status
uint8_t status
Definition: radio_control.h:64
telemetry_periodic
void telemetry_periodic(void)
Definition: main_ap.c:177
tid_t
int8_t tid_t
sys_time timer id type
Definition: sys_time.h:56
handle_periodic_tasks
void handle_periodic_tasks(void)
Definition: main_ap.c:128
led.h
arch independent LED (Light Emitting Diodes) API
imu
struct Imu imu
global IMU state
Definition: imu.c:108
radio_control_init
void radio_control_init(void)
Definition: radio_control.c:32
f
uint16_t f
Camera baseline, in meters (i.e. horizontal distance between the two cameras of the stereo setup)
Definition: wedgebug.c:204
TELEMETRY_FREQUENCY
#define TELEMETRY_FREQUENCY
Definition: main_ap.c:77
commands
static const ShellCommand commands[]
Definition: shell_arch.c:71
DATALINK_PERIOD
#define DATALINK_PERIOD
Definition: main_ap.c:78
RadioControlEvent
#define RadioControlEvent(_received_frame_handler)
Definition: cc2500_paparazzi.h:37
throttle_curve_run
void throttle_curve_run(pprz_t cmds[], uint8_t ap_mode)
Run the throttle curve and generate the output throttle and pitch This depends on the FMODE(flight mo...
Definition: throttle_curve.c:115
Electrical::bat_critical
bool bat_critical
battery critical status
Definition: electrical.h:50
datalink_time
uint16_t datalink_time
Definition: sim_ap.c:41
intermcu_set_actuators
void intermcu_set_actuators(pprz_t *command_values, uint8_t ap_mode)
Definition: intermcu_ap.c:111
RC_OK
#define RC_OK
Definition: radio_control.h:56
autopilot_set_mode
bool autopilot_set_mode(uint8_t new_autopilot_mode)
set autopilot mode
Definition: autopilot.c:187
modules_mcu_core_tid
tid_t modules_mcu_core_tid
IDs for timers.
Definition: main_ap.c:94
sys_time_register_timer
tid_t sys_time_register_timer(float duration, sys_time_cb cb)
Register a new system timer.
Definition: sys_time.c:43
autopilot_check_in_flight
void WEAK autopilot_check_in_flight(bool motors_on)
in flight check utility function actual implementation is firmware dependent
Definition: autopilot.c:265
AP_MODE_HOME
#define AP_MODE_HOME
Definition: autopilot_static.h:39
AHRS_PROPAGATE_FREQUENCY
#define AHRS_PROPAGATE_FREQUENCY
Definition: hf_float.c:55
electrical
struct Electrical electrical
Definition: electrical.c:66
autopilot_get_mode
uint8_t autopilot_get_mode(void)
get autopilot mode
Definition: autopilot.c:211
AP_MODE_FLIP
#define AP_MODE_FLIP
Definition: autopilot_static.h:53
main_ap.h
autopilot_on_rc_frame
void autopilot_on_rc_frame(void)
RC frame handler.
Definition: autopilot.c:176
failsafe_check
void failsafe_check(void)
Definition: main_ap.c:201
modules_sensors_tid
tid_t modules_sensors_tid
Definition: main_ap.c:95
modules_datalink_tid
tid_t modules_datalink_tid
Definition: main_ap.c:98
failsafe_tid
tid_t failsafe_tid
id for failsafe_check() timer FIXME
Definition: main_ap.c:74
RC_REALLY_LOST
#define RC_REALLY_LOST
Definition: radio_control.h:58
DefaultPeriodic
#define DefaultPeriodic
Set default periodic telemetry.
Definition: telemetry.h:66
SENSORS_PERIOD
#define SENSORS_PERIOD
Definition: main_ap.c:77
sys_time_check_and_ack_timer
static bool sys_time_check_and_ack_timer(tid_t id)
Check if timer has elapsed.
Definition: sys_time.h:119
radio_control
struct RadioControl radio_control
Definition: radio_control.c:30
SYS_PERIOD
#define SYS_PERIOD
Definition: main_ap.c:76