navigation.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008-2011  The Paparazzi Team
 * Copyright (C) 2022 Gautier Hattenberger <gautier.hattenberger@enac.fr>
 *
 * This file is part of paparazzi.
 *
 * paparazzi is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * paparazzi is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with paparazzi; see the file COPYING.  If not, see
 * <http://www.gnu.org/licenses/>.
 */
 
#ifndef NAVIGATION_H
#define NAVIGATION_H
 
#include "std.h"
#include "math/pprz_geodetic_int.h"
#include "math/pprz_geodetic_float.h"
#include "state.h"
#include "modules/nav/waypoints.h"
#include "modules/nav/common_flight_plan.h"
#include "autopilot.h"
#include "generated/airframe.h"
 
#ifndef DEFAULT_CIRCLE_RADIUS
#define DEFAULT_CIRCLE_RADIUS 5.f
#endif
 
#ifndef NAV_CLIMB_VSPEED
#define NAV_CLIMB_VSPEED 0.5f
#endif
 
#ifndef NAV_DESCEND_VSPEED
#define NAV_DESCEND_VSPEED -0.8f
#endif
 
#ifndef ARRIVED_AT_WAYPOINT
#define ARRIVED_AT_WAYPOINT 3.0f
#endif
 
#ifndef FAILSAFE_MODE_DISTANCE
#define FAILSAFE_MODE_DISTANCE (1.2*MAX_DIST_FROM_HOME)
#endif
 
#ifndef NAV_CARROT_DIST
#define NAV_CARROT_DIST 12
#endif
 
#ifndef CARROT
#define CARROT 0
#endif
 
#ifndef NAVIGATION_FREQUENCY
#if PERIODIC_FREQUENCY == 512
#define NAVIGATION_FREQUENCY 16
#else // if not 512, assume a multiple of 20 (e.g. 200, 500, 1000, ...)
#define NAVIGATION_FREQUENCY 20
#endif
#endif
 
#define NAV_HORIZONTAL_MODE_WAYPOINT  0
#define NAV_HORIZONTAL_MODE_ROUTE     1
#define NAV_HORIZONTAL_MODE_CIRCLE    2
#define NAV_HORIZONTAL_MODE_ATTITUDE  3
#define NAV_HORIZONTAL_MODE_NONE      4
#define NAV_HORIZONTAL_MODE_GUIDED    5
 
#define NAV_VERTICAL_MODE_MANUAL      0
#define NAV_VERTICAL_MODE_CLIMB       1
#define NAV_VERTICAL_MODE_ALT         2
#define NAV_VERTICAL_MODE_GUIDED      3
 
#define NAV_SETPOINT_MODE_POS         0
#define NAV_SETPOINT_MODE_SPEED       1
#define NAV_SETPOINT_MODE_ACCEL       2
#define NAV_SETPOINT_MODE_ATTITUDE    3 // attitude defined by roll, pitch and heading
#define NAV_SETPOINT_MODE_QUAT        4 // attitude defined by unit quaternion
#define NAV_SETPOINT_MODE_RATE        5
#define NAV_SETPOINT_MODE_MANUAL      6
 
typedef void (*navigation_stage_init)(void);
typedef void (*navigation_goto)(struct EnuCoor_f *wp);
typedef void (*navigation_route)(struct EnuCoor_f *wp_start, struct EnuCoor_f *wp_end);
typedef bool (*navigation_approaching)(struct EnuCoor_f *wp_to, struct EnuCoor_f *wp_from, float approaching_time);
typedef void (*navigation_circle)(struct EnuCoor_f *wp_center, float radius);
typedef void (*navigation_oval_init)(void);
typedef void (*navigation_oval)(struct EnuCoor_f *wp1, struct EnuCoor_f *wp2, float radius);
 
 
struct RotorcraftNavigation {
  // mode
  uint8_t horizontal_mode;  // nav horizontal mode
  uint8_t vertical_mode;    // nav vertical mode
  uint8_t setpoint_mode;    // nav setpoint mode
 
  // commands
  struct EnuCoor_f target;  
  struct EnuCoor_f carrot;  
  struct EnuCoor_f speed;   
  struct EnuCoor_f accel;   
  uint32_t throttle;        
  float roll;               
  float pitch;              
  float heading;            
  struct FloatQuat quat;    
  struct FloatRates rates;  
  float radius;             
  float climb;              
  float fp_altitude;        
  float nav_altitude;       
  float fp_max_speed;       
 
  // misc
  float dist2_to_home;        
  bool too_far_from_home;     
  float failsafe_mode_dist2;  
  float climb_vspeed;         
  float descend_vspeed;       
 
  // pointers to basic nav functions
  navigation_stage_init nav_stage_init;
  navigation_goto nav_goto;
  navigation_route nav_route;
  navigation_approaching nav_approaching;
  navigation_circle nav_circle;
  navigation_oval_init nav_oval_init;
  navigation_oval nav_oval;
};
 
extern struct RotorcraftNavigation nav;
 
extern void nav_register_stage_init(navigation_stage_init nav_stage_init);
extern void nav_register_goto_wp(navigation_goto nav_goto, navigation_route nav_route, navigation_approaching nav_approaching);
extern void nav_register_circle(navigation_circle nav_circle);
extern void nav_register_oval(navigation_oval_init _nav_oval_init, navigation_oval nav_oval);
// TODO: eight, survey
 
 
// flight altitude setting
extern float flight_altitude; // hmsl flight altitude in meters
 
 
/*****************************************************************
 * macros to ensure compatibility between fixedwing and rotorcraft
 *****************************************************************/
 
#define GetPosX() (stateGetPositionEnu_f()->x)
#define GetPosY() (stateGetPositionEnu_f()->y)
#define GetPosAlt() (stateGetPositionEnu_f()->z+stateGetHmslOrigin_f())
#define GetPosHeight() (stateGetPositionEnu_f()->z)
#define GetAltRef() (stateGetHmslOrigin_f())
 
 
extern void nav_init(void);
extern void nav_run(void);
extern void nav_parse_BLOCK(uint8_t *buf);
extern void nav_parse_MOVE_WP(uint8_t *buf);
 
extern float get_dist2_to_waypoint(uint8_t wp_id);
extern float get_dist2_to_point(struct EnuCoor_f *p);
extern void compute_dist2_to_home(void);
extern void nav_home(void);
 
extern void nav_reset_reference(void) __attribute__((unused));
extern void nav_reset_alt(void) __attribute__((unused));
extern void nav_periodic_task(void);
 
extern bool nav_is_in_flight(void);
 
extern void nav_glide_points(struct EnuCoor_f *start_point, struct EnuCoor_f *end_point);
 
extern void nav_set_heading_rad(float rad);
extern void nav_set_heading_deg(float deg);
extern void nav_set_heading_towards(float x, float y);
extern void nav_set_heading_towards_waypoint(uint8_t wp);
extern void nav_set_heading_towards_target(void);
extern void nav_set_heading_current(void);
 
extern void nav_set_failsafe(void);
 
/* ground detection */
extern bool nav_detect_ground(void);
#define NavStartDetectGround() ({ autopilot.detect_ground_once = true; false; })
#define NavDetectGround() nav_detect_ground()
 
/* switching motors on/off */
static inline void NavKillThrottle(void)
{
  if (autopilot_get_mode() == AP_MODE_NAV) { autopilot_set_motors_on(false); }
}
static inline void NavResurrect(void)
{
  if (autopilot_get_mode() == AP_MODE_NAV) { autopilot_set_motors_on(true); }
}
 
 
#define NavSetFailsafe nav_set_failsafe
 
#define NavSetGroundReferenceHere nav_reset_reference
#define NavSetAltitudeReferenceHere nav_reset_alt
 
#define NavSetWaypointHere waypoint_set_here_2d
#define NavCopyWaypoint waypoint_copy
#define NavCopyWaypointPositionOnly waypoint_position_copy
 
bool nav_check_wp_time(struct EnuCoor_f *wp, uint16_t stay_time);
#define NavCheckWaypointTime(wp, time) nav_check_wp_time(&waypoints[wp].enu_f, time)
 
 
/***********************************************************
 * macros used by flight plan to set different modes
 **********************************************************/
 
#define NavAttitude(_roll) {                            \
    nav.horizontal_mode = NAV_HORIZONTAL_MODE_ATTITUDE; \
    nav.setpoint_mode = NAV_SETPOINT_MODE_ATTITUDE;     \
    nav.roll = _roll;                                   \
  }
 
#define NavVerticalAutoThrottleMode(_pitch) {   \
    nav.pitch = _pitch;                         \
  }
 
#define NavVerticalAltitudeMode(_alt, _pre_climb) { \
    nav.vertical_mode = NAV_VERTICAL_MODE_ALT;      \
    nav.fp_altitude = _alt;                         \
  }
 
#define NavVerticalClimbMode(_climb) {            \
    nav.vertical_mode = NAV_VERTICAL_MODE_CLIMB;  \
    nav.climb = _climb;                           \
    nav.speed.z = _climb;                         \
  }
 
#define NavVerticalThrottleMode(_throttle) {      \
    nav.vertical_mode = NAV_VERTICAL_MODE_MANUAL; \
    nav.throttle = _throttle;                     \
  }
 
#define NavHeading nav_set_heading_rad
 
#define NavSetMaxSpeed(_speed) {  \
    nav.fp_max_speed = _speed;    \
  }
 
/***********************************************************
 * built in navigation routines
 **********************************************************/
 
/*********** Navigation to  waypoint *************************************/
static inline void NavGotoWaypoint(uint8_t wp)
{
  struct EnuCoor_f * _wp = waypoint_get_enu_f(wp);
  if (_wp != NULL) {
    nav.nav_goto(_wp);
  }
}
 
/*********** Navigation along a line *************************************/
static inline void NavSegment(uint8_t wp_start, uint8_t wp_end)
{
  struct EnuCoor_f * _wp_start = waypoint_get_enu_f(wp_start);
  struct EnuCoor_f * _wp_end = waypoint_get_enu_f(wp_end);
  if (_wp_start != NULL && _wp_end != NULL) {
    nav.nav_route(_wp_start, _wp_end);
  }
}
 
static inline bool NavApproaching(uint8_t wp, float approaching_time)
{
  struct EnuCoor_f * _wp = waypoint_get_enu_f(wp);
  if (_wp != NULL) {
    return nav.nav_approaching(_wp, NULL, approaching_time);
  }
  return true; // not valid, end now
}
 
static inline bool NavApproachingFrom(uint8_t to, uint8_t from, float approaching_time)
{
  struct EnuCoor_f * _to = waypoint_get_enu_f(to);
  struct EnuCoor_f * _from = waypoint_get_enu_f(from);
  if (_to != NULL && _from != NULL) {
    return nav.nav_approaching(_to, _from, approaching_time);
  }
  return true; // not valid, end now
}
 
/*********** Navigation on a circle **************************************/
static inline void NavCircleWaypoint(uint8_t wp_center, float radius)
{
  struct EnuCoor_f * _wp_center = waypoint_get_enu_f(wp_center);
  if (_wp_center != NULL) {
    nav.nav_circle(_wp_center, radius);
  }
}
 
 
/*********** Navigation along an oval *************************************/
static inline void nav_oval_init(void)
{
  nav.nav_oval_init();
}
 
static inline void Oval(uint8_t wp1, uint8_t wp2, float radius)
{
  struct EnuCoor_f * _wp1 = waypoint_get_enu_f(wp1);
  struct EnuCoor_f * _wp2 = waypoint_get_enu_f(wp2);
  if (_wp1 != NULL && _wp2 != NULL) {
    nav.nav_oval(_wp1, _wp2, radius);
  }
}
 
 
static inline void NavGlide(uint8_t wp_start, uint8_t wp_end)
{
  struct EnuCoor_f * _wp_start = waypoint_get_enu_f(wp_start);
  struct EnuCoor_f * _wp_end = waypoint_get_enu_f(wp_end);
  if (_wp_start != NULL && _wp_end != NULL) {
    nav_glide_points(_wp_start, _wp_end);
  }
}
 
 
/***********************************************************
 * settings handlers
 **********************************************************/
#define nav_IncreaseShift(x) {}
#define nav_SetNavRadius(x) {}
#define navigation_SetFlightAltitude(x) {                         \
    flight_altitude = x;                                          \
    nav.nav_altitude = flight_altitude - stateGetHmslOrigin_f();  \
  }
 
#define NavVerticalAutoPitchMode(_throttle) {}
 
/* follow another aircraft not implemented with this function
 * see dedicated nav modules
 */
#define NavFollow(_i, _d, _h) {}
 
#endif /* NAVIGATION_H */