Dies ist die Beschreibung der Shell 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 Shell API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 7 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Accelerometer Bricklet 2.0
# Get current acceleration
tinkerforge call accelerometer-v2-bricklet $uid get-acceleration
|
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=XYZ # Change XYZ to the UID of your Accelerometer Bricklet 2.0
# Handle incoming acceleration callbacks
tinkerforge dispatch accelerometer-v2-bricklet $uid acceleration &
# Set period for acceleration callback to 1s (1000ms)
tinkerforge call accelerometer-v2-bricklet $uid set-acceleration-callback-configuration 1000 false
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
Mögliche Exit Codes für alle tinkerforge Befehle sind:
Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.
Parameter: |
|
---|
Der call Befehl wird verwendet um eine Funktion des Accelerometer Bricklet 2.0 aufzurufen. Der Befehl kennt mehrere Optionen:
Parameter: |
|
---|
Der dispatch Befehl wird verwendet um eingehende Callbacks des Accelerometer Bricklet 2.0 abzufertigen. Der Befehl kennt mehrere Optionen:
Parameter: |
|
---|
Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:
Getter-Funktionen kennen zusätzlich die folgenden Optionen:
Setter-Funktionen kennen zusätzlich die folgenden Optionen:
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.
Parameter: |
|
---|
Der abzufertigende <callback> kennt mehrere Optionen:
Ausgabe: |
|
---|
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 set-configuration konfiguriert.
Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen den acceleration Callback zu nutzen und die Periode mit set-acceleration-callback-configuration vorzugeben.
Parameter: |
|
---|---|
Ausgabe: |
|
Konfiguriert die Datenrate und den Wertebereich. Mögliche Konfigurationswerte sind:
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>:
Für <full-scale>:
Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-configuration gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für data-rate:
Für full-scale:
Parameter: |
|
---|---|
Ausgabe: |
|
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>:
Ausgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von set-info-led-config gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
Parameter: |
|
---|---|
Ausgabe: |
|
Um einen hohen Durchsatz an Beschleunigungswerten zu erreichen (> 1000Hz) müssen die continuous-acceleration-16-bit oder 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 continuous-acceleration-8-bit-Callback aktiviert. Wenn mindestens eine Achse aktiviert ist mit 16-Bit Auflösung, wird der 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 get-acceleration zurückgegeben) umzuwandeln. Die Formeln hängen ab von der eingestelleten Auflösung (8/16-Bit) und dem eingestellten Wertebereich (siehe set-configuration):
Bei einer Auflösung von 8-Bit werden nur die 8 höchstwertigen Bits übertragen, daher sehen die Formeln wie folgt aus:
Wenn keine Achse aktiviert is, sind beide Callbacks deaktiviert. Wenn einer der "Continuous Callbacks" genutzt wird, wird der 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>:
Ausgabe: |
|
---|
Gibt die Konfiguration für kontinuierliche Beschleunigungswerte zurück, wie mittels set-continuous-acceleration-configuration gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für resolution:
Parameter: |
|
---|---|
Ausgabe: |
|
Konfiguriert den IIR Bypass Filter Modus und die Low Pass Filter Roll Off Corner Frequenz.
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>:
Für <low-pass-filter>:
Neu in Version 2.0.2 (Plugin).
Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-filter-configuration gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für iir-bypass:
Für low-pass-filter:
Neu in Version 2.0.2 (Plugin).
Ausgabe: |
|
---|
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.
Parameter: |
|
---|---|
Ausgabe: |
|
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:
Ausgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Firmware-Pointer für 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.
Parameter: |
|
---|---|
Ausgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von 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.
Parameter: |
|
---|---|
Ausgabe: |
|
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>:
Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
Ausgabe: |
|
---|
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.
Ausgabe: |
|
---|
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.
Parameter: |
|
---|---|
Ausgabe: |
|
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.
Ausgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
Ausgabe: |
|
---|
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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden.
Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der 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 continuous-acceleration-16-bit Callback und continuous-acceleration-8-bit Callback automatisch deaktiviert.
Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels set-acceleration-callback-configuration gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch accelerometer-v2-bricklet <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.
Ausgabe: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels set-acceleration-callback-configuration gesetzten Konfiguration.
Die Parameter sind die gleichen wie get-acceleration.
Ausgabe: |
|
---|
Gibt 30 Beschleunigungswerte mit 16 bit Auflösung zurück. Die Datenrate kann mit der Funktion set-configuration eingestellt werden und der Callback kann per 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 get-acceleration zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe set-configuration):
Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:
Ausgabe: |
|
---|
Gibt 60 Beschleunigungswerte mit 8 bit Auflösung zurück. Die Datenrate kann mit der Funktion set-configuration eingestellt werden und der Callback kann per 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 get-acceleration zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe set-configuration):
Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele: