Shell - IMU Brick 2.0

Dies ist die Beschreibung der Shell API Bindings für den IMU Brick 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Brick 2.0 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 2.0

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

All Data

Download (example-all-data.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

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

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

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

echo "Press key to exit"; read dummy

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

Callback

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

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

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

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

echo "Press key to exit"; read dummy

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

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-v2-brick [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des IMU Brick 2.0 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 2.0 an und endet dann
tinkerforge dispatch imu-v2-brick [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des IMU Brick 2.0 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 2.0 an und endet dann
tinkerforge call imu-v2-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-v2-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-v2-brick <uid> get-orientation
Ausgabe:
  • 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]

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

tinkerforge call imu-v2-brick <uid> get-linear-acceleration
Ausgabe:
  • x – Typ: Int, Einheit: 1 cm/s, Wertebereich: ?
  • y – Typ: Int, Einheit: 1 cm/s, Wertebereich: ?
  • 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 linear-acceleration Callback zu nutzen und die Periode mit set-linear-acceleration-period vorzugeben.

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

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

tinkerforge call imu-v2-brick <uid> get-quaternion
Ausgabe:
  • w – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • x – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • y – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • z – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]

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

tinkerforge call imu-v2-brick <uid> get-all-data
Ausgabe:
  • acceleration – Typ: Int Array, 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 Array, 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 Array, 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 Array, 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 Array, Länge: 4
    • 0: w – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 1: x – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 2: y – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 3: z – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • linear-acceleration – Typ: Int Array, 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 Array, 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]
  • temperature – Typ: Int, Einheit: 1 °C, Wertebereich: [-128 bis 127]
  • calibration-status – Typ: Int, Wertebereich: [0 bis 255]

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

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

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

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

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

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

tinkerforge call imu-v2-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.

Fortgeschrittene Funktionen

tinkerforge call imu-v2-brick <uid> get-acceleration
Ausgabe:
  • x – Typ: Int, Einheit: 1 cm/s, Wertebereich: ?
  • y – Typ: Int, Einheit: 1 cm/s, Wertebereich: ?
  • 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 acceleration Callback zu nutzen und die Periode mit set-acceleration-period vorzugeben.

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

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

tinkerforge call imu-v2-brick <uid> get-angular-velocity
Ausgabe:
  • x – Typ: Int, Einheit: 1/16 °/s, Wertebereich: ?
  • y – Typ: Int, Einheit: 1/16 °/s, Wertebereich: ?
  • 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 angular-velocity Callback zu nutzen und die Periode mit set-angular-velocity-period vorzugeben.

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

tinkerforge call imu-v2-brick <uid> save-calibration
Ausgabe:
  • 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.

tinkerforge call imu-v2-brick <uid> set-sensor-configuration <magnetometer-rate> <gyroscope-range> <gyroscope-bandwidth> <accelerometer-range> <accelerometer-bandwidth>
Parameter:
  • <magnetometer-rate> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 5
  • <gyroscope-range> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • <gyroscope-bandwidth> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 7
  • <accelerometer-range> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
  • <accelerometer-bandwidth> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:
  • keine Ausgabe

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

Für <magnetometer-rate>:

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

Für <gyroscope-range>:

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

Für <gyroscope-bandwidth>:

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

Für <accelerometer-range>:

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

Für <accelerometer-bandwidth>:

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

Neu in Version 2.0.5 (Firmware).

tinkerforge call imu-v2-brick <uid> get-sensor-configuration
Ausgabe:
  • magnetometer-rate – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 5
  • gyroscope-range – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
  • gyroscope-bandwidth – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 7
  • accelerometer-range – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
  • accelerometer-bandwidth – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Sensor-Konfiguration zurück, wie von set-sensor-configuration gesetzt.

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

Für magnetometer-rate:

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

Für gyroscope-range:

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

Für gyroscope-bandwidth:

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

Für accelerometer-range:

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

Für accelerometer-bandwidth:

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

Neu in Version 2.0.5 (Firmware).

tinkerforge call imu-v2-brick <uid> set-sensor-fusion-mode <mode>
Parameter:
  • <mode> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
Ausgabe:
  • keine Ausgabe

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

Für <mode>:

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

Neu in Version 2.0.5 (Firmware).

tinkerforge call imu-v2-brick <uid> get-sensor-fusion-mode
Ausgabe:
  • mode – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1

Gibt den aktuellen Sensor-Fusion-Modus zurück, wie von set-sensor-fusion-mode gesetzt.

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

Für mode:

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

Neu in Version 2.0.5 (Firmware).

tinkerforge call imu-v2-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.0.10 (Firmware).

tinkerforge call imu-v2-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.0.10 (Firmware).

tinkerforge call imu-v2-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.0.7 (Firmware).

tinkerforge call imu-v2-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.0.5 (Firmware).

tinkerforge call imu-v2-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.0.5 (Firmware).

tinkerforge call imu-v2-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.0.5 (Firmware).

tinkerforge call imu-v2-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.

tinkerforge call imu-v2-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.

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

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

tinkerforge call imu-v2-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-v2-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-v2-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-v2-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-v2-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-v2-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-v2-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-v2-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-v2-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-v2-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-v2-brick <uid> set-temperature-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 temperature Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

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

tinkerforge call imu-v2-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-v2-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-v2-brick <uid> set-linear-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 linear-acceleration Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

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

tinkerforge call imu-v2-brick <uid> set-gravity-vector-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 gravity-vector Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

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

tinkerforge call imu-v2-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-v2-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.

tinkerforge call imu-v2-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-v2-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.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch imu-v2-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-v2-brick <uid> acceleration
Ausgabe:
  • 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-period, ausgelöst. Die Parameter sind die Beschleunigungen der X, Y und Z-Achse.

tinkerforge dispatch imu-v2-brick <uid> magnetic-field
Ausgabe:
  • 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-period, ausgelöst. Die Parameter sind die Magnetfeldkomponenten der X, Y und Z-Achse.

tinkerforge dispatch imu-v2-brick <uid> angular-velocity
Ausgabe:
  • 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-period, ausgelöst. Die Parameter sind die Winkelgeschwindigkeiten der X, Y und Z-Achse.

tinkerforge dispatch imu-v2-brick <uid> temperature
Ausgabe:
  • temperature – Typ: Int, Einheit: 1 °C, Wertebereich: [-128 bis 127]

Dieser Callback wird mit der Periode, wie gesetzt mit set-temperature-period, ausgelöst. Der Parameter ist die Temperatur.

tinkerforge dispatch imu-v2-brick <uid> linear-acceleration
Ausgabe:
  • 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-period, ausgelöst. Die Parameter sind die linearen Beschleunigungen der X, Y und Z-Achse.

tinkerforge dispatch imu-v2-brick <uid> gravity-vector
Ausgabe:
  • 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-period, ausgelöst. Die Parameter sind die Erdbeschleunigungsvektor-Werte der X, Y und Z-Achse.

tinkerforge dispatch imu-v2-brick <uid> orientation
Ausgabe:
  • 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-period, ausgelöst. Die Parameter sind die Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in Eulerwinkeln. Siehe get-orientation für Details.

tinkerforge dispatch imu-v2-brick <uid> quaternion
Ausgabe:
  • w – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • x – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • y – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • z – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]

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

tinkerforge dispatch imu-v2-brick <uid> all-data
Ausgabe:
  • acceleration – Typ: Int Array, 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 Array, 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 Array, 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 Array, 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 Array, Länge: 4
    • 0: w – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 1: x – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 2: y – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
    • 3: z – Typ: Int, Einheit: 1/16383, Wertebereich: [-16383 bis 16383]
  • linear-acceleration – Typ: Int Array, 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 Array, 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-period, ausgelöst. Die Parameter sind die gleichen wie bei get-all-data.