Dies ist die Beschreibung der MQTT API Bindings für das Accelerometer Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet 2.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# Change XYZ to the UID of your Accelerometer Bricklet 2.0
2
3setup:
4 # Get current acceleration
5 subscribe to tinkerforge/response/accelerometer_v2_bricklet/XYZ/get_acceleration
6 publish '' to tinkerforge/request/accelerometer_v2_bricklet/XYZ/get_acceleration
Download (example-callback.txt)
1# Change XYZ to the UID of your Accelerometer Bricklet 2.0
2
3setup:
4 # Handle incoming acceleration callbacks
5 subscribe to tinkerforge/callback/accelerometer_v2_bricklet/XYZ/acceleration
6 publish '{"register": true}' to tinkerforge/register/accelerometer_v2_bricklet/XYZ/acceleration # Register acceleration callback
7
8 # Set period for acceleration callback to 1s (1000ms)
9 publish '{"period": 1000, "value_has_to_change": false}' to tinkerforge/request/accelerometer_v2_bricklet/XYZ/set_acceleration_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/....
| Anfrage: |
|
|---|---|
| Antwort: |
|
Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte
haben die Einheit gₙ/10000 (1gₙ = 9,80665m/s²). Der Wertebereich
wird mit request/accelerometer_v2_bricklet/<UID>/set_configuration() konfiguriert.
Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen
den register/accelerometer_v2_bricklet/<UID>/acceleration() Callback zu nutzen und die Periode mit
request/accelerometer_v2_bricklet/<UID>/set_acceleration_callback_configuration() vorzugeben.
| Anfrage: |
|
|---|---|
| Antwort: |
|
Konfiguriert die Datenrate und den Wertebereich. Mögliche Konfigurationswerte sind:
Datenrate zwischen 0,781Hz und 25600Hz.
Wertebereich von ±2g bis zu ±8g.
Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für data_rate:
"0_781hz" = 0
"1_563hz" = 1
"3_125hz" = 2
"6_2512hz" = 3
"12_5hz" = 4
"25hz" = 5
"50hz" = 6
"100hz" = 7
"200hz" = 8
"400hz" = 9
"800hz" = 10
"1600hz" = 11
"3200hz" = 12
"6400hz" = 13
"12800hz" = 14
"25600hz" = 15
Für full_scale:
"2g" = 0
"4g" = 1
"8g" = 2
| Anfrage: |
|
|---|---|
| Antwort: |
|
Gibt die Konfiguration zurück, wie von request/accelerometer_v2_bricklet/<UID>/set_configuration() gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für data_rate:
"0_781hz" = 0
"1_563hz" = 1
"3_125hz" = 2
"6_2512hz" = 3
"12_5hz" = 4
"25hz" = 5
"50hz" = 6
"100hz" = 7
"200hz" = 8
"400hz" = 9
"800hz" = 10
"1600hz" = 11
"3200hz" = 12
"6400hz" = 13
"12800hz" = 14
"25600hz" = 15
Für full_scale:
"2g" = 0
"4g" = 1
"8g" = 2
| Anfrage: |
|
|---|---|
| Antwort: |
|
Konfiguriert die Info-LED (als "Force" auf dem Bricklet gekennzeichnet). Die LED kann ausgeschaltet, eingeschaltet oder im Herzschlagmodus betrieben werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
"off" = 0
"on" = 1
"show_heartbeat" = 2
| Anfrage: |
|
|---|---|
| Antwort: |
|
Gibt die LED-Konfiguration zurück, wie von request/accelerometer_v2_bricklet/<UID>/set_info_led_config() gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
"off" = 0
"on" = 1
"show_heartbeat" = 2
| Anfrage: |
|
|---|---|
| Antwort: |
|
Konfiguriert den IIR Bypass Filter Modus und die Grenzfrequenz des Tiefpassfilters.
Der Filter kann angewendet oder umgangen werden und die Frequenz kann die halbe oder ein Neuntel der Ausgabe-Datenrate sein.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für iir_bypass:
"applied" = 0
"bypassed" = 1
Für low_pass_filter:
"ninth" = 0
"half" = 1
Added in version 2.0.2$nbsp;(Plugin).
| Anfrage: |
|
|---|---|
| Antwort: |
|
Gibt die Konfiguration zurück, wie von request/accelerometer_v2_bricklet/<UID>/set_filter_configuration() gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für iir_bypass:
"applied" = 0
"bypassed" = 1
Für low_pass_filter:
"ninth" = 0
"half" = 1
Added in version 2.0.2$nbsp;(Plugin).
| 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
ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
| 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:
"off" = 0
"on" = 1
"show_heartbeat" = 2
"show_status" = 3
| Anfrage: |
|
|---|---|
| Antwort: |
|
Gibt die Konfiguration zurück, wie von request/accelerometer_v2_bricklet/<UID>/set_status_led_config() gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
"off" = 0
"on" = 1
"show_heartbeat" = 2
"show_status" = 3
| 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.
| 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.
| 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 Accelerometer 2.0.
| Anfrage: |
|
|---|---|
| Antwort: |
|
Die Periode ist die Periode mit der der register/accelerometer_v2_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.
Wenn dieser Callback aktiviert ist, werden der
register/accelerometer_v2_bricklet/<UID>/continuous_acceleration_16_bit() Callback und
register/accelerometer_v2_bricklet/<UID>/continuous_acceleration_8_bit() Callback automatisch deaktiviert.
| Anfrage: |
|
|---|---|
| Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels
request/accelerometer_v2_bricklet/<UID>/set_acceleration_callback_configuration() gesetzt.
| Anfrage: |
|
|---|---|
| Antwort: |
|
Um einen hohen Durchsatz an Beschleunigungswerten zu erreichen (> 1000Hz) müssen
die register/accelerometer_v2_bricklet/<UID>/continuous_acceleration_16_bit() oder register/accelerometer_v2_bricklet/<UID>/continuous_acceleration_8_bit()
Callbacks genutzt werden.
Die Callbacks können für die Achsen (x, y, z) individuell aktiviert werden. Des weiteren kann eine Auflösung von 8-Bit oder 16-Bit ausgewählt werden.
Wenn mindestens eine Achse aktiviert ist mit 8-Bit Auflösung,
wird der register/accelerometer_v2_bricklet/<UID>/continuous_acceleration_8_bit()-Callback aktiviert.
Wenn mindestens eine Achse aktiviert ist mit 16-Bit Auflösung,
wird der register/accelerometer_v2_bricklet/<UID>/continuous_acceleration_16_bit()-Callback aktiviert.
Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.
Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder
in der Einheit gₙ/10000 (gleiche Einheit wie von request/accelerometer_v2_bricklet/<UID>/get_acceleration() zurückgegeben)
umzuwandeln. Die Formeln hängen ab von der eingestelleten Auflösung (8/16-Bit) und dem
eingestellten Wertebereich (siehe request/accelerometer_v2_bricklet/<UID>/set_configuration()):
16-Bit, Wertebereich 2g: Beschleunigung = Rohwert * 625 / 1024
16-Bit, Wertebereich 4g: Beschleunigung = Rohwert * 1250 / 1024
16-Bit, Wertebereich 8g: Beschleunigung = Rohwert * 2500 / 1024
Bei einer Auflösung von 8-Bit werden nur die 8 höchstwertigen Bits übertragen, daher sehen die Formeln wie folgt aus:
8-Bit, Wertebereich 2g: Beschleunigung = Rohwert * 256 * 625 / 1024
8-Bit, Wertebereich 4g: Beschleunigung = Rohwert * 256 * 1250 / 1024
8-Bit, Wertebereich 8g: Beschleunigung = Rohwert * 256 * 2500 / 1024
Wenn keine Achse aktiviert is, sind beide Callbacks deaktiviert. Wenn einer der
"Continuous Callbacks" genutzt wird, wird der register/accelerometer_v2_bricklet/<UID>/acceleration()-Callback
automatisch deaktiviert.
Der maximale Durchsatz hängt von der Konfiguration ab:
Anzahl aktiviert Achsen |
Durchsatz 8-Bit |
Durchsatz 16-Bit |
|---|---|---|
1 |
25600Hz |
25600Hz |
2 |
25600Hz |
15000Hz |
3 |
20000Hz |
10000Hz |
Die folgenden Symbole sind für diese Funktion verfügbar:
Für resolution:
"8bit" = 0
"16bit" = 1
| Anfrage: |
|
|---|---|
| Antwort: |
|
Gibt die Konfiguration für kontinuierliche Beschleunigungswerte zurück, wie mittels
request/accelerometer_v2_bricklet/<UID>/set_continuous_acceleration_configuration() gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für resolution:
"8bit" = 0
"16bit" = 1
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.
| Registrierungsanfrage: |
|
|---|---|
| Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/accelerometer_v2_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/accelerometer_v2_bricklet/<UID>/acceleration[/<SUFFIX>]-Topic veröffentlicht.
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
request/accelerometer_v2_bricklet/<UID>/set_acceleration_callback_configuration() gesetzten Konfiguration.
Die Payload-Member des Callbacks sind die gleichen wie request/accelerometer_v2_bricklet/<UID>/get_acceleration().
| Registrierungsanfrage: |
|
|---|---|
| Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/accelerometer_v2_bricklet/<UID>/continuous_acceleration_16_bit[/<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/accelerometer_v2_bricklet/<UID>/continuous_acceleration_16_bit[/<SUFFIX>]-Topic veröffentlicht.
Gibt 30 Beschleunigungswerte mit 16 bit Auflösung zurück. Die Datenrate
kann mit der Funktion request/accelerometer_v2_bricklet/<UID>/set_configuration() eingestellt werden und
der Callback kann per request/accelerometer_v2_bricklet/<UID>/set_continuous_acceleration_configuration()
aktiviert werden.
Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.
Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder
in der Einheit gₙ/10000 (gleiche Einheit wie von request/accelerometer_v2_bricklet/<UID>/get_acceleration() zurückgegeben)
umzuwandeln. Die Formeln hängen ab von dem
eingestellten Wertebereich (siehe request/accelerometer_v2_bricklet/<UID>/set_configuration()):
Wertebereich 2g: Beschleunigung = Rohwert * 625 / 1024
Wertebereich 4g: Beschleunigung = Rohwert * 1250 / 1024
Wertebereich 8g: Beschleunigung = Rohwert * 2500 / 1024
Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:
x, y, z aktiviert: "x, y, z, ..." 10x wiederholt
x, z aktiviert: "x, z, ..." 15x wiederholt
y aktiviert: "y, ..." 30x wiederholt
| Registrierungsanfrage: |
|
|---|---|
| Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/accelerometer_v2_bricklet/<UID>/continuous_acceleration_8_bit[/<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/accelerometer_v2_bricklet/<UID>/continuous_acceleration_8_bit[/<SUFFIX>]-Topic veröffentlicht.
Gibt 60 Beschleunigungswerte mit 8 bit Auflösung zurück. Die Datenrate
kann mit der Funktion request/accelerometer_v2_bricklet/<UID>/set_configuration() eingestellt werden und
der Callback kann per request/accelerometer_v2_bricklet/<UID>/set_continuous_acceleration_configuration()
aktiviert werden.
Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.
Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder
in der Einheit gₙ/10000 (gleiche Einheit wie von request/accelerometer_v2_bricklet/<UID>/get_acceleration() zurückgegeben)
umzuwandeln. Die Formeln hängen ab von dem
eingestellten Wertebereich (siehe request/accelerometer_v2_bricklet/<UID>/set_configuration()):
Wertebereich 2g: Beschleunigung = Rohwert * 256 * 625 / 1024
Wertebereich 4g: Beschleunigung = Rohwert * 256 * 1250 / 1024
Wertebereich 8g: Beschleunigung = Rohwert * 256 * 2500 / 1024
Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:
x, y, z aktiviert: "x, y, z, ..." 20x wiederholt
x, z aktiviert: "x, z, ..." 30x wiederholt
y aktiviert: "y, ..." 60x wiederholt
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.
| 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:
"bootloader" = 0
"firmware" = 1
"bootloader_wait_for_reboot" = 2
"firmware_wait_for_reboot" = 3
"firmware_wait_for_erase_and_reboot" = 4
Für status:
"ok" = 0
"invalid_mode" = 1
"no_change" = 2
"entry_function_not_present" = 3
"device_identifier_incorrect" = 4
"crc_mismatch" = 5
| Anfrage: |
|
|---|---|
| Antwort: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe request/accelerometer_v2_bricklet/<UID>/set_bootloader_mode().
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
"bootloader" = 0
"firmware" = 1
"bootloader_wait_for_reboot" = 2
"firmware_wait_for_reboot" = 3
"firmware_wait_for_erase_and_reboot" = 4
| Anfrage: |
|
|---|---|
| Antwort: |
|
Setzt den Firmware-Pointer für request/accelerometer_v2_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.
| Anfrage: |
|
|---|---|
| Antwort: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
request/accelerometer_v2_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.
| 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.
| 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.