Spezifikationen / Modbus Protokoll / API / Bricklets / Accelerometer Bricklet 2.0

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 – Typ: int32, Einheit: 1/10000 gₙ, Wertebereich: ? y – Typ: int32, Einheit: 1/10000 gₙ, Wertebereich: ? z – Typ: int32, Einheit: 1/10000 gₙ, Wertebereich: ?

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

BrickletAccelerometerV2.set_configuration¶

Funktions-ID:	2
Anfrage:	data_rate – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 7 full_scale – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
Antwort:	keine Antwort

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

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

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 = 0,781Hz
1 = 1,563Hz
2 = 3,125Hz
3 = 6,2512Hz
4 = 12,5Hz
5 = 25Hz
6 = 50Hz
7 = 100Hz
8 = 200Hz
9 = 400Hz
10 = 800Hz
11 = 1600Hz
12 = 3200Hz
13 = 6400Hz
14 = 12800Hz
15 = 25600Hz

Für full_scale:

0 = 2g
1 = 4g
2 = 8g

BrickletAccelerometerV2.get_configuration¶

Funktions-ID:	3
Anfrage:	keine Nutzdaten
Antwort:	data_rate – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 7 full_scale – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

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 = 0,781Hz
1 = 1,563Hz
2 = 3,125Hz
3 = 6,2512Hz
4 = 12,5Hz
5 = 25Hz
6 = 50Hz
7 = 100Hz
8 = 200Hz
9 = 400Hz
10 = 800Hz
11 = 1600Hz
12 = 3200Hz
13 = 6400Hz
14 = 12800Hz
15 = 25600Hz

Für full_scale:

0 = 2g
1 = 4g
2 = 8g

BrickletAccelerometerV2.set_info_led_config¶

Funktions-ID:	6
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
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 Elemente dieser Funktion definiert:

Für config:

0 = Off
1 = On
2 = Show Heartbeat

BrickletAccelerometerV2.get_info_led_config¶

Funktions-ID:	7
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

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

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

Für config:

0 = Off
1 = On
2 = Show Heartbeat

Fortgeschrittene Funktionen¶

BrickletAccelerometerV2.set_filter_configuration¶

Funktions-ID:	13
Anfrage:	iir_bypass – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 low_pass_filter – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
Antwort:	keine Antwort

Konfiguriert den IIR Bypass Filter Modus und die Grenzfrequenz des Tiefpassfilters.

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

Neu in Version 2.0.2 (Plugin).

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

Für iir_bypass:

0 = Applied
1 = Bypassed

Für low_pass_filter:

0 = Ninth
1 = Half

BrickletAccelerometerV2.get_filter_configuration¶

Funktions-ID:	14
Anfrage:	keine Nutzdaten
Antwort:	iir_bypass – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 low_pass_filter – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

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 Elemente dieser Funktion definiert:

Für iir_bypass:

0 = Applied
1 = Bypassed

Für low_pass_filter:

0 = Ninth
1 = Half

BrickletAccelerometerV2.get_spitfp_error_count¶

Funktions-ID:	234
Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

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_status_led_config¶

Funktions-ID:	239
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
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 Elemente dieser Funktion definiert:

Für config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Status

BrickletAccelerometerV2.get_status_led_config¶

Funktions-ID:	240
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

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

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

Für config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Status

BrickletAccelerometerV2.get_chip_temperature¶

Funktions-ID:	242
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Temperatur, 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.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', '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 2¹⁶ - 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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden.

Konfigurationsfunktionen für Callbacks¶

BrickletAccelerometerV2.set_acceleration_callback_configuration¶

Funktions-ID:	4
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Antwort:	keine Antwort

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

BrickletAccelerometerV2.get_acceleration_callback_configuration¶

Funktions-ID:	5
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

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

BrickletAccelerometerV2.set_continuous_acceleration_configuration¶

Funktions-ID:	9
Anfrage:	enable_x – Typ: bool, Standardwert: false enable_y – Typ: bool, Standardwert: false enable_z – Typ: bool, Standardwert: false resolution – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
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 Elemente dieser Funktion definiert:

Für resolution:

0 = 8bit
1 = 16bit

BrickletAccelerometerV2.get_continuous_acceleration_configuration¶

Funktions-ID:	10
Anfrage:	keine Nutzdaten
Antwort:	enable_x – Typ: bool, Standardwert: false enable_y – Typ: bool, Standardwert: false enable_z – Typ: bool, Standardwert: false resolution – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

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

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

Für resolution:

0 = 8bit
1 = 16bit

Callbacks¶

BrickletAccelerometerV2.CALLBACK_ACCELERATION¶

Funktions-ID:	8
Antwort:	x – Typ: int32, Einheit: 1/10000 gₙ, Wertebereich: ? y – Typ: int32, Einheit: 1/10000 gₙ, Wertebereich: ? z – Typ: int32, Einheit: 1/10000 gₙ, Wertebereich: ?

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

Die Rückgabewerte sind die gleichen wie get_acceleration.

BrickletAccelerometerV2.CALLBACK_CONTINUOUS_ACCELERATION_16_BIT¶

Funktions-ID:	11
Antwort:	acceleration – Typ: int16[30], Einheit: ? gₙ, Wertebereich: ?

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.

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 wiederholt
x, z aktiviert: "x, z, ..." 15x wiederholt
y aktiviert: "y, ..." 30x wiederholt

BrickletAccelerometerV2.CALLBACK_CONTINUOUS_ACCELERATION_8_BIT¶

Funktions-ID:	12
Antwort:	acceleration – Typ: int8[60], Einheit: ? gₙ, Wertebereich: ?

Gibt 60 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.

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 wiederholt
x, z aktiviert: "x, z, ..." 30x wiederholt
y aktiviert: "y, ..." 60x wiederholt

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletAccelerometerV2.set_bootloader_mode¶

Funktions-ID:	235
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:	status – Typ: uint8, Wertebereich: Siehe Bedeutungen

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 Bootloader- 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 Elemente dieser Funktion definiert:

Für mode:

0 = Bootloader
1 = Firmware
2 = Bootloader Wait For Reboot
3 = Firmware Wait For Reboot
4 = Firmware Wait For Erase And Reboot

Für status:

0 = OK
1 = Invalid Mode
2 = No Change
3 = Entry Function Not Present
4 = Device Identifier Incorrect
5 = CRC Mismatch

BrickletAccelerometerV2.get_bootloader_mode¶

Funktions-ID:	236
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

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

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

Für mode:

0 = Bootloader
1 = Firmware
2 = Bootloader Wait For Reboot
3 = Firmware Wait For Reboot
4 = Firmware Wait For Erase And Reboot

BrickletAccelerometerV2.set_write_firmware_pointer¶

Funktions-ID:	237
Anfrage:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
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 – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:	status – Typ: uint8, Wertebereich: [0 bis 255]

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.write_uid¶

Funktions-ID:	248
Anfrage:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 1]
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 – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

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