Shell - IMU Brick

Dies ist die Beschreibung der Shell API Bindings für den IMU Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Brick sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Shell API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.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

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

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

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

# Set period for quaternion callback to 1s (1000ms)
tinkerforge call imu-brick $uid set-quaternion-period 1000

echo "Press key to exit"; read dummy

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

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call imu-brick [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des IMU Brick aufzurufen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
  • --list-functions zeigt eine Liste der bekannten Funktionen des IMU Brick an und endet dann
tinkerforge dispatch imu-brick [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des IMU Brick abzufertigen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
  • --list-callbacks zeigt eine Liste der bekannten Callbacks des IMU Brick an und endet dann
tinkerforge call imu-brick <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

  • --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch imu-brick <uid> <callback> [<option>..]
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifische <callback> an und endet dann
  • --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen

tinkerforge call imu-brick <uid> get-orientation
Ausgabe:
  • 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]

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 orientation Callback zu nutzen und die Periode mit set-orientation-period vorzugeben.

tinkerforge call imu-brick <uid> get-quaternion
Ausgabe:
  • 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]

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 quaternion Callback zu nutzen und die Periode mit set-quaternion-period vorzugeben.

tinkerforge call imu-brick <uid> leds-on
Ausgabe:
  • keine Ausgabe

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

tinkerforge call imu-brick <uid> leds-off
Ausgabe:
  • keine Ausgabe

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

tinkerforge call imu-brick <uid> are-leds-on
Ausgabe:
  • leds – Typ: Bool, Standardwert: true

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

tinkerforge call imu-brick <uid> set-convergence-speed <speed>
Parameter:
  • <speed> – Typ: Int, Einheit: 1 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 30
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call imu-brick <uid> get-convergence-speed
Ausgabe:
  • 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

tinkerforge call imu-brick <uid> get-acceleration
Ausgabe:
  • 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]

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 acceleration Callback zu nutzen und die Periode mit set-acceleration-period vorzugeben.

tinkerforge call imu-brick <uid> get-magnetic-field
Ausgabe:
  • 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]

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 magnetic-field Callback zu nutzen und die Periode mit set-magnetic-field-period vorzugeben.

tinkerforge call imu-brick <uid> get-angular-velocity
Ausgabe:
  • 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]

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 angular-velocity Callback zu nutzen und die Periode mit set-angular-velocity-period vorzugeben.

tinkerforge call imu-brick <uid> get-all-data
Ausgabe:
  • 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]

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 all-data Callback zu nutzen und die Periode mit set-all-data-period vorzugeben.

tinkerforge call imu-brick <uid> get-imu-temperature
Ausgabe:
  • temperature – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur des IMU Brick zurück.

tinkerforge call imu-brick <uid> set-acceleration-range <range>
Parameter:
  • <range> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:
  • keine Ausgabe

Bisher nicht implementiert.

tinkerforge call imu-brick <uid> get-acceleration-range
Ausgabe:
  • range – Typ: Int, Wertebereich: [0 bis 255]

Bisher nicht implementiert.

tinkerforge call imu-brick <uid> set-magnetometer-range <range>
Parameter:
  • <range> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:
  • keine Ausgabe

Bisher nicht implementiert.

tinkerforge call imu-brick <uid> get-magnetometer-range
Ausgabe:
  • range – Typ: Int, Wertebereich: [0 bis 255]

Bisher nicht implementiert.

tinkerforge call imu-brick <uid> set-calibration <typ> <data>
Parameter:
  • <typ> – Typ: Int, Wertebereich: Siehe Symbole
  • <data> – Typ: Int Array, Länge: 10, Wertebereich: [-215 bis 215 - 1]
Ausgabe:
  • keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <typ>:

  • calibration-type-accelerometer-gain = 0
  • calibration-type-accelerometer-bias = 1
  • calibration-type-magnetometer-gain = 2
  • calibration-type-magnetometer-bias = 3
  • calibration-type-gyroscope-gain = 4
  • calibration-type-gyroscope-bias = 5
tinkerforge call imu-brick <uid> get-calibration <typ>
Parameter:
  • <typ> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • data – Typ: Int Array, 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 Symbole sind für diese Funktion verfügbar:

Für <typ>:

  • calibration-type-accelerometer-gain = 0
  • calibration-type-accelerometer-bias = 1
  • calibration-type-magnetometer-gain = 2
  • calibration-type-magnetometer-bias = 3
  • calibration-type-gyroscope-gain = 4
  • calibration-type-gyroscope-bias = 5
tinkerforge call imu-brick <uid> orientation-calculation-on
Ausgabe:
  • keine Ausgabe

Aktiviert die Orientierungsberechnungen des IMU Brick.

Standardmäßig sind die Berechnungen an.

Neu in Version 2.0.2 (Firmware).

tinkerforge call imu-brick <uid> orientation-calculation-off
Ausgabe:
  • keine Ausgabe

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).

tinkerforge call imu-brick <uid> is-orientation-calculation-on
Ausgabe:
  • 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).

tinkerforge call imu-brick <uid> set-spitfp-baudrate-config <enable-dynamic-baudrate> <minimum-dynamic-baudrate>
Parameter:
  • <enable-dynamic-baudrate> – Typ: Bool, Standardwert: true
  • <minimum-dynamic-baudrate> – Typ: Int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Ausgabe:
  • keine Ausgabe

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).

tinkerforge call imu-brick <uid> get-spitfp-baudrate-config
Ausgabe:
  • enable-dynamic-baudrate – Typ: Bool, Standardwert: true
  • 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).

tinkerforge call imu-brick <uid> get-send-timeout-count <communication-method>
Parameter:
  • <communication-method> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • 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 Symbole sind für diese Funktion verfügbar:

Für <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

Neu in Version 2.3.3 (Firmware).

tinkerforge call imu-brick <uid> set-spitfp-baudrate <bricklet-port> <baudrate>
Parameter:
  • <bricklet-port> – Typ: Char, Wertebereich: [a bis b]
  • <baudrate> – Typ: Int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Ausgabe:
  • keine Ausgabe

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).

tinkerforge call imu-brick <uid> get-spitfp-baudrate <bricklet-port>
Parameter:
  • <bricklet-port> – Typ: Char, Wertebereich: [a bis b]
Ausgabe:
  • 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).

tinkerforge call imu-brick <uid> get-spitfp-error-count <bricklet-port>
Parameter:
  • <bricklet-port> – Typ: Char, Wertebereich: [a bis b]
Ausgabe:
  • error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-frame – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • 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).

tinkerforge call imu-brick <uid> enable-status-led
Ausgabe:
  • keine Ausgabe

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).

tinkerforge call imu-brick <uid> disable-status-led
Ausgabe:
  • keine Ausgabe

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).

tinkerforge call imu-brick <uid> is-status-led-enabled
Ausgabe:
  • enabled – Typ: Bool, Standardwert: true

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

Neu in Version 2.3.1 (Firmware).

tinkerforge call imu-brick <uid> get-chip-temperature
Ausgabe:
  • 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.

tinkerforge call imu-brick <uid> reset
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call imu-brick <uid> get-identity
Ausgabe:
  • uid – Typ: String, Länge: bis zu 8
  • connected-uid – Typ: String, Länge: bis zu 8
  • position – Typ: Char, Wertebereich: [0 bis 8]
  • hardware-version – Typ: Int Array, 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]
  • firmware-version – Typ: Int Array, 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]
  • 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. 

Konfigurationsfunktionen für Callbacks

tinkerforge call imu-brick <uid> set-acceleration-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

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

tinkerforge call imu-brick <uid> get-acceleration-period
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set-acceleration-period gesetzt.

tinkerforge call imu-brick <uid> set-magnetic-field-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt die Periode mit welcher der magnetic-field Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

tinkerforge call imu-brick <uid> get-magnetic-field-period
Ausgabe:
  • 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.

tinkerforge call imu-brick <uid> set-angular-velocity-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt die Periode mit welcher der angular-velocity Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

tinkerforge call imu-brick <uid> get-angular-velocity-period
Ausgabe:
  • 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.

tinkerforge call imu-brick <uid> set-all-data-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt die Periode mit welcher der all-data Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

tinkerforge call imu-brick <uid> get-all-data-period
Ausgabe:
  • 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.

tinkerforge call imu-brick <uid> set-orientation-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

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

tinkerforge call imu-brick <uid> get-orientation-period
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set-orientation-period gesetzt.

tinkerforge call imu-brick <uid> set-quaternion-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

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

tinkerforge call imu-brick <uid> get-quaternion-period
Ausgabe:
  • 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:

tinkerforge dispatch imu-brick <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

tinkerforge dispatch imu-brick <uid> acceleration
Ausgabe:
  • 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.

tinkerforge dispatch imu-brick <uid> magnetic-field
Ausgabe:
  • 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.

tinkerforge dispatch imu-brick <uid> angular-velocity
Ausgabe:
  • 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.

tinkerforge dispatch imu-brick <uid> all-data
Ausgabe:
  • 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.

tinkerforge dispatch imu-brick <uid> orientation
Ausgabe:
  • 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.

tinkerforge dispatch imu-brick <uid> quaternion
Ausgabe:
  • 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.

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.

tinkerforge call imu-brick <uid> get-protocol1-bricklet-name <port>
Parameter:
  • <port> – Typ: Char, Wertebereich: [a bis b]
Ausgabe:
  • protocol-version – Typ: Int, Wertebereich: [0 bis 255]
  • firmware-version – Typ: Int Array, 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]
  • name – Typ: String, 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.

tinkerforge call imu-brick <uid> write-bricklet-plugin <port> <offset> <chunk>
Parameter:
  • <port> – Typ: Char, Wertebereich: [a bis b]
  • <offset> – Typ: Int, Wertebereich: [0 bis 255]
  • <chunk> – Typ: Int Array, Länge: 32, Wertebereich: [0 bis 255]
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call imu-brick <uid> read-bricklet-plugin <port> <offset>
Parameter:
  • <port> – Typ: Char, Wertebereich: [a bis b]
  • <offset> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:
  • chunk – Typ: Int Array, 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.