Dies ist die Beschreibung der MQTT API Bindings für das IMU Bricklet 3.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Bricklet 3.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 | # Change XYZ to the UID of your IMU Bricklet 3.0
setup:
# Get current quaternion
subscribe to tinkerforge/response/imu_v3_bricklet/XYZ/get_quaternion
publish '' to tinkerforge/request/imu_v3_bricklet/XYZ/get_quaternion
|
Download (example-all-data.txt)
1 2 3 4 5 6 7 8 9 | # Change XYZ to the UID of your IMU Bricklet 3.0
setup:
# Handle incoming all data callbacks
subscribe to tinkerforge/callback/imu_v3_bricklet/XYZ/all_data
publish '{"register": true}' to tinkerforge/register/imu_v3_bricklet/XYZ/all_data # Register all_data callback
# Set period for all data callback to 0.1s (100ms)
publish '{"period": 100, "value_has_to_change": false}' to tinkerforge/request/imu_v3_bricklet/XYZ/set_all_data_callback_configuration
|
Download (example-callback.txt)
1 2 3 4 5 6 7 8 9 | # Change XYZ to the UID of your IMU Bricklet 3.0
setup:
# Handle incoming quaternion callbacks
subscribe to tinkerforge/callback/imu_v3_bricklet/XYZ/quaternion
publish '{"register": true}' to tinkerforge/register/imu_v3_bricklet/XYZ/quaternion # Register quaternion callback
# Set period for quaternion callback to 0.1s (100ms)
publish '{"period": 100, "value_has_to_change": false}' to tinkerforge/request/imu_v3_bricklet/XYZ/set_quaternion_callback_configuration
|
Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.
Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR
-Member enthält.
Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/...
für .../request/...
und .../callback/...
für .../register/...
.
request/
imu_v3_bricklet/
<UID>/
get_orientation
¶Anfrage: |
|
---|---|
Antwort: |
|
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
register/imu_v3_bricklet/<UID>/orientation
Callback zu nutzen und die Periode mit
request/imu_v3_bricklet/<UID>/set_orientation_callback_configuration
vorzugeben.
request/
imu_v3_bricklet/
<UID>/
get_linear_acceleration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die lineare Beschleunigungen des IMU Brick für die
X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit
request/imu_v3_bricklet/<UID>/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
request/imu_v3_bricklet/<UID>/get_gravity_vector
Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen
den register/imu_v3_bricklet/<UID>/linear_acceleration
Callback zu nutzen und die Periode mit
request/imu_v3_bricklet/<UID>/set_linear_acceleration_callback_configuration
vorzugeben.
request/
imu_v3_bricklet/
<UID>/
get_gravity_vector
¶Anfrage: |
|
---|---|
Antwort: |
|
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
request/imu_v3_bricklet/<UID>/get_linear_acceleration
Wenn die Erdbeschleunigungen periodisch abgefragt werden soll, wird empfohlen
den register/imu_v3_bricklet/<UID>/gravity_vector
Callback zu nutzen und die Periode mit
request/imu_v3_bricklet/<UID>/set_gravity_vector_callback_configuration
vorzugeben.
request/
imu_v3_bricklet/
<UID>/
get_quaternion
¶Anfrage: |
|
---|---|
Antwort: |
|
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
register/imu_v3_bricklet/<UID>/quaternion
Callback zu nutzen und die Periode mit
request/imu_v3_bricklet/<UID>/set_quaternion_callback_configuration
vorzugeben.
request/
imu_v3_bricklet/
<UID>/
get_all_data
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt alle Daten zurück die dem IMU Brick zur Verfügung stehen.
request/imu_v3_bricklet/<UID>/get_acceleration
)request/imu_v3_bricklet/<UID>/get_magnetic_field
)request/imu_v3_bricklet/<UID>/get_angular_velocity
)request/imu_v3_bricklet/<UID>/get_orientation
)request/imu_v3_bricklet/<UID>/get_quaternion
)request/imu_v3_bricklet/<UID>/get_linear_acceleration
)request/imu_v3_bricklet/<UID>/get_gravity_vector
)request/imu_v3_bricklet/<UID>/get_temperature
)Der Kalibrierungsstatus besteht aus vier Paaren von je zwei Bits. Jedes Paar von Bits repräsentiert den Status der aktuellen Kalibrierung.
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
register/imu_v3_bricklet/<UID>/all_data
Callback zu nutzen und die Periode mit
request/imu_v3_bricklet/<UID>/set_all_data_callback_configuration
vorzugeben.
request/
imu_v3_bricklet/
<UID>/
get_acceleration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die
X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit
request/imu_v3_bricklet/<UID>/set_sensor_configuration
konfiguriert wurde.
Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen
den register/imu_v3_bricklet/<UID>/acceleration
Callback zu nutzen und die Periode mit
request/imu_v3_bricklet/<UID>/set_acceleration_callback_configuration
vorzugeben.
request/
imu_v3_bricklet/
<UID>/
get_magnetic_field
¶Anfrage: |
|
---|---|
Antwort: |
|
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 register/imu_v3_bricklet/<UID>/magnetic_field
Callback zu nutzen und die Periode mit
request/imu_v3_bricklet/<UID>/set_magnetic_field_callback_configuration
vorzugeben.
request/
imu_v3_bricklet/
<UID>/
get_angular_velocity
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die kalibrierte Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und
Z-Achse zurück. Die Winkelgeschwindigkeiten liegen im Wertebereich, der mit
request/imu_v3_bricklet/<UID>/set_sensor_configuration
konfiguriert wurde.
Wenn die Winkelgeschwindigkeiten periodisch abgefragt werden sollen, wird
empfohlen den register/imu_v3_bricklet/<UID>/angular_velocity
Callback zu nutzen und die Periode mit
request/imu_v3_bricklet/<UID>/set_angular_velocity_callback_configuration
vorzugeben.
request/
imu_v3_bricklet/
<UID>/
get_temperature
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Temperatur des IMU Brick zurück. Die Temperatur wird im Kern des BNO055 ICs gemessen, es handelt sich nicht um die Umgebungstemperatur.
request/
imu_v3_bricklet/
<UID>/
save_calibration
¶Anfrage: |
|
---|---|
Antwort: |
|
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.
request/
imu_v3_bricklet/
<UID>/
set_sensor_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
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:
Für gyroscope_range:
Für gyroscope_bandwidth:
Für accelerometer_range:
Für accelerometer_bandwidth:
request/
imu_v3_bricklet/
<UID>/
get_sensor_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Sensor-Konfiguration zurück, wie von request/imu_v3_bricklet/<UID>/set_sensor_configuration
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für magnetometer_rate:
Für gyroscope_range:
Für gyroscope_bandwidth:
Für accelerometer_range:
Für accelerometer_bandwidth:
request/
imu_v3_bricklet/
<UID>/
set_sensor_fusion_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Wenn der Fusion-Modus deaktiviert wird, geben die Funktionen
request/imu_v3_bricklet/<UID>/get_acceleration
, request/imu_v3_bricklet/<UID>/get_magnetic_field
und
request/imu_v3_bricklet/<UID>/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:
request/
imu_v3_bricklet/
<UID>/
get_sensor_fusion_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den aktuellen Sensor-Fusion-Modus zurück, wie von
request/imu_v3_bricklet/<UID>/set_sensor_fusion_mode
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
request/
imu_v3_bricklet/
<UID>/
get_spitfp_error_count
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
request/
imu_v3_bricklet/
<UID>/
set_status_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
imu_v3_bricklet/
<UID>/
get_status_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Konfiguration zurück, wie von request/imu_v3_bricklet/<UID>/set_status_led_config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
imu_v3_bricklet/
<UID>/
get_chip_temperature
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
request/
imu_v3_bricklet/
<UID>/
reset
¶Anfrage: |
|
---|---|
Antwort: |
|
Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
request/
imu_v3_bricklet/
<UID>/
get_identity
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.
Der Display Name enthält den Anzeigenamen des IMU 3.0.
request/
imu_v3_bricklet/
<UID>/
set_acceleration_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/imu_v3_bricklet/<UID>/acceleration
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
request/
imu_v3_bricklet/
<UID>/
get_acceleration_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/imu_v3_bricklet/<UID>/set_acceleration_callback_configuration
gesetzt.
request/
imu_v3_bricklet/
<UID>/
set_magnetic_field_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/imu_v3_bricklet/<UID>/magnetic_field
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
request/
imu_v3_bricklet/
<UID>/
get_magnetic_field_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/imu_v3_bricklet/<UID>/set_magnetic_field_callback_configuration
gesetzt.
request/
imu_v3_bricklet/
<UID>/
set_angular_velocity_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/imu_v3_bricklet/<UID>/angular_velocity
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
request/
imu_v3_bricklet/
<UID>/
get_angular_velocity_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/imu_v3_bricklet/<UID>/set_angular_velocity_callback_configuration
gesetzt.
request/
imu_v3_bricklet/
<UID>/
set_temperature_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/imu_v3_bricklet/<UID>/temperature
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
request/
imu_v3_bricklet/
<UID>/
get_temperature_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/imu_v3_bricklet/<UID>/set_temperature_callback_configuration
gesetzt.
request/
imu_v3_bricklet/
<UID>/
set_orientation_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/imu_v3_bricklet/<UID>/orientation
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
request/
imu_v3_bricklet/
<UID>/
get_orientation_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/imu_v3_bricklet/<UID>/set_orientation_callback_configuration
gesetzt.
request/
imu_v3_bricklet/
<UID>/
set_linear_acceleration_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/imu_v3_bricklet/<UID>/linear_acceleration
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
request/
imu_v3_bricklet/
<UID>/
get_linear_acceleration_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/imu_v3_bricklet/<UID>/set_linear_acceleration_callback_configuration
gesetzt.
request/
imu_v3_bricklet/
<UID>/
set_gravity_vector_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/imu_v3_bricklet/<UID>/gravity_vector
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
request/
imu_v3_bricklet/
<UID>/
get_gravity_vector_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/imu_v3_bricklet/<UID>/set_gravity_vector_callback_configuration
gesetzt.
request/
imu_v3_bricklet/
<UID>/
set_quaternion_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/imu_v3_bricklet/<UID>/quaternion
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
request/
imu_v3_bricklet/
<UID>/
get_quaternion_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/imu_v3_bricklet/<UID>/set_quaternion_callback_configuration
gesetzt.
request/
imu_v3_bricklet/
<UID>/
set_all_data_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Die Periode ist die Periode mit der der register/imu_v3_bricklet/<UID>/all_data
Callback
ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
request/
imu_v3_bricklet/
<UID>/
get_all_data_callback_configuration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels request/imu_v3_bricklet/<UID>/set_all_data_callback_configuration
gesetzt.
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit dem entsprechenden .../register/...
-Topic und einem optionalen Suffix durchgeführt werden.
Mit diesem Suffix kann das Callback später deregistriert werden.
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.
register/
imu_v3_bricklet/
<UID>/
acceleration
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/imu_v3_bricklet/<UID>/acceleration[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/imu_v3_bricklet/<UID>/acceleration[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird mit der Periode, wie gesetzt mit
request/imu_v3_bricklet/<UID>/set_acceleration_callback_configuration
, ausgelöst. Die Payload-Member des Callbacks sind die
Beschleunigungen der X, Y und Z-Achse.
register/
imu_v3_bricklet/
<UID>/
magnetic_field
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/imu_v3_bricklet/<UID>/magnetic_field[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/imu_v3_bricklet/<UID>/magnetic_field[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird mit der Periode, wie gesetzt mit
request/imu_v3_bricklet/<UID>/set_magnetic_field_callback_configuration
, ausgelöst. Die Payload-Member des Callbacks sind die
Magnetfeldkomponenten der X, Y und Z-Achse.
register/
imu_v3_bricklet/
<UID>/
angular_velocity
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/imu_v3_bricklet/<UID>/angular_velocity[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/imu_v3_bricklet/<UID>/angular_velocity[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird mit der Periode, wie gesetzt mit
request/imu_v3_bricklet/<UID>/set_angular_velocity_callback_configuration
, ausgelöst. Die Payload-Member des Callbacks sind die
Winkelgeschwindigkeiten der X, Y und Z-Achse.
register/
imu_v3_bricklet/
<UID>/
temperature
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/imu_v3_bricklet/<UID>/temperature[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/imu_v3_bricklet/<UID>/temperature[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird mit der Periode, wie gesetzt mit
request/imu_v3_bricklet/<UID>/set_temperature_callback_configuration
, ausgelöst. Der Payload des Callbacks ist die
Temperatur.
register/
imu_v3_bricklet/
<UID>/
linear_acceleration
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/imu_v3_bricklet/<UID>/linear_acceleration[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/imu_v3_bricklet/<UID>/linear_acceleration[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird mit der Periode, wie gesetzt mit
request/imu_v3_bricklet/<UID>/set_linear_acceleration_callback_configuration
, ausgelöst. Die Payload des Callbacks sind
die linearen Beschleunigungen der X, Y und Z-Achse.
register/
imu_v3_bricklet/
<UID>/
gravity_vector
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/imu_v3_bricklet/<UID>/gravity_vector[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/imu_v3_bricklet/<UID>/gravity_vector[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird mit der Periode, wie gesetzt mit
request/imu_v3_bricklet/<UID>/set_gravity_vector_callback_configuration
, ausgelöst. Die Payload des Callbacks sind die
Erdbeschleunigungsvektor-Werte der X, Y und Z-Achse.
register/
imu_v3_bricklet/
<UID>/
orientation
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/imu_v3_bricklet/<UID>/orientation[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/imu_v3_bricklet/<UID>/orientation[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird mit der Periode, wie gesetzt mit
request/imu_v3_bricklet/<UID>/set_orientation_callback_configuration
, ausgelöst. Die Payload-Member des Callbacks sind die
Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in Eulerwinkeln. Siehe
request/imu_v3_bricklet/<UID>/get_orientation
für Details.
register/
imu_v3_bricklet/
<UID>/
quaternion
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/imu_v3_bricklet/<UID>/quaternion[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/imu_v3_bricklet/<UID>/quaternion[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird mit der Periode, wie gesetzt mit
request/imu_v3_bricklet/<UID>/set_quaternion_callback_configuration
, ausgelöst. Die Payload-Member des Callbacks sind die
Orientierung (w, x, y, z) des IMU Brick in Quaternionen. Siehe
request/imu_v3_bricklet/<UID>/get_quaternion
für Details.
register/
imu_v3_bricklet/
<UID>/
all_data
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/imu_v3_bricklet/<UID>/all_data[/<SUFFIX>]
-Topic hinzugefügt werden.
Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden.
Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.
Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/imu_v3_bricklet/<UID>/all_data[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird mit der Periode, wie gesetzt mit
request/imu_v3_bricklet/<UID>/set_all_data_callback_configuration
, ausgelöst. Die Payload des Callbacks sind die
gleichen wie bei request/imu_v3_bricklet/<UID>/get_all_data
.
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.
request/
imu_v3_bricklet/
<UID>/
set_bootloader_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
Für status:
request/
imu_v3_bricklet/
<UID>/
get_bootloader_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe request/imu_v3_bricklet/<UID>/set_bootloader_mode
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
request/
imu_v3_bricklet/
<UID>/
set_write_firmware_pointer
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Firmware-Pointer für request/imu_v3_bricklet/<UID>/write_firmware
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
request/
imu_v3_bricklet/
<UID>/
write_firmware
¶Anfrage: |
|
---|---|
Antwort: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
request/imu_v3_bricklet/<UID>/set_write_firmware_pointer
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
request/
imu_v3_bricklet/
<UID>/
write_uid
¶Anfrage: |
|
---|---|
Antwort: |
|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
request/
imu_v3_bricklet/
<UID>/
read_uid
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.