Ruby - IMU Brick¶

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/brick_imu'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XXYYZZ' # Change XXYYZZ to the UID of your IMU Brick

ipcon = IPConnection.new # Create IP connection
imu = BrickIMU.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 [x, y, z, w]
quaternion = imu.get_quaternion

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

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/brick_imu'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XXYYZZ' # Change XXYYZZ to the UID of your IMU Brick

ipcon = IPConnection.new # Create IP connection
imu = BrickIMU.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(BrickIMU::CALLBACK_QUATERNION) do |x, y, z, w|
  puts "Quaternion [X]: #{x}"
  puts "Quaternion [Y]: #{y}"
  puts "Quaternion [Z]: #{z}"
  puts "Quaternion [W]: #{w}"
  puts ''
end

# Set period for quaternion callback to 1s (1000ms)
imu.set_quaternion_period 1000

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

Grundfunktionen¶

BrickIMU::new(uid, ipcon) → imu¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	imu – Typ: BrickIMU

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

imu = BrickIMU.new 'YOUR_DEVICE_UID', ipcon

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

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

Rückgabe-Array:	0: roll – Typ: int, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] 1: pitch – Typ: int, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] 2: yaw – Typ: int, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000]

Gibt die aktuelle Orientierung (Roll-, Nick-, Gierwinkel) des IMU Brick in Eulerwinkeln zurück. Zu beachten ist, dass Eulerwinkel immer eine kardanische Blockade erfahren.

Wir empfehlen die Verwendung von Quaternionen stattdessen.

Die Reihenfolge in denen die Orientierungswerte angewandt werden sollten, ist Roll-, Nick-, Gierwinkel.

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

BrickIMU#get_quaternion → [float, float, float, float]¶

Rückgabe-Array:	0: x – Typ: float, Wertebereich: [-1.0 bis 1.0] 1: y – Typ: float, Wertebereich: [-1.0 bis 1.0] 2: z – Typ: float, Wertebereich: [-1.0 bis 1.0] 3: w – Typ: float, Wertebereich: [-1.0 bis 1.0]

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

Die Umrechnung von Quaternionen in Eulerwinkel ist mit folgender Formel möglich:

xAngle = atan2(2*y*w - 2*x*z, 1 - 2*y*y - 2*z*z)
yAngle = atan2(2*x*w - 2*y*z, 1 - 2*x*x - 2*z*z)
zAngle =  asin(2*x*y + 2*z*w)

Es ist auch möglich unabhängige Winkel zu berechen. Yaw, Pitch und Roll in einem rechtshändigen Fahrzeugkoordinatensystem nach DIN70000 können wie folgt berechnet werden:

yaw   =  atan2(2*x*y + 2*w*z, w*w + x*x - y*y - z*z)
pitch = -asin(2*w*y - 2*x*z)
roll  = -atan2(2*y*z + 2*w*x, -w*w + x*x + y*y - z*z))

Diese Umrechnung ist irreversibel aufgrund der kardanischen Blockade.

Die Umrechnung von Quaternionen in eine OpenGL Transformationsmatrix ist mit folgender Formel möglich:

matrix = [[1 - 2*(y*y + z*z),     2*(x*y - w*z),     2*(x*z + w*y), 0],
          [    2*(x*y + w*z), 1 - 2*(x*x + z*z),     2*(y*z - w*x), 0],
          [    2*(x*z - w*y),     2*(y*z + w*x), 1 - 2*(x*x + y*y), 0],
          [                0,                 0,                 0, 1]]

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

BrickIMU#leds_on → nil¶

Aktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.

BrickIMU#leds_off → nil¶

Deaktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.

BrickIMU#are_leds_on → bool¶

Rückgabe:	leds – Typ: bool, Standardwert: true

Gibt zurück ob die Orientierungs- und Richtungs-LEDs des IMU Brick aktiv sind.

BrickIMU#set_convergence_speed(speed) → nil¶

Parameter:	speed – Typ: int, Einheit: 1 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 30

Setzt die Konvergenzgeschwindigkeit des IMU Brick. Die Konvergenzgeschwindigkeit bestimmt wie die unterschiedlichen Sensormessungen vereinigt werden.

Wenn die Orientierung des IMU Brick eine Abweichung von 10° hat und die Konvergenzgeschwindigkeit auf 20°/s konfiguriert ist, dann dauert es 0,5s bis die Orientierung korrigiert ist. Bei einer zu hohen Konvergenzgeschwindigkeit wird nach Erreichen der korrekten Orientierung, diese um die Fluktuationen des Beschleunigungsmessers und des Magnetometers schwanken.

Wenn die Konvergenzgeschwindigkeit auf 0 gesetzt wird, erfolgt die Berechnung der Orientierung praktisch nur anhand der Gyroskopdaten. Dies ergibt sehr gleichmäßige Bewegungen aber Fehler des Gyroskops werden nicht korrigiert. Wenn die Konvergenzgeschwindigkeit über 500 gesetzt wird, erfolgt die Berechnung der Orientierung praktisch nur anhand der Beschleunigungsmesser- und Magnetometerdaten. In diesem Fall sind die Bewegungen abrupt und die Werte werden schwanken. Es treten aber keine akkumulativen Fehler auf.

In Anwendungen mit hohen Winkelgeschwindigkeiten wird eine hohe Konvergenzgeschwindigkeit empfohlen, so dass Fehler des Gyroskops schnell korrigiert werden können. In Anwendungen mit langsamen Bewegungen wird entsprechend eine geringe Konvergenzgeschwindigkeit empfohlen. Es ist möglich die Konvergenzgeschwindigkeit spontan zu ändern. Dadurch ist es möglich (und empfohlen) direkt vor einer abrupten Bewegung die Konvergenzgeschwindigkeit zu erhöhen und im Anschluss wieder zu verringern.

Um ein Gefühl für einen guten Wert, für die Konvergenzgeschwindigkeit, in deiner Anwendung zu bekommen ist es ratsam im Brick Viewer verschiedenste Werte auszuprobieren.

BrickIMU#get_convergence_speed → int¶

Rückgabe:	speed – Typ: int, Einheit: 1 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 30

Gibt die Konvergenzgeschwindigkeit zurück, wie von #set_convergence_speed gesetzt.

Fortgeschrittene Funktionen¶

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

Rückgabe-Array:	0: x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] 1: y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] 2: z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1]

Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X, Y und Z-Achse zurück.

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

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

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

Gibt das kalibrierte Magnetfeld des Magnetometers mit den 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_period vorzugeben.

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

Rückgabe-Array:	0: x – Typ: int, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] 1: y – Typ: int, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] 2: z – Typ: int, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750]

Gibt die kalibrierten Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und Z-Achse in °/14,375s zurück. (Um den Wert in °/s zu erhalten ist es notwendig durch 14,375 zu teilen)

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

BrickIMU#get_all_data → [int, int, int, int, int, int, int, int, int, int]¶

Rückgabe-Array:

0: acc_x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] 1: acc_y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] 2: acc_z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] 3: mag_x – Typ: int, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] 4: mag_y – Typ: int, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] 5: mag_z – Typ: int, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] 6: ang_x – Typ: int, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] 7: ang_y – Typ: int, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] 8: ang_z – Typ: int, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] 9: temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Daten von #get_acceleration, #get_magnetic_field und #get_angular_velocity sowie die Temperatur des IMU Brick zurück.

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

BrickIMU#get_imu_temperature → int¶

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

Gibt die Temperatur des IMU Brick zurück.

BrickIMU#set_acceleration_range(range) → nil¶

Parameter:	range – Typ: int, Wertebereich: [0 bis 255]

Bisher nicht implementiert.

BrickIMU#get_acceleration_range → int¶

Rückgabe:	range – Typ: int, Wertebereich: [0 bis 255]

Bisher nicht implementiert.

BrickIMU#set_magnetometer_range(range) → nil¶

Parameter:	range – Typ: int, Wertebereich: [0 bis 255]

Bisher nicht implementiert.

BrickIMU#get_magnetometer_range → int¶

Rückgabe:	range – Typ: int, Wertebereich: [0 bis 255]

Bisher nicht implementiert.

BrickIMU#set_calibration(typ, data) → nil¶

Parameter:	typ – Typ: int, Wertebereich: Siehe Konstanten data – Typ: [int, ...], Länge: 10, Wertebereich: [-215 bis 215 - 1]

Es sind folgende verschiedene Kalibrierungen möglich:

Typ	Beschreibung	Werte
0	Beschleunigungsmesser Verstärkung	[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]
1	Beschleunigungsmesser Versatz	[bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0]
2	Magnetometer Verstärkung	[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]
3	Magnetometer Versatz	[bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0]
4	Gyroskop Verstärkung	[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]
5	Gyroskop Versatz	[bias xl, bias yl, bias zl, temp l, bias xh, bias yh, bias zh, temp h, 0, 0]

Die Kalibrierung mittels Verstärkung und Versatz wird über folgende Formel realisiert:

new_value = (bias + orig_value) * gain_mul / gain_div

Für die Implementierung einer eigenen Kalibriersoftware sollte beachtet werden, dass zuerst die bisherige Kalibrierung rückgängig gemacht werden muss (Versatz auf 0 und Verstärkung auf 1/1 setzen) und das über mehrere tausend Werte gemittelt werden sollte um ein benutzbares Ergebnis zu erhalten.

Der Versatz des Gyroskops ist sehr temperaturabhängig und daher muss die Kalibrierung des Versatzes mit zwei unterschiedlichen Temperaturen erfolgen. Die Werte xl, yl, zl und temp l sind der Versatz für x, y, z und die zugehörige geringe Temperatur. Die Werte xh, yh, zh und temp h sind entsprechend für eine höhere Temperatur. Die Temperaturdifferenz sollte mindestens 5°C betragen. Die übliche Betriebstemperatur des IMU Brick sollte einer der Kalibrierpunkte sein.

Bemerkung

Wir empfehlen dringend den Brick Viewer zur Kalibrierung des IMU Brick zu verwenden.

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

Für typ:

• BrickIMU::CALIBRATION_TYPE_ACCELEROMETER_GAIN = 0
• BrickIMU::CALIBRATION_TYPE_ACCELEROMETER_BIAS = 1
• BrickIMU::CALIBRATION_TYPE_MAGNETOMETER_GAIN = 2
• BrickIMU::CALIBRATION_TYPE_MAGNETOMETER_BIAS = 3
• BrickIMU::CALIBRATION_TYPE_GYROSCOPE_GAIN = 4
• BrickIMU::CALIBRATION_TYPE_GYROSCOPE_BIAS = 5

BrickIMU#get_calibration(typ) → [int, ...]¶

Parameter:	typ – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	data – Typ: [int, ...], Länge: 10, Wertebereich: [-215 bis 215 - 1]

Gibt die Kalibrierung für den ausgewählten Typ zurück, wie von #set_calibration gesetzt.

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

Für typ:

• BrickIMU::CALIBRATION_TYPE_ACCELEROMETER_GAIN = 0
• BrickIMU::CALIBRATION_TYPE_ACCELEROMETER_BIAS = 1
• BrickIMU::CALIBRATION_TYPE_MAGNETOMETER_GAIN = 2
• BrickIMU::CALIBRATION_TYPE_MAGNETOMETER_BIAS = 3
• BrickIMU::CALIBRATION_TYPE_GYROSCOPE_GAIN = 4
• BrickIMU::CALIBRATION_TYPE_GYROSCOPE_BIAS = 5

BrickIMU#orientation_calculation_on → nil¶

Aktiviert die Orientierungsberechnungen des IMU Brick.

Standardmäßig sind die Berechnungen an.

Neu in Version 2.0.2 (Firmware).

BrickIMU#orientation_calculation_off → nil¶

Deaktiviert die Orientierungsberechnungen des IMU Brick.

Wenn die Berechnungen deaktiviert sind, gibt #get_orientation solange den letzten berechneten Wer zurück bis die Berechnungen wieder aktiviert werden.

Die trigonometrischen Funktionen die zur Berechnung der Orientierung benötigt werden sind sehr teuer. Wir empfehlen die Orientierungsberechnungen zu deaktivieren wenn sie nicht benötigt werden. Dadurch wird mehr Rechenzeit für den Sensorfusions-Algorithmus freigegeben.

Standardmäßig sind die Berechnungen an.

Neu in Version 2.0.2 (Firmware).

BrickIMU#is_orientation_calculation_on → bool¶

Rückgabe:	orientation_calculation_on – Typ: bool, Standardwert: true

Gibt zurück ob die Orientierungsberechnungen des IMU Brick aktiv sind.

Neu in Version 2.0.2 (Firmware).

BrickIMU#set_spitfp_baudrate_config(enable_dynamic_baudrate, minimum_dynamic_baudrate) → nil¶

Parameter:	enable_dynamic_baudrate – Typ: bool, Standardwert: true minimum_dynamic_baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion #set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von #set_spitfp_baudrate gesetzt statisch verwendet.

Neu in Version 2.3.5 (Firmware).

BrickIMU#get_spitfp_baudrate_config → [bool, int]¶

Rückgabe-Array:	0: enable_dynamic_baudrate – Typ: bool, Standardwert: true 1: minimum_dynamic_baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe #set_spitfp_baudrate_config.

Neu in Version 2.3.5 (Firmware).

BrickIMU#get_send_timeout_count(communication_method) → int¶

Parameter:	communication_method – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	timeout_count – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

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

Für communication_method:

• BrickIMU::COMMUNICATION_METHOD_NONE = 0
• BrickIMU::COMMUNICATION_METHOD_USB = 1
• BrickIMU::COMMUNICATION_METHOD_SPI_STACK = 2
• BrickIMU::COMMUNICATION_METHOD_CHIBI = 3
• BrickIMU::COMMUNICATION_METHOD_RS485 = 4
• BrickIMU::COMMUNICATION_METHOD_WIFI = 5
• BrickIMU::COMMUNICATION_METHOD_ETHERNET = 6
• BrickIMU::COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.3.3 (Firmware).

BrickIMU#set_spitfp_baudrate(bricklet_port, baudrate) → nil¶

Parameter:	bricklet_port – Typ: chr, Wertebereich: ['a' bis 'b'] baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Setzt die Baudrate eines spezifischen Bricklet Ports .

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe #get_spitfp_error_count) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe #set_spitfp_baudrate_config).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Neu in Version 2.3.3 (Firmware).

BrickIMU#get_spitfp_baudrate(bricklet_port) → int¶

Parameter:	bricklet_port – Typ: chr, Wertebereich: ['a' bis 'b']
Rückgabe:	baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Gibt die Baudrate für einen Bricklet Port zurück, siehe #set_spitfp_baudrate.

Neu in Version 2.3.3 (Firmware).

BrickIMU#get_spitfp_error_count(bricklet_port) → [int, int, int, int]¶

Parameter:	bricklet_port – Typ: chr, Wertebereich: ['a' bis 'b']
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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.3.3 (Firmware).

BrickIMU#enable_status_led → nil¶

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

BrickIMU#disable_status_led → nil¶

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

BrickIMU#is_status_led_enabled → bool¶

Rückgabe:	enabled – Typ: bool, Standardwert: true

Gibt true zurück wenn die Status LED aktiviert ist, false sonst.

Neu in Version 2.3.1 (Firmware).

BrickIMU#get_chip_temperature → int¶

Rückgabe:	temperature – Typ: int, Einheit: 1/10 °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 Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickIMU#reset → nil¶

Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.

Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

BrickIMU#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: ['0' bis '8'] 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 der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

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

Konfigurationsfunktionen für Callbacks¶

BrickIMU#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.

BrickIMU#set_acceleration_period(period) → nil¶

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

Setzt die Periode mit welcher der ::CALLBACK_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

BrickIMU#get_acceleration_period → int¶

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

Gibt die Periode zurück, wie von #set_acceleration_period gesetzt.

BrickIMU#set_magnetic_field_period(period) → nil¶

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

Setzt die Periode mit welcher der ::CALLBACK_MAGNETIC_FIELD Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

BrickIMU#get_magnetic_field_period → int¶

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

Gibt die Periode zurück, wie von #set_magnetic_field_period gesetzt.

BrickIMU#set_angular_velocity_period(period) → nil¶

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

Setzt die Periode mit welcher der ::CALLBACK_ANGULAR_VELOCITY Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

BrickIMU#get_angular_velocity_period → int¶

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

Gibt die Periode zurück, wie von #set_angular_velocity_period gesetzt.

BrickIMU#set_all_data_period(period) → nil¶

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

Setzt die Periode mit welcher der ::CALLBACK_ALL_DATA Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

BrickIMU#get_all_data_period → int¶

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

Gibt die Periode zurück, wie von #set_all_data_period gesetzt.

BrickIMU#set_orientation_period(period) → nil¶

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

Setzt die Periode mit welcher der ::CALLBACK_ORIENTATION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

BrickIMU#get_orientation_period → int¶

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

Gibt die Periode zurück, wie von #set_orientation_period gesetzt.

BrickIMU#set_quaternion_period(period) → nil¶

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

Setzt die Periode mit welcher der ::CALLBACK_QUATERNION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

BrickIMU#get_quaternion_period → int¶

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

Gibt die Periode zurück, wie von #set_quaternion_period 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.register_callback BrickIMU::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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

BrickIMU::CALLBACK_ACCELERATION¶

Callback-Parameter:	x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1]

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

BrickIMU::CALLBACK_MAGNETIC_FIELD¶

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

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

BrickIMU::CALLBACK_ANGULAR_VELOCITY¶

Callback-Parameter:	x – Typ: int, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] y – Typ: int, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] z – Typ: int, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750]

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

BrickIMU::CALLBACK_ALL_DATA¶

Callback-Parameter:

acc_x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] acc_y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] acc_z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1] mag_x – Typ: int, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] mag_y – Typ: int, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] mag_z – Typ: int, Einheit: 1/10 µT, Wertebereich: [-215 bis 215 - 1] ang_x – Typ: int, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] ang_y – Typ: int, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] ang_z – Typ: int, Einheit: 8/115 °/s, Wertebereich: [-28750 bis 28750] temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_all_data_period, ausgelöst. Die Parameter sind die Beschleunigungen, Magnetfeldkomponenten und die Winkelgeschwindigkeiten der X, Y und Z-Achse sowie die Temperatur des IMU Brick.

BrickIMU::CALLBACK_ORIENTATION¶

Callback-Parameter:	roll – Typ: int, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] pitch – Typ: int, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000] yaw – Typ: int, Einheit: 1/100 °, Wertebereich: [-18000 bis 18000]

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

BrickIMU::CALLBACK_QUATERNION¶

Callback-Parameter:	x – Typ: float, Wertebereich: [-1.0 bis 1.0] y – Typ: float, Wertebereich: [-1.0 bis 1.0] z – Typ: float, Wertebereich: [-1.0 bis 1.0] w – Typ: float, Wertebereich: [-1.0 bis 1.0]

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

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.

BrickIMU#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.

BrickIMU#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:

• BrickIMU::FUNCTION_LEDS_ON = 8
• BrickIMU::FUNCTION_LEDS_OFF = 9
• BrickIMU::FUNCTION_SET_ACCELERATION_RANGE = 11
• BrickIMU::FUNCTION_SET_MAGNETOMETER_RANGE = 13
• BrickIMU::FUNCTION_SET_CONVERGENCE_SPEED = 15
• BrickIMU::FUNCTION_SET_CALIBRATION = 17
• BrickIMU::FUNCTION_SET_ACCELERATION_PERIOD = 19
• BrickIMU::FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 21
• BrickIMU::FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 23
• BrickIMU::FUNCTION_SET_ALL_DATA_PERIOD = 25
• BrickIMU::FUNCTION_SET_ORIENTATION_PERIOD = 27
• BrickIMU::FUNCTION_SET_QUATERNION_PERIOD = 29
• BrickIMU::FUNCTION_ORIENTATION_CALCULATION_ON = 37
• BrickIMU::FUNCTION_ORIENTATION_CALCULATION_OFF = 38
• BrickIMU::FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
• BrickIMU::FUNCTION_SET_SPITFP_BAUDRATE = 234
• BrickIMU::FUNCTION_ENABLE_STATUS_LED = 238
• BrickIMU::FUNCTION_DISABLE_STATUS_LED = 239
• BrickIMU::FUNCTION_RESET = 243
• BrickIMU::FUNCTION_WRITE_BRICKLET_PLUGIN = 246

BrickIMU#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:

• BrickIMU::FUNCTION_LEDS_ON = 8
• BrickIMU::FUNCTION_LEDS_OFF = 9
• BrickIMU::FUNCTION_SET_ACCELERATION_RANGE = 11
• BrickIMU::FUNCTION_SET_MAGNETOMETER_RANGE = 13
• BrickIMU::FUNCTION_SET_CONVERGENCE_SPEED = 15
• BrickIMU::FUNCTION_SET_CALIBRATION = 17
• BrickIMU::FUNCTION_SET_ACCELERATION_PERIOD = 19
• BrickIMU::FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 21
• BrickIMU::FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 23
• BrickIMU::FUNCTION_SET_ALL_DATA_PERIOD = 25
• BrickIMU::FUNCTION_SET_ORIENTATION_PERIOD = 27
• BrickIMU::FUNCTION_SET_QUATERNION_PERIOD = 29
• BrickIMU::FUNCTION_ORIENTATION_CALCULATION_ON = 37
• BrickIMU::FUNCTION_ORIENTATION_CALCULATION_OFF = 38
• BrickIMU::FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
• BrickIMU::FUNCTION_SET_SPITFP_BAUDRATE = 234
• BrickIMU::FUNCTION_ENABLE_STATUS_LED = 238
• BrickIMU::FUNCTION_DISABLE_STATUS_LED = 239
• BrickIMU::FUNCTION_RESET = 243
• BrickIMU::FUNCTION_WRITE_BRICKLET_PLUGIN = 246

BrickIMU#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.

BrickIMU#get_protocol1_bricklet_name(port) → [int, [int, ...], str]¶

Parameter:	port – Typ: chr, Wertebereich: ['a' bis 'b']
Rückgabe-Array:	0: protocol_version – Typ: int, Wertebereich: [0 bis 255] 1: 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] 2: name – Typ: str, Länge: bis zu 40

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

BrickIMU#write_bricklet_plugin(port, offset, chunk) → nil¶

Parameter:	port – Typ: chr, Wertebereich: ['a' bis 'b'] offset – Typ: int, Wertebereich: [0 bis 255] chunk – Typ: [int, ...], Länge: 32, Wertebereich: [0 bis 255]

Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.

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

BrickIMU#read_bricklet_plugin(port, offset) → [int, ...]¶

Parameter:	port – Typ: chr, Wertebereich: ['a' bis 'b'] offset – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	chunk – Typ: [int, ...], Länge: 32, Wertebereich: [0 bis 255]

Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.

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

Konstanten¶

BrickIMU::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um einen IMU Brick 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.

BrickIMU::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines IMU Brick dar.