Deutsch
English
Menu
Software / API Bindings / C# / API Reference and Examples / Bricklets / GPS Bricklet 3.0

C# - GPS Bricklet 3.0

This is the description of the C# 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 C# API bindings is part of their general description.

Examples

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

Simple

Download (ExampleSimple.cs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your GPS Bricklet 3.0

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletGPSV3 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
        long latitude, longitude; char ns, ew;
        gps.GetCoordinates(out latitude, out ns, out longitude, out ew);

        Console.WriteLine("Latitude: " + latitude/1000000.0 + " °");
        Console.WriteLine("N/S: " + ns);
        Console.WriteLine("Longitude: " + longitude/1000000.0 + " °");
        Console.WriteLine("E/W: " + ew);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Callback

Download (ExampleCallback.cs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your GPS Bricklet 3.0

    // Callback function for coordinates callback
    static void CoordinatesCB(BrickletGPSV3 sender, long latitude, char ns,
                              long longitude, char ew)
    {
        Console.WriteLine("Latitude: " + latitude/1000000.0 + " °");
        Console.WriteLine("N/S: " + ns);
        Console.WriteLine("Longitude: " + longitude/1000000.0 + " °");
        Console.WriteLine("E/W: " + ew);
        Console.WriteLine("");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletGPSV3 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 CoordinatesCB
        gps.CoordinatesCallback += CoordinatesCB;

        // 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);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

API

Generally, every method of the C# bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since C# does not support multiple return values directly, we use the out keyword to return multiple values from a method.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

All methods listed below are thread-safe.

Basic Functions

class BrickletGPSV3(string uid, IPConnection ipcon)
Parameters:
  • uid – Type: string
  • ipcon – Type: IPConnection
Returns:
  • gpsV3 – Type: BrickletGPSV3

Creates an object with the unique device ID uid:

BrickletGPSV3 gpsV3 = new BrickletGPSV3("YOUR_DEVICE_UID", ipcon);

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

void BrickletGPSV3.GetCoordinates(out long latitude, out char ns, out long longitude, out char ew)
Output Parameters:
  • latitude – Type: long, Unit: 1/1000000 °, Range: [0 to 90000000]
  • ns – Type: char, Range: ['N', 'S']
  • longitude – Type: long, Unit: 1/1000000 °, Range: [0 to 180000000]
  • ew – Type: char, 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().

void BrickletGPSV3.GetStatus(out bool hasFix, out byte satellitesView)
Output Parameters:
  • hasFix – Type: bool
  • satellitesView – Type: byte, 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.

void BrickletGPSV3.GetAltitude(out int altitude, out int geoidalSeparation)
Output Parameters:
  • altitude – Type: int, Unit: 1 cm, Range: [-231 to 231 - 1]
  • geoidalSeparation – Type: int, Unit: 1 cm, Range: [-231 to 231 - 1]

Returns the current altitude and corresponding geoidal separation.

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

void BrickletGPSV3.GetMotion(out long course, out long speed)
Output Parameters:
  • course – Type: long, Unit: 1/100 °, Range: [0 to 36000]
  • speed – Type: long, Unit: 1/100 km/h, Range: [0 to 232 - 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().

void BrickletGPSV3.GetDateTime(out long date, out long time)
Output Parameters:
  • date – Type: long, Range: [10100 to 311299]
  • time – Type: long, 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.

void BrickletGPSV3.GetSatelliteSystemStatus(byte satelliteSystem, out byte[] satelliteNumbers, out byte fix, out int pdop, out int hdop, out int vdop)
Parameters:
  • satelliteSystem – Type: byte, Range: See constants
Output Parameters:
  • satelliteNumbers – Type: byte[], Length: variable, Range: [0 to 255]
  • fix – Type: byte, Range: See constants
  • pdop – Type: int, Unit: 1/100, Range: [0 to 216 - 1]
  • hdop – Type: int, Unit: 1/100, Range: [0 to 216 - 1]
  • vdop – Type: int, Unit: 1/100, Range: [0 to 216 - 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 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.

The following constants are available for this function:

For satelliteSystem:

  • 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
void BrickletGPSV3.GetSatelliteStatus(byte satelliteSystem, byte satelliteNumber, out short elevation, out short azimuth, out short snr)
Parameters:
  • satelliteSystem – Type: byte, Range: See constants
  • satelliteNumber – Type: byte, Range: [1 to 32]
Output Parameters:
  • elevation – Type: short, Unit: 1 °, Range: [0 to 90]
  • azimuth – Type: short, Unit: 1 °, Range: [0 to 359]
  • snr – Type: short, Unit: 1 dB, Range: [0 to 99]

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.

The following constants are available for this function:

For satelliteSystem:

  • BrickletGPSV3.SATELLITE_SYSTEM_GPS = 0
  • BrickletGPSV3.SATELLITE_SYSTEM_GLONASS = 1
  • BrickletGPSV3.SATELLITE_SYSTEM_GALILEO = 2

Advanced Functions

void BrickletGPSV3.Restart(byte restartType)
Parameters:
  • restartType – Type: byte, 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 restartType:

  • 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(byte config)
Parameters:
  • config – Type: byte, 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
byte BrickletGPSV3.GetFixLEDConfig()
Returns:
  • config – Type: byte, 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(byte sbasConfig)
Parameters:
  • sbasConfig – Type: byte, 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 sbasConfig:

  • BrickletGPSV3.SBAS_ENABLED = 0
  • BrickletGPSV3.SBAS_DISABLED = 1
byte BrickletGPSV3.GetSBASConfig()
Returns:
  • sbasConfig – Type: byte, Range: See constants, Default: 0

Returns the SBAS configuration as set by SetSBASConfig()

The following constants are available for this function:

For sbasConfig:

  • BrickletGPSV3.SBAS_ENABLED = 0
  • BrickletGPSV3.SBAS_DISABLED = 1
void BrickletGPSV3.GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)
Output Parameters:
  • errorCountAckChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: long, Range: [0 to 232 - 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(byte config)
Parameters:
  • config – Type: byte, 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
byte BrickletGPSV3.GetStatusLEDConfig()
Returns:
  • config – Type: byte, 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
short BrickletGPSV3.GetChipTemperature()
Returns:
  • temperature – Type: short, Unit: 1 °C, Range: [-215 to 215 - 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!

void BrickletGPSV3.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)
Output Parameters:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: byte[], Length: 3
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, Range: [0 to 255]
  • firmwareVersion – Type: byte[], Length: 3
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, Range: [0 to 255]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 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.SetCoordinatesCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

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

long BrickletGPSV3.GetCoordinatesCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetCoordinatesCallbackPeriod().

void BrickletGPSV3.SetStatusCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

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

long BrickletGPSV3.GetStatusCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetStatusCallbackPeriod().

void BrickletGPSV3.SetAltitudeCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

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

long BrickletGPSV3.GetAltitudeCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetAltitudeCallbackPeriod().

void BrickletGPSV3.SetMotionCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

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

long BrickletGPSV3.GetMotionCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetMotionCallbackPeriod().

void BrickletGPSV3.SetDateTimeCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

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

long BrickletGPSV3.GetDateTimeCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 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 by appending your callback handler to the corresponding event:

void MyCallback(BrickletGPSV3 sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

gpsV3.ExampleCallback += MyCallback;

The available events 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.

event BrickletGPSV3.PulsePerSecondCallback(BrickletGPSV3 sender)
Callback Parameters:
  • sender – Type: BrickletGPSV3

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.

event BrickletGPSV3.CoordinatesCallback(BrickletGPSV3 sender, long latitude, char ns, long longitude, char ew)
Callback Parameters:
  • sender – Type: BrickletGPSV3
  • latitude – Type: long, Unit: 1/1000000 °, Range: [0 to 90000000]
  • ns – Type: char, Range: ['N', 'S']
  • longitude – Type: long, Unit: 1/1000000 °, Range: [0 to 180000000]
  • ew – Type: char, Range: ['E', 'W']

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

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

event BrickletGPSV3.StatusCallback(BrickletGPSV3 sender, bool hasFix, byte satellitesView)
Callback Parameters:
  • sender – Type: BrickletGPSV3
  • hasFix – Type: bool
  • satellitesView – Type: byte, Range: [0 to 255]

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

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

event BrickletGPSV3.AltitudeCallback(BrickletGPSV3 sender, int altitude, int geoidalSeparation)
Callback Parameters:
  • sender – Type: BrickletGPSV3
  • altitude – Type: int, Unit: 1 cm, Range: [-231 to 231 - 1]
  • geoidalSeparation – Type: int, Unit: 1 cm, Range: [-231 to 231 - 1]

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

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

event BrickletGPSV3.MotionCallback(BrickletGPSV3 sender, long course, long speed)
Callback Parameters:
  • sender – Type: BrickletGPSV3
  • course – Type: long, Unit: 1/100 °, Range: [0 to 36000]
  • speed – Type: long, Unit: 1/100 km/h, Range: [0 to 232 - 1]

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

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

event BrickletGPSV3.DateTimeCallback(BrickletGPSV3 sender, long date, long time)
Callback Parameters:
  • sender – Type: BrickletGPSV3
  • date – Type: long, Range: [10100 to 311299]
  • time – Type: long, Range: [0 to 235959999]

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

The DateTimeCallback 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.

byte[] BrickletGPSV3.GetAPIVersion()
Output Parameters:
  • apiVersion – Type: byte[], Length: 3
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, 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(byte functionId)
Parameters:
  • functionId – Type: byte, Range: See constants
Returns:
  • responseExpected – 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 functionId:

  • 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(byte functionId, bool responseExpected)
Parameters:
  • functionId – Type: byte, Range: See constants
  • responseExpected – 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.

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 functionId:

  • 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 responseExpected)
Parameters:
  • responseExpected – 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.

byte BrickletGPSV3.SetBootloaderMode(byte mode)
Parameters:
  • mode – Type: byte, Range: See constants
Returns:
  • status – Type: byte, 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
byte BrickletGPSV3.GetBootloaderMode()
Returns:
  • mode – Type: byte, 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(long pointer)
Parameters:
  • pointer – Type: long, Unit: 1 B, Range: [0 to 232 - 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.

byte BrickletGPSV3.WriteFirmware(byte[] data)
Parameters:
  • data – Type: byte[], Length: 64, Range: [0 to 255]
Returns:
  • status – Type: byte, 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(long uid)
Parameters:
  • uid – Type: long, Range: [0 to 232 - 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.

long BrickletGPSV3.ReadUID()
Returns:
  • uid – Type: long, Range: [0 to 232 - 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.EnumerateCallback 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.