Modbus - Accelerometer Bricklet

Dies ist die Beschreibung des Modbus 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 Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletAccelerometer.get_acceleration
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • x -- int16
  • y -- int16
  • z -- int16

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
Funktions ID:

8

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Temperatur des Beschleunigungssensors in °C 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 -- bool

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

Fortgeschrittene Funktionen

BrickletAccelerometer.set_configuration
Funktions ID:

9

Anfrage:
  • data_rate -- uint8
  • full_scale -- uint8
  • filter_bandwidth -- uint8
Antwort:

keine Antwort

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

  • Datenrate zwischen 0Hz und 1600Hz.
  • Wertebereich von -2G bis +2G bis zu -16G bis +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 bis +4G Wertebereich und 200Hz Filterbandbreite.

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

  • 0: off, für data_rate
  • 1: 3hz, für data_rate
  • 2: 6hz, für data_rate
  • 3: 12hz, für data_rate
  • 4: 25hz, für data_rate
  • 5: 50hz, für data_rate
  • 6: 100hz, für data_rate
  • 7: 400hz, für data_rate
  • 8: 800hz, für data_rate
  • 9: 1600hz, für data_rate
  • 0: 2g, für full_scale
  • 1: 4g, für full_scale
  • 2: 6g, für full_scale
  • 3: 8g, für full_scale
  • 4: 16g, für full_scale
  • 0: 800hz, für filter_bandwidth
  • 1: 400hz, für filter_bandwidth
  • 2: 200hz, für filter_bandwidth
  • 3: 50hz, für filter_bandwidth
BrickletAccelerometer.get_configuration
Funktions ID:

10

Anfrage:

keine Nutzdaten

Antwort:
  • data_rate -- uint8
  • full_scale -- uint8
  • filter_bandwidth -- uint8

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

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

  • 0: off, für data_rate
  • 1: 3hz, für data_rate
  • 2: 6hz, für data_rate
  • 3: 12hz, für data_rate
  • 4: 25hz, für data_rate
  • 5: 50hz, für data_rate
  • 6: 100hz, für data_rate
  • 7: 400hz, für data_rate
  • 8: 800hz, für data_rate
  • 9: 1600hz, für data_rate
  • 0: 2g, für full_scale
  • 1: 4g, für full_scale
  • 2: 6g, für full_scale
  • 3: 8g, für full_scale
  • 4: 16g, für full_scale
  • 0: 800hz, für filter_bandwidth
  • 1: 400hz, für filter_bandwidth
  • 2: 200hz, für filter_bandwidth
  • 3: 50hz, für filter_bandwidth
BrickletAccelerometer.get_identity
Funktions ID:

255

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

BrickletAccelerometer.set_acceleration_callback_period
Funktions ID:

2

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms 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.

Der Standardwert ist 0.

BrickletAccelerometer.get_acceleration_callback_period
Funktions ID:

3

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

Gibt die Periode zurück, wie von set_acceleration_callback_period gesetzt.

BrickletAccelerometer.set_acceleration_callback_threshold
Funktions ID:

4

Anfrage:
  • option -- char
  • min_x -- int16
  • max_x -- int16
  • min_y -- int16
  • max_y -- int16
  • min_z -- int16
  • max_z -- int16
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)

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

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletAccelerometer.get_acceleration_callback_threshold
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • option -- char
  • min_x -- int16
  • max_x -- int16
  • min_y -- int16
  • max_y -- int16
  • min_z -- int16
  • max_z -- int16

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

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletAccelerometer.set_debounce_period
Funktions ID:

6

Anfrage:
  • debounce -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

BrickletAccelerometer.get_debounce_period
Funktions ID:

7

Anfrage:

keine Nutzdaten

Antwort:
  • debounce -- uint32

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

Callbacks

BrickletAccelerometer.CALLBACK_ACCELERATION
Funktions ID:

14

Antwort:
  • x -- int16
  • y -- int16
  • z -- int16

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 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 -- int16
  • y -- int16
  • z -- int16

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.

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