Package ev3dev.sensors.gps

Class GenericGPS

java.lang.Object

ev3dev.sensors.gps.GenericGPS

All Implemented Interfaces:

SerialSensor

public class GenericGPS
extends java.lang.Object
implements SerialSensor

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DATA_RATE
private java.time.LocalDateTime	date
private GGASentence	ggaSentence
private GSASentence	gsaSentence
private GSVSentence	gsvSentence
private java.io.BufferedReader	input
private java.io.OutputStream	output
private RMCSentence	rmcSentence
(package private) SerialPort	serialPort
private static int	TIME_OUT
private java.lang.String	USBPort
private VTGSentence	vtgSentence

Constructor Summary

Constructors

Constructor and Description
GenericGPS(java.lang.String USBPort)

Method Summary

Modifier and Type	Method and Description
void	close() This should be called when you stop using the port.
float	getAltitude() The altitude above mean sea level
float	getCompassDegrees() Return Compass Degrees in a range: 0.0-359.9
float	getCourse() Get the course heading of the GPS unit.
java.time.LocalDateTime	getDate() Return a Date Object with data from GGA and RMC NMEA Sentence
int	getFixMode() Fix quality: 0 = invalid 1 = GPS fix (SPS) 2 = DGPS fix 3 = PPS fix 4 = Real Time Kinematic 5 = Float RTK 6 = estimated (dead reckoning) (2.3 feature) 7 = Manual input mode 8 = Simulation mode
int	getFixType() 3D fix - values include: 1 = no fix 2 = 2D fix 3 = 3D fix
float	getHDOP() Get the Horizontal Dilution of Precision (HDOP).
double	getLatitude() Get Latitude
char	getLatitudeDirection() Get Latitude Direction
double	getLongitude() Get Longitude
char	getLongitudeDirection() Get Longitude Direction
float	getPDOP() Get the 3D Position Dilution of Precision (PDOP).
int[]	getPRN() Get an Array of Pseudo-Random Noise codes (PRN).
Satellite	getSatellite(int index) Get NMEA Satellite.
int	getSatellitesInView() The satellites in view is a list of satellites the GPS could theoretically connect to (i.e.
int	getSatellitesTracked() Returns the number of satellites being tracked to determine the coordinates.
java.lang.String	getSelectionType() Selection type of 2D or 3D fix 'M' = manual 'A' = automatic
float	getSpeed() Get speed in kilometers per hour
int	getTimeStamp() Get the last time stamp from the satellite for GGA sentence.
float	getVDOP() Get the Vertical Dilution of Precision (VDOP).
void	init()
protected void	sentenceChooser(java.lang.String header, java.lang.String s) Internal helper method to aid in the subclass architecture.
void	serialEvent(SerialPortEvent oEvent) Handle an event on the serial port.
private void	setPortProperty()
private void	updateDate() Update Date values
private void	updateTime() Update Time values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

input

private java.io.BufferedReader input

output

private java.io.OutputStream output

TIME_OUT

private static final int TIME_OUT

See Also:

Constant Field Values

DATA_RATE

private static final int DATA_RATE

See Also:

Constant Field Values

serialPort

SerialPort serialPort

USBPort

private final java.lang.String USBPort

ggaSentence

private GGASentence ggaSentence

vtgSentence

private VTGSentence vtgSentence

gsaSentence

private GSASentence gsaSentence

rmcSentence

private RMCSentence rmcSentence

gsvSentence

private GSVSentence gsvSentence

date

private java.time.LocalDateTime date

Constructor Detail

GenericGPS

public GenericGPS(java.lang.String USBPort)

Method Detail

setPortProperty

private void setPortProperty()

init

public void init()
          throws SerialServiceException

Specified by:

init in interface SerialSensor

Throws:

SerialServiceException

close

public void close()

This should be called when you stop using the port. This will prevent port locking on platforms like Linux.

Specified by:

close in interface SerialSensor

serialEvent

public void serialEvent(SerialPortEvent oEvent)

Handle an event on the serial port. Read the data and print it.

sentenceChooser

protected void sentenceChooser(java.lang.String header,
                               java.lang.String s)

Internal helper method to aid in the subclass architecture. Overwritten by subclass.

Parameters:

header -

s -

getLatitude

public double getLatitude()

Get Latitude

Returns:

the latitude

getLatitudeDirection

public char getLatitudeDirection()

Get Latitude Direction

Returns:

the latitude direction

getLongitude

public double getLongitude()

Get Longitude

Returns:

the longitude

getLongitudeDirection

public char getLongitudeDirection()

Get Longitude Direction

Returns:

the longitude direction

getAltitude

public float getAltitude()

The altitude above mean sea level

Returns:

Meters above sea level e.g. 545.4

getSatellitesTracked

public int getSatellitesTracked()

Returns the number of satellites being tracked to determine the coordinates.

Returns:

Number of satellites e.g. 8

getFixMode

public int getFixMode()

Fix quality:

0 = invalid 1 = GPS fix (SPS) 2 = DGPS fix 3 = PPS fix 4 = Real Time Kinematic 5 = Float RTK 6 = estimated (dead reckoning) (2.3 feature) 7 = Manual input mode 8 = Simulation mode

Returns:

the fix quality

getTimeStamp

public int getTimeStamp()

Get the last time stamp from the satellite for GGA sentence.

Returns:

Time as a UTC integer. 123459 = 12:34:59 UTC

getSpeed

public float getSpeed()

Get speed in kilometers per hour

Returns:

the speed in kilometers per hour

getCourse

public float getCourse()

Get the course heading of the GPS unit.

Returns:

course (0.0 to 360.0)

getSelectionType

public java.lang.String getSelectionType()

Selection type of 2D or 3D fix

'M' = manual 'A' = automatic