flight/modules/GPS/inc/GPS.h

   1 /**
   2  ******************************************************************************
   3  * @addtogroup OpenPilotModules OpenPilot Modules
   4  * @{
   5  * @addtogroup GPSModule GPS Module
   6  * @brief Process GPS information
   7  * @{
   8  *
   9  * @file       GPS.h
  10  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
  11  * @brief      Include file of the GPS module.
  12  *             As with all modules only the initialize function is exposed all other
  13  *             interactions with the module take place through the event queue and
  14  *             objects.
  15  * @see        The GNU Public License (GPL) Version 3
  16  *
  17  *****************************************************************************/
  18 /*
  19  * This program is free software; you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation; either version 3 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful, but
  25  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  26  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  27  * for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License along
  30  * with this program; if not, write to the Free Software Foundation, Inc.,
  31  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  32  */
  33
  34 #ifndef GPS_H
  35 #define GPS_H
  36
  37 #include "gpsvelocitysensor.h"
  38 #include "gpssatellites.h"
  39 #include "gpspositionsensor.h"
  40 #include "gpstime.h"
  41 #include "auxmagsettings.h"
  42
  43 #define NO_PARSER         -3 // no parser available
  44 #define PARSER_OVERRUN    -2 // message buffer overrun before completing the message
  45 #define PARSER_ERROR      -1 // message unparsable by this parser
  46 #define PARSER_INCOMPLETE 0 // parser needs more data to complete the message
  47 #define PARSER_COMPLETE   1 // parser has received a complete message and finished processing
  48
  49 struct GPS_RX_STATS {
  50     uint16_t gpsRxReceived;
  51     uint16_t gpsRxChkSumError;
  52     uint16_t gpsRxOverflow;
  53     uint16_t gpsRxParserError;
  54 };
  55
  56 int32_t GPSInitialize(void);
  57 void gps_set_fc_baud_from_arg(uint8_t baud);
  58 uint32_t hwsettings_gpsspeed_enum_to_baud(uint8_t baud);
  59
  60 #endif // GPS_H
  61
  62 /**
  63  * @}
  64  * @}
  65  */