Dies ist die Beschreibung der Python 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 Python API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Accelerometer Bricklet 2.0
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_accelerometer_v2 import BrickletAccelerometerV2
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
a = BrickletAccelerometerV2(UID, ipcon) # Create device object
ipcon.connect(HOST, PORT) # Connect to brickd
# Don't use device before ipcon is connected
# Get current acceleration
x, y, z = a.get_acceleration()
print("Acceleration [X]: " + str(x/10000.0) + " g")
print("Acceleration [Y]: " + str(y/10000.0) + " g")
print("Acceleration [Z]: " + str(z/10000.0) + " g")
input("Press key to exit\n") # Use raw_input() in Python 2
ipcon.disconnect()
|
Download (example_callback.py)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Accelerometer Bricklet 2.0
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_accelerometer_v2 import BrickletAccelerometerV2
# Callback function for acceleration callback
def cb_acceleration(x, y, z):
print("Acceleration [X]: " + str(x/10000.0) + " g")
print("Acceleration [Y]: " + str(y/10000.0) + " g")
print("Acceleration [Z]: " + str(z/10000.0) + " g")
print("")
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
a = BrickletAccelerometerV2(UID, ipcon) # Create device object
ipcon.connect(HOST, PORT) # Connect to brickd
# Don't use device before ipcon is connected
# Register acceleration callback to function cb_acceleration
a.register_callback(a.CALLBACK_ACCELERATION, cb_acceleration)
# Set period for acceleration callback to 1s (1000ms)
a.set_acceleration_callback_configuration(1000, False)
input("Press key to exit\n") # Use raw_input() in Python 2
ipcon.disconnect()
|
Prinzipiell kann jede Funktion der Python Bindings
tinkerforge.ip_connection.Error
Exception werfen, welche ein value
und
eine description
Property hat. value
kann verschiende Werte haben:
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
BrickletAccelerometerV2
(uid, ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
accelerometer_v2 = BrickletAccelerometerV2("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletAccelerometerV2.
get_acceleration
()¶Rückgabeobjekt: |
|
---|
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 CALLBACK_ACCELERATION
Callback zu nutzen und die Periode mit
set_acceleration_callback_configuration()
vorzugeben.
BrickletAccelerometerV2.
set_configuration
(data_rate, full_scale)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Konstanten sind für diese Funktion verfügbar:
Für data_rate:
Für full_scale:
BrickletAccelerometerV2.
get_configuration
()¶Rückgabeobjekt: |
|
---|
Gibt die Konfiguration zurück, wie von set_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für data_rate:
Für full_scale:
BrickletAccelerometerV2.
set_info_led_config
(config)¶Parameter: |
|
---|---|
Rückgabe: |
|
Konfiguriert die Info-LED (als "Force" auf dem Bricklet gekennzeichnet). Die LED kann ausgeschaltet, eingeschaltet oder im Herzschlagmodus betrieben werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletAccelerometerV2.
get_info_led_config
()¶Rückgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von set_info_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletAccelerometerV2.
set_filter_configuration
(iir_bypass, low_pass_filter)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Konstanten sind für diese Funktion verfügbar:
Für iir_bypass:
Für low_pass_filter:
Neu in Version 2.0.2 (Plugin).
BrickletAccelerometerV2.
get_filter_configuration
()¶Rückgabeobjekt: |
|
---|
Gibt die Konfiguration zurück, wie von set_filter_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für iir_bypass:
Für low_pass_filter:
Neu in Version 2.0.2 (Plugin).
BrickletAccelerometerV2.
get_spitfp_error_count
()¶Rückgabeobjekt: |
|
---|
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.
BrickletAccelerometerV2.
set_status_led_config
(config)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletAccelerometerV2.
get_status_led_config
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set_status_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletAccelerometerV2.
get_chip_temperature
()¶Rückgabe: |
|
---|
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.
BrickletAccelerometerV2.
reset
()¶Rückgabe: |
|
---|
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.
BrickletAccelerometerV2.
get_identity
()¶Rückgabeobjekt: |
|
---|
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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
BrickletAccelerometerV2.
register_callback
(callback_id, function)¶Parameter: |
|
---|---|
Rückgabe: |
|
Registriert die function
für die gegebene callback_id
.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
BrickletAccelerometerV2.
set_acceleration_callback_configuration
(period, value_has_to_change)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die Periode ist die Periode mit der der CALLBACK_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
CALLBACK_CONTINUOUS_ACCELERATION_16_BIT
Callback und
CALLBACK_CONTINUOUS_ACCELERATION_8_BIT
Callback automatisch deaktiviert.
BrickletAccelerometerV2.
get_acceleration_callback_configuration
()¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set_acceleration_callback_configuration()
gesetzt.
BrickletAccelerometerV2.
set_continuous_acceleration_configuration
(enable_x, enable_y, enable_z, resolution)¶Parameter: |
|
---|---|
Rückgabe: |
|
Um einen hohen Durchsatz an Beschleunigungswerten zu erreichen (> 1000Hz) müssen
die CALLBACK_CONTINUOUS_ACCELERATION_16_BIT
oder CALLBACK_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 CALLBACK_CONTINUOUS_ACCELERATION_8_BIT
-Callback aktiviert.
Wenn mindestens eine Achse aktiviert ist mit 16-Bit Auflösung,
wird der CALLBACK_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 CALLBACK_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 Konstanten sind für diese Funktion verfügbar:
Für resolution:
BrickletAccelerometerV2.
get_continuous_acceleration_configuration
()¶Rückgabeobjekt: |
|
---|
Gibt die Konfiguration für kontinuierliche Beschleunigungswerte zurück, wie mittels
set_continuous_acceleration_configuration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für resolution:
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der Funktion register_callback()
des
Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID
und der zweite Parameter die Callback-Funktion:
def my_callback(param):
print(param)
accelerometer_v2.register_callback(BrickletAccelerometerV2.CALLBACK_EXAMPLE, my_callback)
Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.
BrickletAccelerometerV2.
CALLBACK_ACCELERATION
¶Callback-Parameter: |
|
---|
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()
.
BrickletAccelerometerV2.
CALLBACK_CONTINUOUS_ACCELERATION_16_BIT
¶Callback-Parameter: |
|
---|
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:
BrickletAccelerometerV2.
CALLBACK_CONTINUOUS_ACCELERATION_8_BIT
¶Callback-Parameter: |
|
---|
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:
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
BrickletAccelerometerV2.
get_api_version
()¶Rückgabeobjekt: |
|
---|
Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.
BrickletAccelerometerV2.
get_response_expected
(function_id)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels set_response_expected()
. Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für function_id:
BrickletAccelerometerV2.
set_response_expected
(function_id, response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für function_id:
BrickletAccelerometerV2.
set_response_expected_all
(response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
BrickletAccelerometerV2.
set_bootloader_mode
(mode)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
BrickletAccelerometerV2.
get_bootloader_mode
()¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletAccelerometerV2.
set_write_firmware_pointer
(pointer)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
BrickletAccelerometerV2.
write_firmware
(data)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
BrickletAccelerometerV2.
write_uid
(uid)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
BrickletAccelerometerV2.
read_uid
()¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BrickletAccelerometerV2.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Accelerometer Bricklet 2.0 zu identifizieren.
Die get_identity()
Funktion und der
IPConnection.CALLBACK_ENUMERATE
Callback der IP Connection haben ein device_identifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletAccelerometerV2.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet 2.0 dar.