Python - Accelerometer Bricklet

Dies ist die Beschreibung der Python 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 Python API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.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
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Accelerometer Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_accelerometer import BrickletAccelerometer

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    a = BrickletAccelerometer(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/1000.0) + " g")
    print("Acceleration [Y]: " + str(y/1000.0) + " g")
    print("Acceleration [Z]: " + str(z/1000.0) + " g")

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

Callback

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
33
34
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Accelerometer Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_accelerometer import BrickletAccelerometer

# Callback function for acceleration callback
def cb_acceleration(x, y, z):
    print("Acceleration [X]: " + str(x/1000.0) + " g")
    print("Acceleration [Y]: " + str(y/1000.0) + " g")
    print("Acceleration [Z]: " + str(z/1000.0) + " g")
    print("")

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    a = BrickletAccelerometer(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)
    # Note: The acceleration callback is only called every second
    #       if the acceleration has changed since the last call!
    a.set_acceleration_callback_period(1000)

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

Threshold

Download (example_threshold.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
33
34
35
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Accelerometer Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_accelerometer import BrickletAccelerometer

# Callback function for acceleration reached callback
def cb_acceleration_reached(x, y, z):
    print("Acceleration [X]: " + str(x/1000.0) + " g")
    print("Acceleration [Y]: " + str(y/1000.0) + " g")
    print("Acceleration [Z]: " + str(z/1000.0) + " g")
    print("")

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    a = BrickletAccelerometer(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    a.set_debounce_period(10000)

    # Register acceleration reached callback to function cb_acceleration_reached
    a.register_callback(a.CALLBACK_ACCELERATION_REACHED, cb_acceleration_reached)

    # Configure threshold for acceleration "greater than 2 g, 2 g, 2 g"
    a.set_acceleration_callback_threshold(">", 2*1000, 0, 2*1000, 0, 2*1000, 0)

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

API

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:

  • Error.TIMEOUT = -1
  • Error.NOT_ADDED = -6 (seit Python Bindings Version 2.0.0 nicht mehr verwendet)
  • Error.ALREADY_CONNECTED = -7
  • Error.NOT_CONNECTED = -8
  • Error.INVALID_PARAMETER = -9
  • Error.NOT_SUPPORTED = -10
  • Error.UNKNOWN_ERROR_CODE = -11
  • Error.STREAM_OUT_OF_SYNC = -12
  • Error.INVALID_UID = -13
  • Error.NON_ASCII_CHAR_IN_SECRET = -14

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletAccelerometer(uid, ipcon)
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • accelerometer – Typ: BrickletAccelerometer

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

accelerometer = BrickletAccelerometer("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletAccelerometer.get_acceleration()
Rückgabeobjekt:
  • 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 CALLBACK_ACCELERATION Callback zu nutzen und die Periode mit set_acceleration_callback_period() vorzugeben.

BrickletAccelerometer.get_temperature()
Rückgabe:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

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

BrickletAccelerometer.led_on()
Rückgabe:
  • None

Aktiviert die LED auf dem Bricklet.

BrickletAccelerometer.led_off()
Rückgabe:
  • None

Deaktiviert die LED auf dem Bricklet.

BrickletAccelerometer.is_led_on()
Rückgabe:
  • on – Typ: bool

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

Fortgeschrittene Funktionen

BrickletAccelerometer.set_configuration(data_rate, full_scale, filter_bandwidth)
Parameter:
  • data_rate – Typ: int, Wertebereich: Siehe Konstanten
  • full_scale – Typ: int, Wertebereich: Siehe Konstanten
  • filter_bandwidth – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • None

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 Konstanten sind für diese Funktion verfügbar:

Für data_rate:

  • BrickletAccelerometer.DATA_RATE_OFF = 0
  • BrickletAccelerometer.DATA_RATE_3HZ = 1
  • BrickletAccelerometer.DATA_RATE_6HZ = 2
  • BrickletAccelerometer.DATA_RATE_12HZ = 3
  • BrickletAccelerometer.DATA_RATE_25HZ = 4
  • BrickletAccelerometer.DATA_RATE_50HZ = 5
  • BrickletAccelerometer.DATA_RATE_100HZ = 6
  • BrickletAccelerometer.DATA_RATE_400HZ = 7
  • BrickletAccelerometer.DATA_RATE_800HZ = 8
  • BrickletAccelerometer.DATA_RATE_1600HZ = 9

Für full_scale:

  • BrickletAccelerometer.FULL_SCALE_2G = 0
  • BrickletAccelerometer.FULL_SCALE_4G = 1
  • BrickletAccelerometer.FULL_SCALE_6G = 2
  • BrickletAccelerometer.FULL_SCALE_8G = 3
  • BrickletAccelerometer.FULL_SCALE_16G = 4

Für filter_bandwidth:

  • BrickletAccelerometer.FILTER_BANDWIDTH_800HZ = 0
  • BrickletAccelerometer.FILTER_BANDWIDTH_400HZ = 1
  • BrickletAccelerometer.FILTER_BANDWIDTH_200HZ = 2
  • BrickletAccelerometer.FILTER_BANDWIDTH_50HZ = 3
BrickletAccelerometer.get_configuration()
Rückgabeobjekt:
  • data_rate – Typ: int, Wertebereich: Siehe Konstanten
  • full_scale – Typ: int, Wertebereich: Siehe Konstanten
  • filter_bandwidth – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Konfiguration zurück, wie von set_configuration() gesetzt.

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

Für data_rate:

  • BrickletAccelerometer.DATA_RATE_OFF = 0
  • BrickletAccelerometer.DATA_RATE_3HZ = 1
  • BrickletAccelerometer.DATA_RATE_6HZ = 2
  • BrickletAccelerometer.DATA_RATE_12HZ = 3
  • BrickletAccelerometer.DATA_RATE_25HZ = 4
  • BrickletAccelerometer.DATA_RATE_50HZ = 5
  • BrickletAccelerometer.DATA_RATE_100HZ = 6
  • BrickletAccelerometer.DATA_RATE_400HZ = 7
  • BrickletAccelerometer.DATA_RATE_800HZ = 8
  • BrickletAccelerometer.DATA_RATE_1600HZ = 9

Für full_scale:

  • BrickletAccelerometer.FULL_SCALE_2G = 0
  • BrickletAccelerometer.FULL_SCALE_4G = 1
  • BrickletAccelerometer.FULL_SCALE_6G = 2
  • BrickletAccelerometer.FULL_SCALE_8G = 3
  • BrickletAccelerometer.FULL_SCALE_16G = 4

Für filter_bandwidth:

  • BrickletAccelerometer.FILTER_BANDWIDTH_800HZ = 0
  • BrickletAccelerometer.FILTER_BANDWIDTH_400HZ = 1
  • BrickletAccelerometer.FILTER_BANDWIDTH_200HZ = 2
  • BrickletAccelerometer.FILTER_BANDWIDTH_50HZ = 3
BrickletAccelerometer.get_api_version()
Rückgabe:
  • api_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]

Gibt die Version der API Definition (Major, Minor, Revision) 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.

BrickletAccelerometer.get_response_expected(function_id)
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: bool

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:

  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2
  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4
  • BrickletAccelerometer.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletAccelerometer.FUNCTION_SET_CONFIGURATION = 9
  • BrickletAccelerometer.FUNCTION_LED_ON = 11
  • BrickletAccelerometer.FUNCTION_LED_OFF = 12
BrickletAccelerometer.set_response_expected(function_id, response_expected)
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • None

Ä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:

  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2
  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4
  • BrickletAccelerometer.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletAccelerometer.FUNCTION_SET_CONFIGURATION = 9
  • BrickletAccelerometer.FUNCTION_LED_ON = 11
  • BrickletAccelerometer.FUNCTION_LED_OFF = 12
BrickletAccelerometer.set_response_expected_all(response_expected)
Parameter:
  • response_expected – Typ: bool
Rückgabe:
  • None

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

BrickletAccelerometer.get_identity()
Rückgabeobjekt:
  • uid – Typ: str, Länge: bis zu 8
  • connected_uid – Typ: str, Länge: bis zu 8
  • position – Typ: chr
  • hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

BrickletAccelerometer.register_callback(callback_id, function)
Parameter:
  • callback_id – Typ: int
  • function – Typ: callable
Rückgabe:
  • None

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletAccelerometer.set_acceleration_callback_period(period)
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • None

Setzt die Periode mit welcher der CALLBACK_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletAccelerometer.get_acceleration_callback_period()
Rückgabe:
  • 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.

BrickletAccelerometer.set_acceleration_callback_threshold(option, min_x, max_x, min_y, max_y, min_z, max_z)
Parameter:
  • option – Typ: chr, Wertebereich: Siehe Konstanten, 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]
Rückgabe:
  • None

Setzt den Schwellwert für den CALLBACK_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 Konstanten sind für diese Funktion verfügbar:

Für option:

  • BrickletAccelerometer.THRESHOLD_OPTION_OFF = "x"
  • BrickletAccelerometer.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletAccelerometer.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletAccelerometer.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletAccelerometer.THRESHOLD_OPTION_GREATER = ">"
BrickletAccelerometer.get_acceleration_callback_threshold()
Rückgabeobjekt:
  • option – Typ: chr, Wertebereich: Siehe Konstanten, 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 Konstanten sind für diese Funktion verfügbar:

Für option:

  • BrickletAccelerometer.THRESHOLD_OPTION_OFF = "x"
  • BrickletAccelerometer.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletAccelerometer.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletAccelerometer.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletAccelerometer.THRESHOLD_OPTION_GREATER = ">"
BrickletAccelerometer.set_debounce_period(debounce)
Parameter:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • None

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

BrickletAccelerometer.get_debounce_period()
Rückgabe:
  • 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. 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.register_callback(BrickletAccelerometer.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.

BrickletAccelerometer.CALLBACK_ACCELERATION
Callback-Parameter:
  • 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 CALLBACK_ACCELERATION Callback wird nur ausgelöst, wenn sich die Beschleunigung seit der letzten Auslösung geändert hat.

BrickletAccelerometer.CALLBACK_ACCELERATION_REACHED
Callback-Parameter:
  • 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.

Konstanten

BrickletAccelerometer.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Accelerometer Bricklet 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.

BrickletAccelerometer.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet dar.