MATLAB/Octave - Joystick Bricklet¶

Simple (MATLAB)¶

Download (matlab_example_simple.m)

 1function matlab_example_simple()
 2    import com.tinkerforge.IPConnection;
 3    import com.tinkerforge.BrickletJoystick;
 4
 5    HOST = 'localhost';
 6    PORT = 4223;
 7    UID = 'XYZ'; % Change XYZ to the UID of your Joystick Bricklet
 8
 9    ipcon = IPConnection(); % Create IP connection
10    j = handle(BrickletJoystick(UID, ipcon), 'CallbackProperties'); % Create device object
11
12    ipcon.connect(HOST, PORT); % Connect to brickd
13    % Don't use device before ipcon is connected
14
15    % Get current position
16    position = j.getPosition();
17
18    fprintf('Position [X]: %i\n', position.x);
19    fprintf('Position [Y]: %i\n', position.y);
20
21    input('Press key to exit\n', 's');
22    ipcon.disconnect();
23end

Callback (MATLAB)¶

Download (matlab_example_callback.m)

 1function matlab_example_callback()
 2    import com.tinkerforge.IPConnection;
 3    import com.tinkerforge.BrickletJoystick;
 4
 5    HOST = 'localhost';
 6    PORT = 4223;
 7    UID = 'XYZ'; % Change XYZ to the UID of your Joystick Bricklet
 8
 9    ipcon = IPConnection(); % Create IP connection
10    j = handle(BrickletJoystick(UID, ipcon), 'CallbackProperties'); % Create device object
11
12    ipcon.connect(HOST, PORT); % Connect to brickd
13    % Don't use device before ipcon is connected
14
15    % Register pressed callback to function cb_pressed
16    set(j, 'PressedCallback', @(h, e) cb_pressed(e));
17
18    % Register released callback to function cb_released
19    set(j, 'ReleasedCallback', @(h, e) cb_released(e));
20
21    input('Press key to exit\n', 's');
22    ipcon.disconnect();
23end
24
25% Callback function for pressed callback
26function cb_pressed(e)
27    fprintf('Pressed\n');
28end
29
30% Callback function for released callback
31function cb_released(e)
32    fprintf('Released\n');
33end

Find Borders (MATLAB)¶

Download (matlab_example_find_borders.m)

 1function matlab_example_find_borders()
 2    import com.tinkerforge.IPConnection;
 3    import com.tinkerforge.BrickletJoystick;
 4
 5    HOST = 'localhost';
 6    PORT = 4223;
 7    UID = 'XYZ'; % Change XYZ to the UID of your Joystick Bricklet
 8
 9    ipcon = IPConnection(); % Create IP connection
10    j = handle(BrickletJoystick(UID, ipcon), 'CallbackProperties'); % Create device object
11
12    ipcon.connect(HOST, PORT); % Connect to brickd
13    % Don't use device before ipcon is connected
14
15    % Get threshold callbacks with a debounce time of 0.2 seconds (200ms)
16    j.setDebouncePeriod(200);
17
18    % Register position reached callback to function cb_position_reached
19    set(j, 'PositionReachedCallback', @(h, e) cb_position_reached(e));
20
21    % Configure threshold for position "outside of -99, -99 to 99, 99"
22    j.setPositionCallbackThreshold('o', -99, 99, -99, 99);
23
24    input('Press key to exit\n', 's');
25    ipcon.disconnect();
26end
27
28% Callback function for position reached callback
29function cb_position_reached(e)
30    if e.y == 100
31        fprintf('Top\n');
32    elseif e.y == -100
33        fprintf('Bottom\n');
34    end
35    if e.x == 100
36        fprintf('Right\n');
37    elseif e.x == -100
38        fprintf('Left\n');
39    end
40    fprintf('\n');
41end

Simple (Octave)¶

Download (octave_example_simple.m)

 1function octave_example_simple()
 2    more off;
 3
 4    HOST = "localhost";
 5    PORT = 4223;
 6    UID = "XYZ"; % Change XYZ to the UID of your Joystick Bricklet
 7
 8    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
 9    j = javaObject("com.tinkerforge.BrickletJoystick", UID, ipcon); % Create device object
10
11    ipcon.connect(HOST, PORT); % Connect to brickd
12    % Don't use device before ipcon is connected
13
14    % Get current position
15    position = j.getPosition();
16
17    fprintf("Position [X]: %d\n", java2int(position.x));
18    fprintf("Position [Y]: %d\n", java2int(position.y));
19
20    input("Press key to exit\n", "s");
21    ipcon.disconnect();
22end
23
24function int = java2int(value)
25    if compare_versions(version(), "3.8", "<=")
26        int = value.intValue();
27    else
28        int = value;
29    end
30end

Callback (Octave)¶

Download (octave_example_callback.m)

 1function octave_example_callback()
 2    more off;
 3
 4    HOST = "localhost";
 5    PORT = 4223;
 6    UID = "XYZ"; % Change XYZ to the UID of your Joystick Bricklet
 7
 8    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
 9    j = javaObject("com.tinkerforge.BrickletJoystick", UID, ipcon); % Create device object
10
11    ipcon.connect(HOST, PORT); % Connect to brickd
12    % Don't use device before ipcon is connected
13
14    % Register pressed callback to function cb_pressed
15    j.addPressedCallback(@cb_pressed);
16
17    % Register released callback to function cb_released
18    j.addReleasedCallback(@cb_released);
19
20    input("Press key to exit\n", "s");
21    ipcon.disconnect();
22end
23
24% Callback function for pressed callback
25function cb_pressed(e)
26    fprintf("Pressed\n");
27end
28
29% Callback function for released callback
30function cb_released(e)
31    fprintf("Released\n");
32end

Find Borders (Octave)¶

Download (octave_example_find_borders.m)

 1function octave_example_find_borders()
 2    more off;
 3
 4    HOST = "localhost";
 5    PORT = 4223;
 6    UID = "XYZ"; % Change XYZ to the UID of your Joystick Bricklet
 7
 8    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
 9    j = javaObject("com.tinkerforge.BrickletJoystick", UID, ipcon); % Create device object
10
11    ipcon.connect(HOST, PORT); % Connect to brickd
12    % Don't use device before ipcon is connected
13
14    % Get threshold callbacks with a debounce time of 0.2 seconds (200ms)
15    j.setDebouncePeriod(200);
16
17    % Register position reached callback to function cb_position_reached
18    j.addPositionReachedCallback(@cb_position_reached);
19
20    % Configure threshold for position "outside of -99, -99 to 99, 99"
21    j.setPositionCallbackThreshold("o", -99, 99, -99, 99);
22
23    input("Press key to exit\n", "s");
24    ipcon.disconnect();
25end
26
27% Callback function for position reached callback
28function cb_position_reached(e)
29    x = java2int(e.x);
30    y = java2int(e.y);
31
32    if y == 100
33        fprintf("Top\n");
34    elseif y == -100
35        fprintf("Bottom\n");
36    end
37    if x == 100
38        fprintf("Right\n");
39    elseif x ==-100
40        fprintf("Left\n");
41    end
42    fprintf("\n");
43end
44
45function int = java2int(value)
46    if compare_versions(version(), "3.8", "<=")
47        int = value.intValue();
48    else
49        int = value;
50    end
51end

Grundfunktionen¶

class BrickletJoystick(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	joystick – Typ: BrickletJoystick

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid.

In MATLAB:

import com.tinkerforge.BrickletJoystick;

joystick = BrickletJoystick("YOUR_DEVICE_UID", ipcon);

In Octave:

joystick = java_new("com.tinkerforge.BrickletJoystick", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletJoystick.Position BrickletJoystick.getPosition()¶

Rückgabeobjekt:	x – Typ: short, Wertebereich: [-100 bis 100] y – Typ: short, 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 PositionCallback Callback zu nutzen und die Periode mit setPositionCallbackPeriod() vorzugeben.

boolean BrickletJoystick.isPressed()¶

Rückgabe:	pressed – Typ: boolean

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

Es wird empfohlen die PressedCallback und ReleasedCallback Callbacks zu nutzen, um die Taste programmatisch zu behandeln.

Fortgeschrittene Funktionen¶

BrickletJoystick.AnalogValue BrickletJoystick.getAnalogValue()¶

Rückgabeobjekt:	x – Typ: int, Wertebereich: [0 bis 212 - 1] y – Typ: int, Wertebereich: [0 bis 212 - 1]

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

Bemerkung

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

Wenn die Analogwerte periodisch abgefragt werden sollen, wird empfohlen den AnalogValueCallback Callback zu nutzen und die Periode mit setAnalogValueCallbackPeriod() vorzugeben.

void BrickletJoystick.calibrate()¶

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.Identity BrickletJoystick.getIdentity()¶

Rückgabeobjekt:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255] deviceIdentifier – Typ: int, 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

void BrickletJoystick.setPositionCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

long BrickletJoystick.getPositionCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setPositionCallbackPeriod() gesetzt.

void BrickletJoystick.setAnalogValueCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

long BrickletJoystick.getAnalogValueCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setAnalogValueCallbackPeriod() gesetzt.

void BrickletJoystick.setPositionCallbackThreshold(char option, short minX, short maxX, short minY, short maxY)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxX – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 minY – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxY – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den PositionReachedCallback 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 Konstanten sind für diese Funktion verfügbar:

Für option:

• BrickletJoystick.THRESHOLD_OPTION_OFF = 'x'

• BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletJoystick.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletJoystick.THRESHOLD_OPTION_SMALLER = '<'

• BrickletJoystick.THRESHOLD_OPTION_GREATER = '>'

BrickletJoystick.PositionCallbackThreshold BrickletJoystick.getPositionCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxX – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 minY – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxY – Typ: short, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von setPositionCallbackThreshold() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

• BrickletJoystick.THRESHOLD_OPTION_OFF = 'x'

• BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletJoystick.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletJoystick.THRESHOLD_OPTION_SMALLER = '<'

• BrickletJoystick.THRESHOLD_OPTION_GREATER = '>'

void BrickletJoystick.setAnalogValueCallbackThreshold(char option, int minX, int maxX, int minY, int maxY)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxX – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 minY – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxY – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den AnalogValueReachedCallback 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 Konstanten sind für diese Funktion verfügbar:

Für option:

• BrickletJoystick.THRESHOLD_OPTION_OFF = 'x'

• BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletJoystick.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletJoystick.THRESHOLD_OPTION_SMALLER = '<'

• BrickletJoystick.THRESHOLD_OPTION_GREATER = '>'

BrickletJoystick.AnalogValueCallbackThreshold BrickletJoystick.getAnalogValueCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxX – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 minY – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 maxY – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von setAnalogValueCallbackThreshold() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

• BrickletJoystick.THRESHOLD_OPTION_OFF = 'x'

• BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletJoystick.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletJoystick.THRESHOLD_OPTION_SMALLER = '<'

• BrickletJoystick.THRESHOLD_OPTION_GREATER = '>'

void BrickletJoystick.setDebouncePeriod(long debounce)¶

Parameter:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

• PositionReachedCallback,

• AnalogValueReachedCallback

ausgelöst werden, wenn die Schwellwerte

• setPositionCallbackThreshold(),

• setAnalogValueCallbackThreshold()

weiterhin erreicht bleiben.

long BrickletJoystick.getDebouncePeriod()¶

Rückgabe:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb beschrieben.

callback BrickletJoystick.PositionCallback¶

Event-Objekt:	x – Typ: short, Wertebereich: [-100 bis 100] y – Typ: short, Wertebereich: [-100 bis 100]

Dieser Callback wird mit der Periode, wie gesetzt mit setPositionCallbackPeriod(), ausgelöst. Der Parameter ist die Position des Joysticks.

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

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addPositionCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removePositionCallback() wieder entfernt werden.

callback BrickletJoystick.AnalogValueCallback¶

Event-Objekt:	x – Typ: int, Wertebereich: [0 bis 212 - 1] y – Typ: int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit setAnalogValueCallbackPeriod(), ausgelöst. Der Parameter sind die Analogwerte des Joysticks.

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

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addAnalogValueCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeAnalogValueCallback() wieder entfernt werden.

callback BrickletJoystick.PositionReachedCallback¶

Event-Objekt:	x – Typ: short, Wertebereich: [-100 bis 100] y – Typ: short, Wertebereich: [-100 bis 100]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setPositionCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Position des Joysticks.

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

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addPositionReachedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removePositionReachedCallback() wieder entfernt werden.

callback BrickletJoystick.AnalogValueReachedCallback¶

Event-Objekt:	x – Typ: int, Wertebereich: [0 bis 212 - 1] y – Typ: int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter sind die Analogwerte des Joystick.

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

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addAnalogValueReachedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeAnalogValueReachedCallback() wieder entfernt werden.

callback BrickletJoystick.PressedCallback¶

Event-Objekt:	leeres Objekt

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

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addPressedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removePressedCallback() wieder entfernt werden.

callback BrickletJoystick.ReleasedCallback¶

Event-Objekt:	leeres Objekt

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

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addReleasedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeReleasedCallback() wieder entfernt werden.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

short[] BrickletJoystick.getAPIVersion()¶

Rückgabeobjekt:	apiVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

boolean BrickletJoystick.getResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels setResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

• BrickletJoystick.FUNCTION_CALIBRATE = 4

• BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5

• BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7

• BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9

• BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11

• BrickletJoystick.FUNCTION_SET_DEBOUNCE_PERIOD = 13

void BrickletJoystick.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

• BrickletJoystick.FUNCTION_CALIBRATE = 4

• BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5

• BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7

• BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9

• BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11

• BrickletJoystick.FUNCTION_SET_DEBOUNCE_PERIOD = 13

void BrickletJoystick.setResponseExpectedAll(boolean responseExpected)¶

Parameter:	responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten¶

int BrickletJoystick.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Joystick Bricklet zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

String BrickletJoystick.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet dar.