Spezifikationen / TCP/IP Protokoll / API / Bricks und Bricklets / Bricklets / Line Bricklet

TCP/IP - Line Bricklet¶

Dies ist die Beschreibung des TCP/IP Protokolls für das Line Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Line Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API¶

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletLine.get_reflectivity¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	reflectivity – Typ: uint16, Wertebereich: [0 bis 2¹² - 1]

Gibt die aktuell gemessene Reflektivität zurück. Die Reflektivität ist ein Wert zwischen 0 (nicht reflektiv) und 4095 (sehr reflektiv).

Normalerweise hat schwarz eine geringe Reflektivität während weiß eine hohe Reflektivität hat.

Wenn die Reflektivität periodisch abgefragt werden soll, wird empfohlen den CALLBACK_REFLECTIVITY Callback zu nutzen und die Periode mit set_reflectivity_callback_period vorzugeben.

Fortgeschrittene Funktionen¶

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

BrickletLine.set_reflectivity_callback_period¶

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

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

Der CALLBACK_REFLECTIVITY Callback wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

BrickletLine.get_reflectivity_callback_period¶

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

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

BrickletLine.set_reflectivity_callback_threshold¶

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

Setzt den Schwellwert für den CALLBACK_REFLECTIVITY_REACHED Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Reflektivität außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Reflektivität innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Reflektivität kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Reflektivität 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

BrickletLine.get_reflectivity_callback_threshold¶

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

Gibt den Schwellwert zurück, wie von set_reflectivity_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

BrickletLine.set_debounce_period¶

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

Setzt die Periode mit welcher die Schwellwert Callback

CALLBACK_REFLECTIVITY_REACHED

ausgelöst wird, wenn der Schwellwert

set_reflectivity_callback_threshold

weiterhin erreicht bleibt.

BrickletLine.get_debounce_period¶

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

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

Callbacks¶

BrickletLine.CALLBACK_REFLECTIVITY¶

Funktions-ID:	8
Antwort:	reflectivity – Typ: uint16, Wertebereich: [0 bis 2¹² - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_reflectivity_callback_period, ausgelöst. Der Rückgabewert ist die Reflektivität des Sensors.

Der CALLBACK_REFLECTIVITY Callback wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

BrickletLine.CALLBACK_REFLECTIVITY_REACHED¶

Funktions-ID:	9
Antwort:	reflectivity – Typ: uint16, Wertebereich: [0 bis 2¹² - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_reflectivity_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die Reflektivität des Sensors.

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