Modbus - Accelerometer Bricklet 2.0

Dies ist die Beschreibung des Modbus Protokolls 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.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletAccelerometerV2.get_acceleration
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • x -- int32
  • y -- int32
  • z -- int32

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

BrickletAccelerometerV2.set_configuration
Funktions ID:

2

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

keine Antwort

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

  • Datenrate zwischen 0,781Hz und 25600Hz.
  • Wertebereich von -2g bis +2g bis zu -8g bis +8g.

Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.

Die Standardwerte sind 100Hz Datenrate und -2g bis +2g Wertebereich.

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

  • 0: 0 781hz, für data_rate
  • 1: 1 563hz, für data_rate
  • 2: 3 125hz, für data_rate
  • 3: 6 2512hz, für data_rate
  • 4: 12 5hz, für data_rate
  • 5: 25hz, für data_rate
  • 6: 50hz, für data_rate
  • 7: 100hz, für data_rate
  • 8: 200hz, für data_rate
  • 9: 400hz, für data_rate
  • 10: 800hz, für data_rate
  • 11: 1600hz, für data_rate
  • 12: 3200hz, für data_rate
  • 13: 6400hz, für data_rate
  • 14: 12800hz, für data_rate
  • 15: 25600hz, für data_rate
  • 0: 2g, für full_scale
  • 1: 4g, für full_scale
  • 2: 8g, für full_scale
BrickletAccelerometerV2.get_configuration
Funktions ID:

3

Anfrage:

keine Nutzdaten

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

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

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

  • 0: 0 781hz, für data_rate
  • 1: 1 563hz, für data_rate
  • 2: 3 125hz, für data_rate
  • 3: 6 2512hz, für data_rate
  • 4: 12 5hz, für data_rate
  • 5: 25hz, für data_rate
  • 6: 50hz, für data_rate
  • 7: 100hz, für data_rate
  • 8: 200hz, für data_rate
  • 9: 400hz, für data_rate
  • 10: 800hz, für data_rate
  • 11: 1600hz, für data_rate
  • 12: 3200hz, für data_rate
  • 13: 6400hz, für data_rate
  • 14: 12800hz, für data_rate
  • 15: 25600hz, für data_rate
  • 0: 2g, für full_scale
  • 1: 4g, für full_scale
  • 2: 8g, für full_scale
BrickletAccelerometerV2.set_info_led_config
Funktions ID:

6

Anfrage:
  • config -- uint8
Antwort:

keine Antwort

Konfiguriert die Info-LED (als "Force" auf dem Bricklet gekennzeichnet). Die LED kann ausgeschaltet, eingeschaltet oder im Herzschlagmodus betrieben werden.

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

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
BrickletAccelerometerV2.get_info_led_config
Funktions ID:

7

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

Gibt die LED-Konfiguration zurück, wie von set_info_led_config gesetzt.

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

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
BrickletAccelerometerV2.set_continuous_acceleration_configuration
Funktions ID:

9

Anfrage:
  • enable_x -- bool
  • enable_y -- bool
  • enable_z -- bool
  • resolution -- uint8
Antwort:

keine Antwort

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

  • 16-Bit, Wertebereich 2G: Beschleunigung = Rohwert*625/1024
  • 16-Bit, Wertebereich 4G: Beschleunigung = Rohwert*1250/1024
  • 16-Bit, Wertebereich 8G: Beschleunigung = Rohwert*2500/1024

Bei einer Auflösung von 8-Bit werden nur die 8 höchstwertigen Bits übertragen, daher sehen die Formeln wie folgt aus:

  • 8-Bit, Wertebereich 2G: Beschleunigung = Rohwert*256*625/1024
  • 8-Bit, Wertebereich 4G: Beschleunigung = Rohwert*256*1250/1024
  • 8-Bit, Wertebereich 8G: Beschleunigung = Rohwert*256*2500/1024

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

  • 0: 8bit, für resolution
  • 1: 16bit, für resolution
BrickletAccelerometerV2.get_continuous_acceleration_configuration
Funktions ID:

10

Anfrage:

keine Nutzdaten

Antwort:
  • enable_x -- bool
  • enable_y -- bool
  • enable_z -- bool
  • resolution -- uint8

Gibt die Konfiguration für kontinuierliche Beschleunigungswerte zurück, wie mittels set_continuous_acceleration_configuration gesetzt.

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

  • 0: 8bit, für resolution
  • 1: 16bit, für resolution

Fortgeschrittene Funktionen

BrickletAccelerometerV2.set_filter_configuration
Funktions ID:

13

Anfrage:
  • iir_bypass -- uint8
  • low_pass_filter -- uint8
Antwort:

keine Antwort

Konfiguriert den IIR Bypass Filter Modus und die Low Pass Filter Roll Off Corner Frequenz.

Der Filter kann angewendet oder umgangen werden und die Frequenz kann die halbe ein ein Neuntel der Ausgabe-Datenrate sein.

Accelerometer filter

Standardmäßig wird der Filter angewendet und die Frequenz ist ein Neuntel der Ausgabe-Datenrate.

Neu in Version 2.0.2 (Plugin).

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

  • 0: applied, für iir_bypass
  • 1: bypassed, für iir_bypass
  • 0: ninth, für low_pass_filter
  • 1: half, für low_pass_filter
BrickletAccelerometerV2.get_filter_configuration
Funktions ID:

14

Anfrage:

keine Nutzdaten

Antwort:
  • iir_bypass -- uint8
  • low_pass_filter -- uint8

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

Neu in Version 2.0.2 (Plugin).

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

  • 0: applied, für iir_bypass
  • 1: bypassed, für iir_bypass
  • 0: ninth, für low_pass_filter
  • 1: half, für low_pass_filter
BrickletAccelerometerV2.get_spitfp_error_count
Funktions ID:

234

Anfrage:

keine Nutzdaten

Antwort:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

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

235

Anfrage:
  • mode -- uint8
Antwort:
  • status -- uint8

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

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
  • 0: ok, für status
  • 1: invalid mode, für status
  • 2: no change, für status
  • 3: entry function not present, für status
  • 4: device identifier incorrect, für status
  • 5: crc mismatch, für status
BrickletAccelerometerV2.get_bootloader_mode
Funktions ID:

236

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

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

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
BrickletAccelerometerV2.set_write_firmware_pointer
Funktions ID:

237

Anfrage:
  • pointer -- uint32
Antwort:

keine Antwort

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

238

Anfrage:
  • data -- uint8[64]
Antwort:
  • status -- uint8

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

239

Anfrage:
  • config -- uint8
Antwort:

keine Antwort

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

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletAccelerometerV2.get_status_led_config
Funktions ID:

240

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

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

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

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletAccelerometerV2.get_chip_temperature
Funktions ID:

242

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Temperatur in °C, 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
Funktions ID:243
Anfrage:keine Nutzdaten
Antwort:keine Antwort

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

248

Anfrage:
  • uid -- uint32
Antwort:

keine Antwort

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

249

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- uint32

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletAccelerometerV2.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

BrickletAccelerometerV2.set_acceleration_callback_configuration
Funktions ID:

4

Anfrage:
  • period -- uint32
  • value_has_to_change -- bool
Antwort:

keine Antwort

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

Der Standardwert ist (0, false).

BrickletAccelerometerV2.get_acceleration_callback_configuration
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32
  • value_has_to_change -- bool

Gibt die Callback-Konfiguration zurück, wie mittels set_acceleration_callback_configuration gesetzt.

Callbacks

BrickletAccelerometerV2.CALLBACK_ACCELERATION
Funktions ID:

8

Antwort:
  • x -- int32
  • y -- int32
  • z -- int32

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_acceleration_callback_configuration gesetzten Konfiguration

Die Rückgabewerte sind der gleiche wie get_acceleration.

BrickletAccelerometerV2.CALLBACK_CONTINUOUS_ACCELERATION_16_BIT
Funktions ID:

11

Antwort:
  • acceleration -- int16[30]

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

  • Wertebereich 2G: Beschleunigung = Rohwert*625/1024
  • Wertebereich 4G: Beschleunigung = Rohwert*1250/1024
  • Wertebereich 8G: Beschleunigung = Rohwert*2500/1024

Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:

  • x, y, z aktiviert: "x, y, z, ... 10x ..., x, y, z"
  • x, z aktiviert: "x, z, ... 15x ..., x, z"
  • y aktiviert: "y, ... 30x ..., y"
BrickletAccelerometerV2.CALLBACK_CONTINUOUS_ACCELERATION_8_BIT
Funktions ID:

12

Antwort:
  • acceleration -- int8[60]

Gibt 30 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):

  • Wertebereich 2G: Beschleunigung = Rohwert*256*625/1024
  • Wertebereich 4G: Beschleunigung = Rohwert*256*1250/1024
  • Wertebereich 8G: Beschleunigung = Rohwert*256*2500/1024

Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:

  • x, y, z aktiviert: "x, y, z, ... 20x ..., x, y, z"
  • x, z aktiviert: "x, z, ... 30x ..., x, z"
  • y aktiviert: "y, ... 60x ..., y"