Mathematica - IMU Brick 2.0

This is the description of the Mathematica API bindings for the IMU Brick 2.0. General information and technical specifications for the IMU Brick 2.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)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XXYYZZ"(*Change XXYYZZ to the UID of your IMU Brick 2.0*)

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

(*Get current quaternion*)
w=0;x=0;y=0;z=0
imu@GetQuaternion[w,x,y,z]

Print["Quaternion [W]: "<>ToString[N[w/16383.0]]]
Print["Quaternion [X]: "<>ToString[N[x/16383.0]]]
Print["Quaternion [Y]: "<>ToString[N[y/16383.0]]]
Print["Quaternion [Z]: "<>ToString[N[z/16383.0]]]

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

Callback

Download (ExampleCallback.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XXYYZZ"(*Change XXYYZZ to the UID of your IMU Brick 2.0*)

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

(*Callback function for quaternion callback*)
QuaternionCB[sender_,w_,x_,y_,z_]:=
 Module[{},
  Print["Quaternion [W]: "<>ToString[N[w/16383.0]]];
  Print["Quaternion [X]: "<>ToString[N[x/16383.0]]];
  Print["Quaternion [Y]: "<>ToString[N[y/16383.0]]];
  Print["Quaternion [Z]: "<>ToString[N[z/16383.0]]]
 ]

AddEventHandler[imu@QuaternionCallback,QuaternionCB]

(*Set period for quaternion callback to 0.1s (100ms)*)
imu@SetQuaternionPeriod[100]

Input["Click OK to exit"]

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

All Data

Download (ExampleAllData.nb)

 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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XXYYZZ"(*Change XXYYZZ to the UID of your IMU Brick 2.0*)

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

(*Callback function for all data callback*)
AllDataCB[sender_,{acceleration1_,acceleration2_,acceleration3_},
          {magneticField1_,magneticField2_,magneticField3_},
          {angularVelocity1_,angularVelocity2_,angularVelocity3_},
          {eulerAngle1_,eulerAngle2_,eulerAngle3_},
          {quaternion1_,quaternion2_,quaternion3_,quaternion4_},
          {linearAcceleration1_,linearAcceleration2_,linearAcceleration3_},
          {gravityVector1_,gravityVector2_,gravityVector3_},temperature_,
          calibrationStatus_]:=
 Module[{},
  Print["Acceleration [X]: "<>ToString[N[Quantity[acceleration1,"m/s²/100"]]]];
  Print["Acceleration [Y]: "<>ToString[N[Quantity[acceleration2,"m/s²/100"]]]];
  Print["Acceleration [Z]: "<>ToString[N[Quantity[acceleration3,"m/s²/100"]]]];
  Print["Magnetic Field [X]: "<>ToString[N[Quantity[magneticField1,"µT/16"]]]];
  Print["Magnetic Field [Y]: "<>ToString[N[Quantity[magneticField2,"µT/16"]]]];
  Print["Magnetic Field [Z]: "<>ToString[N[Quantity[magneticField3,"µT/16"]]]];
  Print["Angular Velocity [X]: "<>ToString[N[Quantity[angularVelocity1,"°/s/16"]]]];
  Print["Angular Velocity [Y]: "<>ToString[N[Quantity[angularVelocity2,"°/s/16"]]]];
  Print["Angular Velocity [Z]: "<>ToString[N[Quantity[angularVelocity3,"°/s/16"]]]];
  Print["Euler Angle [X]: "<>ToString[N[Quantity[eulerAngle1,"°/16"]]]];
  Print["Euler Angle [Y]: "<>ToString[N[Quantity[eulerAngle2,"°/16"]]]];
  Print["Euler Angle [Z]: "<>ToString[N[Quantity[eulerAngle3,"°/16"]]]];
  Print["Quaternion [W]: "<>ToString[N[quaternion1/16383.0]]];
  Print["Quaternion [X]: "<>ToString[N[quaternion2/16383.0]]];
  Print["Quaternion [Y]: "<>ToString[N[quaternion3/16383.0]]];
  Print["Quaternion [Z]: "<>ToString[N[quaternion4/16383.0]]];
  Print["Linear Acceleration [X]: "<>ToString[N[Quantity[linearAcceleration1,"m/s²/100"]]]];
  Print["Linear Acceleration [Y]: "<>ToString[N[Quantity[linearAcceleration2,"m/s²/100"]]]];
  Print["Linear Acceleration [Z]: "<>ToString[N[Quantity[linearAcceleration3,"m/s²/100"]]]];
  Print["Gravity Vector [X]: "<>ToString[N[Quantity[gravityVector1,"m/s²/100"]]]];
  Print["Gravity Vector [Y]: "<>ToString[N[Quantity[gravityVector2,"m/s²/100"]]]];
  Print["Gravity Vector [Z]: "<>ToString[N[Quantity[gravityVector3,"m/s²/100"]]]];
  Print["Temperature: "<>ToString[N[Quantity[temperature,"°C"]]]];
  Print["Calibration Status: "<>StringJoin[Map[ToString,IntegerDigits[calibrationStatus,2,8]]]]
 ]

AddEventHandler[imu@AllDataCallback,AllDataCB]

(*Set period for all data callback to 0.1s (100ms)*)
imu@SetAllDataPeriod[100]

Input["Click OK to exit"]

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

API

Generally, every method 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 method. 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

BrickIMUV2[uid, ipcon] → imuV2
Parameters:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Returns:
  • imuV2 -- NETObject[BrickIMUV2]

Creates an object with the unique device ID uid:

imuV2=NETNew["Tinkerforge.BrickIMUV2","YOUR_DEVICE_UID",ipcon]

This object can then be used after the IP Connection is connected (see examples above).

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.

BrickIMUV2@GetOrientation[out heading, out roll, out pitch] → Null
Parameters:
  • heading -- Integer
  • roll -- Integer
  • pitch -- Integer

Returns the current orientation (heading, roll, pitch) of the IMU Brick as independent Euler angles in 1/16 degree. Note that Euler angles always experience a gimbal lock. We recommend that you use quaternions instead, if you need the absolute orientation.

The rotation angle has the following ranges:

  • heading: 0° to 360°
  • roll: -90° to +90°
  • pitch: -180° to +180°

If you want to get the orientation periodically, it is recommended to use the OrientationCallback callback and set the period with SetOrientationPeriod[].

BrickIMUV2@GetLinearAcceleration[out x, out y, out z] → Null
Parameters:
  • x -- Integer
  • y -- Integer
  • z -- Integer

Returns the linear acceleration of the IMU Brick for the x, y and z axis in 1/100 m/s².

The linear acceleration is the acceleration in each of the three axis of the IMU Brick with the influences of gravity removed.

It is also possible to get the gravity vector with the influence of linear acceleration removed, see GetGravityVector[].

If you want to get the linear acceleration periodically, it is recommended to use the LinearAccelerationCallback callback and set the period with SetLinearAccelerationPeriod[].

BrickIMUV2@GetGravityVector[out x, out y, out z] → Null
Parameters:
  • x -- Integer
  • y -- Integer
  • z -- Integer

Returns the current gravity vector of the IMU Brick for the x, y and z axis in 1/100 m/s².

The gravity vector is the acceleration that occurs due to gravity. Influences of additional linear acceleration are removed.

It is also possible to get the linear acceleration with the influence of gravity removed, see GetLinearAcceleration[].

If you want to get the gravity vector periodically, it is recommended to use the GravityVectorCallback callback and set the period with SetGravityVectorPeriod[].

BrickIMUV2@GetQuaternion[out w, out x, out y, out z] → Null
Parameters:
  • w -- Integer
  • x -- Integer
  • y -- Integer
  • z -- Integer

Returns the current orientation (w, x, y, z) of the IMU Brick as quaternions.

You have to divide the returns values by 16383 (14 bit) to get the usual range of -1.0 to +1.0 for quaternions.

If you want to get the quaternions periodically, it is recommended to use the QuaternionCallback callback and set the period with SetQuaternionPeriod[].

BrickIMUV2@GetAllData[out {acceleration1, acceleration2, acceleration3}, out {magneticField1, magneticField2, magneticField3}, out {angularVelocity1, angularVelocity2, angularVelocity3}, out {eulerAngle1, eulerAngle2, eulerAngle3}, out {quaternion1, quaternion2, quaternion3, quaternion4}, out {linearAcceleration1, linearAcceleration2, linearAcceleration3}, out {gravityVector1, gravityVector2, gravityVector3}, out temperature, out calibrationStatus] → Null
Parameters:
  • accelerationi -- Integer
  • magneticFieldi -- Integer
  • angularVelocityi -- Integer
  • eulerAnglei -- Integer
  • quaternioni -- Integer
  • linearAccelerationi -- Integer
  • gravityVectori -- Integer
  • temperature -- Integer
  • calibrationStatus -- Integer

Return all of the available data of the IMU Brick.

The calibration status consists of four pairs of two bits. Each pair of bits represents the status of the current calibration.

  • bit 0-1: Magnetometer
  • bit 2-3: Accelerometer
  • bit 4-5: Gyroscope
  • bit 6-7: System

A value of 0 means for "not calibrated" and a value of 3 means "fully calibrated". In your program you should always be able to ignore the calibration status, it is used by the calibration window of the Brick Viewer and it can be ignored after the first calibration. See the documentation in the calibration window for more information regarding the calibration of the IMU Brick.

If you want to get the data periodically, it is recommended to use the AllDataCallback callback and set the period with SetAllDataPeriod[].

BrickIMUV2@LedsOn[] → Null

Turns the orientation and direction LEDs of the IMU Brick on.

BrickIMUV2@LedsOff[] → Null

Turns the orientation and direction LEDs of the IMU Brick off.

BrickIMUV2@AreLedsOn[] → leds
Returns:
  • leds -- True/False

Returns true if the orientation and direction LEDs of the IMU Brick are on, false otherwise.

Advanced Functions

BrickIMUV2@GetAcceleration[out x, out y, out z] → Null
Parameters:
  • x -- Integer
  • y -- Integer
  • z -- Integer

Returns the calibrated acceleration from the accelerometer for the x, y and z axis in 1/100 m/s².

If you want to get the acceleration periodically, it is recommended to use the AccelerationCallback callback and set the period with SetAccelerationPeriod[].

BrickIMUV2@GetMagneticField[out x, out y, out z] → Null
Parameters:
  • x -- Integer
  • y -- Integer
  • z -- Integer

Returns the calibrated magnetic field from the magnetometer for the x, y and z axis in 1/16 µT (Microtesla).

If you want to get the magnetic field periodically, it is recommended to use the MagneticFieldCallback callback and set the period with SetMagneticFieldPeriod[].

BrickIMUV2@GetAngularVelocity[out x, out y, out z] → Null
Parameters:
  • x -- Integer
  • y -- Integer
  • z -- Integer

Returns the calibrated angular velocity from the gyroscope for the x, y and z axis in 1/16 °/s.

If you want to get the angular velocity periodically, it is recommended to use the AngularVelocityCallback acallback nd set the period with SetAngularVelocityPeriod[].

BrickIMUV2@GetTemperature[] → temperature
Returns:
  • temperature -- Integer

Returns the temperature of the IMU Brick. The temperature is given in °C. The temperature is measured in the core of the BNO055 IC, it is not the ambient temperature

BrickIMUV2@SaveCalibration[] → calibrationDone
Returns:
  • calibrationDone -- True/False

A call of this function saves the current calibration to be used as a starting point for the next restart of continuous calibration of the IMU Brick.

A return value of true means that the calibration could be used and false means that it could not be used (this happens if the calibration status is not "fully calibrated").

This function is used by the calibration window of the Brick Viewer, you should not need to call it in your program.

BrickIMUV2@SetSensorConfiguration[magnetometerRate, gyroscopeRange, gyroscopeBandwidth, accelerometerRange, accelerometerBandwidth] → Null
Parameters:
  • magnetometerRate -- Integer
  • gyroscopeRange -- Integer
  • gyroscopeBandwidth -- Integer
  • accelerometerRange -- Integer
  • accelerometerBandwidth -- Integer

Sets the available sensor configuration for the Magnetometer, Gyroscope and Accelerometer. The Accelerometer Range is user selectable in all fusion modes, all other configurations are auto-controlled in fusion mode.

The default values are:

  • Magnetometer Rate 20Hz
  • Gyroscope Range 2000°/s
  • Gyroscope Bandwidth 32Hz
  • Accelerometer Range +/-4G
  • Accelerometer Bandwidth 62.5Hz

The following constants are available for this function:

  • BrickIMUV2`MAGNETOMETERURATEU2HZ = 0
  • BrickIMUV2`MAGNETOMETERURATEU6HZ = 1
  • BrickIMUV2`MAGNETOMETERURATEU8HZ = 2
  • BrickIMUV2`MAGNETOMETERURATEU10HZ = 3
  • BrickIMUV2`MAGNETOMETERURATEU15HZ = 4
  • BrickIMUV2`MAGNETOMETERURATEU20HZ = 5
  • BrickIMUV2`MAGNETOMETERURATEU25HZ = 6
  • BrickIMUV2`MAGNETOMETERURATEU30HZ = 7
  • BrickIMUV2`GYROSCOPEURANGEU2000DPS = 0
  • BrickIMUV2`GYROSCOPEURANGEU1000DPS = 1
  • BrickIMUV2`GYROSCOPEURANGEU500DPS = 2
  • BrickIMUV2`GYROSCOPEURANGEU250DPS = 3
  • BrickIMUV2`GYROSCOPEURANGEU125DPS = 4
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU523HZ = 0
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU230HZ = 1
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU116HZ = 2
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU47HZ = 3
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU23HZ = 4
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU12HZ = 5
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU64HZ = 6
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU32HZ = 7
  • BrickIMUV2`ACCELEROMETERURANGEU2G = 0
  • BrickIMUV2`ACCELEROMETERURANGEU4G = 1
  • BrickIMUV2`ACCELEROMETERURANGEU8G = 2
  • BrickIMUV2`ACCELEROMETERURANGEU16G = 3
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU7U81HZ = 0
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU15U63HZ = 1
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU31U25HZ = 2
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU62U5HZ = 3
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU125HZ = 4
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU250HZ = 5
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU500HZ = 6
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU1000HZ = 7

New in version 2.0.5 (Firmware).

BrickIMUV2@GetSensorConfiguration[out magnetometerRate, out gyroscopeRange, out gyroscopeBandwidth, out accelerometerRange, out accelerometerBandwidth] → Null
Parameters:
  • magnetometerRate -- Integer
  • gyroscopeRange -- Integer
  • gyroscopeBandwidth -- Integer
  • accelerometerRange -- Integer
  • accelerometerBandwidth -- Integer

Returns the sensor configuration as set by SetSensorConfiguration[].

The following constants are available for this function:

  • BrickIMUV2`MAGNETOMETERURATEU2HZ = 0
  • BrickIMUV2`MAGNETOMETERURATEU6HZ = 1
  • BrickIMUV2`MAGNETOMETERURATEU8HZ = 2
  • BrickIMUV2`MAGNETOMETERURATEU10HZ = 3
  • BrickIMUV2`MAGNETOMETERURATEU15HZ = 4
  • BrickIMUV2`MAGNETOMETERURATEU20HZ = 5
  • BrickIMUV2`MAGNETOMETERURATEU25HZ = 6
  • BrickIMUV2`MAGNETOMETERURATEU30HZ = 7
  • BrickIMUV2`GYROSCOPEURANGEU2000DPS = 0
  • BrickIMUV2`GYROSCOPEURANGEU1000DPS = 1
  • BrickIMUV2`GYROSCOPEURANGEU500DPS = 2
  • BrickIMUV2`GYROSCOPEURANGEU250DPS = 3
  • BrickIMUV2`GYROSCOPEURANGEU125DPS = 4
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU523HZ = 0
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU230HZ = 1
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU116HZ = 2
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU47HZ = 3
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU23HZ = 4
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU12HZ = 5
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU64HZ = 6
  • BrickIMUV2`GYROSCOPEUBANDWIDTHU32HZ = 7
  • BrickIMUV2`ACCELEROMETERURANGEU2G = 0
  • BrickIMUV2`ACCELEROMETERURANGEU4G = 1
  • BrickIMUV2`ACCELEROMETERURANGEU8G = 2
  • BrickIMUV2`ACCELEROMETERURANGEU16G = 3
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU7U81HZ = 0
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU15U63HZ = 1
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU31U25HZ = 2
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU62U5HZ = 3
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU125HZ = 4
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU250HZ = 5
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU500HZ = 6
  • BrickIMUV2`ACCELEROMETERUBANDWIDTHU1000HZ = 7

New in version 2.0.5 (Firmware).

BrickIMUV2@SetSensorFusionMode[mode] → Null
Parameters:
  • mode -- Integer

If the fusion mode is turned off, the functions GetAcceleration[], GetMagneticField[] and GetAngularVelocity[] return uncalibrated and uncompensated sensor data. All other sensor data getters return no data.

Since firmware version 2.0.6 you can also use a fusion mode without magnetometer. In this mode the calculated orientation is relative (with magnetometer it is absolute with respect to the earth). However, the calculation can't be influenced by spurious magnetic fields.

Since firmware version 2.0.13 you can also use a fusion mode without fast magnetometer calibration. This mode is the same as the normal fusion mode, but the fast magnetometer calibration is turned off. So to find the orientation the first time will likely take longer, but small magnetic influences might not affect the automatic calibration as much.

By default sensor fusion is on.

The following constants are available for this function:

  • BrickIMUV2`SENSORUFUSIONUOFF = 0
  • BrickIMUV2`SENSORUFUSIONUON = 1
  • BrickIMUV2`SENSORUFUSIONUONUWITHOUTUMAGNETOMETER = 2
  • BrickIMUV2`SENSORUFUSIONUONUWITHOUTUFASTUMAGNETOMETERUCALIBRATION = 3

New in version 2.0.5 (Firmware).

BrickIMUV2@GetSensorFusionMode[] → mode
Returns:
  • mode -- Integer

Returns the sensor fusion mode as set by SetSensorFusionMode[].

The following constants are available for this function:

  • BrickIMUV2`SENSORUFUSIONUOFF = 0
  • BrickIMUV2`SENSORUFUSIONUON = 1
  • BrickIMUV2`SENSORUFUSIONUONUWITHOUTUMAGNETOMETER = 2
  • BrickIMUV2`SENSORUFUSIONUONUWITHOUTUFASTUMAGNETOMETERUCALIBRATION = 3

New in version 2.0.5 (Firmware).

BrickIMUV2@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Returns:
  • apiVersioni -- Integer

Returns the version of the API definition (major, minor, revision) 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.

BrickIMUV2@GetResponseExpected[functionId] → responseExpected
Parameters:
  • functionId -- Integer
Returns:
  • responseExpected -- 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 send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected[] for the list of function ID constants available for this function.

BrickIMUV2@SetResponseExpected[functionId, responseExpected] → Null
Parameters:
  • functionId -- Integer
  • responseExpected -- 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.

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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickIMUV2`FUNCTIONULEDSUON = 10
  • BrickIMUV2`FUNCTIONULEDSUOFF = 11
  • BrickIMUV2`FUNCTIONUSETUACCELERATIONUPERIOD = 14
  • BrickIMUV2`FUNCTIONUSETUMAGNETICUFIELDUPERIOD = 16
  • BrickIMUV2`FUNCTIONUSETUANGULARUVELOCITYUPERIOD = 18
  • BrickIMUV2`FUNCTIONUSETUTEMPERATUREUPERIOD = 20
  • BrickIMUV2`FUNCTIONUSETUORIENTATIONUPERIOD = 22
  • BrickIMUV2`FUNCTIONUSETULINEARUACCELERATIONUPERIOD = 24
  • BrickIMUV2`FUNCTIONUSETUGRAVITYUVECTORUPERIOD = 26
  • BrickIMUV2`FUNCTIONUSETUQUATERNIONUPERIOD = 28
  • BrickIMUV2`FUNCTIONUSETUALLUDATAUPERIOD = 30
  • BrickIMUV2`FUNCTIONUSETUSENSORUCONFIGURATION = 41
  • BrickIMUV2`FUNCTIONUSETUSENSORUFUSIONUMODE = 43
  • BrickIMUV2`FUNCTIONUSETUSPITFPUBAUDRATEUCONFIG = 231
  • BrickIMUV2`FUNCTIONUSETUSPITFPUBAUDRATE = 234
  • BrickIMUV2`FUNCTIONUENABLEUSTATUSULED = 238
  • BrickIMUV2`FUNCTIONUDISABLEUSTATUSULED = 239
  • BrickIMUV2`FUNCTIONURESET = 243
BrickIMUV2@SetResponseExpectedAll[responseExpected] → Null
Parameters:
  • responseExpected -- True/False

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

BrickIMUV2@SetSPITFPBaudrateConfig[enableDynamicBaudrate, minimumDynamicBaudrate] → Null
Parameters:
  • enableDynamicBaudrate -- True/False
  • minimumDynamicBaudrate -- Integer

The SPITF protocol can be used with a dynamic baudrate. If the dynamic baudrate is enabled, the Brick will try to adapt the baudrate for the communication between Bricks and Bricklets according to the amount of data that is transferred.

The baudrate will be increased exponentially if lots of data is send/received and decreased linearly if little data is send/received.

This lowers the baudrate in applications where little data is transferred (e.g. a weather station) and increases the robustness. If there is lots of data to transfer (e.g. Thermal Imaging Bricklet) it automatically increases the baudrate as needed.

In cases where some data has to transferred as fast as possible every few seconds (e.g. RS485 Bricklet with a high baudrate but small payload) you may want to turn the dynamic baudrate off to get the highest possible performance.

The maximum value of the baudrate can be set per port with the function SetSPITFPBaudrate[]. If the dynamic baudrate is disabled, the baudrate as set by SetSPITFPBaudrate[] will be used statically.

The minimum dynamic baudrate has a value range of 400000 to 2000000 baud.

By default dynamic baudrate is enabled and the minimum dynamic baudrate is 400000.

New in version 2.0.10 (Firmware).

BrickIMUV2@GetSPITFPBaudrateConfig[out enableDynamicBaudrate, out minimumDynamicBaudrate] → Null
Parameters:
  • enableDynamicBaudrate -- True/False
  • minimumDynamicBaudrate -- Integer

Returns the baudrate config, see SetSPITFPBaudrateConfig[].

New in version 2.0.10 (Firmware).

BrickIMUV2@GetSendTimeoutCount[communicationMethod] → timeoutCount
Parameters:
  • communicationMethod -- Integer
Returns:
  • timeoutCount -- Integer

Returns the timeout count for the different communication methods.

The methods 0-2 are available for all Bricks, 3-7 only for Master Bricks.

This function is mostly used for debugging during development, in normal operation the counters should nearly always stay at 0.

The following constants are available for this function:

  • BrickIMUV2`COMMUNICATIONUMETHODUNONE = 0
  • BrickIMUV2`COMMUNICATIONUMETHODUUSB = 1
  • BrickIMUV2`COMMUNICATIONUMETHODUSPIUSTACK = 2
  • BrickIMUV2`COMMUNICATIONUMETHODUCHIBI = 3
  • BrickIMUV2`COMMUNICATIONUMETHODURS485 = 4
  • BrickIMUV2`COMMUNICATIONUMETHODUWIFI = 5
  • BrickIMUV2`COMMUNICATIONUMETHODUETHERNET = 6
  • BrickIMUV2`COMMUNICATIONUMETHODUWIFIUV2 = 7

New in version 2.0.7 (Firmware).

BrickIMUV2@SetSPITFPBaudrate[brickletPort, baudrate] → Null
Parameters:
  • brickletPort -- Integer
  • baudrate -- Integer

Sets the baudrate for a specific Bricklet port ('a' - 'd'). The baudrate can be in the range 400000 to 2000000.

If you want to increase the throughput of Bricklets you can increase the baudrate. If you get a high error count because of high interference (see GetSPITFPErrorCount[]) you can decrease the baudrate.

If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (see SetSPITFPBaudrateConfig[]).

Regulatory testing is done with the default baudrate. If CE compatibility or similar is necessary in you applications we recommend to not change the baudrate.

The default baudrate for all ports is 1400000.

New in version 2.0.5 (Firmware).

BrickIMUV2@GetSPITFPBaudrate[brickletPort] → baudrate
Parameters:
  • brickletPort -- Integer
Returns:
  • baudrate -- Integer

Returns the baudrate for a given Bricklet port, see SetSPITFPBaudrate[].

New in version 2.0.5 (Firmware).

BrickIMUV2@GetSPITFPErrorCount[brickletPort, out errorCountACKChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Parameters:
  • brickletPort -- Integer
  • errorCountACKChecksum -- Integer
  • errorCountMessageChecksum -- Integer
  • errorCountFrame -- Integer
  • errorCountOverflow -- Integer

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 Brick side. All Bricklets have a similar function that returns the errors on the Bricklet side.

New in version 2.0.5 (Firmware).

BrickIMUV2@EnableStatusLED[] → Null

Enables the status LED.

The status LED is the blue LED next to the USB connector. If enabled is is on and it flickers if data is transfered. If disabled it is always off.

The default state is enabled.

BrickIMUV2@DisableStatusLED[] → Null

Disables the status LED.

The status LED is the blue LED next to the USB connector. If enabled is is on and it flickers if data is transfered. If disabled it is always off.

The default state is enabled.

BrickIMUV2@IsStatusLEDEnabled[] → enabled
Returns:
  • enabled -- True/False

Returns true if the status LED is enabled, false otherwise.

BrickIMUV2@GetProtocol1BrickletName[port, out protocolVersion, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out name] → Null
Parameters:
  • port -- Integer
  • protocolVersion -- Integer
  • firmwareVersioni -- Integer
  • name -- String

Returns the firmware and protocol version and the name of the Bricklet for a given port.

This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet plugins.

BrickIMUV2@GetChipTemperature[] → temperature
Returns:
  • temperature -- Integer

Returns the temperature in °C/10 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 an accuracy of +-15%. Practically it is only useful as an indicator for temperature changes.

BrickIMUV2@Reset[] → Null

Calling this function will reset the Brick. Calling this function on a Brick inside of a stack will reset the whole stack.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickIMUV2@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameters:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- Integer

Returns the UID, the UID where the Brick is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be '0'-'8' (stack position).

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

Callback Configuration Functions

BrickIMUV2@SetAccelerationPeriod[period] → Null
Parameters:
  • period -- Integer

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

The default value is 0.

BrickIMUV2@GetAccelerationPeriod[] → period
Returns:
  • period -- Integer

Returns the period as set by SetAccelerationPeriod[].

BrickIMUV2@SetMagneticFieldPeriod[period] → Null
Parameters:
  • period -- Integer

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

BrickIMUV2@GetMagneticFieldPeriod[] → period
Returns:
  • period -- Integer

Returns the period as set by SetMagneticFieldPeriod[].

BrickIMUV2@SetAngularVelocityPeriod[period] → Null
Parameters:
  • period -- Integer

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

BrickIMUV2@GetAngularVelocityPeriod[] → period
Returns:
  • period -- Integer

Returns the period as set by SetAngularVelocityPeriod[].

BrickIMUV2@SetTemperaturePeriod[period] → Null
Parameters:
  • period -- Integer

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

BrickIMUV2@GetTemperaturePeriod[] → period
Returns:
  • period -- Integer

Returns the period as set by SetTemperaturePeriod[].

BrickIMUV2@SetOrientationPeriod[period] → Null
Parameters:
  • period -- Integer

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

BrickIMUV2@GetOrientationPeriod[] → period
Returns:
  • period -- Integer

Returns the period as set by SetOrientationPeriod[].

BrickIMUV2@SetLinearAccelerationPeriod[period] → Null
Parameters:
  • period -- Integer

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

BrickIMUV2@GetLinearAccelerationPeriod[] → period
Returns:
  • period -- Integer

Returns the period as set by SetLinearAccelerationPeriod[].

BrickIMUV2@SetGravityVectorPeriod[period] → Null
Parameters:
  • period -- Integer

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

BrickIMUV2@GetGravityVectorPeriod[] → period
Returns:
  • period -- Integer

Returns the period as set by SetGravityVectorPeriod[].

BrickIMUV2@SetQuaternionPeriod[period] → Null
Parameters:
  • period -- Integer

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

BrickIMUV2@GetQuaternionPeriod[] → period
Returns:
  • period -- Integer

Returns the period as set by SetQuaternionPeriod[].

BrickIMUV2@SetAllDataPeriod[period] → Null
Parameters:
  • period -- Integer

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

BrickIMUV2@GetAllDataPeriod[] → period
Returns:
  • period -- Integer

Returns the period as set by SetAllDataPeriod[].

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[imuV2@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 BrickIMUV2@AccelerationCallback[sender, x, y, z]
Parameters:
  • sender -- NETObject[BrickIMUV2]
  • x -- Integer
  • y -- Integer
  • z -- Integer

This callback is triggered periodically with the period that is set by SetAccelerationPeriod[]. The parameters are the acceleration for the x, y and z axis.

event BrickIMUV2@MagneticFieldCallback[sender, x, y, z]
Parameters:
  • sender -- NETObject[BrickIMUV2]
  • x -- Integer
  • y -- Integer
  • z -- Integer

This callback is triggered periodically with the period that is set by SetMagneticFieldPeriod[]. The parameters are the magnetic field for the x, y and z axis.

event BrickIMUV2@AngularVelocityCallback[sender, x, y, z]
Parameters:
  • sender -- NETObject[BrickIMUV2]
  • x -- Integer
  • y -- Integer
  • z -- Integer

This callback is triggered periodically with the period that is set by SetAngularVelocityPeriod[]. The parameters are the angular velocity for the x, y and z axis.

event BrickIMUV2@TemperatureCallback[sender, temperature]
Parameters:
  • sender -- NETObject[BrickIMUV2]
  • temperature -- Integer

This callback is triggered periodically with the period that is set by SetTemperaturePeriod[]. The parameter is the temperature.

event BrickIMUV2@LinearAccelerationCallback[sender, x, y, z]
Parameters:
  • sender -- NETObject[BrickIMUV2]
  • x -- Integer
  • y -- Integer
  • z -- Integer

This callback is triggered periodically with the period that is set by SetLinearAccelerationPeriod[]. The parameters are the linear acceleration for the x, y and z axis.

event BrickIMUV2@GravityVectorCallback[sender, x, y, z]
Parameters:
  • sender -- NETObject[BrickIMUV2]
  • x -- Integer
  • y -- Integer
  • z -- Integer

This callback is triggered periodically with the period that is set by SetGravityVectorPeriod[]. The parameters gravity vector for the x, y and z axis.

event BrickIMUV2@OrientationCallback[sender, heading, roll, pitch]
Parameters:
  • sender -- NETObject[BrickIMUV2]
  • heading -- Integer
  • roll -- Integer
  • pitch -- Integer

This callback is triggered periodically with the period that is set by SetOrientationPeriod[]. The parameters are the orientation (heading (yaw), roll, pitch) of the IMU Brick in Euler angles. See GetOrientation[] for details.

event BrickIMUV2@QuaternionCallback[sender, w, x, y, z]
Parameters:
  • sender -- NETObject[BrickIMUV2]
  • w -- Integer
  • x -- Integer
  • y -- Integer
  • z -- Integer

This callback is triggered periodically with the period that is set by SetQuaternionPeriod[]. The parameters are the orientation (x, y, z, w) of the IMU Brick in quaternions. See GetQuaternion[] for details.

event BrickIMUV2@AllDataCallback[sender, {acceleration1, acceleration2, acceleration3}, {magneticField1, magneticField2, magneticField3}, {angularVelocity1, angularVelocity2, angularVelocity3}, {eulerAngle1, eulerAngle2, eulerAngle3}, {quaternion1, quaternion2, quaternion3, quaternion4}, {linearAcceleration1, linearAcceleration2, linearAcceleration3}, {gravityVector1, gravityVector2, gravityVector3}, temperature, calibrationStatus]
Parameters:
  • sender -- NETObject[BrickIMUV2]
  • accelerationi -- Integer
  • magneticFieldi -- Integer
  • angularVelocityi -- Integer
  • eulerAnglei -- Integer
  • quaternioni -- Integer
  • linearAccelerationi -- Integer
  • gravityVectori -- Integer
  • temperature -- Integer
  • calibrationStatus -- Integer

This callback is triggered periodically with the period that is set by SetAllDataPeriod[]. The parameters are as for GetAllData[].

Constants

BrickIMUV2`DEVICEUIDENTIFIER

This constant is used to identify a IMU Brick 2.0.

The GetIdentity[] function and the EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

BrickIMUV2`DEVICEDISPLAYNAME

This constant represents the human readable name of a IMU Brick 2.0.