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     int lock;
00048 private:
00049     float trunc(float v);
00050     void getline();
00051     
00052     Serial _gps;
00053     char msg[256];
00054 
00055 };
00056 
00057 #endif