Spezifikationen / TCP/IP Protokoll / API / Bricks und Bricklets / Bricklets / Hall Effect Bricklet

TCP/IP - Hall Effect Bricklet¶

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

API¶

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

Grundfunktionen¶

BrickletHallEffect.get_value¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	value – Typ: bool

Gibt true zurück wenn ein Magnetfeld mit 3,5 Millitesla oder größer detektiert wird.

BrickletHallEffect.get_edge_count¶

Funktions-ID:	2
Anfrage:	reset_counter – Typ: bool
Antwort:	count – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

Gibt den aktuellen Wert des Flankenzählers zurück. Die zu zählenden Flanken (steigend, fallend, beide) können mit set_edge_count_config konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Fortgeschrittene Funktionen¶

BrickletHallEffect.set_edge_count_config¶

Funktions-ID:	3
Anfrage:	edge_type – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 debounce – Typ: uint8, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100
Antwort:	keine Antwort

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

0 = steigend
1 = fallend
2 = beide

Wird ein Magnet in die Nähe des Bricklets gebracht (>3,5 Millitesla) erzeugt dies ein low-Signal (fallende Flanke), wenn ein Magnet vom Bricklet entfernt (<2,5 Millitesla) wird entsteht ein high-Signal (steigende Flanke).

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

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

Für edge_type:

0 = Rising
1 = Falling
2 = Both

BrickletHallEffect.get_edge_count_config¶

Funktions-ID:	4
Anfrage:	keine Nutzdaten
Antwort:	edge_type – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 debounce – Typ: uint8, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit zurück, wie von set_edge_count_config gesetzt.

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

Für edge_type:

0 = Rising
1 = Falling
2 = Both

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

BrickletHallEffect.set_edge_interrupt¶

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

Setzt die Anzahl der zu zählenden Flanken bis ein Interrupt aufgerufen wird.

Wenn edges auf n gesetzt ist, wird der Interrupt nach jeder n-ten detektierten Flanke aufgerufen.

Wenn edges auf 0 gesetzt ist, wird der Interrupt deaktiviert.

BrickletHallEffect.get_edge_interrupt¶

Funktions-ID:	6
Anfrage:	keine Nutzdaten
Antwort:	edges – Typ: uint32, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt edges zurück, wie von set_edge_interrupt gesetzt.

BrickletHallEffect.set_edge_count_callback_period¶

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

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

Der CALLBACK_EDGE_COUNT Callback wird nur ausgelöst, wenn sich die Flankenzählung seit der letzten Auslösung geändert hat.

BrickletHallEffect.get_edge_count_callback_period¶

Funktions-ID:	8
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_edge_count_callback_period gesetzt.

Callbacks¶

BrickletHallEffect.CALLBACK_EDGE_COUNT¶

Funktions-ID:	10
Antwort:	count – Typ: uint32, Wertebereich: [0 bis 2³² - 1] value – Typ: bool

Dieser Callback wird mit der Periode, wie gesetzt mit set_edge_count_callback_period, ausgelöst. Die Rückgabewert sind der aktuelle Zählerstand und der aktuelle Wert (siehe get_value and get_edge_count).

Der CALLBACK_EDGE_COUNT Callback wird nur ausgelöst, wenn sich mindestens einer der beiden Werte seit der letzten Auslösung geändert hat.