Paparazzi UAS  v7.0_unstable
Paparazzi is a free software Unmanned Aircraft System.
ins_skeleton.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016 Felix Ruess <felix.ruess@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, see
18  * <http://www.gnu.org/licenses/>.
19  */
20 
28 #include "modules/core/abi.h"
29 #include "mcu_periph/sys_time.h"
30 #include "message_pragmas.h"
31 
32 #include "state.h"
33 
34 #ifndef USE_INS_NAV_INIT
35 #define USE_INS_NAV_INIT TRUE
36 PRINT_CONFIG_MSG("USE_INS_NAV_INIT defaulting to TRUE")
37 #endif
38 
39 /*
40  * ABI bindings
41  */
43 #ifndef INS_MODULE_BARO_ID
44 #if USE_BARO_BOARD
45 #define INS_MODULE_BARO_ID BARO_BOARD_SENDER_ID
46 #else
47 #define INS_MODULE_BARO_ID ABI_BROADCAST
48 #endif
49 #endif
51 
52 
53 #ifndef INS_MODULE_IMU_ID
54 #define INS_MODULE_IMU_ID ABI_BROADCAST
55 #endif
57 
58 
61 #ifndef INS_MODULE_GPS_ID
62 #define INS_MODULE_GPS_ID GPS_MULTI_ID
63 #endif
65 
70 
72 
73 void ins_module_wrapper_init(void);
74 
76 static void ins_ned_to_state(void)
77 {
78  stateSetPositionNed_i(MODULE_INS_SKELETON_ID, &ins_module.ltp_pos);
79  stateSetSpeedNed_i(MODULE_INS_SKELETON_ID, &ins_module.ltp_speed);
80  stateSetAccelNed_i(MODULE_INS_SKELETON_ID, &ins_module.ltp_accel);
81 
82 #if defined SITL && USE_NPS
83  if (nps_bypass_ins) {
85  }
86 #endif
87 }
88 
89 /***********************************************************
90  * ABI callback functions
91  **********************************************************/
92 
93 static void reset_cb(uint8_t sender_id UNUSED, uint8_t flag)
94 {
95  if (flag == INS_RESET_REF) {
96  if (ins_module.gps.fix >= GPS_FIX_3D) {
101  stateSetLocalOrigin_i(MODULE_INS_SKELETON_ID, &ins_module.ltp_def);
102  } else {
103  ins_module.ltp_initialized = false;
104  }
105 
107  }
108 }
109 
110 static void baro_cb(uint8_t __attribute__((unused)) sender_id, __attribute__((unused)) uint32_t stamp, float pressure)
111 {
112  /* call module implementation */
113  ins_module_update_baro(pressure);
115 }
116 
117 static void accel_cb(uint8_t sender_id __attribute__((unused)),
118  uint32_t stamp, struct Int32Vect3 *accel)
119 {
120  /* timestamp in usec when last callback was received */
121  static uint32_t last_stamp = 0;
122 
123  if (last_stamp > 0) {
124  float dt = (float)(stamp - last_stamp) * 1e-6;
125  /* call module implementation */
126  ins_module_propagate(accel, dt);
128  }
129  last_stamp = stamp;
130 }
131 
132 static void gps_cb(uint8_t sender_id __attribute__((unused)),
133  uint32_t stamp, struct GpsState *gps_s)
134 {
135  /* timestamp in usec when last callback was received */
136  static uint32_t last_stamp = 0;
137 
138  if (last_stamp > 0) {
139  float dt = (float)(stamp - last_stamp) * 1e-6;
140 
141  /* copy GPS state */
142  ins_module.gps = *gps_s;
143 
145  reset_cb(MODULE_INS_SKELETON_ID, INS_RESET_REF);
146  }
147 
148  if (gps_s->fix >= GPS_FIX_3D) {
149  /* call module implementation */
150  ins_module_update_gps(gps_s, dt);
152  }
153  }
154  last_stamp = stamp;
155 }
156 
157 /*********************************************************************
158  * weak functions that are used if not implemented in a module
159  ********************************************************************/
160 
161 void WEAK ins_module_init(void)
162 {
163 }
164 
165 void WEAK ins_module_update_baro(float pressure __attribute__((unused)))
166 {
167 }
168 
169 void WEAK ins_module_update_gps(struct GpsState *gps_s, float dt __attribute__((unused)))
170 {
171  /* copy velocity from GPS */
172  if (bit_is_set(gps_s->valid_fields, GPS_VALID_VEL_NED_BIT)) {
173  /* convert speed from cm/s to m/s in BFP with INT32_SPEED_FRAC */
176  }
177  else if (bit_is_set(gps_s->valid_fields, GPS_VALID_VEL_ECEF_BIT)) {
178  /* convert ECEF to NED */
179  struct NedCoor_i gps_speed_cm_s_ned;
180  ned_of_ecef_vect_i(&gps_speed_cm_s_ned, &ins_module.ltp_def, &gps_s->ecef_vel);
181  /* convert speed from cm/s to m/s in BFP with INT32_SPEED_FRAC */
182  INT32_VECT3_SCALE_2(ins_module.ltp_speed, gps_speed_cm_s_ned,
184  }
185 
186  /* copy position from GPS */
187  if (bit_is_set(gps_s->valid_fields, GPS_VALID_POS_ECEF_BIT)) {
188  /* convert ECEF to NED */
189  struct NedCoor_i gps_pos_cm_ned;
190  ned_of_ecef_point_i(&gps_pos_cm_ned, &ins_module.ltp_def, &gps_s->ecef_pos);
191  /* convert pos from cm to m in BFP with INT32_POS_FRAC */
192  INT32_VECT3_SCALE_2(ins_module.ltp_pos, gps_pos_cm_ned,
194  }
195 }
196 
197 void WEAK ins_module_propagate(struct Int32Vect3 *accel, float dt __attribute__((unused)))
198 {
199  /* untilt accels */
200  stateSetAccelBody_i(MODULE_INS_SKELETON_ID, accel);
201  struct Int32Vect3 accel_meas_ltp;
202  int32_rmat_transp_vmult(&accel_meas_ltp, stateGetNedToBodyRMat_i(), accel);
203 
204  VECT3_COPY(ins_module.ltp_accel, accel_meas_ltp);
205 }
206 
208 {
209 }
210 
211 
213 {
214 #if USE_INS_NAV_INIT
215  ins_init_origin_i_from_flightplan(MODULE_INS_SKELETON_ID, &ins_module.ltp_def);
217 #else
218  ins_module.ltp_initialized = false;
219 #endif
220 
224 
225  ins_module_init();
226 
227  // Bind to ABI messages
228  AbiBindMsgBARO_ABS(INS_MODULE_BARO_ID, &baro_ev, baro_cb);
229  AbiBindMsgIMU_ACCEL(INS_MODULE_IMU_ID, &accel_ev, accel_cb);
230  AbiBindMsgGPS(INS_MODULE_GPS_ID, &gps_ev, gps_cb);
231  AbiBindMsgINS_RESET(ABI_BROADCAST, &reset_ev, reset_cb);
232 }
233 
Main include for ABI (AirBorneInterface).
#define ABI_BROADCAST
Broadcast address.
Definition: abi_common.h:58
Event structure to store callbacks in a linked list.
Definition: abi_common.h:67
uint8_t last_wp UNUSED
int32_t hmsl
height above mean sea level (MSL) in mm
Definition: gps.h:94
struct LlaCoor_i lla_pos
position in LLA (lat,lon: deg*1e7; alt: mm over ellipsoid)
Definition: gps.h:92
#define GPS_VALID_VEL_ECEF_BIT
Definition: gps.h:51
#define GPS_VALID_VEL_NED_BIT
Definition: gps.h:52
struct EcefCoor_i ecef_pos
position in ECEF in cm
Definition: gps.h:91
struct EcefCoor_i ecef_vel
speed ECEF in cm/s
Definition: gps.h:95
#define GPS_VALID_POS_ECEF_BIT
Definition: gps.h:48
struct NedCoor_i ned_vel
speed NED in cm/s
Definition: gps.h:96
uint8_t valid_fields
bitfield indicating valid fields (GPS_VALID_x_BIT)
Definition: gps.h:88
#define GPS_FIX_3D
3D GPS fix
Definition: gps.h:44
uint8_t fix
status of fix
Definition: gps.h:107
data structure for GPS information
Definition: gps.h:87
#define VECT3_COPY(_a, _b)
Definition: pprz_algebra.h:140
#define INT32_POS_OF_CM_DEN
#define INT32_SPEED_OF_CM_S_NUM
#define INT32_SPEED_OF_CM_S_DEN
#define INT32_POS_OF_CM_NUM
#define INT32_VECT3_ZERO(_v)
void int32_rmat_transp_vmult(struct Int32Vect3 *vb, struct Int32RMat *m_b2a, struct Int32Vect3 *va)
rotate 3D vector by transposed rotation matrix.
#define INT32_VECT3_SCALE_2(_a, _b, _num, _den)
int32_t hmsl
Height above mean sea level in mm.
int32_t alt
in millimeters above WGS84 reference ellipsoid
struct LlaCoor_i lla
Reference point in lla.
void ltp_def_from_ecef_i(struct LtpDef_i *def, struct EcefCoor_i *ecef)
void ned_of_ecef_point_i(struct NedCoor_i *ned, struct LtpDef_i *def, struct EcefCoor_i *ecef)
Convert a point from ECEF to local NED.
void ned_of_ecef_vect_i(struct NedCoor_i *ned, struct LtpDef_i *def, struct EcefCoor_i *ecef)
Rotate a vector from ECEF to NED.
vector in North East Down coordinates
static void stateSetAccelNed_i(uint16_t id, struct NedCoor_i *ned_accel)
Set acceleration in NED coordinates (int).
Definition: state.h:1127
static void stateSetAccelBody_i(uint16_t id, struct Int32Vect3 *body_accel)
Set acceleration in Body coordinates (int).
Definition: state.h:1167
static struct Int32RMat * stateGetNedToBodyRMat_i(void)
Get vehicle body attitude rotation matrix (int).
Definition: state.h:1282
static void stateSetLocalOrigin_i(uint16_t id, struct LtpDef_i *ltp_def)
Set the local (flat earth) coordinate frame origin (int).
Definition: state.h:519
static void stateSetPositionNed_i(uint16_t id, struct NedCoor_i *ned_pos)
Set position from local NED coordinates (int).
Definition: state.h:638
static void stateSetSpeedNed_i(uint16_t id, struct NedCoor_i *ned_speed)
Set ground speed in local NED coordinates (int).
Definition: state.h:892
void ins_init_origin_i_from_flightplan(uint16_t id, struct LtpDef_i *ltp_def)
initialize the local origin (ltp_def in fixed point) from flight plan position
Definition: ins.c:33
#define INS_RESET_REF
flags for INS reset
Definition: ins.h:36
void WEAK ins_module_propagate(struct Int32Vect3 *accel, float dt)
Definition: ins_skeleton.c:197
static void gps_cb(uint8_t sender_id, uint32_t stamp, struct GpsState *gps_s)
Definition: ins_skeleton.c:132
#define INS_MODULE_GPS_ID
ABI binding for gps data.
Definition: ins_skeleton.c:62
void WEAK ins_module_reset_local_origin(void)
Definition: ins_skeleton.c:207
void ins_module_wrapper_init(void)
Definition: ins_skeleton.c:212
static abi_event accel_ev
Definition: ins_skeleton.c:67
static abi_event reset_ev
Definition: ins_skeleton.c:69
void WEAK ins_module_update_baro(float pressure)
Definition: ins_skeleton.c:165
static void reset_cb(uint8_t sender_id UNUSED, uint8_t flag)
Definition: ins_skeleton.c:93
static abi_event baro_ev
Definition: ins_skeleton.c:66
#define INS_MODULE_BARO_ID
baro
Definition: ins_skeleton.c:47
static void ins_ned_to_state(void)
copy position and speed to state interface
Definition: ins_skeleton.c:76
static void baro_cb(uint8_t sender_id, uint32_t stamp, float pressure)
Definition: ins_skeleton.c:110
void WEAK ins_module_init(void)
Definition: ins_skeleton.c:161
static void accel_cb(uint8_t sender_id, uint32_t stamp, struct Int32Vect3 *accel)
Definition: ins_skeleton.c:117
void WEAK ins_module_update_gps(struct GpsState *gps_s, float dt)
Definition: ins_skeleton.c:169
#define INS_MODULE_IMU_ID
IMU (accel)
Definition: ins_skeleton.c:54
struct InsModuleInt ins_module
global INS state
Definition: ins_skeleton.c:71
static abi_event gps_ev
Definition: ins_skeleton.c:68
Paparazzi specific wrapper to run simple module based INS.
struct NedCoor_i ltp_speed
velocity in m/s in BFP with INT32_SPEED_FRAC
Definition: ins_skeleton.h:46
struct NedCoor_i ltp_pos
position in m in BFP with INT32_POS_FRAC
Definition: ins_skeleton.h:45
struct LtpDef_i ltp_def
Definition: ins_skeleton.h:41
struct GpsState gps
internal copy of last GPS message
Definition: ins_skeleton.h:50
struct NedCoor_i ltp_accel
Definition: ins_skeleton.h:47
bool ltp_initialized
Definition: ins_skeleton.h:42
Ins implementation state (fixed point)
Definition: ins_skeleton.h:40
PRINT_CONFIG_MSG("USE_INS_NAV_INIT defaulting to TRUE")
bool nps_bypass_ins
void sim_overwrite_ins(void)
PRINT_CONFIG_VAR(ONELOOP_ANDI_FILT_CUTOFF)
API to get/set the generic vehicle states.
Architecture independent timing functions.
unsigned int uint32_t
Typedef defining 32 bit unsigned int type.
Definition: vl53l1_types.h:78
unsigned char uint8_t
Typedef defining 8 bit unsigned char type.
Definition: vl53l1_types.h:98