Spezifikationen / Modbus Protokoll / API / Bricklets / Joystick Bricklet

Modbus - Joystick Bricklet¶

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

API¶

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletJoystick.get_position¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	x – Typ: int16, Wertebereich: [-100 bis 100] y – Typ: int16, Wertebereich: [-100 bis 100]

Gibt die Position des Joystick zurück. Die Mittelposition des Joysticks ist x=0, y=0. Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe calibrate).

Wenn die Position periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_POSITION Callback zu nutzen und die Periode mit set_position_callback_period vorzugeben.

BrickletJoystick.is_pressed¶

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

Gibt true zurück wenn die Taste gedrückt ist und sonst false.

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

Fortgeschrittene Funktionen¶

BrickletJoystick.get_analog_value¶

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

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von get_position zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während get_analog_value unverarbeitete Analogwerte zurück gibt. Der einzige Grund get_analog_value zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn die Analogwerte periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit set_analog_value_callback_period vorzugeben.

BrickletJoystick.calibrate¶

Funktions-ID:	4
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet nicht x=0 und y=0 in der Mittelposition zurückgeben, kann diese Funktion aufgerufen werden wenn der Joystick sich unbewegt in der Mittelposition befindet.

Die resultierende Kalibrierung wird in den EEPROM des Joystick Bricklet gespeichert, somit ist die Kalibrierung nur einmalig notwendig.

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

BrickletJoystick.set_position_callback_period¶

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

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

The CALLBACK_POSITION Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

BrickletJoystick.get_position_callback_period¶

Funktions-ID:	6
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_position_callback_period gesetzt.

BrickletJoystick.set_analog_value_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_ANALOG_VALUE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletJoystick.get_analog_value_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_analog_value_callback_period gesetzt.

BrickletJoystick.set_position_callback_threshold¶

Funktions-ID:	9
Anfrage:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min_x – Typ: int16, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max_x – Typ: int16, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 min_y – Typ: int16, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max_y – Typ: int16, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den CALLBACK_POSITION_REACHED Callback.

Die folgenden Optionen sind möglich:

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

BrickletJoystick.get_position_callback_threshold¶

Funktions-ID:	10
Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min_x – Typ: int16, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max_x – Typ: int16, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 min_y – Typ: int16, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 max_y – Typ: int16, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

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

BrickletJoystick.set_analog_value_callback_threshold¶

Funktions-ID:	11
Anfrage:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min_x – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_x – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 min_y – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_y – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den CALLBACK_ANALOG_VALUE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

BrickletJoystick.get_analog_value_callback_threshold¶

Funktions-ID:	12
Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min_x – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_x – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 min_y – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max_y – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

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

BrickletJoystick.set_debounce_period¶

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

Setzt die Periode mit welcher die Schwellwert Callbacks

CALLBACK_POSITION_REACHED,
CALLBACK_ANALOG_VALUE_REACHED

ausgelöst werden, wenn die Schwellwerte

set_position_callback_threshold,
set_analog_value_callback_threshold

weiterhin erreicht bleiben.

BrickletJoystick.get_debounce_period¶

Funktions-ID:	14
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¶

BrickletJoystick.CALLBACK_POSITION¶

Funktions-ID:	15
Antwort:	x – Typ: int16, Wertebereich: [-100 bis 100] y – Typ: int16, Wertebereich: [-100 bis 100]

Dieser Callback wird mit der Periode, wie gesetzt mit set_position_callback_period, ausgelöst. Der Rückgabewert ist die Position des Joysticks.

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

BrickletJoystick.CALLBACK_ANALOG_VALUE¶

Funktions-ID:	16
Antwort:	x – Typ: uint16, Wertebereich: [0 bis 2¹² - 1] y – Typ: uint16, Wertebereich: [0 bis 2¹² - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_analog_value_callback_period, ausgelöst. Der Rückgabewert sind die Analogwerte des Joysticks.

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

BrickletJoystick.CALLBACK_POSITION_REACHED¶

Funktions-ID:	17
Antwort:	x – Typ: int16, Wertebereich: [-100 bis 100] y – Typ: int16, Wertebereich: [-100 bis 100]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_position_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die Position des Joysticks.

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

BrickletJoystick.CALLBACK_ANALOG_VALUE_REACHED¶

Funktions-ID:	18
Antwort:	x – Typ: uint16, Wertebereich: [0 bis 2¹² - 1] y – Typ: uint16, Wertebereich: [0 bis 2¹² - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_analog_value_callback_threshold gesetzt, erreicht wird. Der Rückgabewert sind die Analogwerte des Joystick.

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

BrickletJoystick.CALLBACK_PRESSED¶

Funktions-ID:	19
Antwort:	keine Nutzdaten

Dieser Callback wird ausgelöst, wenn die Taste gedrückt wird.

BrickletJoystick.CALLBACK_RELEASED¶

Funktions-ID:	20
Antwort:	keine Nutzdaten

Dieser Callback wird ausgelöst, wenn die Taste losgelassen wird.