Modbus - Distance IR Bricklet 2.0

Dies ist die Beschreibung des Modbus Protokolls für das Distance IR Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Distance IR Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletDistanceIRV2.get_distance
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • distance – Typ: uint16, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1]

Gibt die gemessene Entfernung des Sensors zurück. Die möglichen Entfernungsbereiche sind 40 bis 300, 100 bis 800 und 200 bis 1500, in Abhängigkeit vom gewählten IR Sensor.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_DISTANCE Callback verwendet werden. Der Callback wird mit der Funktion set_distance_callback_configuration konfiguriert.

BrickletDistanceIRV2.get_analog_value
Funktions-ID:
  • 5
Anfrage:
  • keine Nutzdaten
Antwort:
  • analog_value – Typ: uint32, Wertebereich: [0 bis 2097151]

Gibt den Analogwert des Analog/Digital-Wandler zurück.

Dieser Wert ist ein unverarbeiteter Rohwert. Wir haben sichergestellt, dass die Integrationszeit des ADCs kleiner ist als das Messintervall des Sensors (10ms vs 16,5ms). Dadurch ist sichergestellt das keine Informationen verloren gehen können.

Der Analogwert kann genutzt werden wenn eine eigene Kalibrierung oder Lookup-Tabelle benötigt wird.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_ANALOG_VALUE Callback verwendet werden. Der Callback wird mit der Funktion set_analog_value_callback_configuration konfiguriert.

BrickletDistanceIRV2.set_moving_average_configuration
Funktions-ID:
  • 9
Anfrage:
  • moving_average_length – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 25
Antwort:
  • keine Antwort

Setzt die Länge eines gleitenden Mittelwerts für die Distanz.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Einer neue Wert wird alle ~10ms gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von ca. 10s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

BrickletDistanceIRV2.get_moving_average_configuration
Funktions-ID:
  • 10
Anfrage:
  • keine Nutzdaten
Antwort:
  • moving_average_length – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 25

Gibt die Moving Average-Konfiguration zurück, wie von set_moving_average_configuration gesetzt.

BrickletDistanceIRV2.set_distance_led_config
Funktions-ID:
  • 11
Anfrage:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:
  • keine Antwort

Konfiguriert die Distanz-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED die Distanz anzuzeigen (heller = Objekt näher).

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

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Distance
BrickletDistanceIRV2.get_distance_led_config
Funktions-ID:
  • 12
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von set_distance_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 Distance
BrickletDistanceIRV2.set_sensor_type
Funktions-ID:
  • 13
Anfrage:
  • sensor – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • keine Antwort

Setzt den Sensor-Typ.

Das Bricklet kommt vorkonfiguriert mit dem korrektem Sensor und der Sensor-Typ wird im Flash gespeichert (d.h. das Bricklet behält die Einstellung auch wenn es vom Strom getrennt wird).

Die Einstellung kann im Brick Viewer vorgenommen werden. Diese Funktion sollte in einem externen Programm also nicht ausgeführt werden müssen.

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

Für sensor:

  • 0 = 2Y0A41
  • 1 = 2Y0A21
  • 2 = 2Y0A02
BrickletDistanceIRV2.get_sensor_type
Funktions-ID:
  • 14
Anfrage:
  • keine Nutzdaten
Antwort:
  • sensor – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt den Sensor-Typ zurück, wie von set_sensor_type gesetzt.

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

Für sensor:

  • 0 = 2Y0A41
  • 1 = 2Y0A21
  • 2 = 2Y0A02

Fortgeschrittene Funktionen

BrickletDistanceIRV2.get_spitfp_error_count
Funktions-ID:
  • 234
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: uint32, Wertebereich: [0 bis 232 - 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.

BrickletDistanceIRV2.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
BrickletDistanceIRV2.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
BrickletDistanceIRV2.set_write_firmware_pointer
Funktions-ID:
  • 237
Anfrage:
  • pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 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.

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

BrickletDistanceIRV2.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
BrickletDistanceIRV2.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
BrickletDistanceIRV2.get_chip_temperature
Funktions-ID:
  • 242
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 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.

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

BrickletDistanceIRV2.write_uid
Funktions-ID:
  • 248
Anfrage:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 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.

BrickletDistanceIRV2.read_uid
Funktions-ID:
  • 249
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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

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

BrickletDistanceIRV2.set_distance_callback_configuration
Funktions-ID:
  • 2
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der CALLBACK_DISTANCE 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.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_DISTANCE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletDistanceIRV2.get_distance_callback_configuration
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletDistanceIRV2.set_analog_value_callback_configuration
Funktions-ID:
  • 6
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint32, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: uint32, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der CALLBACK_ANALOG_VALUE 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.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_ANALOG_VALUE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletDistanceIRV2.get_analog_value_callback_configuration
Funktions-ID:
  • 7
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint32, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: uint32, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater

Callbacks

BrickletDistanceIRV2.CALLBACK_DISTANCE
Funktions-ID:
  • 4
Antwort:
  • distance – Typ: uint16, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1]

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

Der Rückgabewert ist der gleiche wie get_distance.

BrickletDistanceIRV2.CALLBACK_ANALOG_VALUE
Funktions-ID:
  • 8
Antwort:
  • analog_value – Typ: uint32, Wertebereich: [0 bis 2097151]

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

Der Rückgabewert ist der gleiche wie get_analog_value.