TCP/IP - Rotary Encoder Bricklet¶

Grundfunktionen¶

BrickletRotaryEncoder.get_count¶

Funktions-ID:	1
Anfrage:	reset – Typ: bool
Antwort:	count – Typ: int32, Wertebereich: [-231 bis 231 - 1]

Gibt den aktuellen Zählerwert des Encoders zurück. Wenn reset auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurück gesetzt.

Der Encoder hat 24 Schritte pro Umdrehung.

Wenn der Encoder nach links gedreht wird wird der Zählerwert dekrementiert, d.h. negative Zählerwerte sind möglich.

BrickletRotaryEncoder.is_pressed¶

Funktions-ID:	10
Anfrage:	keine Nutzdaten
Antwort:	pressed – Typ: bool

Gibt true zurück wenn der Taster gedrückt ist und sonst false.

Es wird empfohlen die CALLBACK_PRESSED und CALLBACK_RELEASED Callbacks zu nutzen, um den Taster programmatisch zu behandeln.

Fortgeschrittene Funktionen¶

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

BrickletRotaryEncoder.set_count_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_COUNT Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletRotaryEncoder.get_count_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_count_callback_period gesetzt.

BrickletRotaryEncoder.set_count_callback_threshold¶

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

Setzt den Schwellwert für den CALLBACK_COUNT_REACHED Callback.

Die folgenden Optionen sind möglich:

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

BrickletRotaryEncoder.get_count_callback_threshold¶

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

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

BrickletRotaryEncoder.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 der Schwellwert-Callback

• CALLBACK_COUNT_REACHED

ausgelöst wird, wenn der Schwellwert

• set_count_callback_threshold

weiterhin erreicht bleibt.

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

BrickletRotaryEncoder.CALLBACK_COUNT¶

Funktions-ID:	8
Antwort:	count – Typ: int32, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_count_callback_period, ausgelöst. Der Rückgabewert ist der Zählerwert des Encoders.

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

BrickletRotaryEncoder.CALLBACK_COUNT_REACHED¶

Funktions-ID:	9
Antwort:	count – Typ: int32, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_count_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist der Zählerwert des Encoders.

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

BrickletRotaryEncoder.CALLBACK_PRESSED¶

Funktions-ID:	11
Antwort:	keine Nutzdaten

Dieser Callback wird ausgelöst, wenn der Taster gedrückt wird.

BrickletRotaryEncoder.CALLBACK_RELEASED¶

Funktions-ID:	12
Antwort:	keine Nutzdaten

Dieser Callback wird ausgelöst, wenn der Taster losgelassen wird.