TCP/IP - Accelerometer Bricklet

Dies ist die Beschreibung des TCP/IP Protokolls für das Accelerometer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletAccelerometer.get_acceleration
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ?
  • y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ?
  • z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ?

Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte haben die Einheit gₙ/1000 (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_period vorzugeben.

BrickletAccelerometer.get_temperature
Funktions-ID:
  • 8
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-103 bis 152]

Gibt die Temperatur des Beschleunigungssensors zurück.

BrickletAccelerometer.led_on
Funktions-ID:
  • 11
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert die LED auf dem Bricklet.

BrickletAccelerometer.led_off
Funktions-ID:
  • 12
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert die LED auf dem Bricklet.

BrickletAccelerometer.is_led_on
Funktions-ID:
  • 13
Anfrage:
  • keine Nutzdaten
Antwort:
  • on – Typ: bool, Standardwert: false

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

Fortgeschrittene Funktionen

BrickletAccelerometer.set_configuration
Funktions-ID:
  • 9
Anfrage:
  • data_rate – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 6
  • full_scale – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1
  • filter_bandwidth – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 2
Antwort:
  • keine Antwort

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 folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für data_rate:

  • 0 = Off
  • 1 = 3Hz
  • 2 = 6Hz
  • 3 = 12Hz
  • 4 = 25Hz
  • 5 = 50Hz
  • 6 = 100Hz
  • 7 = 400Hz
  • 8 = 800Hz
  • 9 = 1600Hz

Für full_scale:

  • 0 = 2g
  • 1 = 4g
  • 2 = 6g
  • 3 = 8g
  • 4 = 16g

Für filter_bandwidth:

  • 0 = 800Hz
  • 1 = 400Hz
  • 2 = 200Hz
  • 3 = 50Hz
BrickletAccelerometer.get_configuration
Funktions-ID:
  • 10
Anfrage:
  • keine Nutzdaten
Antwort:
  • data_rate – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 6
  • full_scale – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1
  • filter_bandwidth – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 2

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für data_rate:

  • 0 = Off
  • 1 = 3Hz
  • 2 = 6Hz
  • 3 = 12Hz
  • 4 = 25Hz
  • 5 = 50Hz
  • 6 = 100Hz
  • 7 = 400Hz
  • 8 = 800Hz
  • 9 = 1600Hz

Für full_scale:

  • 0 = 2g
  • 1 = 4g
  • 2 = 6g
  • 3 = 8g
  • 4 = 16g

Für filter_bandwidth:

  • 0 = 800Hz
  • 1 = 400Hz
  • 2 = 200Hz
  • 3 = 50Hz
BrickletAccelerometer.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, 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 '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. 

Konfigurationsfunktionen für Callbacks

BrickletAccelerometer.set_acceleration_callback_period
Funktions-ID:
  • 2
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, 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
Funktions-ID:
  • 4
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min_x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • min_y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • min_z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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)

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletAccelerometer.get_acceleration_callback_threshold
Funktions-ID:
  • 5
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min_x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • min_y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • min_z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_acceleration_callback_threshold gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletAccelerometer.set_debounce_period
Funktions-ID:
  • 6
Anfrage:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Antwort:
  • keine Antwort

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

BrickletAccelerometer.get_debounce_period
Funktions-ID:
  • 7
Anfrage:
  • keine Nutzdaten
Antwort:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set_debounce_period gesetzt.

Callbacks

BrickletAccelerometer.CALLBACK_ACCELERATION
Funktions-ID:
  • 14
Antwort:
  • x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ?
  • y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ?
  • z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ?

Dieser Callback wird mit der Periode, wie gesetzt mit set_acceleration_callback_period, ausgelöst. Die Rückgabewerte sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich wird mit set_configuration konfiguriert.

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

BrickletAccelerometer.CALLBACK_ACCELERATION_REACHED
Funktions-ID:
  • 15
Antwort:
  • x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ?
  • y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ?
  • z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ?

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_acceleration_callback_threshold gesetzt, erreicht wird. Die Rückgabewerte sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich wird mit set_configuration konfiguriert.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set_debounce_period gesetzt, ausgelöst.