GPS.h

00001 /* mbed EM-406 GPS Module Library
00002  * Copyright (c) 2008-2010, sford
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00020  * THE SOFTWARE.
00021  */
00022 
00023 #include "mbed.h"
00024 
00025 #ifndef MBED_GPS_H
00026 #define MBED_GPS_H
00027 
00028 /**  A GPS interface for reading from a Globalsat EM-406 GPS Module */
00029 class GPS {
00030 public:
00031 
00032     /** Create the GPS interface, connected to the specified serial port
00033      */    
00034     GPS(PinName tx, PinName rx);
00035     
00036     /** Sample the incoming GPS data, returning whether there is a lock
00037      * 
00038      * @return 1 if there was a lock when the sample was taken (and therefore .longitude and .latitude are valid), else 0
00039      */
00040     int sample();
00041     
00042     /** The longitude (call sample() to set) */
00043     float longitude;
00044 
00045     /** The latitude (call sample() to set) */
00046     float latitude;
00047     
00048     /** The UTC time */
00049     float utc;
00050     
00051     //int sek, min, hour;
00052     
00053     /**fix quality*/
00054     int fix;
00055     
00056      /**fix3D fix - values include: 1 = no fix,2 = 2D fix,3 = 3D fix */
00057     int fix_3d;
00058     
00059     /**Altitude, Meters, above mean sea level*/
00060     float altitude;
00061     
00062     /**Number of satellites being tracked*/
00063     int sat_tracked;
00064     
00065     /**dilution of precision (PDOP)*/
00066     //double pdop;
00067     
00068     /**Horizontal dilution of precision (HDOP) */
00069     //double hdop;
00070     
00071     /**Vertical dilution of precision (VDOP)*/
00072     //float vdop;
00073     //char aut;
00074     
00075     /**speed in knots*/
00076     float speed;
00077     
00078     /**date of object*/
00079     int date;
00080     
00081     /**PRNs (IDS) of satellites used for fix (space for 12) */
00082     int id1,id2,id3,id4,id5,id6,id7,id8,id9,id10,id11,id12,id13;
00083     
00084     char msg[280];
00085     
00086 private:
00087     float trunc(float v);
00088     void getline();
00089     //void getline2();
00090     
00091     Serial _gps;
00092 
00093 };
00094 
00095 #endif