Tinkerforge::BrickletGPSV2 - Determine position, velocity and altitude using GPS
This constant is used to identify a GPS Bricklet 2.0.
The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.
This constant represents the display name of a GPS Bricklet 2.0.
This constant is used with the register_callback() subroutine to specify the CALLBACK_PULSE_PER_SECOND callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_COORDINATES callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_STATUS callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_ALTITUDE callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_MOTION callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_DATE_TIME callback.
This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.
Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.
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 by :func:`Get Status`.
Returns if a fix is currently available as well as the, 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.
Returns the current altitude and corresponding geoidal separation.
Both values are given in cm.
Returns the current course and speed. Course is given in hundredths degree and speed is given in hundredths km/h. 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.
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.05.13 as date and 195923568 means 19:59:23.568 as time.
Restarts the GPS Bricklet, the following restart types are available:
.. csv-table:: :header: "Value", "Description" :widths: 10, 100
"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)"
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.
Returns the current
* elevation (0° - 90°), * azimuth (0° - 359°) and * SNR (0dB - 99dB)
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.
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.
Returns the configuration as set by :func:`Set Fix LED Config`
Sets the period in ms with which the :cb:`Coordinates` callback is triggered periodically. A value of 0 turns the callback off.
The :cb:`Coordinates` callback is only triggered if the coordinates changed since the last triggering.
The default value is 0.
Returns the period as set by :func:`Set Coordinates Callback Period`.
Sets the period in ms with which the :cb:`Status` callback is triggered periodically. A value of 0 turns the callback off.
The :cb:`Status` callback is only triggered if the status changed since the last triggering.
Returns the period as set by :func:`Set Status Callback Period`.
Sets the period in ms with which the :cb:`Altitude` callback is triggered periodically. A value of 0 turns the callback off.
The :cb:`Altitude` callback is only triggered if the altitude changed since the last triggering.
Returns the period as set by :func:`Set Altitude Callback Period`.
Sets the period in ms with which the :cb:`Motion` callback is triggered periodically. A value of 0 turns the callback off.
The :cb:`Motion` callback is only triggered if the motion changed since the last triggering.
Returns the period as set by :func:`Set Motion Callback Period`.
Sets the period in ms with which the :cb:`Date Time` callback is triggered periodically. A value of 0 turns the callback off.
The :cb:`Date Time` callback is only triggered if the date or time changed since the last triggering.
Returns the period as set by :func:`Set Date Time Callback Period`.
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.
By default SBAS is enabled and the update rate is 5Hz.
.. versionadded:: 2.0.2$nbsp;(Plugin)
Returns the SBAS configuration as set by :func:`Set SBAS Config`
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
* ack checksum errors, * message checksum errors, * frameing 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.
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 und 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.
Returns the current bootloader mode, see :func:`Set Bootloader Mode`.
Sets the firmware pointer for :func:`Write Firmware`. 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).
Writes 64 Bytes of firmware at the position as written by :func:`Set Write Firmware Pointer` before. The firmware is written to flash every 4 chunks.
You can only write firmware in bootloader mode.
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.
Returns the configuration as set by :func:`Set Status LED Config`
Returns the temperature in °C 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.
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!
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.
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
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' or 'd'.
The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|
To install Tinkerforge, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tinkerforge
CPAN shell
perl -MCPAN -e shell install Tinkerforge
For more information on module installation, please visit the detailed CPAN module installation guide.