Deutsch
English
Menu
Software / API Bindings / Mathematica / API Reference and Examples / Bricklets / IMU Bricklet 3.0

Mathematica - IMU Bricklet 3.0

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

 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="XYZ"(*Change XYZ to the UID of your IMU Bricklet 3.0*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
imu=NETNew["Tinkerforge.BrickletIMUV3",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="XYZ"(*Change XYZ to the UID of your IMU Bricklet 3.0*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
imu=NETNew["Tinkerforge.BrickletIMUV3",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@SetQuaternionCallbackConfiguration[100,False]

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="XYZ"(*Change XYZ to the UID of your IMU Bricklet 3.0*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
imu=NETNew["Tinkerforge.BrickletIMUV3",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 [Heading]: "<>ToString[N[Quantity[eulerAngle1,"°/16"]]]];
  Print["Euler Angle [Roll]: "<>ToString[N[Quantity[eulerAngle2,"°/16"]]]];
  Print["Euler Angle [Pitch]: "<>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@SetAllDataCallbackConfiguration[100,False]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[imu]
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

BrickletIMUV3[uid, ipcon] → imuV3
Parameters:
  • uid – Type: String
  • ipcon – Type: NETObject[IPConnection]
Returns:
  • imuV3 – Type: NETObject[BrickletIMUV3]

Creates an object with the unique device ID uid:

imuV3=NETNew["Tinkerforge.BrickletIMUV3","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.

BrickletIMUV3@GetOrientation[out heading, out roll, out pitch] → Null
Output Parameters:
  • heading – Type: Integer, Unit: 1/16 °, Range: [0 to 5760]
  • roll – Type: Integer, Unit: 1/16 °, Range: [-1440 to 1440]
  • pitch – Type: Integer, Unit: 1/16 °, Range: [-2880 to 2880]

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

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

BrickletIMUV3@GetLinearAcceleration[out x, out y, out z] → Null
Output Parameters:
  • x – Type: Integer, Unit: 1 cm/s², Range: ?
  • y – Type: Integer, Unit: 1 cm/s², Range: ?
  • z – Type: Integer, Unit: 1 cm/s², Range: ?

Returns the linear acceleration of the IMU Brick for the x, y and z axis. The acceleration is in the range configured with SetSensorConfiguration[].

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

BrickletIMUV3@GetGravityVector[out x, out y, out z] → Null
Output Parameters:
  • x – Type: Integer, Unit: 1 cm/s², Range: [-981 to 981]
  • y – Type: Integer, Unit: 1 cm/s², Range: [-981 to 981]
  • z – Type: Integer, Unit: 1 cm/s², Range: [-981 to 981]

Returns the current gravity vector of the IMU Brick for the x, y and z axis.

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

BrickletIMUV3@GetQuaternion[out w, out x, out y, out z] → Null
Output Parameters:
  • w – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
  • x – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
  • y – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
  • z – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]

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

You have to divide the return 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 SetQuaternionCallbackConfiguration[].

BrickletIMUV3@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
Output Parameters:
  • accelerationi – Type: Integer
    • 1: x – Type: Integer, Unit: 1 cm/s², Range: ?
    • 2: y – Type: Integer, Unit: 1 cm/s², Range: ?
    • 3: z – Type: Integer, Unit: 1 cm/s², Range: ?
  • magneticFieldi – Type: Integer
    • 1: x – Type: Integer, Unit: 1/16 µT, Range: [-20800 to 20800]
    • 2: y – Type: Integer, Unit: 1/16 µT, Range: [-20800 to 20800]
    • 3: z – Type: Integer, Unit: 1/16 µT, Range: [-40000 to 40000]
  • angularVelocityi – Type: Integer
    • 1: x – Type: Integer, Unit: 1/16 °/s, Range: ?
    • 2: y – Type: Integer, Unit: 1/16 °/s, Range: ?
    • 3: z – Type: Integer, Unit: 1/16 °/s, Range: ?
  • eulerAnglei – Type: Integer
    • 1: heading – Type: Integer, Unit: 1/16 °, Range: [0 to 5760]
    • 2: roll – Type: Integer, Unit: 1/16 °, Range: [-1440 to 1440]
    • 3: pitch – Type: Integer, Unit: 1/16 °, Range: [-2880 to 2880]
  • quaternioni – Type: Integer
    • 1: w – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
    • 2: x – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
    • 3: y – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
    • 4: z – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
  • linearAccelerationi – Type: Integer
    • 1: x – Type: Integer, Unit: 1 cm/s², Range: ?
    • 2: y – Type: Integer, Unit: 1 cm/s², Range: ?
    • 3: z – Type: Integer, Unit: 1 cm/s², Range: ?
  • gravityVectori – Type: Integer
    • 1: x – Type: Integer, Unit: 1 cm/s², Range: [-981 to 981]
    • 2: y – Type: Integer, Unit: 1 cm/s², Range: [-981 to 981]
    • 3: z – Type: Integer, Unit: 1 cm/s², Range: [-981 to 981]
  • temperature – Type: Integer, Unit: 1 °C, Range: [-128 to 127]
  • calibrationStatus – Type: Integer, Range: [0 to 255]

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

Advanced Functions

BrickletIMUV3@GetAcceleration[out x, out y, out z] → Null
Output Parameters:
  • x – Type: Integer, Unit: 1 cm/s², Range: ?
  • y – Type: Integer, Unit: 1 cm/s², Range: ?
  • z – Type: Integer, Unit: 1 cm/s², Range: ?

Returns the calibrated acceleration from the accelerometer for the x, y and z axis. The acceleration is in the range configured with SetSensorConfiguration[].

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

BrickletIMUV3@GetMagneticField[out x, out y, out z] → Null
Output Parameters:
  • x – Type: Integer, Unit: 1/16 µT, Range: [-20800 to 20800]
  • y – Type: Integer, Unit: 1/16 µT, Range: [-20800 to 20800]
  • z – Type: Integer, Unit: 1/16 µT, Range: [-40000 to 40000]

Returns the calibrated magnetic field from the magnetometer for the x, y and z axis.

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

BrickletIMUV3@GetAngularVelocity[out x, out y, out z] → Null
Output Parameters:
  • x – Type: Integer, Unit: 1/16 °/s, Range: ?
  • y – Type: Integer, Unit: 1/16 °/s, Range: ?
  • z – Type: Integer, Unit: 1/16 °/s, Range: ?

Returns the calibrated angular velocity from the gyroscope for the x, y and z axis. The angular velocity is in the range configured with SetSensorConfiguration[].

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

BrickletIMUV3@GetTemperature[] → temperature
Returns:
  • temperature – Type: Integer, Unit: 1 °C, Range: [-128 to 127]

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

BrickletIMUV3@SaveCalibration[] → calibrationDone
Returns:
  • calibrationDone – Type: 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.

BrickletIMUV3@SetSensorConfiguration[magnetometerRate, gyroscopeRange, gyroscopeBandwidth, accelerometerRange, accelerometerBandwidth] → Null
Parameters:
  • magnetometerRate – Type: Integer, Range: See constants, Default: 5
  • gyroscopeRange – Type: Integer, Range: See constants, Default: 0
  • gyroscopeBandwidth – Type: Integer, Range: See constants, Default: 7
  • accelerometerRange – Type: Integer, Range: See constants, Default: 1
  • accelerometerBandwidth – Type: Integer, Range: See constants, Default: 3

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 following constants are available for this function:

For magnetometerRate:

  • BrickletIMUV3`MAGNETOMETERURATEU2HZ = 0
  • BrickletIMUV3`MAGNETOMETERURATEU6HZ = 1
  • BrickletIMUV3`MAGNETOMETERURATEU8HZ = 2
  • BrickletIMUV3`MAGNETOMETERURATEU10HZ = 3
  • BrickletIMUV3`MAGNETOMETERURATEU15HZ = 4
  • BrickletIMUV3`MAGNETOMETERURATEU20HZ = 5
  • BrickletIMUV3`MAGNETOMETERURATEU25HZ = 6
  • BrickletIMUV3`MAGNETOMETERURATEU30HZ = 7

For gyroscopeRange:

  • BrickletIMUV3`GYROSCOPEURANGEU2000DPS = 0
  • BrickletIMUV3`GYROSCOPEURANGEU1000DPS = 1
  • BrickletIMUV3`GYROSCOPEURANGEU500DPS = 2
  • BrickletIMUV3`GYROSCOPEURANGEU250DPS = 3
  • BrickletIMUV3`GYROSCOPEURANGEU125DPS = 4

For gyroscopeBandwidth:

  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU523HZ = 0
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU230HZ = 1
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU116HZ = 2
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU47HZ = 3
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU23HZ = 4
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU12HZ = 5
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU64HZ = 6
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU32HZ = 7

For accelerometerRange:

  • BrickletIMUV3`ACCELEROMETERURANGEU2G = 0
  • BrickletIMUV3`ACCELEROMETERURANGEU4G = 1
  • BrickletIMUV3`ACCELEROMETERURANGEU8G = 2
  • BrickletIMUV3`ACCELEROMETERURANGEU16G = 3

For accelerometerBandwidth:

  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU7U81HZ = 0
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU15U63HZ = 1
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU31U25HZ = 2
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU62U5HZ = 3
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU125HZ = 4
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU250HZ = 5
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU500HZ = 6
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU1000HZ = 7
BrickletIMUV3@GetSensorConfiguration[out magnetometerRate, out gyroscopeRange, out gyroscopeBandwidth, out accelerometerRange, out accelerometerBandwidth] → Null
Output Parameters:
  • magnetometerRate – Type: Integer, Range: See constants, Default: 5
  • gyroscopeRange – Type: Integer, Range: See constants, Default: 0
  • gyroscopeBandwidth – Type: Integer, Range: See constants, Default: 7
  • accelerometerRange – Type: Integer, Range: See constants, Default: 1
  • accelerometerBandwidth – Type: Integer, Range: See constants, Default: 3

Returns the sensor configuration as set by SetSensorConfiguration[].

The following constants are available for this function:

For magnetometerRate:

  • BrickletIMUV3`MAGNETOMETERURATEU2HZ = 0
  • BrickletIMUV3`MAGNETOMETERURATEU6HZ = 1
  • BrickletIMUV3`MAGNETOMETERURATEU8HZ = 2
  • BrickletIMUV3`MAGNETOMETERURATEU10HZ = 3
  • BrickletIMUV3`MAGNETOMETERURATEU15HZ = 4
  • BrickletIMUV3`MAGNETOMETERURATEU20HZ = 5
  • BrickletIMUV3`MAGNETOMETERURATEU25HZ = 6
  • BrickletIMUV3`MAGNETOMETERURATEU30HZ = 7

For gyroscopeRange:

  • BrickletIMUV3`GYROSCOPEURANGEU2000DPS = 0
  • BrickletIMUV3`GYROSCOPEURANGEU1000DPS = 1
  • BrickletIMUV3`GYROSCOPEURANGEU500DPS = 2
  • BrickletIMUV3`GYROSCOPEURANGEU250DPS = 3
  • BrickletIMUV3`GYROSCOPEURANGEU125DPS = 4

For gyroscopeBandwidth:

  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU523HZ = 0
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU230HZ = 1
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU116HZ = 2
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU47HZ = 3
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU23HZ = 4
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU12HZ = 5
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU64HZ = 6
  • BrickletIMUV3`GYROSCOPEUBANDWIDTHU32HZ = 7

For accelerometerRange:

  • BrickletIMUV3`ACCELEROMETERURANGEU2G = 0
  • BrickletIMUV3`ACCELEROMETERURANGEU4G = 1
  • BrickletIMUV3`ACCELEROMETERURANGEU8G = 2
  • BrickletIMUV3`ACCELEROMETERURANGEU16G = 3

For accelerometerBandwidth:

  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU7U81HZ = 0
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU15U63HZ = 1
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU31U25HZ = 2
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU62U5HZ = 3
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU125HZ = 4
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU250HZ = 5
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU500HZ = 6
  • BrickletIMUV3`ACCELEROMETERUBANDWIDTHU1000HZ = 7
BrickletIMUV3@SetSensorFusionMode[mode] → Null
Parameters:
  • mode – Type: Integer, Range: See constants, Default: 1

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.

The following constants are available for this function:

For mode:

  • BrickletIMUV3`SENSORUFUSIONUOFF = 0
  • BrickletIMUV3`SENSORUFUSIONUON = 1
  • BrickletIMUV3`SENSORUFUSIONUONUWITHOUTUMAGNETOMETER = 2
  • BrickletIMUV3`SENSORUFUSIONUONUWITHOUTUFASTUMAGNETOMETERUCALIBRATION = 3
BrickletIMUV3@GetSensorFusionMode[] → mode
Returns:
  • mode – Type: Integer, Range: See constants, Default: 1

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

The following constants are available for this function:

For mode:

  • BrickletIMUV3`SENSORUFUSIONUOFF = 0
  • BrickletIMUV3`SENSORUFUSIONUON = 1
  • BrickletIMUV3`SENSORUFUSIONUONUWITHOUTUMAGNETOMETER = 2
  • BrickletIMUV3`SENSORUFUSIONUONUWITHOUTUFASTUMAGNETOMETERUCALIBRATION = 3
BrickletIMUV3@GetSPITFPErrorCount[out errorCountAckChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Output Parameters:
  • errorCountAckChecksum – Type: Integer, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: Integer, Range: [0 to 232 - 1]
  • errorCountFrame – Type: Integer, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: Integer, 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.

BrickletIMUV3@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:

  • BrickletIMUV3`STATUSULEDUCONFIGUOFF = 0
  • BrickletIMUV3`STATUSULEDUCONFIGUON = 1
  • BrickletIMUV3`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletIMUV3`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletIMUV3@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:

  • BrickletIMUV3`STATUSULEDUCONFIGUOFF = 0
  • BrickletIMUV3`STATUSULEDUCONFIGUON = 1
  • BrickletIMUV3`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletIMUV3`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletIMUV3@GetChipTemperature[] → temperature
Returns:
  • temperature – Type: Integer, 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.

BrickletIMUV3@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!

BrickletIMUV3@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
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 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

BrickletIMUV3@SetAccelerationCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

BrickletIMUV3@GetAccelerationCallbackConfiguration[out period, out valueHasToChange] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

Returns the callback configuration as set by SetAccelerationCallbackConfiguration[].

BrickletIMUV3@SetMagneticFieldCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

BrickletIMUV3@GetMagneticFieldCallbackConfiguration[out period, out valueHasToChange] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

Returns the callback configuration as set by SetMagneticFieldCallbackConfiguration[].

BrickletIMUV3@SetAngularVelocityCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

BrickletIMUV3@GetAngularVelocityCallbackConfiguration[out period, out valueHasToChange] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

Returns the callback configuration as set by SetAngularVelocityCallbackConfiguration[].

BrickletIMUV3@SetTemperatureCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

BrickletIMUV3@GetTemperatureCallbackConfiguration[out period, out valueHasToChange] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

Returns the callback configuration as set by SetTemperatureCallbackConfiguration[].

BrickletIMUV3@SetOrientationCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

BrickletIMUV3@GetOrientationCallbackConfiguration[out period, out valueHasToChange] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

Returns the callback configuration as set by SetOrientationCallbackConfiguration[].

BrickletIMUV3@SetLinearAccelerationCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

BrickletIMUV3@GetLinearAccelerationCallbackConfiguration[out period, out valueHasToChange] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

Returns the callback configuration as set by SetLinearAccelerationCallbackConfiguration[].

BrickletIMUV3@SetGravityVectorCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

BrickletIMUV3@GetGravityVectorCallbackConfiguration[out period, out valueHasToChange] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

Returns the callback configuration as set by SetGravityVectorCallbackConfiguration[].

BrickletIMUV3@SetQuaternionCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

BrickletIMUV3@GetQuaternionCallbackConfiguration[out period, out valueHasToChange] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

Returns the callback configuration as set by SetQuaternionCallbackConfiguration[].

BrickletIMUV3@SetAllDataCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

BrickletIMUV3@GetAllDataCallbackConfiguration[out period, out valueHasToChange] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

Returns the callback configuration as set by SetAllDataCallbackConfiguration[].

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[imuV3@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 BrickletIMUV3@AccelerationCallback[sender, x, y, z]
Callback Parameters:
  • sender – Type: NETObject[BrickletIMUV3]
  • x – Type: Integer, Unit: 1 cm/s², Range: ?
  • y – Type: Integer, Unit: 1 cm/s², Range: ?
  • z – Type: Integer, Unit: 1 cm/s², Range: ?

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

event BrickletIMUV3@MagneticFieldCallback[sender, x, y, z]
Callback Parameters:
  • sender – Type: NETObject[BrickletIMUV3]
  • x – Type: Integer, Unit: 1/16 µT, Range: [-20800 to 20800]
  • y – Type: Integer, Unit: 1/16 µT, Range: [-20800 to 20800]
  • z – Type: Integer, Unit: 1/16 µT, Range: [-40000 to 40000]

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

event BrickletIMUV3@AngularVelocityCallback[sender, x, y, z]
Callback Parameters:
  • sender – Type: NETObject[BrickletIMUV3]
  • x – Type: Integer, Unit: 1/16 °/s, Range: ?
  • y – Type: Integer, Unit: 1/16 °/s, Range: ?
  • z – Type: Integer, Unit: 1/16 °/s, Range: ?

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

event BrickletIMUV3@TemperatureCallback[sender, temperature]
Callback Parameters:
  • sender – Type: NETObject[BrickletIMUV3]
  • temperature – Type: Integer, Unit: 1 °C, Range: [-128 to 127]

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

event BrickletIMUV3@LinearAccelerationCallback[sender, x, y, z]
Callback Parameters:
  • sender – Type: NETObject[BrickletIMUV3]
  • x – Type: Integer, Unit: 1 cm/s², Range: ?
  • y – Type: Integer, Unit: 1 cm/s², Range: ?
  • z – Type: Integer, Unit: 1 cm/s², Range: ?

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

event BrickletIMUV3@GravityVectorCallback[sender, x, y, z]
Callback Parameters:
  • sender – Type: NETObject[BrickletIMUV3]
  • x – Type: Integer, Unit: 1 cm/s², Range: [-981 to 981]
  • y – Type: Integer, Unit: 1 cm/s², Range: [-981 to 981]
  • z – Type: Integer, Unit: 1 cm/s², Range: [-981 to 981]

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

event BrickletIMUV3@OrientationCallback[sender, heading, roll, pitch]
Callback Parameters:
  • sender – Type: NETObject[BrickletIMUV3]
  • heading – Type: Integer, Unit: 1/16 °, Range: [0 to 5760]
  • roll – Type: Integer, Unit: 1/16 °, Range: [-1440 to 1440]
  • pitch – Type: Integer, Unit: 1/16 °, Range: [-2880 to 2880]

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

event BrickletIMUV3@QuaternionCallback[sender, w, x, y, z]
Callback Parameters:
  • sender – Type: NETObject[BrickletIMUV3]
  • w – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
  • x – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
  • y – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
  • z – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]

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

event BrickletIMUV3@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]
Callback Parameters:
  • sender – Type: NETObject[BrickletIMUV3]
  • accelerationi – Type: Integer
    • 1: x – Type: Integer, Unit: 1 cm/s², Range: ?
    • 2: y – Type: Integer, Unit: 1 cm/s², Range: ?
    • 3: z – Type: Integer, Unit: 1 cm/s², Range: ?
  • magneticFieldi – Type: Integer
    • 1: x – Type: Integer, Unit: 1/16 µT, Range: [-20800 to 20800]
    • 2: y – Type: Integer, Unit: 1/16 µT, Range: [-20800 to 20800]
    • 3: z – Type: Integer, Unit: 1/16 µT, Range: [-40000 to 40000]
  • angularVelocityi – Type: Integer
    • 1: x – Type: Integer, Unit: 1/16 °/s, Range: ?
    • 2: y – Type: Integer, Unit: 1/16 °/s, Range: ?
    • 3: z – Type: Integer, Unit: 1/16 °/s, Range: ?
  • eulerAnglei – Type: Integer
    • 1: heading – Type: Integer, Unit: 1/16 °, Range: [0 to 5760]
    • 2: roll – Type: Integer, Unit: 1/16 °, Range: [-1440 to 1440]
    • 3: pitch – Type: Integer, Unit: 1/16 °, Range: [-2880 to 2880]
  • quaternioni – Type: Integer
    • 1: w – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
    • 2: x – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
    • 3: y – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
    • 4: z – Type: Integer, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]
  • linearAccelerationi – Type: Integer
    • 1: x – Type: Integer, Unit: 1 cm/s², Range: ?
    • 2: y – Type: Integer, Unit: 1 cm/s², Range: ?
    • 3: z – Type: Integer, Unit: 1 cm/s², Range: ?
  • gravityVectori – Type: Integer
    • 1: x – Type: Integer, Unit: 1 cm/s², Range: ?
    • 2: y – Type: Integer, Unit: 1 cm/s², Range: ?
    • 3: z – Type: Integer, Unit: 1 cm/s², Range: ?
  • temperature – Type: Integer, Unit: 1 °C, Range: [-128 to 127]
  • calibrationStatus – Type: Integer, Range: [0 to 255]

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

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.

BrickletIMUV3@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.

BrickletIMUV3@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:

  • BrickletIMUV3`FUNCTIONUSETUSENSORUCONFIGURATION = 11
  • BrickletIMUV3`FUNCTIONUSETUSENSORUFUSIONUMODE = 13
  • BrickletIMUV3`FUNCTIONUSETUACCELERATIONUCALLBACKUCONFIGURATION = 15
  • BrickletIMUV3`FUNCTIONUSETUMAGNETICUFIELDUCALLBACKUCONFIGURATION = 17
  • BrickletIMUV3`FUNCTIONUSETUANGULARUVELOCITYUCALLBACKUCONFIGURATION = 19
  • BrickletIMUV3`FUNCTIONUSETUTEMPERATUREUCALLBACKUCONFIGURATION = 21
  • BrickletIMUV3`FUNCTIONUSETUORIENTATIONUCALLBACKUCONFIGURATION = 23
  • BrickletIMUV3`FUNCTIONUSETULINEARUACCELERATIONUCALLBACKUCONFIGURATION = 25
  • BrickletIMUV3`FUNCTIONUSETUGRAVITYUVECTORUCALLBACKUCONFIGURATION = 27
  • BrickletIMUV3`FUNCTIONUSETUQUATERNIONUCALLBACKUCONFIGURATION = 29
  • BrickletIMUV3`FUNCTIONUSETUALLUDATAUCALLBACKUCONFIGURATION = 31
  • BrickletIMUV3`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletIMUV3`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletIMUV3`FUNCTIONURESET = 243
  • BrickletIMUV3`FUNCTIONUWRITEUUID = 248
BrickletIMUV3@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.

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:

  • BrickletIMUV3`FUNCTIONUSETUSENSORUCONFIGURATION = 11
  • BrickletIMUV3`FUNCTIONUSETUSENSORUFUSIONUMODE = 13
  • BrickletIMUV3`FUNCTIONUSETUACCELERATIONUCALLBACKUCONFIGURATION = 15
  • BrickletIMUV3`FUNCTIONUSETUMAGNETICUFIELDUCALLBACKUCONFIGURATION = 17
  • BrickletIMUV3`FUNCTIONUSETUANGULARUVELOCITYUCALLBACKUCONFIGURATION = 19
  • BrickletIMUV3`FUNCTIONUSETUTEMPERATUREUCALLBACKUCONFIGURATION = 21
  • BrickletIMUV3`FUNCTIONUSETUORIENTATIONUCALLBACKUCONFIGURATION = 23
  • BrickletIMUV3`FUNCTIONUSETULINEARUACCELERATIONUCALLBACKUCONFIGURATION = 25
  • BrickletIMUV3`FUNCTIONUSETUGRAVITYUVECTORUCALLBACKUCONFIGURATION = 27
  • BrickletIMUV3`FUNCTIONUSETUQUATERNIONUCALLBACKUCONFIGURATION = 29
  • BrickletIMUV3`FUNCTIONUSETUALLUDATAUCALLBACKUCONFIGURATION = 31
  • BrickletIMUV3`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletIMUV3`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletIMUV3`FUNCTIONURESET = 243
  • BrickletIMUV3`FUNCTIONUWRITEUUID = 248
BrickletIMUV3@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.

BrickletIMUV3@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:

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

For status:

  • BrickletIMUV3`BOOTLOADERUSTATUSUOK = 0
  • BrickletIMUV3`BOOTLOADERUSTATUSUINVALIDUMODE = 1
  • BrickletIMUV3`BOOTLOADERUSTATUSUNOUCHANGE = 2
  • BrickletIMUV3`BOOTLOADERUSTATUSUENTRYUFUNCTIONUNOTUPRESENT = 3
  • BrickletIMUV3`BOOTLOADERUSTATUSUDEVICEUIDENTIFIERUINCORRECT = 4
  • BrickletIMUV3`BOOTLOADERUSTATUSUCRCUMISMATCH = 5
BrickletIMUV3@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:

  • BrickletIMUV3`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletIMUV3`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletIMUV3`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletIMUV3`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletIMUV3`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
BrickletIMUV3@SetWriteFirmwarePointer[pointer] → Null
Parameters:
  • pointer – Type: Integer, 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.

BrickletIMUV3@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.

BrickletIMUV3@WriteUID[uid] → Null
Parameters:
  • uid – Type: Integer, 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.

BrickletIMUV3@ReadUID[] → uid
Returns:
  • uid – Type: Integer, Range: [0 to 232 - 1]

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

Constants

BrickletIMUV3`DEVICEUIDENTIFIER

This constant is used to identify a IMU 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.

BrickletIMUV3`DEVICEDISPLAYNAME

This constant represents the human readable name of a IMU Bricklet 3.0.