Package com.tinkerforge
Class BrickletGPSV2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletGPSV2
-
public class BrickletGPSV2 extends Device
Determine position, velocity and altitude using GPS
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletGPSV2.Altitude
static interface
BrickletGPSV2.AltitudeListener
This listener is triggered periodically with the period that is set bysetAltitudeCallbackPeriod(long)
.class
BrickletGPSV2.Coordinates
static interface
BrickletGPSV2.CoordinatesListener
This listener is triggered periodically with the period that is set bysetCoordinatesCallbackPeriod(long)
.class
BrickletGPSV2.DateTime
static interface
BrickletGPSV2.DateTimeListener
This listener is triggered periodically with the period that is set bysetDateTimeCallbackPeriod(long)
.class
BrickletGPSV2.Motion
static interface
BrickletGPSV2.MotionListener
This listener is triggered periodically with the period that is set bysetMotionCallbackPeriod(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 bysetStatusCallbackPeriod(long)
.-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletGPSV2(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 bysetAltitudeCallbackPeriod(long)
.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(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 bysetCoordinatesCallbackPeriod(long)
.BrickletGPSV2.DateTime
getDateTime()
Returns the current date and time.long
getDateTimeCallbackPeriod()
Returns the period as set bysetDateTimeCallbackPeriod(long)
.int
getFixLEDConfig()
Returns the configuration as set bysetFixLEDConfig(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 bysetMotionCallbackPeriod(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 bysetSBASConfig(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 number of satellites that are in view.long
getStatusCallbackPeriod()
Returns the period as set bysetStatusCallbackPeriod(long)
.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(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)" \endverbatimvoid
setAltitudeCallbackPeriod(long period)
Sets the period with which theBrickletGPSV2.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 theBrickletGPSV2.CoordinatesListener
listener is triggered periodically.void
setDateTimeCallbackPeriod(long period)
Sets the period with which theBrickletGPSV2.DateTimeListener
listener is triggered periodically.void
setFixLEDConfig(int config)
Sets the fix LED configuration.void
setMotionCallbackPeriod(long period)
Sets the period with which theBrickletGPSV2.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 theBrickletGPSV2.StatusListener
listener is triggered periodically.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.int
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before.void
writeUID(long uid)
Writes a new UID into flash.-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_COORDINATES
public static final byte FUNCTION_GET_COORDINATES
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS
public static final byte FUNCTION_GET_STATUS
- See Also:
- Constant Field Values
-
FUNCTION_GET_ALTITUDE
public static final byte FUNCTION_GET_ALTITUDE
- See Also:
- Constant Field Values
-
FUNCTION_GET_MOTION
public static final byte FUNCTION_GET_MOTION
- See Also:
- Constant Field Values
-
FUNCTION_GET_DATE_TIME
public static final byte FUNCTION_GET_DATE_TIME
- See Also:
- Constant Field Values
-
FUNCTION_RESTART
public static final byte FUNCTION_RESTART
- See Also:
- Constant Field Values
-
FUNCTION_GET_SATELLITE_SYSTEM_STATUS_LOW_LEVEL
public static final byte FUNCTION_GET_SATELLITE_SYSTEM_STATUS_LOW_LEVEL
- See Also:
- Constant Field Values
-
FUNCTION_GET_SATELLITE_STATUS
public static final byte FUNCTION_GET_SATELLITE_STATUS
- See Also:
- Constant Field Values
-
FUNCTION_SET_FIX_LED_CONFIG
public static final byte FUNCTION_SET_FIX_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_FIX_LED_CONFIG
public static final byte FUNCTION_GET_FIX_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_SET_COORDINATES_CALLBACK_PERIOD
public static final byte FUNCTION_SET_COORDINATES_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_COORDINATES_CALLBACK_PERIOD
public static final byte FUNCTION_GET_COORDINATES_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATUS_CALLBACK_PERIOD
public static final byte FUNCTION_SET_STATUS_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS_CALLBACK_PERIOD
public static final byte FUNCTION_GET_STATUS_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD
public static final byte FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_ALTITUDE_CALLBACK_PERIOD
public static final byte FUNCTION_GET_ALTITUDE_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_MOTION_CALLBACK_PERIOD
public static final byte FUNCTION_SET_MOTION_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_MOTION_CALLBACK_PERIOD
public static final byte FUNCTION_GET_MOTION_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD
public static final byte FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD
public static final byte FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_SBAS_CONFIG
public static final byte FUNCTION_SET_SBAS_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_SBAS_CONFIG
public static final byte FUNCTION_GET_SBAS_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_WRITE_FIRMWARE
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_UID
public static final byte FUNCTION_WRITE_UID
- See Also:
- Constant Field Values
-
FUNCTION_READ_UID
public static final byte FUNCTION_READ_UID
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
RESTART_TYPE_HOT_START
public static final int RESTART_TYPE_HOT_START
- See Also:
- Constant Field Values
-
RESTART_TYPE_WARM_START
public static final int RESTART_TYPE_WARM_START
- See Also:
- Constant Field Values
-
RESTART_TYPE_COLD_START
public static final int RESTART_TYPE_COLD_START
- See Also:
- Constant Field Values
-
RESTART_TYPE_FACTORY_RESET
public static final int RESTART_TYPE_FACTORY_RESET
- See Also:
- Constant Field Values
-
SATELLITE_SYSTEM_GPS
public static final int SATELLITE_SYSTEM_GPS
- See Also:
- Constant Field Values
-
SATELLITE_SYSTEM_GLONASS
public static final int SATELLITE_SYSTEM_GLONASS
- See Also:
- Constant Field Values
-
SATELLITE_SYSTEM_GALILEO
public static final int SATELLITE_SYSTEM_GALILEO
- See Also:
- Constant Field Values
-
FIX_NO_FIX
public static final int FIX_NO_FIX
- See Also:
- Constant Field Values
-
FIX_2D_FIX
public static final int FIX_2D_FIX
- See Also:
- Constant Field Values
-
FIX_3D_FIX
public static final int FIX_3D_FIX
- See Also:
- Constant Field Values
-
FIX_LED_CONFIG_OFF
public static final int FIX_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
FIX_LED_CONFIG_ON
public static final int FIX_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
FIX_LED_CONFIG_SHOW_HEARTBEAT
public static final int FIX_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
FIX_LED_CONFIG_SHOW_FIX
public static final int FIX_LED_CONFIG_SHOW_FIX
- See Also:
- Constant Field Values
-
FIX_LED_CONFIG_SHOW_PPS
public static final int FIX_LED_CONFIG_SHOW_PPS
- See Also:
- Constant Field Values
-
SBAS_ENABLED
public static final int SBAS_ENABLED
- See Also:
- Constant Field Values
-
SBAS_DISABLED
public static final int SBAS_DISABLED
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_BOOTLOADER
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_FIRMWARE
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_OK
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_INVALID_MODE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_NO_CHANGE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_CRC_MISMATCH
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_STATUS
public static final int STATUS_LED_CONFIG_SHOW_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletGPSV2
public BrickletGPSV2(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
getCoordinates
public BrickletGPSV2.Coordinates getCoordinates() throws TinkerforgeException
Returns the GPS coordinates. Latitude and longitude are given in the ``DD.dddddd°`` format, the value 57123468 means 57.123468°. The parameter ``ns`` and ``ew`` are the cardinal directions for latitude and longitude. Possible values for ``ns`` and ``ew`` are 'N', 'S', 'E' and 'W' (north, south, east and west). This data is only valid if there is currently a fix as indicated bygetStatus()
.- Throws:
TinkerforgeException
-
getStatus
public BrickletGPSV2.Status getStatus() throws TinkerforgeException
Returns if a fix is currently available as well as the number of satellites that are in view. There is also a :ref:`green LED <gps_v2_bricklet_fix_led>` on the Bricklet that indicates the fix status.- Throws:
TinkerforgeException
-
getAltitude
public BrickletGPSV2.Altitude getAltitude() throws TinkerforgeException
Returns the current altitude and corresponding geoidal separation. This data is only valid if there is currently a fix as indicated bygetStatus()
.- Throws:
TinkerforgeException
-
getMotion
public BrickletGPSV2.Motion getMotion() throws TinkerforgeException
Returns the current course and speed. A course of 0° means the Bricklet is traveling north bound and 90° means it is traveling east bound. Please note that this only returns useful values if an actual movement is present. This data is only valid if there is currently a fix as indicated bygetStatus()
.- Throws:
TinkerforgeException
-
getDateTime
public BrickletGPSV2.DateTime getDateTime() throws TinkerforgeException
Returns the current date and time. The date is given in the format ``ddmmyy`` and the time is given in the format ``hhmmss.sss``. For example, 140713 means 14.07.13 as date and 195923568 means 19:59:23.568 as time.- Throws:
TinkerforgeException
-
restart
public void restart(int restartType) throws TinkerforgeException
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- Throws:
TinkerforgeException
-
getSatelliteSystemStatusLowLevel
public BrickletGPSV2.SatelliteSystemStatusLowLevel getSatelliteSystemStatusLowLevel(int satelliteSystem) throws TinkerforgeException
Returns the * satellite numbers list (up to 12 items) * fix value, * PDOP value, * HDOP value and * VDOP value for a given satellite system. Currently GPS and GLONASS are supported, Galileo is not yet supported. The GPS and GLONASS satellites have unique numbers and the satellite list gives the numbers of the satellites that are currently utilized. The number 0 is not a valid satellite number and can be ignored in the list.- Throws:
TinkerforgeException
-
getSatelliteStatus
public BrickletGPSV2.SatelliteStatus getSatelliteStatus(int satelliteSystem, int satelliteNumber) throws TinkerforgeException
Returns the current elevation, azimuth and SNR for a given satellite and satellite system. The satellite number here always goes from 1 to 32. For GLONASS it corresponds to the satellites 65-96. Galileo is not yet supported.- Throws:
TinkerforgeException
-
setFixLEDConfig
public void setFixLEDConfig(int config) throws TinkerforgeException
Sets the fix LED configuration. By default the LED shows if the Bricklet got a GPS fix yet. If a fix is established the LED turns on. If there is no fix then the LED is turned off. You can also turn the LED permanently on/off, show a heartbeat or let it blink in sync with the PPS (pulse per second) output of the GPS module. If the Bricklet is in bootloader mode, the LED is off.- Throws:
TinkerforgeException
-
getFixLEDConfig
public int getFixLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetFixLEDConfig(int)
- Throws:
TinkerforgeException
-
setCoordinatesCallbackPeriod
public void setCoordinatesCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickletGPSV2.CoordinatesListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickletGPSV2.CoordinatesListener
listener is only triggered if the coordinates changed since the last triggering.- Throws:
TinkerforgeException
-
getCoordinatesCallbackPeriod
public long getCoordinatesCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetCoordinatesCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setStatusCallbackPeriod
public void setStatusCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickletGPSV2.StatusListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickletGPSV2.StatusListener
listener is only triggered if the status changed since the last triggering.- Throws:
TinkerforgeException
-
getStatusCallbackPeriod
public long getStatusCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetStatusCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setAltitudeCallbackPeriod
public void setAltitudeCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickletGPSV2.AltitudeListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickletGPSV2.AltitudeListener
listener is only triggered if the altitude changed since the last triggering.- Throws:
TinkerforgeException
-
getAltitudeCallbackPeriod
public long getAltitudeCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetAltitudeCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setMotionCallbackPeriod
public void setMotionCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickletGPSV2.MotionListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickletGPSV2.MotionListener
listener is only triggered if the motion changed since the last triggering.- Throws:
TinkerforgeException
-
getMotionCallbackPeriod
public long getMotionCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetMotionCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setDateTimeCallbackPeriod
public void setDateTimeCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickletGPSV2.DateTimeListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickletGPSV2.DateTimeListener
listener is only triggered if the date or time changed since the last triggering.- Throws:
TinkerforgeException
-
getDateTimeCallbackPeriod
public long getDateTimeCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetDateTimeCallbackPeriod(long)
.- Throws:
TinkerforgeException
-
setSBASConfig
public void setSBASConfig(int sbasConfig) throws TinkerforgeException
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. With SBAS disabled the update rate is increased to 10Hz. .. versionadded:: 2.0.2$nbsp;(Plugin)- Throws:
TinkerforgeException
-
getSBASConfig
public int getSBASConfig() throws TinkerforgeException
Returns the SBAS configuration as set bysetSBASConfig(int)
.. versionadded:: 2.0.2$nbsp;(Plugin)- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletGPSV2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
Returns the error count for the communication between Brick and Bricklet. The errors are divided into * ACK checksum errors, * message checksum errors, * framing errors and * overflow errors. The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.- Throws:
TinkerforgeException
-
setBootloaderMode
public int setBootloaderMode(int mode) throws TinkerforgeException
Sets the bootloader mode and returns the status after the requested mode change was instigated. You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
getBootloaderMode
public int getBootloaderMode() throws TinkerforgeException
Returns the current bootloader mode, seesetBootloaderMode(int)
.- Throws:
TinkerforgeException
-
setWriteFirmwarePointer
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
Sets the firmware pointer forwriteFirmware(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.- Throws:
TinkerforgeException
-
writeFirmware
public int writeFirmware(int[] data) throws TinkerforgeException
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(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.- Throws:
TinkerforgeException
-
setStatusLEDConfig
public void setStatusLEDConfig(int config) throws TinkerforgeException
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets. You can also turn the LED permanently on/off or show a heartbeat. If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.- Throws:
TinkerforgeException
-
getStatusLEDConfig
public int getStatusLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetStatusLEDConfig(int)
- Throws:
TinkerforgeException
-
getChipTemperature
public int getChipTemperature() throws TinkerforgeException
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature! The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.- Throws:
TinkerforgeException
-
reset
public void reset() throws TinkerforgeException
Calling this function will reset the Bricklet. All configurations will be lost. After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!- Throws:
TinkerforgeException
-
writeUID
public void writeUID(long uid) throws TinkerforgeException
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first. We recommend that you use Brick Viewer to change the UID.- Throws:
TinkerforgeException
-
readUID
public long readUID() throws TinkerforgeException
Returns the current UID as an integer. Encode as Base58 to get the usual string version.- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier. The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
getSatelliteSystemStatus
public BrickletGPSV2.SatelliteSystemStatus getSatelliteSystemStatus(int satelliteSystem) throws TinkerforgeException
Returns the * satellite numbers list (up to 12 items) * fix value, * PDOP value, * HDOP value and * VDOP value for a given satellite system. Currently GPS and GLONASS are supported, Galileo is not yet supported. The GPS and GLONASS satellites have unique numbers and the satellite list gives the numbers of the satellites that are currently utilized. The number 0 is not a valid satellite number and can be ignored in the list.- Throws:
TinkerforgeException
-
addPulsePerSecondListener
public void addPulsePerSecondListener(BrickletGPSV2.PulsePerSecondListener listener)
Adds a PulsePerSecond listener.
-
removePulsePerSecondListener
public void removePulsePerSecondListener(BrickletGPSV2.PulsePerSecondListener listener)
Removes a PulsePerSecond listener.
-
addCoordinatesListener
public void addCoordinatesListener(BrickletGPSV2.CoordinatesListener listener)
Adds a Coordinates listener.
-
removeCoordinatesListener
public void removeCoordinatesListener(BrickletGPSV2.CoordinatesListener listener)
Removes a Coordinates listener.
-
addStatusListener
public void addStatusListener(BrickletGPSV2.StatusListener listener)
Adds a Status listener.
-
removeStatusListener
public void removeStatusListener(BrickletGPSV2.StatusListener listener)
Removes a Status listener.
-
addAltitudeListener
public void addAltitudeListener(BrickletGPSV2.AltitudeListener listener)
Adds a Altitude listener.
-
removeAltitudeListener
public void removeAltitudeListener(BrickletGPSV2.AltitudeListener listener)
Removes a Altitude listener.
-
addMotionListener
public void addMotionListener(BrickletGPSV2.MotionListener listener)
Adds a Motion listener.
-
removeMotionListener
public void removeMotionListener(BrickletGPSV2.MotionListener listener)
Removes a Motion listener.
-
addDateTimeListener
public void addDateTimeListener(BrickletGPSV2.DateTimeListener listener)
Adds a DateTime listener.
-
removeDateTimeListener
public void removeDateTimeListener(BrickletGPSV2.DateTimeListener listener)
Removes a DateTime listener.
-
-