001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.hardware.gps;
031
032import gnu.io.SerialPort;
033
034import java.util.List;
035
036import org.openimaj.hardware.serial.SerialDataListener;
037import org.openimaj.hardware.serial.SerialDevice;
038
039/**
040 *      This class reads GPS data from a serial port and makes available
041 *      the latest location information through its getters.
042 * 
043 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
044 *      
045 *      @created 11 Jul 2011
046 */
047public class GPSSerialReader implements Runnable
048{
049        private double lng = 0;
050        private double lat = 0;
051        private int nSats = 0;
052        private String portName = null; 
053        
054        /**
055         *      Constructor that takes the name of the serial port onto which
056         *      the GPS is transmitting data.
057         * 
058         * 
059         *  @param portName The name of the port
060         */
061        public GPSSerialReader( String portName)
062        {
063                this.portName = portName;
064        }
065
066        /**
067         *  {@inheritDoc}
068         *  @see java.lang.Runnable#run()
069         */
070        @Override
071        public void run()
072        {
073                try
074        {
075                String firstPort = portName;
076                System.out.println( "Opening "+firstPort );
077                
078                // This is the standard GPS configuration
079                SerialDevice sd = new SerialDevice( firstPort, 4800, SerialPort.DATABITS_8, 
080                                SerialPort.STOPBITS_1, SerialPort.PARITY_NONE );
081                
082                sd.addSerialDataListener( new SerialDataListener()
083                        {
084                        private NMEAParser parser = new NMEAParser();
085                        
086                                @Override
087                                public void dataReceived( String data )
088                                {
089                                        System.out.println( "Data: '"+data.trim()+"'" );
090                                        List<NMEAMessage> m = parser.parseString( data );
091                                        
092                                        if( m.size() > 0 )
093                                        {
094                                                System.out.println( m );
095                                                
096                                                for( NMEAMessage mm : m )
097                                                {
098                                                        if( mm.get("lat") != null )
099                                                                lat = (Double)mm.get("lat");
100                                                        if( mm.get("lng") != null )
101                                                                lng = (Double)mm.get("lng");
102                                                        if( mm.get("numberOfSatellites") != null )
103                                                                nSats = (Integer)mm.get("numberOfSatellites");
104                                                }
105                                        }
106                                }
107                        });
108        }
109        catch( Exception e )
110        {
111                e.printStackTrace();
112        }               
113        }
114        
115        /**
116         * @return The latitude
117         */
118        public double getLatitude()
119        {
120                return lat;
121        }
122        
123        /**
124         * @return The longitude
125         */
126        public double getLongitude()
127        {
128                return lng;
129        }
130        
131        /**
132         * @return The number of satellites
133         */
134        public int getNumberOfSatellites()
135        {
136                return nSats;
137        }
138        
139    /**
140     * Test
141     * @param args
142     */
143    static public void main( String[] args )
144    {
145        if (args.length == 1) {
146                new GPSSerialReader(args[0]).run();
147        } else {
148                new GPSSerialReader("/dev/ttyUSB0").run();
149        }
150    }
151}