waypoints.c

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Felix Ruess <felix.ruess@gmail.com>
 *
 * 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/>.
 */
 
#include "modules/nav/waypoints.h"
#include "state.h"
#include "modules/datalink/downlink.h"
#include "generated/flight_plan.h"
 
#if FLIGHTRECORDER_SDLOG
#include "modules/loggers/flight_recorder.h"
#include "modules/loggers/pprzlog_tp.h"
#endif
 
const uint8_t nb_waypoint = NB_WAYPOINT;
struct Waypoint waypoints[NB_WAYPOINT];
 
static void waypoint_send_moved_enu(uint8_t wp_id, int32_t x, int32_t y, int32_t z)
{
  DOWNLINK_SEND_WP_MOVED_ENU(DefaultChannel, DefaultDevice, &wp_id, &x, &y, &z);
#if FLIGHTRECORDER_SDLOG
  pprz_msg_send_WP_MOVED_ENU(&pprzlog_tp.trans_tx, &flightrecorder_sdlog.device, AC_ID,
                            &wp_id, &x, &y, &z);
#endif
}
 
static void waypoint_send_moved_lla(uint8_t wp_id, int32_t lat, int32_t lon, int32_t hmsl)
{
  DOWNLINK_SEND_WP_MOVED_LLA(DefaultChannel, DefaultDevice, &wp_id, &lat, &lon, &hmsl);
#if FLIGHTRECORDER_SDLOG
  pprz_msg_send_WP_MOVED_LLA(&pprzlog_tp.trans_tx, &flightrecorder_sdlog.device, AC_ID,
                            &wp_id, &lat, &lon, &hmsl);
#endif
}
 
#if PERIODIC_TELEMETRY
#include "modules/datalink/telemetry.h"
#include "math/pprz_random.h"
 
static void send_wp_moved(struct transport_tx *trans, struct link_device *dev)
{
  static uint8_t i;
 
  // Randomness added for multiple transport devices
  if (rand_uniform() > 0.02f) { i++; }
 
  if (i >= nb_waypoint) { i = 0; }
  pprz_msg_send_WP_MOVED_ENU(trans, dev, AC_ID,
                             &i,
                             &(waypoints[i].enu_i.x),
                             &(waypoints[i].enu_i.y),
                             &(waypoints[i].enu_i.z));
}
#endif
 
void waypoints_init(void)
{
  struct EnuCoor_f wp_tmp_float[NB_WAYPOINT] = WAYPOINTS_ENU;
  struct LlaCoor_i wp_tmp_lla_i[NB_WAYPOINT] = WAYPOINTS_LLA_WGS84;
  /* element in array is TRUE if absolute/global waypoint */
  bool is_global[NB_WAYPOINT] = WAYPOINTS_GLOBAL;
  uint8_t i = 0;
  for (i = 0; i < nb_waypoint; i++) {
    /* clear all flags */
    waypoints[i].flags = 0;
    /* init waypoint as global LLA or local ENU */
    if (is_global[i]) {
      waypoint_set_global_flag(i);
      waypoint_set_lla(i, &wp_tmp_lla_i[i]);
    } else {
      waypoint_set_enu(i, &wp_tmp_float[i]);
    }
  }
 
#if PERIODIC_TELEMETRY
  register_periodic_telemetry(DefaultPeriodic, PPRZ_MSG_ID_WP_MOVED, send_wp_moved);
#endif
}
 
bool waypoint_is_global(uint8_t wp_id)
{
  if (wp_id < nb_waypoint) {
    return bit_is_set(waypoints[wp_id].flags, WP_FLAG_GLOBAL);
  }
  return false;
}
 
void waypoint_set_global_flag(uint8_t wp_id)
{
  if (wp_id < nb_waypoint) {
    SetBit(waypoints[wp_id].flags, WP_FLAG_GLOBAL);
  }
}
 
void waypoint_clear_global_flag(uint8_t wp_id)
{
  if (wp_id < nb_waypoint) {
    ClearBit(waypoints[wp_id].flags, WP_FLAG_GLOBAL);
  }
}
 
float waypoint_get_x(uint8_t wp_id)
{
  if (wp_id < nb_waypoint) {
    return waypoints[wp_id].enu_f.x;
  }
  return 0.f;
}
 
float waypoint_get_y(uint8_t wp_id)
{
  if (wp_id < nb_waypoint) {
    return waypoints[wp_id].enu_f.y;
  }
  return 0.f;
}
 
float waypoint_get_alt(uint8_t wp_id)
{
  if (wp_id < nb_waypoint) {
    return waypoints[wp_id].enu_f.z;
  }
  return 0.f;
}
 
float waypoint_get_lla_alt(uint8_t wp_id)
{
  if (wp_id < nb_waypoint) {
    return waypoints[wp_id].lla.alt/1000.f - stateGetLlaOrigin_i().alt/1000.f;
  }
  return 0.f;
}
 
float waypoint_get_lat_deg(uint8_t wp_id)
{
  if (wp_id < nb_waypoint) {
    if (!waypoint_is_global(wp_id) && !bit_is_set(waypoints[wp_id].flags, WP_FLAG_LLA_I)) {
      waypoint_globalize(wp_id);
    }
    return DEG_OF_EM7DEG(waypoints[wp_id].lla.lat);
  }
  else {
    return 0.f;
  }
}
 
float waypoint_get_lat_rad(uint8_t wp_id)
{
  return RadOfDeg(waypoint_get_lat_deg(wp_id));
}
 
float waypoint_get_lon_deg(uint8_t wp_id)
{
  if (wp_id < nb_waypoint) {
    if (!waypoint_is_global(wp_id) && !bit_is_set(waypoints[wp_id].flags, WP_FLAG_LLA_I)) {
      waypoint_globalize(wp_id);
    }
    return DEG_OF_EM7DEG(waypoints[wp_id].lla.lon);
  }
  else {
    return 0.f;
  }
}
 
float waypoint_get_lon_rad(uint8_t wp_id)
{
  return RadOfDeg(waypoint_get_lon_deg(wp_id));
}
 
void waypoint_set_enu_i(uint8_t wp_id, struct EnuCoor_i *enu)
{
  if (wp_id < nb_waypoint) {
    waypoints[wp_id].enu_i = *enu;
    SetBit(waypoints[wp_id].flags, WP_FLAG_ENU_I);
    ENU_FLOAT_OF_BFP(waypoints[wp_id].enu_f, waypoints[wp_id].enu_i);
    SetBit(waypoints[wp_id].flags, WP_FLAG_ENU_F);
    ClearBit(waypoints[wp_id].flags, WP_FLAG_LLA_I);
    waypoint_globalize(wp_id);
  }
}
 
void waypoint_set_enu(uint8_t wp_id, struct EnuCoor_f *enu)
{
  if (wp_id < nb_waypoint) {
    waypoints[wp_id].enu_f = *enu;
    SetBit(waypoints[wp_id].flags, WP_FLAG_ENU_I);
    ENU_BFP_OF_REAL(waypoints[wp_id].enu_i, waypoints[wp_id].enu_f);
    SetBit(waypoints[wp_id].flags, WP_FLAG_ENU_F);
    ClearBit(waypoints[wp_id].flags, WP_FLAG_LLA_I);
    waypoint_globalize(wp_id);
  }
}
 
void waypoint_move_enu_i(uint8_t wp_id, struct EnuCoor_i *new_pos)
{
  if (wp_id < nb_waypoint) {
    waypoint_set_enu_i(wp_id, new_pos);
    waypoint_send_moved_enu(wp_id, new_pos->x, new_pos->y, new_pos->z);
  }
}
 
void waypoint_set_xy_i(uint8_t wp_id, int32_t x, int32_t y)
{
  if (wp_id < nb_waypoint) {
    waypoints[wp_id].enu_i.x = x;
    waypoints[wp_id].enu_i.y = y;
    /* also update ENU float representation */
    waypoints[wp_id].enu_f.x = POS_FLOAT_OF_BFP(waypoints[wp_id].enu_i.x);
    waypoints[wp_id].enu_f.y = POS_FLOAT_OF_BFP(waypoints[wp_id].enu_i.y);
    waypoint_globalize(wp_id);
  }
}
 
void waypoint_move_xy_i(uint8_t wp_id, int32_t x, int32_t y)
{
  if (wp_id < nb_waypoint) {
    waypoint_set_xy_i(wp_id, x, y);
    waypoint_send_moved_enu(wp_id, x, y, waypoints[wp_id].enu_i.z);
  }
}
 
void waypoint_set_alt_i(uint8_t wp_id, int32_t alt)
{
  if (wp_id < nb_waypoint) {
    waypoints[wp_id].enu_i.z = alt;
    /* also update ENU float representation */
    waypoints[wp_id].enu_f.z = POS_FLOAT_OF_BFP(waypoints[wp_id].enu_i.z);
    waypoint_globalize(wp_id);
  }
}
 
void waypoint_set_alt(uint8_t wp_id, float alt)
{
  if (wp_id < nb_waypoint) {
    waypoints[wp_id].enu_f.z = alt;
    /* also update ENU fixed point representation */
    waypoints[wp_id].enu_i.z = POS_BFP_OF_REAL(waypoints[wp_id].enu_f.z);
    waypoint_globalize(wp_id);
  }
}
 
void waypoint_set_lla(uint8_t wp_id, struct LlaCoor_i *lla)
{
  if (wp_id >= nb_waypoint) {
    return;
  }
  waypoints[wp_id].lla = *lla;
  SetBit(waypoints[wp_id].flags, WP_FLAG_LLA_I);
  waypoint_localize(wp_id);
}
 
void waypoint_move_lla(uint8_t wp_id, struct LlaCoor_i *lla)
{
  if (wp_id >= nb_waypoint) {
    return;
  }
  waypoint_set_lla(wp_id, lla);
  if (waypoint_is_global(wp_id)) {
    /* lla->alt is above ellipsoid, WP_MOVED_LLA has hmsl alt */
    int32_t hmsl = lla->alt - stateGetLlaOrigin_i().alt + stateGetHmslOrigin_i();
    waypoint_send_moved_lla(wp_id, lla->lat, lla->lon, hmsl);
  } else {
    waypoint_send_moved_enu(wp_id, waypoints[wp_id].enu_i.x,
                            waypoints[wp_id].enu_i.y, waypoints[wp_id].enu_i.z);
  }
}
 
void waypoint_set_latlon(uint8_t wp_id, struct LlaCoor_i *lla)
{
  if (wp_id >= nb_waypoint) {
    return;
  }
  waypoints[wp_id].lla.lat = lla->lat;
  waypoints[wp_id].lla.lon = lla->lon;
  SetBit(waypoints[wp_id].flags, WP_FLAG_LLA_I);
  waypoint_localize(wp_id);
}
 
void waypoint_set_here(uint8_t wp_id)
{
  if (wp_id >= nb_waypoint) {
    return;
  }
  if (waypoint_is_global(wp_id)) {
    waypoint_set_lla(wp_id, stateGetPositionLla_i());
  } else {
    waypoint_set_enu_i(wp_id, stateGetPositionEnu_i());
  }
}
 
void waypoint_set_here_2d(uint8_t wp_id)
{
  if (wp_id >= nb_waypoint) {
    return;
  }
  if (waypoint_is_global(wp_id)) {
    waypoint_set_latlon(wp_id, stateGetPositionLla_i());
  } else {
    waypoint_set_xy_i(wp_id, stateGetPositionEnu_i()->x, stateGetPositionEnu_i()->y);
  }
}
 
void waypoint_move_here_2d(uint8_t wp_id)
{
  if (wp_id >= nb_waypoint) {
    return;
  }
  if (waypoint_is_global(wp_id)) {
    /* lla->alt is above ellipsoid, WP_MOVED_LLA has hmsl alt */
    struct LlaCoor_i *lla = &(waypoints[wp_id].lla);
    int32_t hmsl = lla->alt - stateGetLlaOrigin_i().alt + stateGetHmslOrigin_i();
    waypoint_send_moved_lla(wp_id, lla->lat, lla->lon, hmsl);
  } else {
    waypoint_send_moved_enu(wp_id, waypoints[wp_id].enu_i.x,
                            waypoints[wp_id].enu_i.y, waypoints[wp_id].enu_i.z);
  }
}
 
void waypoint_globalize(uint8_t wp_id)
{
  if (state.ned_initialized_i) {
    struct EcefCoor_i ecef;
    ecef_of_enu_pos_i(&ecef, stateGetNedOrigin_i(), &waypoints[wp_id].enu_i);
    lla_of_ecef_i(&waypoints[wp_id].lla, &ecef);
    SetBit(waypoints[wp_id].flags, WP_FLAG_LLA_I);
  }
}
 
void waypoint_localize(uint8_t wp_id)
{
  if (state.ned_initialized_i) {
    struct EnuCoor_i enu;
    enu_of_lla_point_i(&enu, stateGetNedOrigin_i(), &waypoints[wp_id].lla);
    // convert ENU pos from cm to BFP with INT32_POS_FRAC
    enu.x = POS_BFP_OF_REAL((int64_t) enu.x) / 100;
    enu.y = POS_BFP_OF_REAL((int64_t) enu.y) / 100;
    enu.z = POS_BFP_OF_REAL((int64_t) enu.z) / 100;
    waypoints[wp_id].enu_i = enu;
    SetBit(waypoints[wp_id].flags, WP_FLAG_ENU_I);
    ENU_FLOAT_OF_BFP(waypoints[wp_id].enu_f, waypoints[wp_id].enu_i);
    SetBit(waypoints[wp_id].flags, WP_FLAG_ENU_F);
  }
}
 
void waypoints_localize_all(void)
{
  uint8_t i = 0;
  for (i = 0; i < nb_waypoint; i++) {
    if (waypoint_is_global(i)) {
      waypoint_localize(i);
    }
  }
}
 
struct LlaCoor_i *waypoint_get_lla(uint8_t wp_id)
{
  if (wp_id < nb_waypoint) {
    if (!waypoint_is_global(wp_id) && !bit_is_set(waypoints[wp_id].flags, WP_FLAG_LLA_I)) {
      waypoint_globalize(wp_id);
    }
    return &waypoints[wp_id].lla;
  }
  else {
    return NULL;
  }
}
 
struct EnuCoor_f *waypoint_get_enu_f(uint8_t wp_id)
{
  if (wp_id < nb_waypoint) {
    if (waypoint_is_global(wp_id) && !bit_is_set(waypoints[wp_id].flags, WP_FLAG_ENU_F)) {
      waypoint_localize(wp_id);
    }
    return &waypoints[wp_id].enu_f;
  }
  else {
    return NULL;
  }
}
 
struct EnuCoor_i *waypoint_get_enu_i(uint8_t wp_id)
{
  if (wp_id < nb_waypoint) {
    if (waypoint_is_global(wp_id) && !bit_is_set(waypoints[wp_id].flags, WP_FLAG_ENU_I)) {
      waypoint_localize(wp_id);
    }
    return &waypoints[wp_id].enu_i;
  }
  else {
    return NULL;
  }
}
 
void waypoint_copy(uint8_t wp_dest, uint8_t wp_src)
{
  if (wp_dest < nb_waypoint && wp_src < nb_waypoint) {
    waypoints[wp_dest] = waypoints[wp_src];
  }
}
 
void waypoint_position_copy(uint8_t wp_dest, uint8_t wp_src)
{
  if (wp_dest < nb_waypoint && wp_src < nb_waypoint) {
    waypoints[wp_dest].enu_f.x = waypoints[wp_src].enu_f.x;
    waypoints[wp_dest].enu_f.y = waypoints[wp_src].enu_f.y;
    waypoints[wp_dest].enu_i.x = waypoints[wp_src].enu_i.x;
    waypoints[wp_dest].enu_i.y = waypoints[wp_src].enu_i.y;
    waypoints[wp_dest].lla.lat = waypoints[wp_src].lla.lat;
    waypoints[wp_dest].lla.lon = waypoints[wp_src].lla.lon;
  }
}