Paparazzi UAS v7.1_unstable
Paparazzi is a free software Unmanned Aircraft System.
Loading...
Searching...
No Matches
common_nav.h File Reference
#include "std.h"
#include "state.h"
#include "modules/nav/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)
#define WaypointY(_wp)
#define WaypointAlt(_wp)
 waypoint altitude in m above MSL
#define Height(_h)
#define NavSetGroundReferenceHere()
#define NavSetAltitudeReferenceHere()
#define NavSetWaypointHere(_wp)
#define NavSetWaypointHereSend(_wp)
#define NavSetWaypointPosAndAltHere(_wp)
#define NavSetWaypointDistBehind(_wp, _ref, dist)

Functions

void nav_move_waypoint (uint8_t wp_id, float utm_east, float utm_north, float alt)
 Move a waypoint to given UTM coordinates.
void nav_move_waypoint_enu (uint8_t wp_id, float x, float y, float alt)
 Move a waypoint in local frame.
void nav_move_waypoint_point (uint8_t wp_id, struct point *p)
 Move a waypoint from point structure (local frame).
void nav_send_waypoint (uint8_t wp_id)
 Send a waypoint throught default telemetry channel.
void compute_dist2_to_home (void)
 Computes squared distance to the HOME waypoint potentially sets too_far_from_home.
void nav_reset_utm_zone (void)
 Reset the UTM zone to current GPS fix.
void nav_reset_reference (void)
 Reset the geographic reference to the current GPS fix.
void nav_reset_alt (void)
 Reset the altitude reference to the current GPS alt.
void nav_update_waypoints_alt (void)
 Shift altitude of the waypoint according to a new ground altitude.
void common_nav_periodic_task (void)
float get_time_to_home (void)
 Compute time to home use wind and airspeed when available.

Variables

float max_dist_from_home
float dist2_to_home
float dist2_to_wp
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
int32_t nav_utm_east0
int32_t nav_utm_north0
uint8_t nav_utm_zone0

Data Structure Documentation

◆ point

struct point

Definition at line 39 of file common_nav.h.

Data Fields
float a
float x
float y

Macro Definition Documentation

◆ Height

#define Height ( _h)
Value:
(_h + ground_alt)
float ground_alt
size == nb_waypoint, waypoint 0 is a dummy waypoint
Definition common_nav.c:46

Definition at line 49 of file common_nav.h.

Referenced by calculate_wind_no_airspeed().

◆ NavSetAltitudeReferenceHere

#define NavSetAltitudeReferenceHere ( )
Value:
void nav_update_waypoints_alt(void)
Shift altitude of the waypoint according to a new ground altitude.
Definition common_nav.c:161
void nav_reset_alt(void)
Definition navigation.c:241

Definition at line 79 of file common_nav.h.

◆ NavSetGroundReferenceHere

#define NavSetGroundReferenceHere ( )
Value:
void nav_reset_reference(void)
Reset the geographic reference to the current GPS fix.
Definition navigation.c:234

Definition at line 77 of file common_nav.h.

◆ NavSetWaypointDistBehind

#define NavSetWaypointDistBehind ( _wp,
_ref,
dist )
Value:
({ \
waypoints[_wp].x = waypoints[_ref].x - dist*sin(stateGetNedToBodyEulers_f()->psi); \
waypoints[_wp].y = waypoints[_ref].y - dist*cos(stateGetNedToBodyEulers_f()->psi); \
false; \
})
struct point waypoints[NB_WAYPOINT]
size == nb_waypoint, waypoint 0 is a dummy waypoint
Definition common_nav.c:44
static struct FloatEulers * stateGetNedToBodyEulers_f(void)
Get vehicle body attitude euler angles (float).
Definition state.h:1325

Definition at line 101 of file common_nav.h.

◆ NavSetWaypointHere

#define NavSetWaypointHere ( _wp)
Value:
({ \
false; \
})
static struct EnuCoor_f * stateGetPositionEnu_f(void)
Get position in local ENU coordinates (float).
Definition state.h:859
float y
in meters
float x
in meters

Definition at line 81 of file common_nav.h.

◆ NavSetWaypointHereSend

#define NavSetWaypointHereSend ( _wp)
Value:
({ \
RunOnceEvery(NAVIGATION_FREQUENCY/1, {nav_send_waypoint(_wp);}) \
false; \
})
void nav_send_waypoint(uint8_t wp_id)
Send a waypoint throught default telemetry channel.
Definition common_nav.c:226
#define NAVIGATION_FREQUENCY
Default fixedwing navigation frequency.
Definition nav.h:49

Definition at line 87 of file common_nav.h.

◆ NavSetWaypointPosAndAltHere

#define NavSetWaypointPosAndAltHere ( _wp)
Value:
({ \
false; \
})
float z
in meters

Definition at line 94 of file common_nav.h.

◆ WaypointAlt

◆ WaypointX

◆ WaypointY

Function Documentation

◆ common_nav_periodic_task()

void common_nav_periodic_task ( void )
extern

Definition at line 169 of file common_nav.c.

References block_time, NAVIGATION_FREQUENCY, and stage_time.

Referenced by navigation_task().

Here is the caller graph for this function:

◆ compute_dist2_to_home()

void compute_dist2_to_home ( void )
extern

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 326 of file navigation.c.

References dist2_to_home, get_dist2_to_waypoint(), max_dist2_from_home, nav, stateGetPositionEnu_f(), too_far_from_home, waypoints, EnuCoor_f::x, 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:

◆ get_time_to_home()

float get_time_to_home ( void )
extern

Compute time to home use wind and airspeed when available.

Definition at line 71 of file common_nav.c.

References float_vect2_norm(), stateGetAirspeed_f(), stateGetHorizontalWindspeed_f(), stateGetPositionEnu_f(), stateIsAirspeedValid(), stateIsWindspeedValid(), waypoints, EnuCoor_f::x, FloatVect2::x, EnuCoor_f::y, and FloatVect2::y.

Here is the call graph for this function:

◆ nav_move_waypoint()

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

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 180 of file common_nav.c.

References LlaCoor_f::alt, max_dist_from_home, nav_utm_east0, nav_utm_north0, nb_waypoint, and waypoints.

Referenced by nav_parse_MOVE_WP().

Here is the caller graph for this function:

◆ nav_move_waypoint_enu()

void nav_move_waypoint_enu ( uint8_t wp_id,
float x,
float y,
float alt )
extern

Move a waypoint in local frame.

Parameters
[in]wp_idWaypoint ID
[in]uxx (east) coordinate
[in]uyy (north) coordinate
[in]altAltitude above MSL.

Definition at line 200 of file common_nav.c.

References LlaCoor_f::alt, max_dist_from_home, nb_waypoint, and waypoints.

Referenced by nav_lace_run(), nav_move_waypoint_point(), nav_rosette_run(), and nav_trinity_run().

Here is the caller graph for this function:

◆ nav_move_waypoint_point()

void nav_move_waypoint_point ( uint8_t wp_id,
struct point * p )
extern

Move a waypoint from point structure (local frame).

Parameters
[in]wp_idWaypoint ID
[in]pnew point

Definition at line 218 of file common_nav.c.

References nav_move_waypoint_enu(), and p.

Referenced by cloud_sim_move(), and cloud_sim_reset().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nav_reset_alt()

void nav_reset_alt ( void )
extern

Reset the altitude reference to the current GPS alt.

Definition at line 241 of file navigation.c.

References ground_alt, INS_RESET_VERTICAL_REF, previous_ground_alt, stateGetHmslOrigin_f(), and waypoints_localize_all().

Here is the call graph for this function:

◆ nav_reset_reference()

void nav_reset_reference ( void )
extern

Reset the geographic reference to the current GPS fix.

Definition at line 234 of file navigation.c.

References UtmCoor_f::east, ground_alt, INS_RESET_REF, nav_utm_east0, nav_utm_north0, nav_utm_zone0, UtmCoor_f::north, previous_ground_alt, stateGetHmslOrigin_f(), stateGetUtmOrigin_f(), waypoints_localize_all(), and UtmCoor_f::zone.

Here is the call graph for this function:

◆ nav_reset_utm_zone()

void nav_reset_utm_zone ( void )
extern

Reset the UTM zone to current GPS fix.

Definition at line 107 of file common_nav.c.

References UtmCoor_f::alt, UtmCoor_f::east, gps, GPS_VALID_POS_UTM_BIT, ground_alt, lla_of_utm_f(), nav_utm_east0, nav_utm_north0, nav_utm_zone0, UtmCoor_f::north, stateSetLocalUtmOrigin_f(), utm_of_lla_f(), and UtmCoor_f::zone.

Here is the call graph for this function:

◆ nav_send_waypoint()

void nav_send_waypoint ( uint8_t wp_id)
extern

Send a waypoint throught default telemetry channel.

Parameters
[in]wp_idWaypoint ID

Definition at line 226 of file common_nav.c.

References UtmCoor_f::alt, DefaultChannel, DefaultDevice, UtmCoor_f::east, nav_utm_east0, nav_utm_north0, nav_utm_zone0, nb_waypoint, UtmCoor_f::north, waypoints, and UtmCoor_f::zone.

Referenced by cloud_sim_move(), cloud_sim_reset(), nav_lace_run(), nav_rosette_run(), and nav_trinity_run().

Here is the caller graph for this function:

◆ nav_update_waypoints_alt()

void nav_update_waypoints_alt ( void )
extern

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

Definition at line 161 of file common_nav.c.

References ground_alt, previous_ground_alt, and waypoints.

Variable Documentation

◆ dist2_to_home

float dist2_to_home
extern

Definition at line 38 of file common_nav.c.

Referenced by compute_dist2_to_home(), monitor_task(), and nav_home().

◆ dist2_to_wp

float dist2_to_wp
extern

◆ ground_alt

◆ max_dist_from_home

float max_dist_from_home
extern

Definition at line 53 of file navigation.c.

Referenced by mission_point_of_lla(), nav_move_waypoint(), and nav_move_waypoint_enu().

◆ nav_utm_east0

◆ nav_utm_north0

◆ nav_utm_zone0

◆ nb_waypoint

const uint8_t nb_waypoint
extern

Definition at line 43 of file common_nav.c.

◆ too_far_from_home

bool too_far_from_home
extern

Definition at line 41 of file common_nav.c.

Referenced by autopilot_failsafe_checks(), and compute_dist2_to_home().

◆ waypoints

struct point waypoints[]
extern

Definition at line 44 of file common_nav.c.