MATLAB/Octave - Temperature IR Bricklet

Dies ist die Beschreibung der MATLAB/Octave API Bindings für das Temperature IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature IR Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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
22
23
24
25
function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletTemperatureIR;

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

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

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

    % Get current ambient temperature
    ambientTemperature = tir.getAmbientTemperature();
    fprintf('Ambient Temperature: %g °C\n', ambientTemperature/10.0);

    % Get current object temperature
    objectTemperature = tir.getObjectTemperature();
    fprintf('Object Temperature: %g °C\n', objectTemperature/10.0);

    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.BrickletTemperatureIR;

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

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

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

    % Register object temperature callback to function cb_object_temperature
    set(tir, 'ObjectTemperatureCallback', @(h, e) cb_object_temperature(e));

    % Set period for object temperature callback to 1s (1000ms)
    % Note: The object temperature callback is only called every second
    %       if the object temperature has changed since the last call!
    tir.setObjectTemperatureCallbackPeriod(1000);

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

% Callback function for object temperature callback
function cb_object_temperature(e)
    fprintf('Object Temperature: %g °C\n', e.temperature/10.0);
end

Water Boiling (MATLAB)

Download (matlab_example_water_boiling.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
31
32
33
34
35
36
37
function matlab_example_water_boiling()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletTemperatureIR;

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

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

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

    % Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
    tir.setEmissivity(64224);

    % Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    tir.setDebouncePeriod(10000);

    % Register object temperature reached callback to function
    % cb_object_temperature_reached
    set(tir, 'ObjectTemperatureReachedCallback',
        @(h, e) cb_object_temperature_reached(e));

    % Configure threshold for object temperature "greater than 100 °C"
    tir.setObjectTemperatureCallbackThreshold('>', 100*10, 0);

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

% Callback function for object temperature reached callback
function cb_object_temperature_reached(e)
    fprintf('Object Temperature: %g °C\n', e.temperature/10.0);
    fprintf('The water is boiling!\n');
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
21
22
23
24
25
26
27
28
29
30
31
32
function octave_example_simple()
    more off;

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

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

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

    % Get current ambient temperature
    ambientTemperature = tir.getAmbientTemperature();
    fprintf("Ambient Temperature: %g °C\n", java2int(ambientTemperature)/10.0);

    % Get current object temperature
    objectTemperature = tir.getObjectTemperature();
    fprintf("Object Temperature: %g °C\n", java2int(objectTemperature)/10.0);

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

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
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
30
31
32
33
34
35
36
37
function octave_example_callback()
    more off;

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

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

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

    % Register object temperature callback to function cb_object_temperature
    tir.addObjectTemperatureCallback(@cb_object_temperature);

    % Set period for object temperature callback to 1s (1000ms)
    % Note: The object temperature callback is only called every second
    %       if the object temperature has changed since the last call!
    tir.setObjectTemperatureCallbackPeriod(1000);

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

% Callback function for object temperature callback
function cb_object_temperature(e)
    fprintf("Object Temperature: %g °C\n", java2int(e.temperature)/10.0);
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

Water Boiling (Octave)

Download (octave_example_water_boiling.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
31
32
33
34
35
36
37
38
39
40
41
42
43
function octave_example_water_boiling()
    more off;

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

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

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

    % Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
    tir.setEmissivity(64224);

    % Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    tir.setDebouncePeriod(10000);

    % Register object temperature reached callback to function
    % cb_object_temperature_reached
    tir.addObjectTemperatureReachedCallback(@cb_object_temperature_reached);

    % Configure threshold for object temperature "greater than 100 °C"
    tir.setObjectTemperatureCallbackThreshold(">", 100*10, 0);

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

% Callback function for object temperature reached callback
function cb_object_temperature_reached(e)
    fprintf("Object Temperature: %g °C\n", java2int(e.temperature)/10.0);
    fprintf("The water is boiling!\n");
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

API

Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletTemperatureIR(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • temperatureIR – Typ: BrickletTemperatureIR

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

In MATLAB:

import com.tinkerforge.BrickletTemperatureIR;

temperatureIR = BrickletTemperatureIR("YOUR_DEVICE_UID", ipcon);

In Octave:

temperatureIR = java_new("com.tinkerforge.BrickletTemperatureIR", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

short BrickletTemperatureIR.getAmbientTemperature()
Rückgabe:
  • temperature – Typ: short, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

Gibt die Umgebungstemperatur des Sensors zurück.

Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen den AmbientTemperatureCallback Callback zu nutzen und die Periode mit setAmbientTemperatureCallbackPeriod() vorzugeben.

short BrickletTemperatureIR.getObjectTemperature()
Rückgabe:
  • temperature – Typ: short, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt.

Die Temperatur von unterschiedlichen Materialien ist abhängig von ihrem Emissionsgrad. Der Emissionsgrad des Materials kann mit setEmissivity() gesetzt werden.

Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen den ObjectTemperatureCallback Callback zu nutzen und die Periode mit setObjectTemperatureCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

void BrickletTemperatureIR.setEmissivity(int emissivity)
Parameter:
  • emissivity – Typ: int, Einheit: 1/65535, Wertebereich: [6553 bis 216 - 1], Standardwert: 216 - 1

Setzt den Emissionsgrad, welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von getObjectTemperature() zurückgegeben.

Der Emissionsgrad wird normalerweise als Wert zwischen 0,0 und 1,0 angegeben. Eine Liste von Emissionsgraden unterschiedlicher Materialien ist hier zu finden.

Der Parameter von setEmissivity() muss mit eine Faktor von 65535 (16-Bit) vorgegeben werden. Beispiel: Ein Emissionsgrad von 0,1 kann mit dem Wert 6553 gesetzt werden, ein Emissionsgrad von 0,5 mit dem Wert 32767 und so weiter.

Bemerkung

Wenn eine exakte Messung der Objekttemperatur notwendig ist, ist es entscheidend eine exakten Emissionsgrad anzugeben.

Der Emissionsgrad wird in nicht-flüchtigem Speicher gespeichert und wird auch noch einem Neustart weiter genutzt.

int BrickletTemperatureIR.getEmissivity()
Rückgabe:
  • emissivity – Typ: int, Einheit: 1/65535, Wertebereich: [6553 bis 216 - 1], Standardwert: 216 - 1

Gibt den Emissionsgrad zurück, wie von setEmissivity() gesetzt.

BrickletTemperatureIR.Identity BrickletTemperatureIR.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', 'i', '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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 BrickletTemperatureIR.setAmbientTemperatureCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

long BrickletTemperatureIR.getAmbientTemperatureCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletTemperatureIR.setObjectTemperatureCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

long BrickletTemperatureIR.getObjectTemperatureCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletTemperatureIR.setAmbientTemperatureCallbackThreshold(char option, short min, short max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: short, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: short, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den AmbientTemperatureReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'
BrickletTemperatureIR.AmbientTemperatureCallbackThreshold BrickletTemperatureIR.getAmbientTemperatureCallbackThreshold()
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: short, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: short, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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

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

Für option:

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'
void BrickletTemperatureIR.setObjectTemperatureCallbackThreshold(char option, short min, short max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: short, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: short, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den ObjectTemperatureReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'
BrickletTemperatureIR.ObjectTemperatureCallbackThreshold BrickletTemperatureIR.getObjectTemperatureCallbackThreshold()
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: short, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: short, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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

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

Für option:

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'
void BrickletTemperatureIR.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

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

long BrickletTemperatureIR.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.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

callback BrickletTemperatureIR.AmbientTemperatureCallback
Event-Objekt:
  • temperature – Typ: short, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

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

Der AmbientTemperatureCallback Callback wird nur ausgelöst, wenn sich die Temperatur 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 addAmbientTemperatureCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeAmbientTemperatureCallback() wieder entfernt werden.

callback BrickletTemperatureIR.ObjectTemperatureCallback
Event-Objekt:
  • temperature – Typ: short, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

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

Der ObjectTemperatureCallback Callback wird nur ausgelöst, wenn sich die Objekttemperatur 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 addObjectTemperatureCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeObjectTemperatureCallback() wieder entfernt werden.

callback BrickletTemperatureIR.AmbientTemperatureReachedCallback
Event-Objekt:
  • temperature – Typ: short, Einheit: 1/10 °C, Wertebereich: [-400 bis 1250]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setAmbientTemperatureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Umgebungstemperatur 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 addAmbientTemperatureReachedCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeAmbientTemperatureReachedCallback() wieder entfernt werden.

callback BrickletTemperatureIR.ObjectTemperatureReachedCallback
Event-Objekt:
  • temperature – Typ: short, Einheit: 1/10 °C, Wertebereich: [-700 bis 3800]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setObjectTemperatureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Objekttemperatur 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 addObjectTemperatureReachedCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeObjectTemperatureReachedCallback() 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[] BrickletTemperatureIR.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 BrickletTemperatureIR.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, 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:

  • BrickletTemperatureIR.FUNCTION_SET_EMISSIVITY = 3
  • BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • BrickletTemperatureIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13
void BrickletTemperatureIR.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, 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:

  • BrickletTemperatureIR.FUNCTION_SET_EMISSIVITY = 3
  • BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • BrickletTemperatureIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13
void BrickletTemperatureIR.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 BrickletTemperatureIR.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Temperature 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 BrickletTemperatureIR.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Temperature IR Bricklet dar.