Paparazzi UAS  v5.14.0_stable-0-g3f680d1
Paparazzi is a free software Unmanned Aircraft System.
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
common_nav.h File Reference
#include "std.h"
#include "state.h"
#include "subsystems/navigation/common_flight_plan.h"
+ Include dependency graph for common_nav.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  point
 

Macros

#define WaypointX(_wp)   (waypoints[_wp].x)
 
#define WaypointY(_wp)   (waypoints[_wp].y)
 
#define WaypointAlt(_wp)   (waypoints[_wp].a)
 waypoint altitude in m above MSL More...
 
#define Height(_h)   (_h + ground_alt)
 
#define NavSetGroundReferenceHere()   ({ nav_reset_reference(); nav_update_waypoints_alt(); false; })
 
#define NavSetAltitudeReferenceHere()   ({ nav_reset_alt(); nav_update_waypoints_alt(); false; })
 
#define NavSetWaypointHere(_wp)
 
#define NavSetWaypointPosAndAltHere(_wp)
 

Functions

void nav_move_waypoint (uint8_t wp_id, float utm_east, float utm_north, float alt)
 Move a waypoint to given UTM coordinates. More...
 
void compute_dist2_to_home (void)
 Computes squared distance to the HOME waypoint potentially sets too_far_from_home. More...
 
void nav_reset_utm_zone (void)
 Reset the UTM zone to current GPS fix. More...
 
void nav_reset_reference (void)
 Reset the geographic reference to the current GPS fix. More...
 
void nav_reset_alt (void)
 Reset the altitude reference to the current GPS alt. More...
 
void nav_update_waypoints_alt (void)
 Shift altitude of the waypoint according to a new ground altitude. More...
 
void common_nav_periodic_task_4Hz (void)
 

Variables

float max_dist_from_home
 
float dist2_to_home
 squared distance to home waypoint More...
 
float dist2_to_wp
 squared distance to next waypoint More...
 
bool too_far_from_home
 
const uint8_t nb_waypoint
 
struct point waypoints []
 
float ground_alt
 size == nb_waypoint, waypoint 0 is a dummy waypoint More...
 
int32_t nav_utm_east0
 
int32_t nav_utm_north0
 
uint8_t nav_utm_zone0
 

Data Structure Documentation

struct point

Definition at line 39 of file common_nav.h.

Data Fields
float a
float x
float y

Macro Definition Documentation

#define Height (   _h)    (_h + ground_alt)

Definition at line 49 of file common_nav.h.

#define NavSetAltitudeReferenceHere ( )    ({ nav_reset_alt(); nav_update_waypoints_alt(); false; })

Definition at line 75 of file common_nav.h.

#define NavSetGroundReferenceHere ( )    ({ nav_reset_reference(); nav_update_waypoints_alt(); false; })

Definition at line 73 of file common_nav.h.

#define NavSetWaypointHere (   _wp)
Value:
({ \
})
float x
Definition: common_nav.h:40
static struct EnuCoor_f * stateGetPositionEnu_f(void)
Get position in local ENU coordinates (float).
Definition: state.h:719
float y
Definition: common_nav.h:41
float x
in meters
struct point waypoints[]
Definition: common_nav.c:38
#define false
Definition: rtwtypes.h:24
float y
in meters

Definition at line 77 of file common_nav.h.

#define NavSetWaypointPosAndAltHere (   _wp)
Value:
({ \
})
float x
Definition: common_nav.h:40
static struct EnuCoor_f * stateGetPositionEnu_f(void)
Get position in local ENU coordinates (float).
Definition: state.h:719
float ground_alt
size == nb_waypoint, waypoint 0 is a dummy waypoint
Definition: common_nav.c:40
float y
Definition: common_nav.h:41
float x
in meters
struct point waypoints[]
Definition: common_nav.c:38
float z
in meters
float a
Definition: common_nav.h:42
#define false
Definition: rtwtypes.h:24
float y
in meters

Definition at line 83 of file common_nav.h.

#define WaypointAlt (   _wp)    (waypoints[_wp].a)

Function Documentation

void common_nav_periodic_task_4Hz ( void  )

Definition at line 117 of file common_nav.c.

References block_time, and stage_time.

Referenced by navigation_task().

+ Here is the caller graph for this function:

void compute_dist2_to_home ( void  )

Computes squared distance to the HOME waypoint potentially sets too_far_from_home.

Computes squared distance to the HOME waypoint potentially sets too_far_from_home.

Updates dist2_to_home and potentially sets too_far_from_home

Definition at line 473 of file navigation.c.

References dist2_to_home, RoverNavigation::dist2_to_home, get_dist2_to_waypoint(), max_dist2_from_home, nav, stateGetPositionEnu_f(), too_far_from_home, RoverNavigation::too_far_from_home, point::x, EnuCoor_f::x, point::y, and EnuCoor_f::y.

Referenced by autopilot_static_periodic(), nav_home(), and nav_periodic_task().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void nav_move_waypoint ( uint8_t  wp_id,
float  ux,
float  uy,
float  alt 
)

Move a waypoint to given UTM coordinates.

Parameters
[in]wp_idWaypoint ID
[in]uxUTM x (east) coordinate
[in]uyUTM y (north) coordinate
[in]altAltitude above MSL.

Definition at line 128 of file common_nav.c.

References point::a, UtmCoor_f::alt, max_dist_from_home, nav_utm_east0, nav_utm_north0, nb_waypoint, point::x, and point::y.

Referenced by firmware_parse_msg().

+ Here is the caller graph for this function:

void nav_reset_alt ( void  )

Reset the altitude reference to the current GPS alt.

Definition at line 355 of file navigation.c.

References UtmCoor_f::alt, ground_alt, ins_reset_altitude_ref(), previous_ground_alt, state, State::utm_origin_f, and waypoints_localize_all().

+ Here is the call graph for this function:

void nav_reset_reference ( void  )

Reset the geographic reference to the current GPS fix.

Definition at line 348 of file navigation.c.

References UtmCoor_f::alt, UtmCoor_f::east, ground_alt, ins_reset_local_origin(), nav_utm_east0, nav_utm_north0, nav_utm_zone0, UtmCoor_f::north, previous_ground_alt, state, State::utm_origin_f, waypoints_localize_all(), and UtmCoor_f::zone.

+ Here is the call graph for this function:

void nav_reset_utm_zone ( void  )

Reset the UTM zone to current GPS fix.

Definition at line 66 of file common_nav.c.

References UtmCoor_f::alt, UtmCoor_f::east, ground_alt, ins_reset_utm_zone(), nav_utm_east0, nav_utm_north0, nav_utm_zone0, UtmCoor_f::north, and UtmCoor_f::zone.

+ Here is the call graph for this function:

void nav_update_waypoints_alt ( void  )

Shift altitude of the waypoint according to a new ground altitude.

Definition at line 109 of file common_nav.c.

References point::a, ground_alt, and previous_ground_alt.

Variable Documentation

float dist2_to_home

squared distance to home waypoint

Definition at line 82 of file navigation.c.

Referenced by autopilot_static_periodic(), compute_dist2_to_home(), monitor_task(), nav_home(), nav_init(), and send_nav_status().

float dist2_to_wp

squared distance to next waypoint

Definition at line 85 of file navigation.c.

Referenced by nav_approaching_xy(), nav_circle(), nav_home(), nav_init(), nav_periodic_task(), nav_route(), and send_nav_status().

float max_dist_from_home

Definition at line 79 of file navigation.c.

Referenced by mission_point_of_lla(), and nav_move_waypoint().

const uint8_t nb_waypoint

Definition at line 37 of file common_nav.c.

bool too_far_from_home
struct point waypoints[]

Definition at line 38 of file common_nav.c.