Shell - IMU Brick 2.0¶

Simple¶

Download (example-simple.sh)

1
2
3
4
5
6
7

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XXYYZZ # Change XXYYZZ to the UID of your IMU Brick 2.0

# Get current quaternion
tinkerforge call imu-v2-brick $uid get-quaternion

All Data¶

Download (example-all-data.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XXYYZZ # Change XXYYZZ to the UID of your IMU Brick 2.0

# Handle incoming all data callbacks
tinkerforge dispatch imu-v2-brick $uid all-data &

# Set period for all data callback to 0.1s (100ms)
tinkerforge call imu-v2-brick $uid set-all-data-period 100

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Callback¶

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XXYYZZ # Change XXYYZZ to the UID of your IMU Brick 2.0

# Handle incoming quaternion callbacks
tinkerforge dispatch imu-v2-brick $uid quaternion &

# Set period for quaternion callback to 0.1s (100ms)
tinkerforge call imu-v2-brick $uid set-quaternion-period 100

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Command Structure¶

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call imu-v2-brick [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the IMU Brick 2.0. It can take several options:

• --help shows help for the specific call command and exits
• --list-functions shows a list of known functions of the IMU Brick 2.0 and exits

tinkerforge dispatch imu-v2-brick [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the IMU Brick 2.0. It can take several options:

• --help shows help for the specific dispatch command and exits
• --list-callbacks shows a list of known callbacks of the IMU Brick 2.0 and exits

tinkerforge call imu-v2-brick <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

• --help shows help for the specific function and exits

Getter functions can take the following options:

• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

• --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch imu-v2-brick <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: String

The <callback> to be dispatched can take several options:

• --help shows help for the specific callback and exits
• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions¶

tinkerforge call imu-v2-brick <uid> get-orientation¶

Output:	heading – Type: Int, Unit: 1/16 °, Range: [0 to 5760] roll – Type: Int, Unit: 1/16 °, Range: [-1440 to 1440] pitch – Type: Int, 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 orientation callback and set the period with set-orientation-period.

tinkerforge call imu-v2-brick <uid> get-linear-acceleration¶

Output:	x – Type: Int, Unit: 1 cm/s², Range: ? y – Type: Int, Unit: 1 cm/s², Range: ? z – Type: Int, 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 set-sensor-configuration.

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 get-gravity-vector.

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

tinkerforge call imu-v2-brick <uid> get-gravity-vector¶

Output:	x – Type: Int, Unit: 1 cm/s², Range: [-981 to 981] y – Type: Int, Unit: 1 cm/s², Range: [-981 to 981] z – Type: Int, 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 get-linear-acceleration.

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

tinkerforge call imu-v2-brick <uid> get-quaternion¶

Output:	w – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] x – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] y – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] z – Type: Int, 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 quaternion callback and set the period with set-quaternion-period.

tinkerforge call imu-v2-brick <uid> get-all-data¶

Output:

acceleration – Type: Int Array, Length: 3 0: x – Type: Int, Unit: 1 cm/s², Range: ? 1: y – Type: Int, Unit: 1 cm/s², Range: ? 2: z – Type: Int, Unit: 1 cm/s², Range: ? magnetic-field – Type: Int Array, Length: 3 0: x – Type: Int, Unit: 1/16 µT, Range: [-20800 to 20800] 1: y – Type: Int, Unit: 1/16 µT, Range: [-20800 to 20800] 2: z – Type: Int, Unit: 1/16 µT, Range: [-40000 to 40000] angular-velocity – Type: Int Array, Length: 3 0: x – Type: Int, Unit: 1/16 °/s, Range: ? 1: y – Type: Int, Unit: 1/16 °/s, Range: ? 2: z – Type: Int, Unit: 1/16 °/s, Range: ? euler-angle – Type: Int Array, Length: 3 0: heading – Type: Int, Unit: 1/16 °, Range: [0 to 5760] 1: roll – Type: Int, Unit: 1/16 °, Range: [-1440 to 1440] 2: pitch – Type: Int, Unit: 1/16 °, Range: [-2880 to 2880] quaternion – Type: Int Array, Length: 4 0: w – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] 1: x – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] 2: y – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] 3: z – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] linear-acceleration – Type: Int Array, Length: 3 0: x – Type: Int, Unit: 1 cm/s², Range: ? 1: y – Type: Int, Unit: 1 cm/s², Range: ? 2: z – Type: Int, Unit: 1 cm/s², Range: ? gravity-vector – Type: Int Array, Length: 3 0: x – Type: Int, Unit: 1 cm/s², Range: [-981 to 981] 1: y – Type: Int, Unit: 1 cm/s², Range: [-981 to 981] 2: z – Type: Int, Unit: 1 cm/s², Range: [-981 to 981] temperature – Type: Int, Unit: 1 °C, Range: [-128 to 127] calibration-status – Type: Int, Range: [0 to 255]

Return all of the available data of the IMU Brick.

• acceleration (see get-acceleration)
• magnetic field (see get-magnetic-field)
• angular velocity (see get-angular-velocity)
• Euler angles (see get-orientation)
• quaternion (see get-quaternion)
• linear acceleration (see get-linear-acceleration)
• gravity vector (see get-gravity-vector)
• temperature (see get-temperature)
• calibration status (see below)

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 all-data callback and set the period with set-all-data-period.

tinkerforge call imu-v2-brick <uid> leds-on¶

Output:	no output

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

tinkerforge call imu-v2-brick <uid> leds-off¶

Output:	no output

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

tinkerforge call imu-v2-brick <uid> are-leds-on¶

Output:	leds – Type: Bool, Default: true

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

Advanced Functions¶

tinkerforge call imu-v2-brick <uid> get-acceleration¶

Output:	x – Type: Int, Unit: 1 cm/s², Range: ? y – Type: Int, Unit: 1 cm/s², Range: ? z – Type: Int, 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 set-sensor-configuration.

If you want to get the acceleration periodically, it is recommended to use the acceleration callback and set the period with set-acceleration-period.

tinkerforge call imu-v2-brick <uid> get-magnetic-field¶

Output:	x – Type: Int, Unit: 1/16 µT, Range: [-20800 to 20800] y – Type: Int, Unit: 1/16 µT, Range: [-20800 to 20800] z – Type: Int, 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 magnetic-field callback and set the period with set-magnetic-field-period.

tinkerforge call imu-v2-brick <uid> get-angular-velocity¶

Output:	x – Type: Int, Unit: 1/16 °/s, Range: ? y – Type: Int, Unit: 1/16 °/s, Range: ? z – Type: Int, 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 set-sensor-configuration.

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

tinkerforge call imu-v2-brick <uid> get-temperature¶

Output:	temperature – Type: Int, 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

tinkerforge call imu-v2-brick <uid> save-calibration¶

Output:	calibration-done – Type: Bool

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.

tinkerforge call imu-v2-brick <uid> set-sensor-configuration <magnetometer-rate> <gyroscope-range> <gyroscope-bandwidth> <accelerometer-range> <accelerometer-bandwidth>¶

Parameters:	<magnetometer-rate> – Type: Int, Range: See symbols, Default: 5 <gyroscope-range> – Type: Int, Range: See symbols, Default: 0 <gyroscope-bandwidth> – Type: Int, Range: See symbols, Default: 7 <accelerometer-range> – Type: Int, Range: See symbols, Default: 1 <accelerometer-bandwidth> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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

For <magnetometer-rate>:

• magnetometer-rate-2hz = 0
• magnetometer-rate-6hz = 1
• magnetometer-rate-8hz = 2
• magnetometer-rate-10hz = 3
• magnetometer-rate-15hz = 4
• magnetometer-rate-20hz = 5
• magnetometer-rate-25hz = 6
• magnetometer-rate-30hz = 7

For <gyroscope-range>:

• gyroscope-range-2000dps = 0
• gyroscope-range-1000dps = 1
• gyroscope-range-500dps = 2
• gyroscope-range-250dps = 3
• gyroscope-range-125dps = 4

For <gyroscope-bandwidth>:

• gyroscope-bandwidth-523hz = 0
• gyroscope-bandwidth-230hz = 1
• gyroscope-bandwidth-116hz = 2
• gyroscope-bandwidth-47hz = 3
• gyroscope-bandwidth-23hz = 4
• gyroscope-bandwidth-12hz = 5
• gyroscope-bandwidth-64hz = 6
• gyroscope-bandwidth-32hz = 7

For <accelerometer-range>:

• accelerometer-range-2g = 0
• accelerometer-range-4g = 1
• accelerometer-range-8g = 2
• accelerometer-range-16g = 3

For <accelerometer-bandwidth>:

• accelerometer-bandwidth-7-81hz = 0
• accelerometer-bandwidth-15-63hz = 1
• accelerometer-bandwidth-31-25hz = 2
• accelerometer-bandwidth-62-5hz = 3
• accelerometer-bandwidth-125hz = 4
• accelerometer-bandwidth-250hz = 5
• accelerometer-bandwidth-500hz = 6
• accelerometer-bandwidth-1000hz = 7

New in version 2.0.5 (Firmware).

tinkerforge call imu-v2-brick <uid> get-sensor-configuration¶

Output:	magnetometer-rate – Type: Int, Range: See symbols, Default: 5 gyroscope-range – Type: Int, Range: See symbols, Default: 0 gyroscope-bandwidth – Type: Int, Range: See symbols, Default: 7 accelerometer-range – Type: Int, Range: See symbols, Default: 1 accelerometer-bandwidth – Type: Int, Range: See symbols, Default: 3

Returns the sensor configuration as set by set-sensor-configuration.

The following symbols are available for this function:

For magnetometer-rate:

• magnetometer-rate-2hz = 0
• magnetometer-rate-6hz = 1
• magnetometer-rate-8hz = 2
• magnetometer-rate-10hz = 3
• magnetometer-rate-15hz = 4
• magnetometer-rate-20hz = 5
• magnetometer-rate-25hz = 6
• magnetometer-rate-30hz = 7

For gyroscope-range:

• gyroscope-range-2000dps = 0
• gyroscope-range-1000dps = 1
• gyroscope-range-500dps = 2
• gyroscope-range-250dps = 3
• gyroscope-range-125dps = 4

For gyroscope-bandwidth:

• gyroscope-bandwidth-523hz = 0
• gyroscope-bandwidth-230hz = 1
• gyroscope-bandwidth-116hz = 2
• gyroscope-bandwidth-47hz = 3
• gyroscope-bandwidth-23hz = 4
• gyroscope-bandwidth-12hz = 5
• gyroscope-bandwidth-64hz = 6
• gyroscope-bandwidth-32hz = 7

For accelerometer-range:

• accelerometer-range-2g = 0
• accelerometer-range-4g = 1
• accelerometer-range-8g = 2
• accelerometer-range-16g = 3

For accelerometer-bandwidth:

• accelerometer-bandwidth-7-81hz = 0
• accelerometer-bandwidth-15-63hz = 1
• accelerometer-bandwidth-31-25hz = 2
• accelerometer-bandwidth-62-5hz = 3
• accelerometer-bandwidth-125hz = 4
• accelerometer-bandwidth-250hz = 5
• accelerometer-bandwidth-500hz = 6
• accelerometer-bandwidth-1000hz = 7

New in version 2.0.5 (Firmware).

tinkerforge call imu-v2-brick <uid> set-sensor-fusion-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols, Default: 1
Output:	no output

If the fusion mode is turned off, the functions get-acceleration, get-magnetic-field and get-angular-velocity 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 symbols are available for this function:

For <mode>:

• sensor-fusion-off = 0
• sensor-fusion-on = 1
• sensor-fusion-on-without-magnetometer = 2
• sensor-fusion-on-without-fast-magnetometer-calibration = 3

New in version 2.0.5 (Firmware).

tinkerforge call imu-v2-brick <uid> get-sensor-fusion-mode¶

Output:	mode – Type: Int, Range: See symbols, Default: 1

Returns the sensor fusion mode as set by set-sensor-fusion-mode.

The following symbols are available for this function:

For mode:

• sensor-fusion-off = 0
• sensor-fusion-on = 1
• sensor-fusion-on-without-magnetometer = 2
• sensor-fusion-on-without-fast-magnetometer-calibration = 3

New in version 2.0.5 (Firmware).

tinkerforge call imu-v2-brick <uid> set-spitfp-baudrate-config <enable-dynamic-baudrate> <minimum-dynamic-baudrate>¶

Parameters:	<enable-dynamic-baudrate> – Type: Bool, Default: true <minimum-dynamic-baudrate> – Type: Int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000
Output:	no output

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 sent/received and decreased linearly if little data is sent/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 set-spitfp-baudrate. If the dynamic baudrate is disabled, the baudrate as set by set-spitfp-baudrate will be used statically.

New in version 2.0.10 (Firmware).

tinkerforge call imu-v2-brick <uid> get-spitfp-baudrate-config¶

Output:	enable-dynamic-baudrate – Type: Bool, Default: true minimum-dynamic-baudrate – Type: Int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000

Returns the baudrate config, see set-spitfp-baudrate-config.

New in version 2.0.10 (Firmware).

tinkerforge call imu-v2-brick <uid> get-send-timeout-count <communication-method>¶

Parameters:	<communication-method> – Type: Int, Range: See symbols
Output:	timeout-count – Type: Int, Range: [0 to 232 - 1]

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

For <communication-method>:

• communication-method-none = 0
• communication-method-usb = 1
• communication-method-spi-stack = 2
• communication-method-chibi = 3
• communication-method-rs485 = 4
• communication-method-wifi = 5
• communication-method-ethernet = 6
• communication-method-wifi-v2 = 7

New in version 2.0.7 (Firmware).

tinkerforge call imu-v2-brick <uid> set-spitfp-baudrate <bricklet-port> <baudrate>¶

Parameters:	<bricklet-port> – Type: Char, Range: [a to b] <baudrate> – Type: Int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000
Output:	no output

Sets the baudrate for a specific Bricklet port.

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 get-spitfp-error-count) you can decrease the baudrate.

If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (see set-spitfp-baudrate-config).

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

New in version 2.0.5 (Firmware).

tinkerforge call imu-v2-brick <uid> get-spitfp-baudrate <bricklet-port>¶

Parameters:	<bricklet-port> – Type: Char, Range: [a to b]
Output:	baudrate – Type: Int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000

Returns the baudrate for a given Bricklet port, see set-spitfp-baudrate.

New in version 2.0.5 (Firmware).

tinkerforge call imu-v2-brick <uid> get-spitfp-error-count <bricklet-port>¶

Parameters:	<bricklet-port> – Type: Char, Range: [a to b]
Output:	error-count-ack-checksum – Type: Int, Range: [0 to 232 - 1] error-count-message-checksum – Type: Int, Range: [0 to 232 - 1] error-count-frame – Type: Int, Range: [0 to 232 - 1] error-count-overflow – Type: Int, 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 Brick side. All Bricklets have a similar function that returns the errors on the Bricklet side.

New in version 2.0.5 (Firmware).

tinkerforge call imu-v2-brick <uid> enable-status-led¶

Output:	no output

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.

tinkerforge call imu-v2-brick <uid> disable-status-led¶

Output:	no output

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.

tinkerforge call imu-v2-brick <uid> is-status-led-enabled¶

Output:	enabled – Type: Bool, Default: true

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

tinkerforge call imu-v2-brick <uid> get-chip-temperature¶

Output:	temperature – Type: Int, Unit: 1/10 °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 an accuracy of ±15%. Practically it is only useful as an indicator for temperature changes.

tinkerforge call imu-v2-brick <uid> reset¶

Output:	no output

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!

tinkerforge call imu-v2-brick <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [0 to 8] hardware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] firmware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] device-identifier – Type: Int, Range: [0 to 216 - 1]

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 is the position in the stack from '0' (bottom) to '8' (top).

The device identifier numbers can be found here. 

Callback Configuration Functions¶

tinkerforge call imu-v2-brick <uid> set-acceleration-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

tinkerforge call imu-v2-brick <uid> get-acceleration-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-acceleration-period.

tinkerforge call imu-v2-brick <uid> set-magnetic-field-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

tinkerforge call imu-v2-brick <uid> get-magnetic-field-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-magnetic-field-period.

tinkerforge call imu-v2-brick <uid> set-angular-velocity-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

tinkerforge call imu-v2-brick <uid> get-angular-velocity-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-angular-velocity-period.

tinkerforge call imu-v2-brick <uid> set-temperature-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

tinkerforge call imu-v2-brick <uid> get-temperature-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-temperature-period.

tinkerforge call imu-v2-brick <uid> set-orientation-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

tinkerforge call imu-v2-brick <uid> get-orientation-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-orientation-period.

tinkerforge call imu-v2-brick <uid> set-linear-acceleration-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

tinkerforge call imu-v2-brick <uid> get-linear-acceleration-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-linear-acceleration-period.

tinkerforge call imu-v2-brick <uid> set-gravity-vector-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

tinkerforge call imu-v2-brick <uid> get-gravity-vector-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-gravity-vector-period.

tinkerforge call imu-v2-brick <uid> set-quaternion-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

tinkerforge call imu-v2-brick <uid> get-quaternion-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-quaternion-period.

tinkerforge call imu-v2-brick <uid> set-all-data-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

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

tinkerforge call imu-v2-brick <uid> get-all-data-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-all-data-period.

Callbacks¶

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch imu-v2-brick <uid> example

The available callbacks are described below.

tinkerforge dispatch imu-v2-brick <uid> acceleration¶

Output:	x – Type: Int, Unit: 1 cm/s², Range: ? y – Type: Int, Unit: 1 cm/s², Range: ? z – Type: Int, Unit: 1 cm/s², Range: ?

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

tinkerforge dispatch imu-v2-brick <uid> magnetic-field¶

Output:	x – Type: Int, Unit: 1/16 µT, Range: [-20800 to 20800] y – Type: Int, Unit: 1/16 µT, Range: [-20800 to 20800] z – Type: Int, Unit: 1/16 µT, Range: [-40000 to 40000]

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

tinkerforge dispatch imu-v2-brick <uid> angular-velocity¶

Output:	x – Type: Int, Unit: 1/16 °/s, Range: ? y – Type: Int, Unit: 1/16 °/s, Range: ? z – Type: Int, Unit: 1/16 °/s, Range: ?

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

tinkerforge dispatch imu-v2-brick <uid> temperature¶

Output:	temperature – Type: Int, Unit: 1 °C, Range: [-128 to 127]

This callback is triggered periodically with the period that is set by set-temperature-period. The parameter is the temperature.

tinkerforge dispatch imu-v2-brick <uid> linear-acceleration¶

Output:	x – Type: Int, Unit: 1 cm/s², Range: ? y – Type: Int, Unit: 1 cm/s², Range: ? z – Type: Int, Unit: 1 cm/s², Range: ?

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

tinkerforge dispatch imu-v2-brick <uid> gravity-vector¶

Output:	x – Type: Int, Unit: 1 cm/s², Range: [-981 to 981] y – Type: Int, Unit: 1 cm/s², Range: [-981 to 981] z – Type: Int, Unit: 1 cm/s², Range: [-981 to 981]

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

tinkerforge dispatch imu-v2-brick <uid> orientation¶

Output:	heading – Type: Int, Unit: 1/16 °, Range: [0 to 5760] roll – Type: Int, Unit: 1/16 °, Range: [-1440 to 1440] pitch – Type: Int, Unit: 1/16 °, Range: [-2880 to 2880]

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

tinkerforge dispatch imu-v2-brick <uid> quaternion¶

Output:	w – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] x – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] y – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] z – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1]

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

tinkerforge dispatch imu-v2-brick <uid> all-data¶

Output:

acceleration – Type: Int Array, Length: 3 0: x – Type: Int, Unit: 1 cm/s², Range: ? 1: y – Type: Int, Unit: 1 cm/s², Range: ? 2: z – Type: Int, Unit: 1 cm/s², Range: ? magnetic-field – Type: Int Array, Length: 3 0: x – Type: Int, Unit: 1/16 µT, Range: [-20800 to 20800] 1: y – Type: Int, Unit: 1/16 µT, Range: [-20800 to 20800] 2: z – Type: Int, Unit: 1/16 µT, Range: [-40000 to 40000] angular-velocity – Type: Int Array, Length: 3 0: x – Type: Int, Unit: 1/16 °/s, Range: ? 1: y – Type: Int, Unit: 1/16 °/s, Range: ? 2: z – Type: Int, Unit: 1/16 °/s, Range: ? euler-angle – Type: Int Array, Length: 3 0: heading – Type: Int, Unit: 1/16 °, Range: [0 to 5760] 1: roll – Type: Int, Unit: 1/16 °, Range: [-1440 to 1440] 2: pitch – Type: Int, Unit: 1/16 °, Range: [-2880 to 2880] quaternion – Type: Int Array, Length: 4 0: w – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] 1: x – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] 2: y – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] 3: z – Type: Int, Unit: 1/16383, Range: [-214 + 1 to 214 - 1] linear-acceleration – Type: Int Array, Length: 3 0: x – Type: Int, Unit: 1 cm/s², Range: ? 1: y – Type: Int, Unit: 1 cm/s², Range: ? 2: z – Type: Int, Unit: 1 cm/s², Range: ? gravity-vector – Type: Int Array, Length: 3 0: x – Type: Int, Unit: 1 cm/s², Range: ? 1: y – Type: Int, Unit: 1 cm/s², Range: ? 2: z – Type: Int, Unit: 1 cm/s², Range: ? temperature – Type: Int, Unit: 1 °C, Range: [-128 to 127] calibration-status – Type: Int, Range: [0 to 255]

This callback is triggered periodically with the period that is set by set-all-data-period. The parameters are as for get-all-data.

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.

tinkerforge call imu-v2-brick <uid> get-protocol1-bricklet-name <port>¶

Parameters:	<port> – Type: Char, Range: [a to b]
Output:	protocol-version – Type: Int, Range: [0 to 255] firmware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] name – Type: String, Length: up to 40

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.

tinkerforge call imu-v2-brick <uid> write-bricklet-plugin <port> <offset> <chunk>¶

Parameters:	<port> – Type: Char, Range: [a to b] <offset> – Type: Int, Range: [0 to 255] <chunk> – Type: Int Array, Length: 32, Range: [0 to 255]
Output:	no output

Writes 32 bytes of firmware to the bricklet attached at the given port. The bytes are written to the position offset * 32.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call imu-v2-brick <uid> read-bricklet-plugin <port> <offset>¶

Parameters:	<port> – Type: Char, Range: [a to b] <offset> – Type: Int, Range: [0 to 255]
Output:	chunk – Type: Int Array, Length: 32, Range: [0 to 255]

Reads 32 bytes of firmware from the bricklet attached at the given port. The bytes are read starting at the position offset * 32.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.