Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
GPSData

GPSData Class Reference

Constructors

Instance Methods

Constructors

new GPSData(parameters)

Initalizes an instance of GPSData.

Instance Methods

gPSData.getActual() ⇒ Boolean

Get the Actual

Kind: Instance method of GPSData
Returns: Boolean - the KEY_ACTUAL value

gPSData.getAltitude() ⇒ Number

Get the Altitude

Kind: Instance method of GPSData
Returns: Number - the KEY_ALTITUDE value

gPSData.getCompassDirection() ⇒ CompassDirection

Get the CompassDirection

Kind: Instance method of GPSData
Returns: CompassDirection - the KEY_COMPASS_DIRECTION value

gPSData.getDimension() ⇒ Dimension

Get the Dimension

Kind: Instance method of GPSData
Returns: Dimension - the KEY_DIMENSION value

gPSData.getHdop() ⇒ Number

Get the Hdop

Kind: Instance method of GPSData
Returns: Number - the KEY_HDOP value

gPSData.getHeading() ⇒ Number

Get the Heading

Kind: Instance method of GPSData
Returns: Number - the KEY_HEADING value

gPSData.getLatitudeDegrees() ⇒ Number

Get the LatitudeDegrees

Kind: Instance method of GPSData
Returns: Number - the KEY_LATITUDE_DEGREES value

gPSData.getLongitudeDegrees() ⇒ Number

Get the LongitudeDegrees

Kind: Instance method of GPSData
Returns: Number - the KEY_LONGITUDE_DEGREES value

gPSData.getPdop() ⇒ Number

Get the Pdop

Kind: Instance method of GPSData
Returns: Number - the KEY_PDOP value

gPSData.getSatellites() ⇒ Number

Get the Satellites

Kind: Instance method of GPSData
Returns: Number - the KEY_SATELLITES value

gPSData.getShifted() ⇒ Boolean

Get the Shifted

Kind: Instance method of GPSData
Returns: Boolean - the KEY_SHIFTED value

gPSData.getSpeed() ⇒ Number

Get the Speed

Kind: Instance method of GPSData
Returns: Number - the KEY_SPEED value

gPSData.getUtcDay() ⇒ Number

Get the UtcDay

Kind: Instance method of GPSData
Returns: Number - the KEY_UTC_DAY value

gPSData.getUtcHours() ⇒ Number

Get the UtcHours

Kind: Instance method of GPSData
Returns: Number - the KEY_UTC_HOURS value

gPSData.getUtcMinutes() ⇒ Number

Get the UtcMinutes

Kind: Instance method of GPSData
Returns: Number - the KEY_UTC_MINUTES value

gPSData.getUtcMonth() ⇒ Number

Get the UtcMonth

Kind: Instance method of GPSData
Returns: Number - the KEY_UTC_MONTH value

gPSData.getUtcSeconds() ⇒ Number

Get the UtcSeconds

Kind: Instance method of GPSData
Returns: Number - the KEY_UTC_SECONDS value

gPSData.getUtcYear() ⇒ Number

Get the UtcYear

Kind: Instance method of GPSData
Returns: Number - the KEY_UTC_YEAR value

gPSData.getVdop() ⇒ Number

Get the Vdop

Kind: Instance method of GPSData
Returns: Number - the KEY_VDOP value

gPSData.setActual(actual) ⇒ GPSData

Set the Actual

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
actual Boolean True, if actual. False, if inferred. - The desired Actual.

gPSData.setAltitude(altitude) ⇒ GPSData

Set the Altitude

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
altitude Number Altitude in meters - The desired Altitude.

gPSData.setCompassDirection(direction) ⇒ GPSData

Set the CompassDirection

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
direction CompassDirection See CompassDirection. - The desired CompassDirection.

gPSData.setDimension(dimension) ⇒ GPSData

Set the Dimension

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
dimension Dimension See Dimension - The desired Dimension.

gPSData.setHdop(hdop) ⇒ GPSData

Set the Hdop

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
hdop Number HDOP. If value is unknown, value shall be set to 0. - The desired Hdop.

gPSData.setHeading(heading) ⇒ GPSData

Set the Heading

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
heading Number The heading. North is 0. Resolution is 0.01 - The desired Heading.

gPSData.setLatitudeDegrees(degrees) ⇒ GPSData

Set the LatitudeDegrees

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
degrees Number The desired LatitudeDegrees.

gPSData.setLongitudeDegrees(degrees) ⇒ GPSData

Set the LongitudeDegrees

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
degrees Number The desired LongitudeDegrees.

gPSData.setPdop(pdop) ⇒ GPSData

Set the Pdop

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
pdop Number PDOP. If undefined or unavailable, then value shall be set to 0. - The desired Pdop.

gPSData.setSatellites(satellites) ⇒ GPSData

Set the Satellites

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
satellites Number Number of satellites in view - The desired Satellites.

gPSData.setShifted(shifted) ⇒ GPSData

Set the Shifted

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
shifted Boolean True, if GPS lat/long, time, and altitude have been purposefully shifted (requires a - The desired Shifted. proprietary algorithm to unshift). False, if the GPS data is raw and un-shifted. If not provided, then value is assumed False.

gPSData.setSpeed(speed) ⇒ GPSData

Set the Speed

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
speed Number The speed in KPH - The desired Speed.

gPSData.setUtcDay(day) ⇒ GPSData

Set the UtcDay

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
day Number The current UTC day. - The desired UtcDay.

gPSData.setUtcHours(hours) ⇒ GPSData

Set the UtcHours

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
hours Number The current UTC hour. - The desired UtcHours.

gPSData.setUtcMinutes(minutes) ⇒ GPSData

Set the UtcMinutes

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
minutes Number The current UTC minute. - The desired UtcMinutes.

gPSData.setUtcMonth(month) ⇒ GPSData

Set the UtcMonth

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
month Number The current UTC month. - The desired UtcMonth.

gPSData.setUtcSeconds(seconds) ⇒ GPSData

Set the UtcSeconds

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
seconds Number The current UTC second. - The desired UtcSeconds.

gPSData.setUtcYear(year) ⇒ GPSData

Set the UtcYear

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
year Number The current UTC year. - The desired UtcYear.

gPSData.setVdop(vdop) ⇒ GPSData

Set the Vdop

Kind: Instance method of GPSData
Returns: GPSData - The class instance for method chaining.

ParamTypeDescription
vdop Number VDOP. If value is unknown, value shall be set to 0. - The desired Vdop.
View on GitHub.com
Previous Section Next Section