Shell - Accelerometer Bricklet

Dies ist die Beschreibung der Shell API Bindings für das Accelerometer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet 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=XYZ # Change XYZ to the UID of your Accelerometer Bricklet

# Get current acceleration
tinkerforge call accelerometer-bricklet $uid get-acceleration

Callback

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
#!/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

# Handle incoming acceleration callbacks
tinkerforge dispatch accelerometer-bricklet $uid acceleration &

# Set period for acceleration callback to 1s (1000ms)
# Note: The acceleration callback is only called every second
#       if the acceleration has changed since the last call!
tinkerforge call accelerometer-bricklet $uid set-acceleration-callback-period 1000

echo "Press key to exit"; read dummy

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

Threshold

Download (example-threshold.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
#!/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

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call accelerometer-bricklet $uid set-debounce-period 10000

# Handle incoming acceleration reached callbacks
tinkerforge dispatch accelerometer-bricklet $uid acceleration-reached &

# Configure threshold for acceleration "greater than 2 g, 2 g, 2 g"
tinkerforge call accelerometer-bricklet $uid set-acceleration-callback-threshold threshold-option-greater 2000 0 2000 0 2000 0

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

Der call Befehl wird verwendet um eine Funktion des Accelerometer Bricklet 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 Accelerometer Bricklet an und endet dann
tinkerforge dispatch accelerometer-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Accelerometer Bricklet 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 Accelerometer Bricklet an und endet dann
tinkerforge call accelerometer-bricklet <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 accelerometer-bricklet <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 accelerometer-bricklet <uid> get-acceleration
Ausgabe:
  • x – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • y – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • z – Typ: Int, Wertebereich: [-215 bis 215 - 1]

Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte haben die Einheit g/1000 (1g = 9,80665m/s²), nicht zu verwechseln mit Gramm.

Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen den acceleration Callback zu nutzen und die Periode mit set-acceleration-callback-period vorzugeben.

tinkerforge call accelerometer-bricklet <uid> get-temperature
Ausgabe:
  • temperature – Typ: Int, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur des Beschleunigungssensors in °C zurück.

tinkerforge call accelerometer-bricklet <uid> led-on
Ausgabe:
  • keine Ausgabe

Aktiviert die LED auf dem Bricklet.

tinkerforge call accelerometer-bricklet <uid> led-off
Ausgabe:
  • keine Ausgabe

Deaktiviert die LED auf dem Bricklet.

tinkerforge call accelerometer-bricklet <uid> is-led-on
Ausgabe:
  • on – Typ: Bool

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

Fortgeschrittene Funktionen

tinkerforge call accelerometer-bricklet <uid> set-configuration <data-rate> <full-scale> <filter-bandwidth>
Parameter:
  • <data-rate> – Typ: Int, Wertebereich: Siehe Symbole
  • <full-scale> – Typ: Int, Wertebereich: Siehe Symbole
  • <filter-bandwidth> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

Konfiguriert die Datenrate, den Wertebereich und die Filterbandbreite. Mögliche Konfigurationswerte sind:

  • Datenrate zwischen 0Hz und 1600Hz.
  • Wertebereich von ±2g bis zu ±16g.
  • Filterbandbreite zwischen 50Hz und 800Hz.

Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.

Die Standardwerte sind 100Hz Datenrate, ±4g Wertebereich und 200Hz Filterbandbreite.

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

Für <data-rate>:

  • data-rate-off = 0
  • data-rate-3hz = 1
  • data-rate-6hz = 2
  • data-rate-12hz = 3
  • data-rate-25hz = 4
  • data-rate-50hz = 5
  • data-rate-100hz = 6
  • data-rate-400hz = 7
  • data-rate-800hz = 8
  • data-rate-1600hz = 9

Für <full-scale>:

  • full-scale-2g = 0
  • full-scale-4g = 1
  • full-scale-6g = 2
  • full-scale-8g = 3
  • full-scale-16g = 4

Für <filter-bandwidth>:

  • filter-bandwidth-800hz = 0
  • filter-bandwidth-400hz = 1
  • filter-bandwidth-200hz = 2
  • filter-bandwidth-50hz = 3
tinkerforge call accelerometer-bricklet <uid> get-configuration
Ausgabe:
  • data-rate – Typ: Int, Wertebereich: Siehe Symbole
  • full-scale – Typ: Int, Wertebereich: Siehe Symbole
  • filter-bandwidth – Typ: Int, Wertebereich: Siehe Symbole

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

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

Für data-rate:

  • data-rate-off = 0
  • data-rate-3hz = 1
  • data-rate-6hz = 2
  • data-rate-12hz = 3
  • data-rate-25hz = 4
  • data-rate-50hz = 5
  • data-rate-100hz = 6
  • data-rate-400hz = 7
  • data-rate-800hz = 8
  • data-rate-1600hz = 9

Für full-scale:

  • full-scale-2g = 0
  • full-scale-4g = 1
  • full-scale-6g = 2
  • full-scale-8g = 3
  • full-scale-16g = 4

Für filter-bandwidth:

  • filter-bandwidth-800hz = 0
  • filter-bandwidth-400hz = 1
  • filter-bandwidth-200hz = 2
  • filter-bandwidth-50hz = 3
tinkerforge call accelerometer-bricklet <uid> get-identity
Ausgabe:
  • uid – Typ: String, Länge: bis zu 8
  • connected-uid – Typ: String, Länge: bis zu 8
  • position – Typ: Char
  • hardware-version – Typ: Int Array, Länge: 3, Wertebereich: [0 bis 255]
  • firmware-version – Typ: Int Array, Länge: 3, Wertebereich: [0 bis 255]
  • device-identifier – Typ: Int, Wertebereich: [0 bis 216 - 1]

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

tinkerforge call accelerometer-bricklet <uid> set-acceleration-callback-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.

Der acceleration Callback wird nur ausgelöst, wenn sich die Acceleration seit der letzten Auslösung geändert hat.

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

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

tinkerforge call accelerometer-bricklet <uid> set-acceleration-callback-threshold <option> <min-x> <max-x> <min-y> <max-y> <min-z> <max-z>
Parameter:
  • <option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • <min-x> – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • <max-x> – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • <min-y> – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • <max-y> – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • <min-z> – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • <max-z> – Typ: Int, Wertebereich: [-215 bis 215 - 1]
Ausgabe:
  • keine Ausgabe

Setzt den Schwellwert für den acceleration-reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Beschleunigung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Beschleunigung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Beschleunigung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Beschleunigung größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0, 0, 0, 0, 0, 0, 0).

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

Für <option>:

  • threshold-option-off = x
  • threshold-option-outside = o
  • threshold-option-inside = i
  • threshold-option-smaller = <
  • threshold-option-greater = >
tinkerforge call accelerometer-bricklet <uid> get-acceleration-callback-threshold
Ausgabe:
  • option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • min-x – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • max-x – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • min-y – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • max-y – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • min-z – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • max-z – Typ: Int, Wertebereich: [-215 bis 215 - 1]

Gibt den Schwellwert zurück, wie von set-acceleration-callback-threshold gesetzt.

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

Für option:

  • threshold-option-off = x
  • threshold-option-outside = o
  • threshold-option-inside = i
  • threshold-option-smaller = <
  • threshold-option-greater = >
tinkerforge call accelerometer-bricklet <uid> set-debounce-period <debounce>
Parameter:
  • <debounce> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Ausgabe:
  • keine Ausgabe

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

tinkerforge call accelerometer-bricklet <uid> get-debounce-period
Ausgabe:
  • debounce – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set-debounce-period gesetzt.

Callbacks

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

tinkerforge dispatch accelerometer-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.

tinkerforge dispatch accelerometer-bricklet <uid> acceleration
Ausgabe:
  • x – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • y – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • z – Typ: Int, Wertebereich: [-215 bis 215 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set-acceleration-callback-period, ausgelöst. Die Parameter sind die Beschleunigungen der X-, Y- und Z-Achse.

Der acceleration Callback wird nur ausgelöst, wenn sich die Beschleunigung seit der letzten Auslösung geändert hat.

tinkerforge dispatch accelerometer-bricklet <uid> acceleration-reached
Ausgabe:
  • x – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • y – Typ: Int, Wertebereich: [-215 bis 215 - 1]
  • z – Typ: Int, Wertebereich: [-215 bis 215 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set-acceleration-callback-threshold gesetzt, erreicht wird. Die Parameter sind die Beschleunigungen der X-, Y- und Z-Achse.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set-debounce-period gesetzt, ausgelöst.