MATLAB/Octave - Distance IR Bricklet¶

Simple (MATLAB)¶

Download (matlab_example_simple.m)

 1function matlab_example_simple()
 2    import com.tinkerforge.IPConnection;
 3    import com.tinkerforge.BrickletDistanceIR;
 4
 5    HOST = 'localhost';
 6    PORT = 4223;
 7    UID = 'XYZ'; % Change XYZ to the UID of your Distance IR Bricklet
 8
 9    ipcon = IPConnection(); % Create IP connection
10    dir = handle(BrickletDistanceIR(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 distance
16    distance = dir.getDistance();
17    fprintf('Distance: %g cm\n', distance/10.0);
18
19    input('Press key to exit\n', 's');
20    ipcon.disconnect();
21end

Callback (MATLAB)¶

Download (matlab_example_callback.m)

 1function matlab_example_callback()
 2    import com.tinkerforge.IPConnection;
 3    import com.tinkerforge.BrickletDistanceIR;
 4
 5    HOST = 'localhost';
 6    PORT = 4223;
 7    UID = 'XYZ'; % Change XYZ to the UID of your Distance IR Bricklet
 8
 9    ipcon = IPConnection(); % Create IP connection
10    dir = handle(BrickletDistanceIR(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 distance callback to function cb_distance
16    set(dir, 'DistanceCallback', @(h, e) cb_distance(e));
17
18    % Set period for distance callback to 0.2s (200ms)
19    % Note: The distance callback is only called every 0.2 seconds
20    %       if the distance has changed since the last call!
21    dir.setDistanceCallbackPeriod(200);
22
23    input('Press key to exit\n', 's');
24    ipcon.disconnect();
25end
26
27% Callback function for distance callback
28function cb_distance(e)
29    fprintf('Distance: %g cm\n', e.distance/10.0);
30end

Threshold (MATLAB)¶

Download (matlab_example_threshold.m)

 1function matlab_example_threshold()
 2    import com.tinkerforge.IPConnection;
 3    import com.tinkerforge.BrickletDistanceIR;
 4
 5    HOST = 'localhost';
 6    PORT = 4223;
 7    UID = 'XYZ'; % Change XYZ to the UID of your Distance IR Bricklet
 8
 9    ipcon = IPConnection(); % Create IP connection
10    dir = handle(BrickletDistanceIR(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 10 seconds (10000ms)
16    dir.setDebouncePeriod(10000);
17
18    % Register distance reached callback to function cb_distance_reached
19    set(dir, 'DistanceReachedCallback', @(h, e) cb_distance_reached(e));
20
21    % Configure threshold for distance "smaller than 30 cm"
22    dir.setDistanceCallbackThreshold('<', 30*10, 0);
23
24    input('Press key to exit\n', 's');
25    ipcon.disconnect();
26end
27
28% Callback function for distance reached callback
29function cb_distance_reached(e)
30    fprintf('Distance: %g cm\n', e.distance/10.0);
31end

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 Distance IR Bricklet
 7
 8    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
 9    dir = javaObject("com.tinkerforge.BrickletDistanceIR", 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 distance
15    distance = dir.getDistance();
16    fprintf("Distance: %g cm\n", distance/10.0);
17
18    input("Press key to exit\n", "s");
19    ipcon.disconnect();
20end

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 Distance IR Bricklet
 7
 8    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
 9    dir = javaObject("com.tinkerforge.BrickletDistanceIR", 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 distance callback to function cb_distance
15    dir.addDistanceCallback(@cb_distance);
16
17    % Set period for distance callback to 0.2s (200ms)
18    % Note: The distance callback is only called every 0.2 seconds
19    %       if the distance has changed since the last call!
20    dir.setDistanceCallbackPeriod(200);
21
22    input("Press key to exit\n", "s");
23    ipcon.disconnect();
24end
25
26% Callback function for distance callback
27function cb_distance(e)
28    fprintf("Distance: %g cm\n", e.distance/10.0);
29end

Threshold (Octave)¶

Download (octave_example_threshold.m)

 1function octave_example_threshold()
 2    more off;
 3
 4    HOST = "localhost";
 5    PORT = 4223;
 6    UID = "XYZ"; % Change XYZ to the UID of your Distance IR Bricklet
 7
 8    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
 9    dir = javaObject("com.tinkerforge.BrickletDistanceIR", 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 10 seconds (10000ms)
15    dir.setDebouncePeriod(10000);
16
17    % Register distance reached callback to function cb_distance_reached
18    dir.addDistanceReachedCallback(@cb_distance_reached);
19
20    % Configure threshold for distance "smaller than 30 cm"
21    dir.setDistanceCallbackThreshold("<", 30*10, 0);
22
23    input("Press key to exit\n", "s");
24    ipcon.disconnect();
25end
26
27% Callback function for distance reached callback
28function cb_distance_reached(e)
29    fprintf("Distance: %g cm\n", e.distance/10.0);
30end

Grundfunktionen¶

class BrickletDistanceIR(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	distanceIR – Typ: BrickletDistanceIR

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

In MATLAB:

import com.tinkerforge.BrickletDistanceIR;

distanceIR = BrickletDistanceIR("YOUR_DEVICE_UID", ipcon);

In Octave:

distanceIR = java_new("com.tinkerforge.BrickletDistanceIR", "YOUR_DEVICE_UID", ipcon);

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

int BrickletDistanceIR.getDistance()¶

Rückgabe:	distance – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1]

Gibt die gemessene Entfernung des Sensors zurück. Die möglichen Entfernungsbereiche sind 40 bis 300, 100 bis 800 und 200 bis 1500, in Abhängigkeit vom gewählten IR Sensor.

Wenn die Entfernung periodisch abgefragt werden soll, wird empfohlen den DistanceCallback Callback zu nutzen und die Periode mit setDistanceCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

int BrickletDistanceIR.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 getDistance() 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.

void BrickletDistanceIR.setSamplingPoint(short position, int distance)¶

Parameter:	position – Typ: short, Wertebereich: [0 bis 127] distance – Typ: int, Einheit: 1/10 mm, Wertebereich: [0 bis 216 - 1]

Setzt einen Messpunkt für eine vorgegebene Position in der Wertetabelle. Die Wertetabelle beinhaltet 128 äquidistante Analogwerte mit entsprechenden Entfernungen.

Wenn eine Entfernung von 50cm bei einem Analogwert von 2048 gemessen wird, dann sollte der Aufruf der Funktion mit (64, 5000) erfolgen. Der verwendete Analog-Digital-Wandler hat eine Auflösung von 12 Bit. Mit 128 Messpunkten im gesamten Bereich bedeutet das, dass jeder Messpunkt 32 Analogwerte umfasst. Daher wird dem Analogwert 2048 der Messpunkt 64 = 2048/32 zugeordnet.

Messpunkte werden im EEPROM des Distance IR Bricklet gespeichert und werden bei jedem Hochfahren geladen.

Bemerkung

Ein einfacher Weg, die Messpunkte des Distance IR Bricklet zu kalibrieren, ist im Brick Viewer implementiert. Wenn der Bricklet kalibriert werden soll wird dringend empfohlen diese Implementierung zu nutzen.

int BrickletDistanceIR.getSamplingPoint(short position)¶

Parameter:	position – Typ: short, Wertebereich: [0 bis 127]
Rückgabe:	distance – Typ: int, Einheit: 1/10 mm, Wertebereich: [0 bis 216 - 1]

Gibt die Entfernung eines Messpunktes zurück, wie von setSamplingPoint() gesetzt.

BrickletDistanceIR.Identity BrickletDistanceIR.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 BrickletDistanceIR.setDistanceCallbackPeriod(long period)¶

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

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

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

long BrickletDistanceIR.getDistanceCallbackPeriod()¶

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

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

void BrickletDistanceIR.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 BrickletDistanceIR.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 BrickletDistanceIR.setDistanceCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den DistanceReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Entfernung außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Entfernung innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Entfernung kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Entfernung größer als der min Wert ist (max wird ignoriert)

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

Für option:

• BrickletDistanceIR.THRESHOLD_OPTION_OFF = 'x'

• BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = '<'

• BrickletDistanceIR.THRESHOLD_OPTION_GREATER = '>'

BrickletDistanceIR.DistanceCallbackThreshold BrickletDistanceIR.getDistanceCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

• BrickletDistanceIR.THRESHOLD_OPTION_OFF = 'x'

• BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = '<'

• BrickletDistanceIR.THRESHOLD_OPTION_GREATER = '>'

void BrickletDistanceIR.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 des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes 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:

• BrickletDistanceIR.THRESHOLD_OPTION_OFF = 'x'

• BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = '<'

• BrickletDistanceIR.THRESHOLD_OPTION_GREATER = '>'

BrickletDistanceIR.AnalogValueCallbackThreshold BrickletDistanceIR.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:

• BrickletDistanceIR.THRESHOLD_OPTION_OFF = 'x'

• BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = 'o'

• BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = 'i'

• BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = '<'

• BrickletDistanceIR.THRESHOLD_OPTION_GREATER = '>'

void BrickletDistanceIR.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

• DistanceReachedCallback,

• AnalogValueReachedCallback

ausgelöst werden, wenn die Schwellwerte

• setDistanceCallbackThreshold(),

• setAnalogValueCallbackThreshold()

weiterhin erreicht bleiben.

long BrickletDistanceIR.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 BrickletDistanceIR.DistanceCallback¶

Event-Objekt:	distance – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit setDistanceCallbackPeriod(), ausgelöst. Der Parameter ist die Entfernung des Sensors.

Der DistanceCallback Callback wird nur ausgelöst, wenn sich der Strom 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 addDistanceCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeDistanceCallback() wieder entfernt werden.

callback BrickletDistanceIR.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 Sensors.

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 BrickletDistanceIR.DistanceReachedCallback¶

Event-Objekt:	distance – Typ: int, Einheit: 1 mm, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setDistanceCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Entfernung des Sensors.

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 addDistanceReachedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeDistanceReachedCallback() wieder entfernt werden.

callback BrickletDistanceIR.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 Sensors.

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

• BrickletDistanceIR.FUNCTION_SET_SAMPLING_POINT = 3

• BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 5

• BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7

• BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 9

• BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11

• BrickletDistanceIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13

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

• BrickletDistanceIR.FUNCTION_SET_SAMPLING_POINT = 3

• BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 5

• BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7

• BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 9

• BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11

• BrickletDistanceIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13

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

Diese Konstante wird verwendet um ein Distance IR 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 BrickletDistanceIR.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Distance IR Bricklet dar.