Software / API Bindings / PHP / API Reference and Examples / Bricklets / GPS Bricklet 3.0

PHP - GPS Bricklet 3.0¶

This is the description of the PHP API bindings for the GPS Bricklet 3.0. General information and technical specifications for the GPS Bricklet 3.0 are summarized in its hardware description.

An installation guide for the PHP API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.0).

Simple¶

Download (ExampleSimple.php)

<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletGPSV3.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletGPSV3;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your GPS Bricklet 3.0

$ipcon = new IPConnection(); // Create IP connection
$gps = new BrickletGPSV3(UID, $ipcon); // Create device object

$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected

// Get current coordinates
$coordinates = $gps->getCoordinates();

echo "Latitude: " . $coordinates['latitude']/1000000.0 . " °\n";
echo "N/S: " . $coordinates['ns'] . "\n";
echo "Longitude: " . $coordinates['longitude']/1000000.0 . " °\n";
echo "E/W: " . $coordinates['ew'] . "\n";

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Callback¶

Download (ExampleCallback.php)

<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletGPSV3.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletGPSV3;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your GPS Bricklet 3.0

// Callback function for coordinates callback
function cb_coordinates($latitude, $ns, $longitude, $ew)
{
    echo "Latitude: " . $latitude/1000000.0 . " °\n";
    echo "N/S: $ns\n";
    echo "Longitude: " . $longitude/1000000.0 . " °\n";
    echo "E/W: $ew\n";
    echo "\n";
}

$ipcon = new IPConnection(); // Create IP connection
$gps = new BrickletGPSV3(UID, $ipcon); // Create device object

$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected

// Register coordinates callback to function cb_coordinates
$gps->registerCallback(BrickletGPSV3::CALLBACK_COORDINATES, 'cb_coordinates');

// Set period for coordinates callback to 1s (1000ms)
// Note: The coordinates callback is only called every second
//       if the coordinates has changed since the last call!
$gps->setCoordinatesCallbackPeriod(1000);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API¶

Functions that return multiple values return them in an associative array.

Basic Functions¶

class BrickletGPSV3(string $uid, IPConnection $ipcon)¶

Parameters:	$uid – Type: string $ipcon – Type: IPConnection
Returns:	$gps_v3 – Type: BrickletGPSV3

Creates an object with the unique device ID $uid:

<?php   $gps_v3 = new BrickletGPSV3('YOUR_DEVICE_UID', $ipcon);   ?>

This object can then be used after the IP Connection is connected.

array BrickletGPSV3::getCoordinates()¶

Return Array:	'latitude' – Type: int, Unit: 1/1000000 °, Range: [0 to 90000000] 'ns' – Type: string, Range: ['N', 'S'] 'longitude' – Type: int, Unit: 1/1000000 °, Range: [0 to 180000000] 'ew' – Type: string, Range: ['E', 'W']

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 getStatus().

array BrickletGPSV3::getStatus()¶

Return Array:	'has_fix' – Type: bool 'satellites_view' – Type: int, Range: [0 to 255]

Returns if a fix is currently available as well as the number of satellites that are in view.

There is also a green LED on the Bricklet that indicates the fix status.

array BrickletGPSV3::getAltitude()¶

Return Array:	'altitude' – Type: int, Unit: 1 cm, Range: [-2³¹ to 2³¹ - 1] 'geoidal_separation' – Type: int, Unit: 1 cm, Range: [-2³¹ to 2³¹ - 1]

Returns the current altitude and corresponding geoidal separation.

This data is only valid if there is currently a fix as indicated by getStatus().

array BrickletGPSV3::getMotion()¶

Return Array:	'course' – Type: int, Unit: 1/100 °, Range: [0 to 36000] 'speed' – Type: int, Unit: 1/100 km/h, Range: [0 to 2³² - 1]

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 by getStatus().

array BrickletGPSV3::getDateTime()¶

Return Array:	'date' – Type: int, Range: [10100 to 311299] 'time' – Type: int, Range: [0 to 235959999]

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.

array BrickletGPSV3::getSatelliteSystemStatus(int $satellite_system)¶

Parameters:	$satellite_system – Type: int, Range: See constants
Return Array:	'satellite_numbers' – Type: array(int, ...), Length: variable, Range: [0 to 255] 'fix' – Type: int, Range: See constants 'pdop' – Type: int, Unit: 1/100, Range: [0 to 2¹⁶ - 1] 'hdop' – Type: int, Unit: 1/100, Range: [0 to 2¹⁶ - 1] 'vdop' – Type: int, Unit: 1/100, Range: [0 to 2¹⁶ - 1]

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, GLONASS and Galileo are 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.

The following constants are available for this function:

For $satellite_system:

BrickletGPSV3::SATELLITE_SYSTEM_GPS = 0
BrickletGPSV3::SATELLITE_SYSTEM_GLONASS = 1
BrickletGPSV3::SATELLITE_SYSTEM_GALILEO = 2

For $fix:

BrickletGPSV3::FIX_NO_FIX = 1
BrickletGPSV3::FIX_2D_FIX = 2
BrickletGPSV3::FIX_3D_FIX = 3

array BrickletGPSV3::getSatelliteStatus(int $satellite_system, int $satellite_number)¶

Parameters:	$satellite_system – Type: int, Range: See constants $satellite_number – Type: int, Range: [1 to 32]
Return Array:	'elevation' – Type: int, Unit: 1 °, Range: [0 to 90] 'azimuth' – Type: int, Unit: 1 °, Range: [0 to 359] 'snr' – Type: int, Unit: 1 dB, Range: [0 to 99]

Returns the current elevation, azimuth and SNR for a given satellite and satellite system.

The available satellite numbers are:

GPS: 1-32
GLONASS: 65-96
Galileo: 301-332

The following constants are available for this function:

For $satellite_system:

BrickletGPSV3::SATELLITE_SYSTEM_GPS = 0
BrickletGPSV3::SATELLITE_SYSTEM_GLONASS = 1
BrickletGPSV3::SATELLITE_SYSTEM_GALILEO = 2

Advanced Functions¶

void BrickletGPSV3::restart(int $restart_type)¶

Parameters:	$restart_type – Type: int, Range: See constants

Restarts the GPS Bricklet, the following restart types are available:

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)

The following constants are available for this function:

For $restart_type:

BrickletGPSV3::RESTART_TYPE_HOT_START = 0
BrickletGPSV3::RESTART_TYPE_WARM_START = 1
BrickletGPSV3::RESTART_TYPE_COLD_START = 2
BrickletGPSV3::RESTART_TYPE_FACTORY_RESET = 3

void BrickletGPSV3::setFixLEDConfig(int $config)¶

Parameters:	$config – Type: int, Range: See constants, Default: 3

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.

The following constants are available for this function:

For $config:

BrickletGPSV3::FIX_LED_CONFIG_OFF = 0
BrickletGPSV3::FIX_LED_CONFIG_ON = 1
BrickletGPSV3::FIX_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletGPSV3::FIX_LED_CONFIG_SHOW_FIX = 3
BrickletGPSV3::FIX_LED_CONFIG_SHOW_PPS = 4

int BrickletGPSV3::getFixLEDConfig()¶

Returns:	$config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setFixLEDConfig()

The following constants are available for this function:

For $config:

BrickletGPSV3::FIX_LED_CONFIG_OFF = 0
BrickletGPSV3::FIX_LED_CONFIG_ON = 1
BrickletGPSV3::FIX_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletGPSV3::FIX_LED_CONFIG_SHOW_FIX = 3
BrickletGPSV3::FIX_LED_CONFIG_SHOW_PPS = 4

void BrickletGPSV3::setSBASConfig(int $sbas_config)¶

Parameters:	$sbas_config – Type: int, Range: See constants, Default: 0

If SBAS 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.

The following constants are available for this function:

For $sbas_config:

BrickletGPSV3::SBAS_ENABLED = 0
BrickletGPSV3::SBAS_DISABLED = 1

int BrickletGPSV3::getSBASConfig()¶

Returns:	$sbas_config – Type: int, Range: See constants, Default: 0

Returns the SBAS configuration as set by setSBASConfig()

The following constants are available for this function:

For $sbas_config:

BrickletGPSV3::SBAS_ENABLED = 0
BrickletGPSV3::SBAS_DISABLED = 1

array BrickletGPSV3::getSPITFPErrorCount()¶

Return Array:	'error_count_ack_checksum' – Type: int, Range: [0 to 2³² - 1] 'error_count_message_checksum' – Type: int, Range: [0 to 2³² - 1] 'error_count_frame' – Type: int, Range: [0 to 2³² - 1] 'error_count_overflow' – Type: int, Range: [0 to 2³² - 1]

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.

void BrickletGPSV3::setStatusLEDConfig(int $config)¶

Parameters:	$config – Type: int, Range: See constants, Default: 3

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.

The following constants are available for this function:

For $config:

BrickletGPSV3::STATUS_LED_CONFIG_OFF = 0
BrickletGPSV3::STATUS_LED_CONFIG_ON = 1
BrickletGPSV3::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletGPSV3::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletGPSV3::getStatusLEDConfig()¶

Returns:	$config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For $config:

BrickletGPSV3::STATUS_LED_CONFIG_OFF = 0
BrickletGPSV3::STATUS_LED_CONFIG_ON = 1
BrickletGPSV3::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletGPSV3::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletGPSV3::getChipTemperature()¶

Returns:	$temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

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.

void BrickletGPSV3::reset()¶

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!

array BrickletGPSV3::getIdentity()¶

Return Array:

Return Array:	'uid' – Type: string, Length: up to 8 'connected_uid' – Type: string, Length: up to 8 'position' – Type: string, Range: ['a' to 'h', 'z'] 'hardware_version' – Type: array(int, ...), Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255] 'firmware_version' – Type: array(int, ...), Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255] 'device_identifier' – Type: int, Range: [0 to 2¹⁶ - 1]

'uid' – Type: string, Length: up to 8
'connected_uid' – Type: string, Length: up to 8
'position' – Type: string, Range: ['a' to 'h', 'z']
'hardware_version' – Type: array(int, ...), Length: 3

0: $major – Type: int, Range: [0 to 255]
1: $minor – Type: int, Range: [0 to 255]
2: $revision – Type: int, Range: [0 to 255]

'firmware_version' – Type: array(int, ...), Length: 3

0: $major – Type: int, Range: [0 to 255]
1: $minor – Type: int, Range: [0 to 255]
2: $revision – Type: int, Range: [0 to 255]

'device_identifier' – Type: int, Range: [0 to 2¹⁶ - 1]

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 Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

void BrickletGPSV3::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)¶

Parameters:	$callback_id – Type: int $callback – Type: callable $user_data – Type: mixed

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

void BrickletGPSV3::setCoordinatesCallbackPeriod(int $period)¶

Parameters:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the CALLBACK_COORDINATES callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_COORDINATES callback is only triggered if the coordinates changed since the last triggering.

int BrickletGPSV3::getCoordinatesCallbackPeriod()¶

Returns:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by setCoordinatesCallbackPeriod().

void BrickletGPSV3::setStatusCallbackPeriod(int $period)¶

Parameters:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the CALLBACK_STATUS callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_STATUS callback is only triggered if the status changed since the last triggering.

int BrickletGPSV3::getStatusCallbackPeriod()¶

Returns:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by setStatusCallbackPeriod().

void BrickletGPSV3::setAltitudeCallbackPeriod(int $period)¶

Parameters:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the CALLBACK_ALTITUDE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_ALTITUDE callback is only triggered if the altitude changed since the last triggering.

int BrickletGPSV3::getAltitudeCallbackPeriod()¶

Returns:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by setAltitudeCallbackPeriod().

void BrickletGPSV3::setMotionCallbackPeriod(int $period)¶

Parameters:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the CALLBACK_MOTION callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_MOTION callback is only triggered if the motion changed since the last triggering.

int BrickletGPSV3::getMotionCallbackPeriod()¶

Returns:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by setMotionCallbackPeriod().

void BrickletGPSV3::setDateTimeCallbackPeriod(int $period)¶

Parameters:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the CALLBACK_DATE_TIME callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_DATE_TIME callback is only triggered if the date or time changed since the last triggering.

int BrickletGPSV3::getDateTimeCallbackPeriod()¶

Returns:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by setDateTimeCallbackPeriod().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$gps_v3->registerCallback(BrickletGPSV3::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

int BrickletGPSV3::CALLBACK_PULSE_PER_SECOND¶

<?php   void callback([mixed $user_data])   ?>

Callback Parameters:	$user_data – Type: mixed

This callback is triggered precisely once per second, see PPS.

The precision of two subsequent pulses will be skewed because of the latency in the USB/RS485/Ethernet connection. But in the long run this will be very precise. For example a count of 3600 pulses will take exactly 1 hour.

int BrickletGPSV3::CALLBACK_COORDINATES¶

<?php   void callback(int $latitude, string $ns, int $longitude, string $ew [, mixed $user_data])   ?>

Callback Parameters:	$latitude – Type: int, Unit: 1/1000000 °, Range: [0 to 90000000] $ns – Type: string, Range: ['N', 'S'] $longitude – Type: int, Unit: 1/1000000 °, Range: [0 to 180000000] $ew – Type: string, Range: ['E', 'W'] $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setCoordinatesCallbackPeriod(). The parameters are the same as for getCoordinates().

The CALLBACK_COORDINATES callback is only triggered if the coordinates changed since the last triggering and if there is currently a fix as indicated by getStatus().

int BrickletGPSV3::CALLBACK_STATUS¶

<?php   void callback(bool $has_fix, int $satellites_view [, mixed $user_data])   ?>

Callback Parameters:	$has_fix – Type: bool $satellites_view – Type: int, Range: [0 to 255] $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setStatusCallbackPeriod(). The parameters are the same as for getStatus().

The CALLBACK_STATUS callback is only triggered if the status changed since the last triggering.

int BrickletGPSV3::CALLBACK_ALTITUDE¶

<?php   void callback(int $altitude, int $geoidal_separation [, mixed $user_data])   ?>

Callback Parameters:	$altitude – Type: int, Unit: 1 cm, Range: [-2³¹ to 2³¹ - 1] $geoidal_separation – Type: int, Unit: 1 cm, Range: [-2³¹ to 2³¹ - 1] $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setAltitudeCallbackPeriod(). The parameters are the same as for getAltitude().

The CALLBACK_ALTITUDE callback is only triggered if the altitude changed since the last triggering and if there is currently a fix as indicated by getStatus().

int BrickletGPSV3::CALLBACK_MOTION¶

<?php   void callback(int $course, int $speed [, mixed $user_data])   ?>

Callback Parameters:	$course – Type: int, Unit: 1/100 °, Range: [0 to 36000] $speed – Type: int, Unit: 1/100 km/h, Range: [0 to 2³² - 1] $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setMotionCallbackPeriod(). The parameters are the same as for getMotion().

The CALLBACK_MOTION callback is only triggered if the motion changed since the last triggering and if there is currently a fix as indicated by getStatus().

int BrickletGPSV3::CALLBACK_DATE_TIME¶

<?php   void callback(int $date, int $time [, mixed $user_data])   ?>

Callback Parameters:	$date – Type: int, Range: [10100 to 311299] $time – Type: int, Range: [0 to 235959999] $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setDateTimeCallbackPeriod(). The parameters are the same as for getDateTime().

The CALLBACK_DATE_TIME callback is only triggered if the date or time changed since the last triggering.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

array BrickletGPSV3::getAPIVersion()¶

Return Array:	$api_version – Type: array(int, ...), Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

bool BrickletGPSV3::getResponseExpected(int $function_id)¶

Parameters:	$function_id – Type: int, Range: See constants
Returns:	$response_expected – Type: bool

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

BrickletGPSV3::FUNCTION_RESTART = 6
BrickletGPSV3::FUNCTION_SET_FIX_LED_CONFIG = 9
BrickletGPSV3::FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 11
BrickletGPSV3::FUNCTION_SET_STATUS_CALLBACK_PERIOD = 13
BrickletGPSV3::FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 15
BrickletGPSV3::FUNCTION_SET_MOTION_CALLBACK_PERIOD = 17
BrickletGPSV3::FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 19
BrickletGPSV3::FUNCTION_SET_SBAS_CONFIG = 27
BrickletGPSV3::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletGPSV3::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletGPSV3::FUNCTION_RESET = 243
BrickletGPSV3::FUNCTION_WRITE_UID = 248

void BrickletGPSV3::setResponseExpected(int $function_id, bool $response_expected)¶

Parameters:	$function_id – Type: int, Range: See constants $response_expected – Type: bool

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For $function_id:

BrickletGPSV3::FUNCTION_RESTART = 6
BrickletGPSV3::FUNCTION_SET_FIX_LED_CONFIG = 9
BrickletGPSV3::FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 11
BrickletGPSV3::FUNCTION_SET_STATUS_CALLBACK_PERIOD = 13
BrickletGPSV3::FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 15
BrickletGPSV3::FUNCTION_SET_MOTION_CALLBACK_PERIOD = 17
BrickletGPSV3::FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 19
BrickletGPSV3::FUNCTION_SET_SBAS_CONFIG = 27
BrickletGPSV3::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletGPSV3::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletGPSV3::FUNCTION_RESET = 243
BrickletGPSV3::FUNCTION_WRITE_UID = 248

void BrickletGPSV3::setResponseExpectedAll(bool $response_expected)¶

Parameters:	$response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

int BrickletGPSV3::setBootloaderMode(int $mode)¶

Parameters:	$mode – Type: int, Range: See constants
Returns:	$status – Type: int, Range: See constants

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.

The following constants are available for this function:

For $mode:

BrickletGPSV3::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletGPSV3::BOOTLOADER_MODE_FIRMWARE = 1
BrickletGPSV3::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletGPSV3::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletGPSV3::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For $status:

BrickletGPSV3::BOOTLOADER_STATUS_OK = 0
BrickletGPSV3::BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletGPSV3::BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletGPSV3::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletGPSV3::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletGPSV3::BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletGPSV3::getBootloaderMode()¶

Returns:	$mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For $mode:

BrickletGPSV3::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletGPSV3::BOOTLOADER_MODE_FIRMWARE = 1
BrickletGPSV3::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletGPSV3::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletGPSV3::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletGPSV3::setWriteFirmwarePointer(int $pointer)¶

Parameters:	$pointer – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]

Sets the firmware pointer for writeFirmware(). 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.

int BrickletGPSV3::writeFirmware(array $data)¶

Parameters:	$data – Type: array(int, ...), Length: 64, Range: [0 to 255]
Returns:	$status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() 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.

void BrickletGPSV3::writeUID(int $uid)¶

Parameters:	$uid – Type: int, Range: [0 to 2³² - 1]

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.

int BrickletGPSV3::readUID()¶

Returns:	$uid – Type: int, Range: [0 to 2³² - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

int BrickletGPSV3::DEVICE_IDENTIFIER¶

This constant is used to identify a GPS Bricklet 3.0.

The getIdentity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

string BrickletGPSV3::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a GPS Bricklet 3.0.