Ruby - IMU Bricklet 3.0¶

Simple¶

Download (example_simple.rb)

 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

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_imu_v3'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your IMU Bricklet 3.0

ipcon = IPConnection.new # Create IP connection
imu = BrickletIMUV3.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get current quaternion as [w, x, y, z]
quaternion = imu.get_quaternion

puts "Quaternion [W]: #{quaternion[0]/16383.0}"
puts "Quaternion [X]: #{quaternion[1]/16383.0}"
puts "Quaternion [Y]: #{quaternion[2]/16383.0}"
puts "Quaternion [Z]: #{quaternion[3]/16383.0}"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Callback¶

Download (example_callback.rb)

 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

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_imu_v3'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your IMU Bricklet 3.0

ipcon = IPConnection.new # Create IP connection
imu = BrickletIMUV3.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register quaternion callback
imu.register_callback(BrickletIMUV3::CALLBACK_QUATERNION) do |w, x, y, z|
  puts "Quaternion [W]: #{w/16383.0}"
  puts "Quaternion [X]: #{x/16383.0}"
  puts "Quaternion [Y]: #{y/16383.0}"
  puts "Quaternion [Z]: #{z/16383.0}"
  puts ''
end

# Set period for quaternion callback to 0.1s (100ms)
imu.set_quaternion_callback_configuration 100, false

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

All Data¶

Download (example_all_data.rb)

 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

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_imu_v3'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your IMU Bricklet 3.0

ipcon = IPConnection.new # Create IP connection
imu = BrickletIMUV3.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register all data callback
imu.register_callback(BrickletIMUV3::CALLBACK_ALL_DATA) do |acceleration, magnetic_field,
                                                            angular_velocity, euler_angle,
                                                            quaternion,
                                                            linear_acceleration,
                                                            gravity_vector, temperature,
                                                            calibration_status|
  puts "Acceleration [X]: #{acceleration[0]/100.0} m/s²"
  puts "Acceleration [Y]: #{acceleration[1]/100.0} m/s²"
  puts "Acceleration [Z]: #{acceleration[2]/100.0} m/s²"
  puts "Magnetic Field [X]: #{magnetic_field[0]/16.0} µT"
  puts "Magnetic Field [Y]: #{magnetic_field[1]/16.0} µT"
  puts "Magnetic Field [Z]: #{magnetic_field[2]/16.0} µT"
  puts "Angular Velocity [X]: #{angular_velocity[0]/16.0} °/s"
  puts "Angular Velocity [Y]: #{angular_velocity[1]/16.0} °/s"
  puts "Angular Velocity [Z]: #{angular_velocity[2]/16.0} °/s"
  puts "Euler Angle [Heading]: #{euler_angle[0]/16.0} °"
  puts "Euler Angle [Roll]: #{euler_angle[1]/16.0} °"
  puts "Euler Angle [Pitch]: #{euler_angle[2]/16.0} °"
  puts "Quaternion [W]: #{quaternion[0]/16383.0}"
  puts "Quaternion [X]: #{quaternion[1]/16383.0}"
  puts "Quaternion [Y]: #{quaternion[2]/16383.0}"
  puts "Quaternion [Z]: #{quaternion[3]/16383.0}"
  puts "Linear Acceleration [X]: #{linear_acceleration[0]/100.0} m/s²"
  puts "Linear Acceleration [Y]: #{linear_acceleration[1]/100.0} m/s²"
  puts "Linear Acceleration [Z]: #{linear_acceleration[2]/100.0} m/s²"
  puts "Gravity Vector [X]: #{gravity_vector[0]/100.0} m/s²"
  puts "Gravity Vector [Y]: #{gravity_vector[1]/100.0} m/s²"
  puts "Gravity Vector [Z]: #{gravity_vector[2]/100.0} m/s²"
  puts "Temperature: #{temperature} °C"
  puts "Calibration Status: #{'%08b' % calibration_status}"
  puts ''
end

# Set period for all data callback to 0.1s (100ms)
imu.set_all_data_callback_configuration 100, false

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Grundfunktionen¶

BrickletIMUV3::new(uid, ipcon) → imu_v3¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	imu_v3 – Typ: BrickletIMUV3

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

imu_v3 = BrickletIMUV3.new 'YOUR_DEVICE_UID', ipcon

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletIMUV3#get_orientation → [int, int, int]¶

Rückgabe-Array:	0: heading – Typ: int, Einheit: 1/16 °, Wertebereich: [0 bis 5760] 1: roll – Typ: int, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] 2: pitch – Typ: int, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]

Gibt die aktuelle Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in unabhängigen Eulerwinkeln zurück. Zu beachten ist, dass Eulerwinkel immer eine kardanische Blockade erfahren. Wir empfehlen daher stattdessen Quaternionen zu verwenden, wenn die absolute Lage im Raum bestimmt werden soll.

Wenn die Orientierung periodisch abgefragt werden sollen, wird empfohlen den ::CALLBACK_ORIENTATION Callback zu nutzen und die Periode mit #set_orientation_callback_configuration vorzugeben.

BrickletIMUV3#get_linear_acceleration → [int, int, int]¶

Rückgabe-Array:	0: x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int, Einheit: 1 cm/s², Wertebereich: ?

Gibt die lineare Beschleunigungen des IMU Brick für die X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit #set_sensor_configuration konfiguriert wurde.

Die lineare Beschleunigung ist die Beschleunigung in jede der drei Achsen. Der Einfluss von Erdbeschleunigung ist entfernt.

Es ist auch möglich einen Vektor der Erdbeschleunigung zu bekommen, siehe #get_gravity_vector

Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_LINEAR_ACCELERATION Callback zu nutzen und die Periode mit #set_linear_acceleration_callback_configuration vorzugeben.

BrickletIMUV3#get_gravity_vector → [int, int, int]¶

Rückgabe-Array:	0: x – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 1: y – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 2: z – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981]

Gibt den Vektor der Erdbeschleunigung des IMU Brick für die X-, Y- und Z-Achse zurück.

Die Erdbeschleunigung ist die Beschleunigung die auf Grund von Schwerkraft entsteht. Einflüsse von linearen Beschleunigungen sind entfernt.

Es ist auch möglich die lineare Beschleunigung zu bekommen, siehe #get_linear_acceleration

Wenn die Erdbeschleunigungen periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_GRAVITY_VECTOR Callback zu nutzen und die Periode mit #set_gravity_vector_callback_configuration vorzugeben.

BrickletIMUV3#get_quaternion → [int, int, int, int]¶

Rückgabe-Array:	0: w – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] 1: x – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] 2: y – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] 3: z – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1]

Gibt die aktuelle Orientierung (w, x, y, z) des IMU Brick als Quaterinonen zurück.

Die Rückgabewerte müssen mit 16383 (14 Bit) dividiert werden, um in den üblichen Wertebereich für Quaternionen (-1,0 bis +1,0) gebracht zu werden.

Wenn die Quaternionen periodisch abgefragt werden sollen, wird empfohlen den ::CALLBACK_QUATERNION Callback zu nutzen und die Periode mit #set_quaternion_callback_configuration vorzugeben.

BrickletIMUV3#get_all_data → [[int, ...], [int, ...], [int, ...], [int, ...], [int, ...], [int, ...], [int, ...], int, int]¶

Rückgabe-Array:

0: acceleration – Typ: [int, ...], Länge: 3 0: x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 1: magnetic_field – Typ: [int, ...], Länge: 3 0: x – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 1: y – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 2: z – Typ: int, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000] 2: angular_velocity – Typ: [int, ...], Länge: 3 0: x – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? 1: y – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? 2: z – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? 3: euler_angle – Typ: [int, ...], Länge: 3 0: heading – Typ: int, Einheit: 1/16 °, Wertebereich: [0 bis 5760] 1: roll – Typ: int, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] 2: pitch – Typ: int, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880] 4: quaternion – Typ: [int, ...], Länge: 4 0: w – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] 1: x – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] 2: y – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] 3: z – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] 5: linear_acceleration – Typ: [int, ...], Länge: 3 0: x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 6: gravity_vector – Typ: [int, ...], Länge: 3 0: x – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 1: y – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 2: z – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 7: temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-128 bis 127] 8: calibration_status – Typ: int, Wertebereich: [0 bis 255]

Gibt alle Daten zurück die dem IMU Brick zur Verfügung stehen.

• Beschleunigung (see #get_acceleration)
• Magnetfeld (see #get_magnetic_field)
• Winkelgeschwindigkeit (see #get_angular_velocity)
• Eulerwinkel (see #get_orientation)
• Quaternion (see #get_quaternion)
• Lineare Beschleunigung (see #get_linear_acceleration)
• Erdbeschleunigungsvektor (see #get_gravity_vector)
• Temperatur (see #get_temperature)
• Kalibrierungsstatus (siehe unten)

Der Kalibrierungsstatus besteht aus vier Paaren von je zwei Bits. Jedes Paar von Bits repräsentiert den Status der aktuellen Kalibrierung.

• Bit 0-1: Magnetometer
• Bit 2-3: Beschleunigungsmesser
• Bit 4-5: Gyroskop
• Bit 6-7: System

Ein Wert von 0 bedeutet "nicht kalibriert" und ein Wert von 3 bedeutet "vollständig kalibriert". Normalerweise kann der Kalibrierungsstatus vollständig ignoriert werden. Er wird vom Brick Viewer im Kalibrierungsfenster benutzt und nur für die initiale Kalibrierung benötigt. Mehr Information zur Kalibrierung des IMU Bricks gibt es im Kalibrierungsfenster.

Wenn die Daten periodisch abgefragt werden sollen, wird empfohlen den ::CALLBACK_ALL_DATA Callback zu nutzen und die Periode mit #set_all_data_callback_configuration vorzugeben.

Fortgeschrittene Funktionen¶

BrickletIMUV3#get_acceleration → [int, int, int]¶

Rückgabe-Array:	0: x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int, Einheit: 1 cm/s², Wertebereich: ?

Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit #set_sensor_configuration konfiguriert wurde.

Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_ACCELERATION Callback zu nutzen und die Periode mit #set_acceleration_callback_configuration vorzugeben.

BrickletIMUV3#get_magnetic_field → [int, int, int]¶

Rückgabe-Array:	0: x – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 1: y – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 2: z – Typ: int, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]

Gibt das kalibrierte Magnetfeld des Magnetometers für die X-, Y- und Z-Komponenten zurück.

Wenn das Magnetfeld periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_MAGNETIC_FIELD Callback zu nutzen und die Periode mit #set_magnetic_field_callback_configuration vorzugeben.

BrickletIMUV3#get_angular_velocity → [int, int, int]¶

Rückgabe-Array:	0: x – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? 1: y – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? 2: z – Typ: int, Einheit: 1/16 °/s, Wertebereich: ?

Gibt die kalibrierte Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und Z-Achse zurück. Die Winkelgeschwindigkeiten liegen im Wertebereich, der mit #set_sensor_configuration konfiguriert wurde.

Wenn die Winkelgeschwindigkeiten periodisch abgefragt werden sollen, wird empfohlen den ::CALLBACK_ANGULAR_VELOCITY Callback zu nutzen und die Periode mit #set_angular_velocity_callback_configuration vorzugeben.

BrickletIMUV3#get_temperature → int¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-128 bis 127]

Gibt die Temperatur des IMU Brick zurück. Die Temperatur wird im Kern des BNO055 ICs gemessen, es handelt sich nicht um die Umgebungstemperatur.

BrickletIMUV3#save_calibration → bool¶

Rückgabe:	calibration_done – Typ: bool

Ein Aufruf dieser Funktion speichert die aktuelle Kalibrierung damit sie beim nächsten Neustart des IMU Brick als Startpunkt für die kontinuierliche Kalibrierung genutzt werden kann.

Ein Rückgabewert von true bedeutet das die Kalibrierung genutzt werden konnte und false bedeutet das die Kalibrierung nicht genutzt werden konnte (dies passiert wenn der Kalibrierungsstatus nicht "fully calibrated" ist).

Diese Funktion wird vom Kalibrierungsfenster des Brick Viewer benutzt. Sie sollte in einem normalen Benutzerprogramm nicht aufgerufen werden müssen.

BrickletIMUV3#set_sensor_configuration(magnetometer_rate, gyroscope_range, gyroscope_bandwidth, accelerometer_range, accelerometer_bandwidth) → nil¶

Parameter:	magnetometer_rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 5 gyroscope_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 gyroscope_bandwidth – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 7 accelerometer_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 accelerometer_bandwidth – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die verfügbaren Sensor-Konfigurationen für Magnetometer, Gyroskop und Beschleunigungssensor. Der Beschleunigungssensor-Wertebereich ist in allen Fusion-Modi wählbar, während alle anderen Konfigurationen im Fusion-Modus automatisch kontrolliert werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für magnetometer_rate:

• BrickletIMUV3::MAGNETOMETER_RATE_2HZ = 0
• BrickletIMUV3::MAGNETOMETER_RATE_6HZ = 1
• BrickletIMUV3::MAGNETOMETER_RATE_8HZ = 2
• BrickletIMUV3::MAGNETOMETER_RATE_10HZ = 3
• BrickletIMUV3::MAGNETOMETER_RATE_15HZ = 4
• BrickletIMUV3::MAGNETOMETER_RATE_20HZ = 5
• BrickletIMUV3::MAGNETOMETER_RATE_25HZ = 6
• BrickletIMUV3::MAGNETOMETER_RATE_30HZ = 7

Für gyroscope_range:

• BrickletIMUV3::GYROSCOPE_RANGE_2000DPS = 0
• BrickletIMUV3::GYROSCOPE_RANGE_1000DPS = 1
• BrickletIMUV3::GYROSCOPE_RANGE_500DPS = 2
• BrickletIMUV3::GYROSCOPE_RANGE_250DPS = 3
• BrickletIMUV3::GYROSCOPE_RANGE_125DPS = 4

Für gyroscope_bandwidth:

• BrickletIMUV3::GYROSCOPE_BANDWIDTH_523HZ = 0
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_230HZ = 1
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_116HZ = 2
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_47HZ = 3
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_23HZ = 4
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_12HZ = 5
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_64HZ = 6
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_32HZ = 7

Für accelerometer_range:

• BrickletIMUV3::ACCELEROMETER_RANGE_2G = 0
• BrickletIMUV3::ACCELEROMETER_RANGE_4G = 1
• BrickletIMUV3::ACCELEROMETER_RANGE_8G = 2
• BrickletIMUV3::ACCELEROMETER_RANGE_16G = 3

Für accelerometer_bandwidth:

• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_7_81HZ = 0
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_15_63HZ = 1
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_31_25HZ = 2
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_62_5HZ = 3
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_125HZ = 4
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_250HZ = 5
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_500HZ = 6
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_1000HZ = 7

BrickletIMUV3#get_sensor_configuration → [int, int, int, int, int]¶

Rückgabe-Array:

0: magnetometer_rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 5 1: gyroscope_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 2: gyroscope_bandwidth – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 7 3: accelerometer_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 4: accelerometer_bandwidth – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Sensor-Konfiguration zurück, wie von #set_sensor_configuration gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für magnetometer_rate:

• BrickletIMUV3::MAGNETOMETER_RATE_2HZ = 0
• BrickletIMUV3::MAGNETOMETER_RATE_6HZ = 1
• BrickletIMUV3::MAGNETOMETER_RATE_8HZ = 2
• BrickletIMUV3::MAGNETOMETER_RATE_10HZ = 3
• BrickletIMUV3::MAGNETOMETER_RATE_15HZ = 4
• BrickletIMUV3::MAGNETOMETER_RATE_20HZ = 5
• BrickletIMUV3::MAGNETOMETER_RATE_25HZ = 6
• BrickletIMUV3::MAGNETOMETER_RATE_30HZ = 7

Für gyroscope_range:

• BrickletIMUV3::GYROSCOPE_RANGE_2000DPS = 0
• BrickletIMUV3::GYROSCOPE_RANGE_1000DPS = 1
• BrickletIMUV3::GYROSCOPE_RANGE_500DPS = 2
• BrickletIMUV3::GYROSCOPE_RANGE_250DPS = 3
• BrickletIMUV3::GYROSCOPE_RANGE_125DPS = 4

Für gyroscope_bandwidth:

• BrickletIMUV3::GYROSCOPE_BANDWIDTH_523HZ = 0
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_230HZ = 1
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_116HZ = 2
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_47HZ = 3
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_23HZ = 4
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_12HZ = 5
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_64HZ = 6
• BrickletIMUV3::GYROSCOPE_BANDWIDTH_32HZ = 7

Für accelerometer_range:

• BrickletIMUV3::ACCELEROMETER_RANGE_2G = 0
• BrickletIMUV3::ACCELEROMETER_RANGE_4G = 1
• BrickletIMUV3::ACCELEROMETER_RANGE_8G = 2
• BrickletIMUV3::ACCELEROMETER_RANGE_16G = 3

Für accelerometer_bandwidth:

• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_7_81HZ = 0
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_15_63HZ = 1
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_31_25HZ = 2
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_62_5HZ = 3
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_125HZ = 4
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_250HZ = 5
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_500HZ = 6
• BrickletIMUV3::ACCELEROMETER_BANDWIDTH_1000HZ = 7

BrickletIMUV3#set_sensor_fusion_mode(mode) → nil¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Wenn der Fusion-Modus deaktiviert wird, geben die Funktionen #get_acceleration, #get_magnetic_field und #get_angular_velocity unkalibrierte und umkompensierte Sensorwerte zurück. Alle anderen Sensordaten-Getter geben keine Daten zurück.

Seit Firmware Version 2.0.6 kann auch ein Fusion-Modus ohne Magnetometer ausgewählt werden. In diesem Modus wird die Orientierung relativ berechnet (mit Magnetometer ist sie absolut in Bezug auf die Erde). Allerdings kann die Berechnung in diesem Fall nicht von störenden Magnetfeldern beeinflusst werden.

Seit Firmware Version 2.0.13 kann auch ein Fusion-Modus ohne schnelle Magnetometer-Kalibrierung ausgewählt werden. Dieser Modus ist der gleiche wie der "normale" Fusion-Modus, aber die schnelle Magnetometer-Kalibrierung ist aus. D.h. die Orientierung zu finden mag beim ersten start länger dauern, allerdings mag es sein das kleine magnetische einflüsse die automatische Kalibrierung nicht so stark stören.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

• BrickletIMUV3::SENSOR_FUSION_OFF = 0
• BrickletIMUV3::SENSOR_FUSION_ON = 1
• BrickletIMUV3::SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
• BrickletIMUV3::SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

BrickletIMUV3#get_sensor_fusion_mode → int¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt den aktuellen Sensor-Fusion-Modus zurück, wie von #set_sensor_fusion_mode gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

• BrickletIMUV3::SENSOR_FUSION_OFF = 0
• BrickletIMUV3::SENSOR_FUSION_ON = 1
• BrickletIMUV3::SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
• BrickletIMUV3::SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

BrickletIMUV3#get_spitfp_error_count → [int, int, int, int]¶

Rückgabe-Array:	0: error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] 2: error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1] 3: error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

• ACK-Checksummen Fehler,
• Message-Checksummen Fehler,
• Framing Fehler und
• Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletIMUV3#set_status_led_config(config) → nil¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

• BrickletIMUV3::STATUS_LED_CONFIG_OFF = 0
• BrickletIMUV3::STATUS_LED_CONFIG_ON = 1
• BrickletIMUV3::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIMUV3::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletIMUV3#get_status_led_config → int¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von #set_status_led_config gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

• BrickletIMUV3::STATUS_LED_CONFIG_OFF = 0
• BrickletIMUV3::STATUS_LED_CONFIG_ON = 1
• BrickletIMUV3::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIMUV3::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletIMUV3#get_chip_temperature → int¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletIMUV3#reset → nil¶

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletIMUV3#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Rückgabe-Array:

0: uid – Typ: str, Länge: bis zu 8 1: connected_uid – Typ: str, Länge: bis zu 8 2: position – Typ: chr, Wertebereich: ['a' bis 'h', 'z'] 3: hardware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] 4: firmware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] 5: device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

BrickletIMUV3#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameter:	callback_id – Typ: int

Registriert den block für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletIMUV3#set_acceleration_callback_configuration(period, value_has_to_change) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3#get_acceleration_callback_configuration → [int, bool]¶

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_acceleration_callback_configuration gesetzt.

BrickletIMUV3#set_magnetic_field_callback_configuration(period, value_has_to_change) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_MAGNETIC_FIELD Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3#get_magnetic_field_callback_configuration → [int, bool]¶

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_magnetic_field_callback_configuration gesetzt.

BrickletIMUV3#set_angular_velocity_callback_configuration(period, value_has_to_change) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_ANGULAR_VELOCITY Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3#get_angular_velocity_callback_configuration → [int, bool]¶

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_angular_velocity_callback_configuration gesetzt.

BrickletIMUV3#set_temperature_callback_configuration(period, value_has_to_change) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3#get_temperature_callback_configuration → [int, bool]¶

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_temperature_callback_configuration gesetzt.

BrickletIMUV3#set_orientation_callback_configuration(period, value_has_to_change) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_ORIENTATION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3#get_orientation_callback_configuration → [int, bool]¶

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_orientation_callback_configuration gesetzt.

BrickletIMUV3#set_linear_acceleration_callback_configuration(period, value_has_to_change) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_LINEAR_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3#get_linear_acceleration_callback_configuration → [int, bool]¶

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_linear_acceleration_callback_configuration gesetzt.

BrickletIMUV3#set_gravity_vector_callback_configuration(period, value_has_to_change) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_GRAVITY_VECTOR Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3#get_gravity_vector_callback_configuration → [int, bool]¶

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_gravity_vector_callback_configuration gesetzt.

BrickletIMUV3#set_quaternion_callback_configuration(period, value_has_to_change) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_QUATERNION Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3#get_quaternion_callback_configuration → [int, bool]¶

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_quaternion_callback_configuration gesetzt.

BrickletIMUV3#set_all_data_callback_configuration(period, value_has_to_change) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_ALL_DATA Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletIMUV3#get_all_data_callback_configuration → [int, bool]¶

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_all_data_callback_configuration gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion #register_callback des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite Parameter der Block:

imu_v3.register_callback BrickletIMUV3::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

BrickletIMUV3::CALLBACK_ACCELERATION¶

Callback-Parameter:	x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? z – Typ: int, Einheit: 1 cm/s², Wertebereich: ?

Dieser Callback wird mit der Periode, wie gesetzt mit #set_acceleration_callback_configuration, ausgelöst. Die Parameter sind die Beschleunigungen der X, Y und Z-Achse.

BrickletIMUV3::CALLBACK_MAGNETIC_FIELD¶

Callback-Parameter:	x – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] y – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] z – Typ: int, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_magnetic_field_callback_configuration, ausgelöst. Die Parameter sind die Magnetfeldkomponenten der X, Y und Z-Achse.

BrickletIMUV3::CALLBACK_ANGULAR_VELOCITY¶

Callback-Parameter:	x – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? y – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? z – Typ: int, Einheit: 1/16 °/s, Wertebereich: ?

Dieser Callback wird mit der Periode, wie gesetzt mit #set_angular_velocity_callback_configuration, ausgelöst. Die Parameter sind die Winkelgeschwindigkeiten der X, Y und Z-Achse.

BrickletIMUV3::CALLBACK_TEMPERATURE¶

Callback-Parameter:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-128 bis 127]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_temperature_callback_configuration, ausgelöst. Der Parameter ist die Temperatur.

BrickletIMUV3::CALLBACK_LINEAR_ACCELERATION¶

Callback-Parameter:	x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? z – Typ: int, Einheit: 1 cm/s², Wertebereich: ?

Dieser Callback wird mit der Periode, wie gesetzt mit #set_linear_acceleration_callback_configuration, ausgelöst. Die Parameter sind die linearen Beschleunigungen der X, Y und Z-Achse.

BrickletIMUV3::CALLBACK_GRAVITY_VECTOR¶

Callback-Parameter:	x – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] y – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] z – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_gravity_vector_callback_configuration, ausgelöst. Die Parameter sind die Erdbeschleunigungsvektor-Werte der X, Y und Z-Achse.

BrickletIMUV3::CALLBACK_ORIENTATION¶

Callback-Parameter:	heading – Typ: int, Einheit: 1/16 °, Wertebereich: [0 bis 5760] roll – Typ: int, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] pitch – Typ: int, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_orientation_callback_configuration, ausgelöst. Die Parameter sind die Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in Eulerwinkeln. Siehe #get_orientation für Details.

BrickletIMUV3::CALLBACK_QUATERNION¶

Callback-Parameter:	w – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] x – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] y – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] z – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_quaternion_callback_configuration, ausgelöst. Die Parameter sind die Orientierung (w, x, y, z) des IMU Brick in Quaternionen. Siehe #get_quaternion für Details.

BrickletIMUV3::CALLBACK_ALL_DATA¶

Callback-Parameter:

acceleration – Typ: [int, ...], Länge: 3 0: x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int, Einheit: 1 cm/s², Wertebereich: ? magnetic_field – Typ: [int, ...], Länge: 3 0: x – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 1: y – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 2: z – Typ: int, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000] angular_velocity – Typ: [int, ...], Länge: 3 0: x – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? 1: y – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? 2: z – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? euler_angle – Typ: [int, ...], Länge: 3 0: heading – Typ: int, Einheit: 1/16 °, Wertebereich: [0 bis 5760] 1: roll – Typ: int, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] 2: pitch – Typ: int, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880] quaternion – Typ: [int, ...], Länge: 4 0: w – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] 1: x – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] 2: y – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] 3: z – Typ: int, Einheit: 1/16383, Wertebereich: [-214 + 1 bis 214 - 1] linear_acceleration – Typ: [int, ...], Länge: 3 0: x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int, Einheit: 1 cm/s², Wertebereich: ? gravity_vector – Typ: [int, ...], Länge: 3 0: x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 1: y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 2: z – Typ: int, Einheit: 1 cm/s², Wertebereich: ? temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-128 bis 127] calibration_status – Typ: int, Wertebereich: [0 bis 255]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_all_data_callback_configuration, ausgelöst. Die Parameter sind die gleichen wie bei #get_all_data.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletIMUV3#get_api_version → [int, ...]¶

Rückgabe-Array:	0: api_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletIMUV3#get_response_expected(function_id) → bool¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels #set_response_expected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

• BrickletIMUV3::FUNCTION_SET_SENSOR_CONFIGURATION = 11
• BrickletIMUV3::FUNCTION_SET_SENSOR_FUSION_MODE = 13
• BrickletIMUV3::FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 15
• BrickletIMUV3::FUNCTION_SET_MAGNETIC_FIELD_CALLBACK_CONFIGURATION = 17
• BrickletIMUV3::FUNCTION_SET_ANGULAR_VELOCITY_CALLBACK_CONFIGURATION = 19
• BrickletIMUV3::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 21
• BrickletIMUV3::FUNCTION_SET_ORIENTATION_CALLBACK_CONFIGURATION = 23
• BrickletIMUV3::FUNCTION_SET_LINEAR_ACCELERATION_CALLBACK_CONFIGURATION = 25
• BrickletIMUV3::FUNCTION_SET_GRAVITY_VECTOR_CALLBACK_CONFIGURATION = 27
• BrickletIMUV3::FUNCTION_SET_QUATERNION_CALLBACK_CONFIGURATION = 29
• BrickletIMUV3::FUNCTION_SET_ALL_DATA_CALLBACK_CONFIGURATION = 31
• BrickletIMUV3::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIMUV3::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIMUV3::FUNCTION_RESET = 243
• BrickletIMUV3::FUNCTION_WRITE_UID = 248

BrickletIMUV3#set_response_expected(function_id, response_expected) → nil¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten response_expected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

• BrickletIMUV3::FUNCTION_SET_SENSOR_CONFIGURATION = 11
• BrickletIMUV3::FUNCTION_SET_SENSOR_FUSION_MODE = 13
• BrickletIMUV3::FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 15
• BrickletIMUV3::FUNCTION_SET_MAGNETIC_FIELD_CALLBACK_CONFIGURATION = 17
• BrickletIMUV3::FUNCTION_SET_ANGULAR_VELOCITY_CALLBACK_CONFIGURATION = 19
• BrickletIMUV3::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 21
• BrickletIMUV3::FUNCTION_SET_ORIENTATION_CALLBACK_CONFIGURATION = 23
• BrickletIMUV3::FUNCTION_SET_LINEAR_ACCELERATION_CALLBACK_CONFIGURATION = 25
• BrickletIMUV3::FUNCTION_SET_GRAVITY_VECTOR_CALLBACK_CONFIGURATION = 27
• BrickletIMUV3::FUNCTION_SET_QUATERNION_CALLBACK_CONFIGURATION = 29
• BrickletIMUV3::FUNCTION_SET_ALL_DATA_CALLBACK_CONFIGURATION = 31
• BrickletIMUV3::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIMUV3::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIMUV3::FUNCTION_RESET = 243
• BrickletIMUV3::FUNCTION_WRITE_UID = 248

BrickletIMUV3#set_response_expected_all(response_expected) → nil¶

Parameter:	response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletIMUV3#set_bootloader_mode(mode) → int¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

• BrickletIMUV3::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletIMUV3::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletIMUV3::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletIMUV3::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletIMUV3::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BrickletIMUV3::BOOTLOADER_STATUS_OK = 0
• BrickletIMUV3::BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletIMUV3::BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletIMUV3::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletIMUV3::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletIMUV3::BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletIMUV3#get_bootloader_mode → int¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

• BrickletIMUV3::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletIMUV3::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletIMUV3::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletIMUV3::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletIMUV3::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletIMUV3#set_write_firmware_pointer(pointer) → nil¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für #write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletIMUV3#write_firmware(data) → int¶

Parameter:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von #set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletIMUV3#write_uid(uid) → nil¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletIMUV3#read_uid → int¶

Rückgabe:	uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

BrickletIMUV3::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein IMU Bricklet 3.0 zu identifizieren.

Die #get_identity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletIMUV3::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines IMU Bricklet 3.0 dar.