public class BrickletGPSV2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletGPSV2.Altitude |
static interface |
BrickletGPSV2.AltitudeListener
This listener is triggered periodically with the period that is set by
setAltitudeCallbackPeriod(long) . |
class |
BrickletGPSV2.Coordinates |
static interface |
BrickletGPSV2.CoordinatesListener
This listener is triggered periodically with the period that is set by
setCoordinatesCallbackPeriod(long) . |
class |
BrickletGPSV2.DateTime |
static interface |
BrickletGPSV2.DateTimeListener
This listener is triggered periodically with the period that is set by
setDateTimeCallbackPeriod(long) . |
class |
BrickletGPSV2.Motion |
static interface |
BrickletGPSV2.MotionListener
This listener is triggered periodically with the period that is set by
setMotionCallbackPeriod(long) . |
static interface |
BrickletGPSV2.PulsePerSecondListener
This listener is triggered precisely once per second,
see `PPS <https://en.wikipedia.org/wiki/Pulse-per-second_signal>`__.
|
class |
BrickletGPSV2.SatelliteStatus |
class |
BrickletGPSV2.SatelliteSystemStatus |
class |
BrickletGPSV2.SatelliteSystemStatusLowLevel |
class |
BrickletGPSV2.SPITFPErrorCount |
class |
BrickletGPSV2.Status |
static interface |
BrickletGPSV2.StatusListener
This listener is triggered periodically with the period that is set by
setStatusCallbackPeriod(long) . |
Device.Identity
Constructor and Description |
---|
BrickletGPSV2(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addAltitudeListener(BrickletGPSV2.AltitudeListener listener)
Adds a Altitude listener.
|
void |
addCoordinatesListener(BrickletGPSV2.CoordinatesListener listener)
Adds a Coordinates listener.
|
void |
addDateTimeListener(BrickletGPSV2.DateTimeListener listener)
Adds a DateTime listener.
|
void |
addMotionListener(BrickletGPSV2.MotionListener listener)
Adds a Motion listener.
|
void |
addPulsePerSecondListener(BrickletGPSV2.PulsePerSecondListener listener)
Adds a PulsePerSecond listener.
|
void |
addStatusListener(BrickletGPSV2.StatusListener listener)
Adds a Status listener.
|
BrickletGPSV2.Altitude |
getAltitude()
Returns the current altitude and corresponding geoidal separation.
|
long |
getAltitudeCallbackPeriod()
Returns the period as set by
setAltitudeCallbackPeriod(long) . |
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
BrickletGPSV2.Coordinates |
getCoordinates()
Returns the GPS coordinates.
|
long |
getCoordinatesCallbackPeriod()
Returns the period as set by
setCoordinatesCallbackPeriod(long) . |
BrickletGPSV2.DateTime |
getDateTime()
Returns the current date and time.
|
long |
getDateTimeCallbackPeriod()
Returns the period as set by
setDateTimeCallbackPeriod(long) . |
int |
getFixLEDConfig()
Returns the configuration as set by
setFixLEDConfig(int) |
Device.Identity |
getIdentity()
Returns the UID, the UID where the Bricklet is connected to,
the position, the hardware and firmware version as well as the
device identifier.
|
BrickletGPSV2.Motion |
getMotion()
Returns the current course and speed.
|
long |
getMotionCallbackPeriod()
Returns the period as set by
setMotionCallbackPeriod(long) . |
BrickletGPSV2.SatelliteStatus |
getSatelliteStatus(int satelliteSystem,
int satelliteNumber)
Returns the current elevation, azimuth and SNR
for a given satellite and satellite system.
|
BrickletGPSV2.SatelliteSystemStatus |
getSatelliteSystemStatus(int satelliteSystem)
Returns the
* satellite numbers list (up to 12 items)
* fix value,
* PDOP value,
* HDOP value and
* VDOP value
for a given satellite system.
|
BrickletGPSV2.SatelliteSystemStatusLowLevel |
getSatelliteSystemStatusLowLevel(int satelliteSystem)
Returns the
* satellite numbers list (up to 12 items)
* fix value,
* PDOP value,
* HDOP value and
* VDOP value
for a given satellite system.
|
int |
getSBASConfig()
Returns the SBAS configuration as set by
setSBASConfig(int)
.. |
BrickletGPSV2.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
BrickletGPSV2.Status |
getStatus()
Returns if a fix is currently available as well as the, the number of
satellites that are in view.
|
long |
getStatusCallbackPeriod()
Returns the period as set by
setStatusCallbackPeriod(long) . |
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
long |
readUID()
Returns the current UID as an integer.
|
void |
removeAltitudeListener(BrickletGPSV2.AltitudeListener listener)
Removes a Altitude listener.
|
void |
removeCoordinatesListener(BrickletGPSV2.CoordinatesListener listener)
Removes a Coordinates listener.
|
void |
removeDateTimeListener(BrickletGPSV2.DateTimeListener listener)
Removes a DateTime listener.
|
void |
removeMotionListener(BrickletGPSV2.MotionListener listener)
Removes a Motion listener.
|
void |
removePulsePerSecondListener(BrickletGPSV2.PulsePerSecondListener listener)
Removes a PulsePerSecond listener.
|
void |
removeStatusListener(BrickletGPSV2.StatusListener listener)
Removes a Status listener.
|
void |
reset()
Calling this function will reset the Bricklet.
|
void |
restart(int restartType)
Restarts the GPS Bricklet, the following restart types are available:
\verbatim
"Value", "Description"
"0", "Hot start (use all available data in the NV store)"
"1", "Warm start (don't use ephemeris at restart)"
"2", "Cold start (don't use time, position, almanacs and ephemeris at restart)"
"3", "Factory reset (clear all system/user configurations at restart)"
\endverbatim
|
void |
setAltitudeCallbackPeriod(long period)
Sets the period with which the
BrickletGPSV2.AltitudeListener listener is triggered
periodically. |
int |
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested
mode change was instigated.
|
void |
setCoordinatesCallbackPeriod(long period)
Sets the period with which the
BrickletGPSV2.CoordinatesListener listener is triggered
periodically. |
void |
setDateTimeCallbackPeriod(long period)
Sets the period with which the
BrickletGPSV2.DateTimeListener listener is triggered
periodically. |
void |
setFixLEDConfig(int config)
Sets the fix LED configuration.
|
void |
setMotionCallbackPeriod(long period)
Sets the period with which the
BrickletGPSV2.MotionListener listener is triggered
periodically. |
void |
setSBASConfig(int sbasConfig)
If `SBAS <https://en.wikipedia.org/wiki/GNSS_augmentation#Satellite-based_augmentation_system>`__ is enabled,
the position accuracy increases (if SBAS satellites are in view),
but the update rate is limited to 5Hz.
|
void |
setStatusCallbackPeriod(long period)
Sets the period with which the
BrickletGPSV2.StatusListener listener is triggered
periodically. |
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(int[]) . |
int |
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written by
setWriteFirmwarePointer(long) before. |
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_COORDINATES
public static final byte FUNCTION_GET_STATUS
public static final byte FUNCTION_GET_ALTITUDE
public static final byte FUNCTION_GET_MOTION
public static final byte FUNCTION_GET_DATE_TIME
public static final byte FUNCTION_RESTART
public static final byte FUNCTION_GET_SATELLITE_SYSTEM_STATUS_LOW_LEVEL
public static final byte FUNCTION_GET_SATELLITE_STATUS
public static final byte FUNCTION_SET_FIX_LED_CONFIG
public static final byte FUNCTION_GET_FIX_LED_CONFIG
public static final byte FUNCTION_SET_COORDINATES_CALLBACK_PERIOD
public static final byte FUNCTION_GET_COORDINATES_CALLBACK_PERIOD
public static final byte FUNCTION_SET_STATUS_CALLBACK_PERIOD
public static final byte FUNCTION_GET_STATUS_CALLBACK_PERIOD
public static final byte FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD
public static final byte FUNCTION_GET_ALTITUDE_CALLBACK_PERIOD
public static final byte FUNCTION_SET_MOTION_CALLBACK_PERIOD
public static final byte FUNCTION_GET_MOTION_CALLBACK_PERIOD
public static final byte FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD
public static final byte FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD
public static final byte FUNCTION_SET_SBAS_CONFIG
public static final byte FUNCTION_GET_SBAS_CONFIG
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final int RESTART_TYPE_HOT_START
public static final int RESTART_TYPE_WARM_START
public static final int RESTART_TYPE_COLD_START
public static final int RESTART_TYPE_FACTORY_RESET
public static final int SATELLITE_SYSTEM_GPS
public static final int SATELLITE_SYSTEM_GLONASS
public static final int SATELLITE_SYSTEM_GALILEO
public static final int FIX_NO_FIX
public static final int FIX_2D_FIX
public static final int FIX_3D_FIX
public static final int FIX_LED_CONFIG_OFF
public static final int FIX_LED_CONFIG_ON
public static final int FIX_LED_CONFIG_SHOW_HEARTBEAT
public static final int FIX_LED_CONFIG_SHOW_FIX
public static final int FIX_LED_CONFIG_SHOW_PPS
public static final int SBAS_ENABLED
public static final int SBAS_DISABLED
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletGPSV2(String uid, IPConnection ipcon)
public BrickletGPSV2.Coordinates getCoordinates() throws TinkerforgeException
getStatus()
.TinkerforgeException
public BrickletGPSV2.Status getStatus() throws TinkerforgeException
TinkerforgeException
public BrickletGPSV2.Altitude getAltitude() throws TinkerforgeException
getStatus()
.TinkerforgeException
public BrickletGPSV2.Motion getMotion() throws TinkerforgeException
getStatus()
.TinkerforgeException
public BrickletGPSV2.DateTime getDateTime() throws TinkerforgeException
TinkerforgeException
public void restart(int restartType) throws TinkerforgeException
TinkerforgeException
public BrickletGPSV2.SatelliteSystemStatusLowLevel getSatelliteSystemStatusLowLevel(int satelliteSystem) throws TinkerforgeException
TinkerforgeException
public BrickletGPSV2.SatelliteStatus getSatelliteStatus(int satelliteSystem, int satelliteNumber) throws TinkerforgeException
TinkerforgeException
public void setFixLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getFixLEDConfig() throws TinkerforgeException
setFixLEDConfig(int)
TinkerforgeException
public void setCoordinatesCallbackPeriod(long period) throws TinkerforgeException
BrickletGPSV2.CoordinatesListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickletGPSV2.CoordinatesListener
listener is only triggered if the coordinates changed
since the last triggering.TinkerforgeException
public long getCoordinatesCallbackPeriod() throws TinkerforgeException
setCoordinatesCallbackPeriod(long)
.TinkerforgeException
public void setStatusCallbackPeriod(long period) throws TinkerforgeException
BrickletGPSV2.StatusListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickletGPSV2.StatusListener
listener is only triggered if the status changed since the
last triggering.TinkerforgeException
public long getStatusCallbackPeriod() throws TinkerforgeException
setStatusCallbackPeriod(long)
.TinkerforgeException
public void setAltitudeCallbackPeriod(long period) throws TinkerforgeException
BrickletGPSV2.AltitudeListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickletGPSV2.AltitudeListener
listener is only triggered if the altitude changed since the
last triggering.TinkerforgeException
public long getAltitudeCallbackPeriod() throws TinkerforgeException
setAltitudeCallbackPeriod(long)
.TinkerforgeException
public void setMotionCallbackPeriod(long period) throws TinkerforgeException
BrickletGPSV2.MotionListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickletGPSV2.MotionListener
listener is only triggered if the motion changed since the
last triggering.TinkerforgeException
public long getMotionCallbackPeriod() throws TinkerforgeException
setMotionCallbackPeriod(long)
.TinkerforgeException
public void setDateTimeCallbackPeriod(long period) throws TinkerforgeException
BrickletGPSV2.DateTimeListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickletGPSV2.DateTimeListener
listener is only triggered if the date or time changed
since the last triggering.TinkerforgeException
public long getDateTimeCallbackPeriod() throws TinkerforgeException
setDateTimeCallbackPeriod(long)
.TinkerforgeException
public void setSBASConfig(int sbasConfig) throws TinkerforgeException
TinkerforgeException
public int getSBASConfig() throws TinkerforgeException
setSBASConfig(int)
.. versionadded:: 2.0.2$nbsp;(Plugin)TinkerforgeException
public BrickletGPSV2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
writeFirmware(int[])
. The pointer has
to be increased by chunks of size 64. The data is written to flash
every 4 chunks (which equals to one page of size 256).
This function is used by Brick Viewer during flashing. It should not be
necessary to call it in a normal user program.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
setWriteFirmwarePointer(long)
before. The firmware is written
to flash every 4 chunks.
You can only write firmware in bootloader mode.
This function is used by Brick Viewer during flashing. It should not be
necessary to call it in a normal user program.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public BrickletGPSV2.SatelliteSystemStatus getSatelliteSystemStatus(int satelliteSystem) throws TinkerforgeException
TinkerforgeException
public void addPulsePerSecondListener(BrickletGPSV2.PulsePerSecondListener listener)
public void removePulsePerSecondListener(BrickletGPSV2.PulsePerSecondListener listener)
public void addCoordinatesListener(BrickletGPSV2.CoordinatesListener listener)
public void removeCoordinatesListener(BrickletGPSV2.CoordinatesListener listener)
public void addStatusListener(BrickletGPSV2.StatusListener listener)
public void removeStatusListener(BrickletGPSV2.StatusListener listener)
public void addAltitudeListener(BrickletGPSV2.AltitudeListener listener)
public void removeAltitudeListener(BrickletGPSV2.AltitudeListener listener)
public void addMotionListener(BrickletGPSV2.MotionListener listener)
public void removeMotionListener(BrickletGPSV2.MotionListener listener)
public void addDateTimeListener(BrickletGPSV2.DateTimeListener listener)
public void removeDateTimeListener(BrickletGPSV2.DateTimeListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.