MQTT - Accelerometer Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.txt)

1
2
3
4
5
6
# Change XYZ to the UID of your Accelerometer Bricklet

setup:
    # Get current acceleration
    subscribe to tinkerforge/response/accelerometer_bricklet/XYZ/get_acceleration
    publish '' to tinkerforge/request/accelerometer_bricklet/XYZ/get_acceleration

Callback

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your Accelerometer Bricklet

setup:
    # Handle incoming acceleration callbacks
    subscribe to tinkerforge/callback/accelerometer_bricklet/XYZ/acceleration
    publish '{"register": true}' to tinkerforge/register/accelerometer_bricklet/XYZ/acceleration # Register acceleration callback
    
    # 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!
    publish '{"period": 1000}' to tinkerforge/request/accelerometer_bricklet/XYZ/set_acceleration_callback_period

Threshold

Download (example-threshold.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Change XYZ to the UID of your Accelerometer Bricklet

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/accelerometer_bricklet/XYZ/set_debounce_period
    
    # Handle incoming acceleration reached callbacks
    subscribe to tinkerforge/callback/accelerometer_bricklet/XYZ/acceleration_reached
    publish '{"register": true}' to tinkerforge/register/accelerometer_bricklet/XYZ/acceleration_reached # Register acceleration_reached callback
    
    # Configure threshold for acceleration "greater than 2 g, 2 g, 2 g"
    publish '{"option": "greater", "min_x": 2000, "max_x": 0, "min_y": 2000, "max_y": 0, "min_z": 2000, "max_z": 0}' to tinkerforge/request/accelerometer_bricklet/XYZ/set_acceleration_callback_threshold

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/accelerometer_bricklet/<UID>/get_acceleration
Anfrage:
  • keine Nutzdaten
Antwort:
  • x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
  • y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
  • z – Typ: int, 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 request/accelerometer_bricklet/<UID>/set_configuration konfiguriert.

Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen den register/accelerometer_bricklet/<UID>/acceleration Callback zu nutzen und die Periode mit request/accelerometer_bricklet/<UID>/set_acceleration_callback_period vorzugeben.

request/accelerometer_bricklet/<UID>/get_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-103 bis 152]

Gibt die Temperatur des Beschleunigungssensors zurück.

request/accelerometer_bricklet/<UID>/led_on
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert die LED auf dem Bricklet.

request/accelerometer_bricklet/<UID>/led_off
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert die LED auf dem Bricklet.

request/accelerometer_bricklet/<UID>/is_led_on
Anfrage:
  • keine Nutzdaten
Antwort:
  • on – Typ: bool, Standardwert: false

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

Fortgeschrittene Funktionen

request/accelerometer_bricklet/<UID>/set_configuration
Anfrage:
  • data_rate – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 6
  • full_scale – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1
  • filter_bandwidth – Typ: int, Wertebereich: Siehe Symbole, 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 Symbole sind für diese Funktion verfügbar:

Für data_rate:

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

Für full_scale:

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

Für filter_bandwidth:

  • "800hz" = 0
  • "400hz" = 1
  • "200hz" = 2
  • "50hz" = 3
request/accelerometer_bricklet/<UID>/get_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • data_rate – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 6
  • full_scale – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1
  • filter_bandwidth – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 2

Gibt die Konfiguration zurück, wie von request/accelerometer_bricklet/<UID>/set_configuration gesetzt.

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

Für data_rate:

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

Für full_scale:

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

Für filter_bandwidth:

  • "800hz" = 0
  • "400hz" = 1
  • "200hz" = 2
  • "50hz" = 3
request/accelerometer_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Accelerometer.

Konfigurationsfunktionen für Callbacks

request/accelerometer_bricklet/<UID>/set_acceleration_callback_period
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der register/accelerometer_bricklet/<UID>/acceleration Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/accelerometer_bricklet/<UID>/acceleration Callback wird nur ausgelöst, wenn sich die Acceleration seit der letzten Auslösung geändert hat.

request/accelerometer_bricklet/<UID>/get_acceleration_callback_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/accelerometer_bricklet/<UID>/set_acceleration_callback_period gesetzt.

request/accelerometer_bricklet/<UID>/set_acceleration_callback_threshold
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min_x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • min_y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • min_z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den register/accelerometer_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/accelerometer_bricklet/<UID>/get_acceleration_callback_threshold
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min_x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • min_y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • min_z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max_z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/accelerometer_bricklet/<UID>/set_acceleration_callback_threshold gesetzt.

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/accelerometer_bricklet/<UID>/set_debounce_period
Anfrage:
  • debounce – Typ: int, 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.

request/accelerometer_bricklet/<UID>/get_debounce_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von request/accelerometer_bricklet/<UID>/set_debounce_period gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

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.

register/accelerometer_bricklet/<UID>/acceleration
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
  • y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
  • z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/accelerometer_bricklet/<UID>/acceleration[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/accelerometer_bricklet/<UID>/acceleration[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/accelerometer_bricklet/<UID>/set_acceleration_callback_period, ausgelöst. Die Payload-Member des Callbacks sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich wird mit request/accelerometer_bricklet/<UID>/set_configuration konfiguriert.

Der register/accelerometer_bricklet/<UID>/acceleration Callback wird nur ausgelöst, wenn sich die Beschleunigung seit der letzten Auslösung geändert hat.

register/accelerometer_bricklet/<UID>/acceleration_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • x – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
  • y – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?
  • z – Typ: int, Einheit: 1/1000 gₙ, Wertebereich: ?

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/accelerometer_bricklet/<UID>/acceleration_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/accelerometer_bricklet/<UID>/acceleration_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/accelerometer_bricklet/<UID>/set_acceleration_callback_threshold gesetzt, erreicht wird. Die Payload-Member des Callbacks sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich wird mit request/accelerometer_bricklet/<UID>/set_configuration konfiguriert.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/accelerometer_bricklet/<UID>/set_debounce_period gesetzt, ausgelöst.