MATLAB/Octave - Linear Poti Bricklet¶

Simple (MATLAB)¶

Download (matlab_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLinearPoti;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Linear Poti Bricklet

    ipcon = IPConnection(); % Create IP connection
    lp = handle(BrickletLinearPoti(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current position
    position = lp.getPosition();
    fprintf('Position: %i %%\n', position); % Range: 0 to 100

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)¶

Download (matlab_example_callback.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLinearPoti;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Linear Poti Bricklet

    ipcon = IPConnection(); % Create IP connection
    lp = handle(BrickletLinearPoti(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register position callback to function cb_position
    set(lp, 'PositionCallback', @(h, e) cb_position(e));

    % Set period for position callback to 0.05s (50ms)
    % Note: The position callback is only called every 0.05 seconds
    %       if the position has changed since the last call!
    lp.setPositionCallbackPeriod(50);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for position callback
function cb_position(e)
    fprintf('Position: %i %%\n', e.position); % Range: 0 to 100
end

Simple (Octave)¶

Download (octave_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Linear Poti Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    lp = javaObject("com.tinkerforge.BrickletLinearPoti", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current position
    position = lp.getPosition();
    fprintf("Position: %d %%\n", position); % Range: 0 to 100

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Callback (Octave)¶

Download (octave_example_callback.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Linear Poti Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    lp = javaObject("com.tinkerforge.BrickletLinearPoti", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register position callback to function cb_position
    lp.addPositionCallback(@cb_position);

    % Set period for position callback to 0.05s (50ms)
    % Note: The position callback is only called every 0.05 seconds
    %       if the position has changed since the last call!
    lp.setPositionCallbackPeriod(50);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for position callback
function cb_position(e)
    fprintf("Position: %d %%\n", e.position); % Range: 0 to 100
end

Grundfunktionen¶

class BrickletLinearPoti(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	linearPoti – Typ: BrickletLinearPoti

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

In MATLAB:

import com.tinkerforge.BrickletLinearPoti;

linearPoti = BrickletLinearPoti("YOUR_DEVICE_UID", ipcon);

In Octave:

linearPoti = java_new("com.tinkerforge.BrickletLinearPoti", "YOUR_DEVICE_UID", ipcon);

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

int BrickletLinearPoti.getPosition()¶

Rückgabe:	position – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100]

Gibt die Position des Linearpotentiometers zurück. Der Wertebereich ist von 0% (Schieberegler unten) und 100% (Schieberegler oben).

Wenn die Position periodisch abgefragt werden soll, wird empfohlen den PositionCallback Callback zu nutzen und die Periode mit setPositionCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

int BrickletLinearPoti.getAnalogValue()¶

Rückgabe:	value – 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 der Analogwert periodisch abgefragt werden soll, wird empfohlen den AnalogValueCallback Callback zu nutzen und die Periode mit setAnalogValueCallbackPeriod() vorzugeben.

BrickletLinearPoti.Identity BrickletLinearPoti.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 BrickletLinearPoti.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.

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

long BrickletLinearPoti.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 BrickletLinearPoti.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 der Analogwert seit der letzten Auslösung geändert hat.

long BrickletLinearPoti.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 BrickletLinearPoti.setPositionCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 216 - 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 der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Position größer als der min Wert ist (max wird ignoriert)

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

Für option:

• BrickletLinearPoti.THRESHOLD_OPTION_OFF = 'x'
• BrickletLinearPoti.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletLinearPoti.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletLinearPoti.THRESHOLD_OPTION_SMALLER = '<'
• BrickletLinearPoti.THRESHOLD_OPTION_GREATER = '>'

BrickletLinearPoti.PositionCallbackThreshold BrickletLinearPoti.getPositionCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 216 - 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:

• BrickletLinearPoti.THRESHOLD_OPTION_OFF = 'x'
• BrickletLinearPoti.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletLinearPoti.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletLinearPoti.THRESHOLD_OPTION_SMALLER = '<'
• BrickletLinearPoti.THRESHOLD_OPTION_GREATER = '>'

void BrickletLinearPoti.setAnalogValueCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – 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 der Analogwert außerhalb der min und max Werte ist
'i'	Callback wird ausgelöst, wenn der Analogwert innerhalb der min und max Werte ist
'<'	Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert)

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

Für option:

• BrickletLinearPoti.THRESHOLD_OPTION_OFF = 'x'
• BrickletLinearPoti.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletLinearPoti.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletLinearPoti.THRESHOLD_OPTION_SMALLER = '<'
• BrickletLinearPoti.THRESHOLD_OPTION_GREATER = '>'

BrickletLinearPoti.AnalogValueCallbackThreshold BrickletLinearPoti.getAnalogValueCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – 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:

• BrickletLinearPoti.THRESHOLD_OPTION_OFF = 'x'
• BrickletLinearPoti.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletLinearPoti.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletLinearPoti.THRESHOLD_OPTION_SMALLER = '<'
• BrickletLinearPoti.THRESHOLD_OPTION_GREATER = '>'

void BrickletLinearPoti.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 BrickletLinearPoti.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 BrickletLinearPoti.PositionCallback¶

Event-Objekt:	position – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100]

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

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 BrickletLinearPoti.AnalogValueCallback¶

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

Dieser Callback wird mit der Periode, wie gesetzt mit setAnalogValueCallbackPeriod(), ausgelöst. Der Parameter ist der Analogwert des Linearpotentiometers.

Der AnalogValueCallback Callback wird nur ausgelöst, wenn sich der Analogwert 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 BrickletLinearPoti.PositionReachedCallback¶

Event-Objekt:	position – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100]

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

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 BrickletLinearPoti.AnalogValueReachedCallback¶

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert des Linearpotentiometers.

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.

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[] BrickletLinearPoti.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 BrickletLinearPoti.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:

• BrickletLinearPoti.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
• BrickletLinearPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletLinearPoti.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
• BrickletLinearPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletLinearPoti.FUNCTION_SET_DEBOUNCE_PERIOD = 11

void BrickletLinearPoti.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:

• BrickletLinearPoti.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
• BrickletLinearPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletLinearPoti.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
• BrickletLinearPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletLinearPoti.FUNCTION_SET_DEBOUNCE_PERIOD = 11

void BrickletLinearPoti.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 BrickletLinearPoti.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Linear Poti 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 BrickletLinearPoti.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Linear Poti Bricklet dar.