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

Mathematica - GPS Bricklet 3.0¶

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

Examples¶

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

Simple¶

Download (ExampleSimple.nb)

Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your GPS Bricklet 3.0*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
gps=NETNew["Tinkerforge.BrickletGPSV3",uid,ipcon]
ipcon@Connect[host,port]

(*Get current coordinates*)
latitude=0;ns=0;longitude=0;ew=0
gps@GetCoordinates[latitude,ns,longitude,ew]

Print["Latitude: "<>ToString[N[Quantity[latitude,"°/1000000"]]]]
Print["N/S: "<>FromCharacterCode[ns]]
Print["Longitude: "<>ToString[N[Quantity[longitude,"°/1000000"]]]]
Print["E/W: "<>FromCharacterCode[ew]]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[gps]
ReleaseNETObject[ipcon]

Callback¶

Download (ExampleCallback.nb)

Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your GPS Bricklet 3.0*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
gps=NETNew["Tinkerforge.BrickletGPSV3",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for coordinates callback*)
CoordinatesCB[sender_,latitude_,ns_,longitude_,ew_]:=
 Module[{},
  Print["Latitude: "<>ToString[N[Quantity[latitude,"°/1000000"]]]];
  Print["N/S: "<>FromCharacterCode[ns]];
  Print["Longitude: "<>ToString[N[Quantity[longitude,"°/1000000"]]]];
  Print["E/W: "<>FromCharacterCode[ew]]
 ]

AddEventHandler[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]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[gps]
ReleaseNETObject[ipcon]

API¶

Generally, every function of the Mathematica 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 .NET/Link does not support multiple return values directly, we use the out keyword to return multiple values from a function. For further information about the out keyword in .NET/Link see the corresponding Mathematica .NET/Link documentation.

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

Basic Functions¶

BrickletGPSV3[uid, ipcon] → gpsV3¶

Parameters:	uid – Type: String ipcon – Type: NETObject[IPConnection]
Returns:	gpsV3 – Type: NETObject[BrickletGPSV3]

Creates an object with the unique device ID uid:

gpsV3=NETNew["Tinkerforge.BrickletGPSV3","YOUR_DEVICE_UID",ipcon]

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

The .NET runtime has built-in garbage collection that frees objects that are no longer in use by a program. But because Mathematica can not automatically tell when a Mathematica "program" doesn't use a .NET object anymore, this has to be done by the program. For this the ReleaseNETObject[] function is used in the examples.

For further information about object management in .NET/Link see the corresponding Mathematica .NET/Link documentation.

BrickletGPSV3@GetCoordinates[out latitude, out ns, out longitude, out ew] → Null¶

Output Parameters:	latitude – Type: Integer, Unit: 1/1000000 °, Range: [0 to 90000000] ns – Type: Integer, Range: [ToCharacterCode["N"][[0]], ToCharacterCode["S"][[0]]] longitude – Type: Integer, Unit: 1/1000000 °, Range: [0 to 180000000] ew – Type: Integer, Range: [ToCharacterCode["E"][[0]], ToCharacterCode["W"][[0]]]

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[].

BrickletGPSV3@GetStatus[out hasFix, out satellitesView] → Null¶

Output Parameters:	hasFix – Type: True/False satellitesView – Type: Integer, 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.

BrickletGPSV3@GetAltitude[out altitude, out geoidalSeparation] → Null¶

Output Parameters:	altitude – Type: Integer, Unit: 1 cm, Range: [-2³¹ to 2³¹ - 1] geoidalSeparation – Type: Integer, 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[].

BrickletGPSV3@GetMotion[out course, out speed] → Null¶

Output Parameters:	course – Type: Integer, Unit: 1/100 °, Range: [0 to 36000] speed – Type: Integer, 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[].

BrickletGPSV3@GetDateTime[out date, out time] → Null¶

Output Parameters:	date – Type: Integer, Range: [10100 to 311299] time – Type: Integer, 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.

BrickletGPSV3@GetSatelliteSystemStatus[satelliteSystem, out {satelliteNumbers1, satelliteNumbers2, ...}, out fix, out pdop, out hdop, out vdop] → Null¶

Parameters:	satelliteSystem – Type: Integer, Range: See constants
Output Parameters:	satelliteNumbersi – Type: Integer, Range: [0 to 255] fix – Type: Integer, Range: See constants pdop – Type: Integer, Unit: 1/100, Range: [0 to 2¹⁶ - 1] hdop – Type: Integer, Unit: 1/100, Range: [0 to 2¹⁶ - 1] vdop – Type: Integer, 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 satelliteSystem:

BrickletGPSV3`SATELLITEUSYSTEMUGPS = 0
BrickletGPSV3`SATELLITEUSYSTEMUGLONASS = 1
BrickletGPSV3`SATELLITEUSYSTEMUGALILEO = 2

For fix:

BrickletGPSV3`FIXUNOUFIX = 1
BrickletGPSV3`FIXU2DUFIX = 2
BrickletGPSV3`FIXU3DUFIX = 3

BrickletGPSV3@GetSatelliteStatus[satelliteSystem, satelliteNumber, out elevation, out azimuth, out snr] → Null¶

Parameters:	satelliteSystem – Type: Integer, Range: See constants satelliteNumber – Type: Integer, Range: [1 to 32]
Output Parameters:	elevation – Type: Integer, Unit: 1 °, Range: [0 to 90] azimuth – Type: Integer, Unit: 1 °, Range: [0 to 359] snr – Type: Integer, 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 satelliteSystem:

BrickletGPSV3`SATELLITEUSYSTEMUGPS = 0
BrickletGPSV3`SATELLITEUSYSTEMUGLONASS = 1
BrickletGPSV3`SATELLITEUSYSTEMUGALILEO = 2

Advanced Functions¶

BrickletGPSV3@Restart[restartType] → Null¶

Parameters:	restartType – Type: Integer, 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`RESTARTUTYPEUHOTUSTART = 0
BrickletGPSV3`RESTARTUTYPEUWARMUSTART = 1
BrickletGPSV3`RESTARTUTYPEUCOLDUSTART = 2
BrickletGPSV3`RESTARTUTYPEUFACTORYURESET = 3

BrickletGPSV3@SetFixLEDConfig[config] → Null¶

Parameters:	config – Type: Integer, 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`FIXULEDUCONFIGUOFF = 0
BrickletGPSV3`FIXULEDUCONFIGUON = 1
BrickletGPSV3`FIXULEDUCONFIGUSHOWUHEARTBEAT = 2
BrickletGPSV3`FIXULEDUCONFIGUSHOWUFIX = 3
BrickletGPSV3`FIXULEDUCONFIGUSHOWUPPS = 4

BrickletGPSV3@GetFixLEDConfig[] → config¶

Returns:	config – Type: Integer, Range: See constants, Default: 3

Returns the configuration as set by SetFixLEDConfig[]

The following constants are available for this function:

For config:

BrickletGPSV3`FIXULEDUCONFIGUOFF = 0
BrickletGPSV3`FIXULEDUCONFIGUON = 1
BrickletGPSV3`FIXULEDUCONFIGUSHOWUHEARTBEAT = 2
BrickletGPSV3`FIXULEDUCONFIGUSHOWUFIX = 3
BrickletGPSV3`FIXULEDUCONFIGUSHOWUPPS = 4

BrickletGPSV3@SetSBASConfig[sbasConfig] → Null¶

Parameters:	sbasConfig – Type: Integer, 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`SBASUENABLED = 0
BrickletGPSV3`SBASUDISABLED = 1

BrickletGPSV3@GetSBASConfig[] → sbasConfig¶

Returns:	sbasConfig – Type: Integer, Range: See constants, Default: 0

Returns the SBAS configuration as set by SetSBASConfig[]

The following constants are available for this function:

For sbasConfig:

BrickletGPSV3`SBASUENABLED = 0
BrickletGPSV3`SBASUDISABLED = 1

BrickletGPSV3@GetSPITFPErrorCount[out errorCountAckChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null¶

Output Parameters:	errorCountAckChecksum – Type: Integer, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: Integer, Range: [0 to 2³² - 1] errorCountFrame – Type: Integer, Range: [0 to 2³² - 1] errorCountOverflow – Type: Integer, 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.

BrickletGPSV3@SetStatusLEDConfig[config] → Null¶

Parameters:	config – Type: Integer, 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`STATUSULEDUCONFIGUOFF = 0
BrickletGPSV3`STATUSULEDUCONFIGUON = 1
BrickletGPSV3`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
BrickletGPSV3`STATUSULEDUCONFIGUSHOWUSTATUS = 3

BrickletGPSV3@GetStatusLEDConfig[] → config¶

Returns:	config – Type: Integer, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig[]

The following constants are available for this function:

For config:

BrickletGPSV3`STATUSULEDUCONFIGUOFF = 0
BrickletGPSV3`STATUSULEDUCONFIGUON = 1
BrickletGPSV3`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
BrickletGPSV3`STATUSULEDUCONFIGUSHOWUSTATUS = 3

BrickletGPSV3@GetChipTemperature[] → temperature¶

Returns:	temperature – Type: Integer, 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.

BrickletGPSV3@Reset[] → Null¶

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!

BrickletGPSV3@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null¶

Output Parameters:

Output Parameters:	uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Integer, Range: [ToCharacterCode["a"][[0]] to ToCharacterCode["h"][[0]], ToCharacterCode["z"][[0]]] hardwareVersioni – Type: Integer 1: major – Type: Integer, Range: [0 to 255] 2: minor – Type: Integer, Range: [0 to 255] 3: revision – Type: Integer, Range: [0 to 255] firmwareVersioni – Type: Integer 1: major – Type: Integer, Range: [0 to 255] 2: minor – Type: Integer, Range: [0 to 255] 3: revision – Type: Integer, Range: [0 to 255] deviceIdentifier – Type: Integer, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connectedUid – Type: String, Length: up to 8
position – Type: Integer, Range: [ToCharacterCode["a"][[0]] to ToCharacterCode["h"][[0]], ToCharacterCode["z"][[0]]]
hardwareVersioni – Type: Integer

1: major – Type: Integer, Range: [0 to 255]
2: minor – Type: Integer, Range: [0 to 255]
3: revision – Type: Integer, Range: [0 to 255]

firmwareVersioni – Type: Integer

1: major – Type: Integer, Range: [0 to 255]
2: minor – Type: Integer, Range: [0 to 255]
3: revision – Type: Integer, Range: [0 to 255]

deviceIdentifier – Type: Integer, 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¶

BrickletGPSV3@SetCoordinatesCallbackPeriod[period] → Null¶

Parameters:	period – Type: Integer, Unit: 1 ms, Range: [0 to 2³² - 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.

BrickletGPSV3@GetCoordinatesCallbackPeriod[] → period¶

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

Returns the period as set by SetCoordinatesCallbackPeriod[].

BrickletGPSV3@SetStatusCallbackPeriod[period] → Null¶

Parameters:	period – Type: Integer, Unit: 1 ms, Range: [0 to 2³² - 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.

BrickletGPSV3@GetStatusCallbackPeriod[] → period¶

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

Returns the period as set by SetStatusCallbackPeriod[].

BrickletGPSV3@SetAltitudeCallbackPeriod[period] → Null¶

Parameters:	period – Type: Integer, Unit: 1 ms, Range: [0 to 2³² - 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.

BrickletGPSV3@GetAltitudeCallbackPeriod[] → period¶

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

Returns the period as set by SetAltitudeCallbackPeriod[].

BrickletGPSV3@SetMotionCallbackPeriod[period] → Null¶

Parameters:	period – Type: Integer, Unit: 1 ms, Range: [0 to 2³² - 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.

BrickletGPSV3@GetMotionCallbackPeriod[] → period¶

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

Returns the period as set by SetMotionCallbackPeriod[].

BrickletGPSV3@SetDateTimeCallbackPeriod[period] → Null¶

Parameters:	period – Type: Integer, Unit: 1 ms, Range: [0 to 2³² - 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.

BrickletGPSV3@GetDateTimeCallbackPeriod[] → period¶

Returns:	period – Type: Integer, 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 by assigning a function to a callback property of the device object:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[gpsV3@ExampleCallback,MyCallback]

For further information about event handling using .NET/Link see the corresponding Mathematica .NET/Link documentation.

The available callback property and their type of parameters 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[sender]¶

Callback Parameters:	sender – Type: NETObject[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[sender, latitude, ns, longitude, ew]¶

Callback Parameters:	sender – Type: NETObject[BrickletGPSV3] latitude – Type: Integer, Unit: 1/1000000 °, Range: [0 to 90000000] ns – Type: Integer, Range: [ToCharacterCode["N"][[0]], ToCharacterCode["S"][[0]]] longitude – Type: Integer, Unit: 1/1000000 °, Range: [0 to 180000000] ew – Type: Integer, Range: [ToCharacterCode["E"][[0]], ToCharacterCode["W"][[0]]]

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[sender, hasFix, satellitesView]¶

Callback Parameters:	sender – Type: NETObject[BrickletGPSV3] hasFix – Type: True/False satellitesView – Type: Integer, 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[sender, altitude, geoidalSeparation]¶

Callback Parameters:	sender – Type: NETObject[BrickletGPSV3] altitude – Type: Integer, Unit: 1 cm, Range: [-2³¹ to 2³¹ - 1] geoidalSeparation – Type: Integer, Unit: 1 cm, Range: [-2³¹ to 2³¹ - 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[sender, course, speed]¶

Callback Parameters:	sender – Type: NETObject[BrickletGPSV3] course – Type: Integer, Unit: 1/100 °, Range: [0 to 36000] speed – Type: Integer, Unit: 1/100 km/h, Range: [0 to 2³² - 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[sender, date, time]¶

Callback Parameters:	sender – Type: NETObject[BrickletGPSV3] date – Type: Integer, Range: [10100 to 311299] time – Type: Integer, 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.

BrickletGPSV3@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}¶

Output Parameters:	apiVersioni – Type: Integer 1: major – Type: Integer, Range: [0 to 255] 2: minor – Type: Integer, Range: [0 to 255] 3: revision – Type: Integer, 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.

BrickletGPSV3@GetResponseExpected[functionId] → responseExpected¶

Parameters:	functionId – Type: Integer, Range: See constants
Returns:	responseExpected – Type: True/False

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`FUNCTIONURESTART = 6
BrickletGPSV3`FUNCTIONUSETUFIXULEDUCONFIG = 9
BrickletGPSV3`FUNCTIONUSETUCOORDINATESUCALLBACKUPERIOD = 11
BrickletGPSV3`FUNCTIONUSETUSTATUSUCALLBACKUPERIOD = 13
BrickletGPSV3`FUNCTIONUSETUALTITUDEUCALLBACKUPERIOD = 15
BrickletGPSV3`FUNCTIONUSETUMOTIONUCALLBACKUPERIOD = 17
BrickletGPSV3`FUNCTIONUSETUDATEUTIMEUCALLBACKUPERIOD = 19
BrickletGPSV3`FUNCTIONUSETUSBASUCONFIG = 27
BrickletGPSV3`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
BrickletGPSV3`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
BrickletGPSV3`FUNCTIONURESET = 243
BrickletGPSV3`FUNCTIONUWRITEUUID = 248

BrickletGPSV3@SetResponseExpected[functionId, responseExpected] → Null¶

Parameters:	functionId – Type: Integer, Range: See constants responseExpected – Type: True/False

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

BrickletGPSV3`FUNCTIONURESTART = 6
BrickletGPSV3`FUNCTIONUSETUFIXULEDUCONFIG = 9
BrickletGPSV3`FUNCTIONUSETUCOORDINATESUCALLBACKUPERIOD = 11
BrickletGPSV3`FUNCTIONUSETUSTATUSUCALLBACKUPERIOD = 13
BrickletGPSV3`FUNCTIONUSETUALTITUDEUCALLBACKUPERIOD = 15
BrickletGPSV3`FUNCTIONUSETUMOTIONUCALLBACKUPERIOD = 17
BrickletGPSV3`FUNCTIONUSETUDATEUTIMEUCALLBACKUPERIOD = 19
BrickletGPSV3`FUNCTIONUSETUSBASUCONFIG = 27
BrickletGPSV3`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
BrickletGPSV3`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
BrickletGPSV3`FUNCTIONURESET = 243
BrickletGPSV3`FUNCTIONUWRITEUUID = 248

BrickletGPSV3@SetResponseExpectedAll[responseExpected] → Null¶

Parameters:	responseExpected – Type: True/False

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.

BrickletGPSV3@SetBootloaderMode[mode] → status¶

Parameters:	mode – Type: Integer, Range: See constants
Returns:	status – Type: Integer, 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`BOOTLOADERUMODEUBOOTLOADER = 0
BrickletGPSV3`BOOTLOADERUMODEUFIRMWARE = 1
BrickletGPSV3`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
BrickletGPSV3`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
BrickletGPSV3`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4

For status:

BrickletGPSV3`BOOTLOADERUSTATUSUOK = 0
BrickletGPSV3`BOOTLOADERUSTATUSUINVALIDUMODE = 1
BrickletGPSV3`BOOTLOADERUSTATUSUNOUCHANGE = 2
BrickletGPSV3`BOOTLOADERUSTATUSUENTRYUFUNCTIONUNOTUPRESENT = 3
BrickletGPSV3`BOOTLOADERUSTATUSUDEVICEUIDENTIFIERUINCORRECT = 4
BrickletGPSV3`BOOTLOADERUSTATUSUCRCUMISMATCH = 5

BrickletGPSV3@GetBootloaderMode[] → mode¶

Returns:	mode – Type: Integer, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode[].

The following constants are available for this function:

For mode:

BrickletGPSV3`BOOTLOADERUMODEUBOOTLOADER = 0
BrickletGPSV3`BOOTLOADERUMODEUFIRMWARE = 1
BrickletGPSV3`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
BrickletGPSV3`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
BrickletGPSV3`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4

BrickletGPSV3@SetWriteFirmwarePointer[pointer] → Null¶

Parameters:	pointer – Type: Integer, 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.

BrickletGPSV3@WriteFirmware[{data1, data2, ..., data64}] → status¶

Parameters:	datai – Type: Integer, Range: [0 to 255]
Returns:	status – Type: Integer, 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.

BrickletGPSV3@WriteUID[uid] → Null¶

Parameters:	uid – Type: Integer, 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.

BrickletGPSV3@ReadUID[] → uid¶

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

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

Constants¶

BrickletGPSV3`DEVICEUIDENTIFIER¶

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.

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