navigation.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 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_float.h"
#include "state.h"
#include "modules/nav/waypoints.h"
#include "modules/nav/common_flight_plan.h"
#include "autopilot.h"
 
#ifndef CARROT
#define CARROT 0.f
#endif
 
#ifndef CARROT_DIST
#define CARROT_DIST 5.f
#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
 
 
#ifndef DEFAULT_CIRCLE_RADIUS
#define DEFAULT_CIRCLE_RADIUS 6.0f
#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
 
#define NAV_MODE_WAYPOINT 0
#define NAV_MODE_ROUTE    1
#define NAV_MODE_CIRCLE   2
#define NAV_MODE_HEADING  3
#define NAV_MODE_MANUAL   4
 
typedef void (*nav_rover_stage_init)(void);
typedef void (*nav_rover_goto)(struct EnuCoor_f *wp);
typedef void (*nav_rover_route)(struct EnuCoor_f *wp_start, struct EnuCoor_f *wp_end);
typedef bool (*nav_rover_approaching)(struct EnuCoor_f *wp_to, struct EnuCoor_f *wp_from, float approaching_time);
typedef void (*nav_rover_circle)(struct EnuCoor_f *wp_center, float radius);
typedef void (*nav_rover_oval_init)(void);
typedef void (*nav_rover_oval)(struct EnuCoor_f *wp1, struct EnuCoor_f *wp2, float radius);
 
 
struct RoverNavigation {
  // mode
  uint8_t mode;             // nav mode
 
  // commands
  struct EnuCoor_f target;  
  struct EnuCoor_f carrot;  
  float heading;            
  float radius;             
  float speed;              
  float turn;               
  float shift;              
 
  // misc
  float dist2_to_home;        
  bool too_far_from_home;     
  float failsafe_mode_dist2;  
  bool exception_flag[10];    
  struct EnuCoor_f last_pos;  
 
  // pointers to basic nav functions
  nav_rover_stage_init nav_stage_init;
  nav_rover_goto nav_goto;
  nav_rover_route nav_route;
  nav_rover_approaching nav_approaching;
  nav_rover_circle nav_circle;
  nav_rover_oval_init nav_oval_init;
  nav_rover_oval nav_oval;
};
 
extern struct RoverNavigation nav;
 
extern void nav_register_stage_init(nav_rover_stage_init nav_stage_init);
extern void nav_register_goto_wp(nav_rover_goto nav_goto,
    nav_rover_route nav_route,
    nav_rover_approaching nav_approaching);
extern void nav_register_circle(nav_rover_circle nav_circle);
extern void nav_register_oval(nav_rover_oval_init nav_oval_init, nav_rover_oval nav_oval);
// TODO: eight, survey
 
 
/*****************************************************************
 * 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())
 
 
#define NormCourse(x) { \
    while (x < 0) x += 360; \
    while (x >= 360) x -= 360; \
  }
#define NormCourseRad(x) { \
    while (x < 0) x += 2*M_PI; \
    while (x >= 2*M_PI) x -= 2*M_PI; \
  }
 
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 void set_exception_flag(uint8_t flag_num);
 
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_set_manual(float speed, float turn);
 
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_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);
 
/* 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, float stay_time);
#define NavCheckWaypointTime(wp, time) nav_check_wp_time(&waypoints[wp].enu_f, time)
 
 
/***********************************************************
 * macros used by flight plan to set different modes
 **********************************************************/
 
// command direct turn rate from FP roll [-1.; 1.]
#define NavAttitude(_roll) {  \
  nav.mode = NAV_MODE_MANUAL; \
  nav.turn = _roll;           \
  BoundAbs(nav.turn, 1.f);    \
}
 
// command direct motor speed from FP throttle [-1.; 1.]
#define NavVerticalThrottleMode(_speed) { \
  nav.speed = _speed;                     \
  BoundAbs(nav.speed, 1.f);               \
}
 
#define NavHeading nav_set_heading_rad
 
#define NavSetMaxSpeed(_speed) {} // not used
 
 
/***********************************************************
 * built in navigation routines
 **********************************************************/
 
/*********** Navigation to  waypoint *************************************/
static inline void NavGotoWaypoint(uint8_t wp)
{
  nav.mode = NAV_MODE_WAYPOINT;
  if (nav.nav_goto) {
    nav.nav_goto(&waypoints[wp].enu_f);
  }
}
 
/*********** Navigation along a line *************************************/
static inline void NavSegment(uint8_t wp_start, uint8_t wp_end)
{
  nav.mode = NAV_MODE_ROUTE;
  if (nav.nav_route) {
    nav.nav_route(&waypoints[wp_start].enu_f, &waypoints[wp_end].enu_f);
  }
}
 
static inline bool NavApproaching(uint8_t wp, float approaching_time)
{
  if (nav.nav_approaching) {
    return nav.nav_approaching(&waypoints[wp].enu_f, NULL, approaching_time);
  }
  else {
    return true;
  }
}
 
static inline bool NavApproachingFrom(uint8_t to, uint8_t from, float approaching_time)
{
  if (nav.nav_approaching) {
    return nav.nav_approaching(&waypoints[to].enu_f, &waypoints[from].enu_f, approaching_time);
  }
  else {
    return true;
  }
}
 
/*********** Navigation on a circle **************************************/
static inline void NavCircleWaypoint(uint8_t wp_center, float radius)
{
  nav.mode = NAV_MODE_CIRCLE;
  if (nav.nav_circle) {
    nav.nav_circle(&waypoints[wp_center].enu_f, radius);
  }
}
 
/*********** Navigation along an oval *************************************/
static inline void nav_oval_init(void)
{
  if (nav.nav_oval_init) {
    nav.nav_oval_init();
  }
}
 
static inline void Oval(uint8_t wp1, uint8_t wp2, float radius)
{
  if (nav.nav_oval) {
    nav.nav_oval(&waypoints[wp1].enu_f, &waypoints[wp2].enu_f, radius);
  }
}
 
 
#define navigation_IncreaseShift(x) { if (x==0) nav.shift = 0; else nav.shift += x; }
 
#define navigation_SetNavRadius(x) { if (x==1) nav.radius = DEFAULT_CIRCLE_RADIUS; else if (x==-1) nav.radius = -DEFAULT_CIRCLE_RADIUS; else nav.radius = x; }
 
 
/* follow another aircraft TODO */
#define NavFollow nav_follow(_id, _dist, _height) {}
 
 
#define NavGlide(_start_wp, _wp) {}
#define NavVerticalAutoThrottleMode(_pitch) {}
#define NavVerticalAutoPitchMode(_throttle) {}
#define NavVerticalAltitudeMode(_alt, _pre_climb) {}
#define NavVerticalClimbMode(_climb) {}
 
 
#endif /* NAVIGATION_H */