Modbus - Distance US Bricklet¶

Grundfunktionen¶

BrickletDistanceUS.get_distance_value¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	distance – Typ: uint16, Wertebereich: [0 bis 212 - 1]

Gibt den aktuellen Entfernungswert zurück. Ein kleiner Wert entspricht einer kleinen Entfernung, ein großer Wert entspricht einer großen Entfernung. Das Verhältnis zwischen gemessenem Entfernungswert und wirklicher Entfernung wird durch die 5V Versorgungsspannung beeinflusst (Abweichungen der Versorgungsspannung führen zu Abweichungen in den Entfernungswerten) und ist nicht-linear (Auflösung ist größer im Nahbereich).

Wenn der Entfernungswert periodisch abgefragt werden soll, wird empfohlen den CALLBACK_DISTANCE Callback zu nutzen und die Periode mit set_distance_callback_period vorzugeben.

Fortgeschrittene Funktionen¶

BrickletDistanceUS.set_moving_average¶

Funktions-ID:	10
Anfrage:	average – Typ: uint8, Wertebereich: [0 bis 100], Standardwert: 20
Antwort:	keine Antwort

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

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

BrickletDistanceUS.get_moving_average¶

Funktions-ID:	11
Anfrage:	keine Nutzdaten
Antwort:	average – Typ: uint8, Wertebereich: [0 bis 100], Standardwert: 20

Gibt die Länge des gleitenden Mittelwerts zurück, wie von set_moving_average gesetzt.

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

BrickletDistanceUS.set_distance_callback_period¶

Funktions-ID:	2
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der CALLBACK_DISTANCE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CALLBACK_DISTANCE Callback wird nur ausgelöst, wenn sich der Entfernungswert seit der letzten Auslösung geändert hat.

BrickletDistanceUS.get_distance_callback_period¶

Funktions-ID:	3
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletDistanceUS.set_distance_callback_threshold¶

Funktions-ID:	4
Anfrage:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: uint16, Wertebereich: [0 bis 212 - 1] max – Typ: uint16, Wertebereich: [0 bis 212 - 1]
Antwort:	keine Antwort

Setzt den Schwellwert für den CALLBACK_DISTANCE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn der Entfernungswert außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn der Entfernungswert innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn der Entfernungswert kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn der Entfernungswert größer als der min Wert ist (max wird ignoriert)

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

Für option:

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

BrickletDistanceUS.get_distance_callback_threshold¶

Funktions-ID:	5
Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: uint16, Wertebereich: [0 bis 212 - 1] max – Typ: uint16, Wertebereich: [0 bis 212 - 1]

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

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

Für option:

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

BrickletDistanceUS.set_debounce_period¶

Funktions-ID:	6
Anfrage:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Antwort:	keine Antwort

Setzt die Periode mit welcher die Schwellwert Callbacks

• CALLBACK_DISTANCE_REACHED,

ausgelöst werden, wenn die Schwellwerte

• set_distance_callback_threshold,

weiterhin erreicht bleiben.

BrickletDistanceUS.get_debounce_period¶

Funktions-ID:	7
Anfrage:	keine Nutzdaten
Antwort:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

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

Callbacks¶

BrickletDistanceUS.CALLBACK_DISTANCE¶

Funktions-ID:	8
Antwort:	distance – Typ: uint16, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_distance_callback_period, ausgelöst. Der Rückgabewert ist die Entfernungswert des Sensors.

Der CALLBACK_DISTANCE Callback wird nur ausgelöst, wenn sich der Entfernungswert seit der letzten Auslösung geändert hat.

BrickletDistanceUS.CALLBACK_DISTANCE_REACHED¶

Funktions-ID:	9
Antwort:	distance – Typ: uint16, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_distance_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist der Entfernungswert des Sensors.

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