Software / API Bindings / MATLAB/Octave / API Referenz und Beispiele / Bricklets (Abgekündigt) / PTC Bricklet

MATLAB/Octave - PTC Bricklet¶

Dies ist die Beschreibung der MATLAB/Octave API Bindings für das PTC Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des PTC 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)

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

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

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

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

    % Get current temperature
    temperature = ptc.getTemperature();
    fprintf('Temperature: %g °C\n', temperature/100.0);

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

Callback (MATLAB)¶

Download (matlab_example_callback.m)

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

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

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

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

    % Register temperature callback to function cb_temperature
    set(ptc, 'TemperatureCallback', @(h, e) cb_temperature(e));

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

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

% Callback function for temperature callback
function cb_temperature(e)
    fprintf('Temperature: %g °C\n', e.temperature/100.0);
end

Threshold (MATLAB)¶

Download (matlab_example_threshold.m)

function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletPTC;

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

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

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

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

    % Register temperature reached callback to function cb_temperature_reached
    set(ptc, 'TemperatureReachedCallback', @(h, e) cb_temperature_reached(e));

    % Configure threshold for temperature "greater than 30 °C"
    ptc.setTemperatureCallbackThreshold('>', 30*100, 0);

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

% Callback function for temperature reached callback
function cb_temperature_reached(e)
    fprintf('Temperature: %g °C\n', e.temperature/100.0);
end

Simple (Octave)¶

Download (octave_example_simple.m)

function octave_example_simple()
    more off;

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

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

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

    % Get current temperature
    temperature = ptc.getTemperature();
    fprintf("Temperature: %g °C\n", temperature/100.0);

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

Callback (Octave)¶

Download (octave_example_callback.m)

function octave_example_callback()
    more off;

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

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

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

    % Register temperature callback to function cb_temperature
    ptc.addTemperatureCallback(@cb_temperature);

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

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

% Callback function for temperature callback
function cb_temperature(e)
    fprintf("Temperature: %g °C\n", e.temperature/100.0);
end

Threshold (Octave)¶

Download (octave_example_threshold.m)

function octave_example_threshold()
    more off;

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

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

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

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

    % Register temperature reached callback to function cb_temperature_reached
    ptc.addTemperatureReachedCallback(@cb_temperature_reached);

    % Configure threshold for temperature "greater than 30 °C"
    ptc.setTemperatureCallbackThreshold(">", 30*100, 0);

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

% Callback function for temperature reached callback
function cb_temperature_reached(e)
    fprintf("Temperature: %g °C\n", e.temperature/100.0);
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 BrickletPTC(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	ptc – Typ: BrickletPTC

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

In MATLAB:

import com.tinkerforge.BrickletPTC;

ptc = BrickletPTC("YOUR_DEVICE_UID", ipcon);

In Octave:

ptc = java_new("com.tinkerforge.BrickletPTC", "YOUR_DEVICE_UID", ipcon);

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

int BrickletPTC.getTemperature()¶

Rückgabe:	temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

Gibt die Temperatur des verbundenen Sensors zurück.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den TemperatureCallback Callback zu nutzen und die Periode mit setTemperatureCallbackPeriod() vorzugeben.

boolean BrickletPTC.isSensorConnected()¶

Rückgabe:	connected – Typ: boolean

Gibt true zurück wenn ein Sensor korrekt verbunden ist.

Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.

void BrickletPTC.setWireMode(short mode)¶

Parameter:	mode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 2

Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.

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

Für mode:

BrickletPTC.WIRE_MODE_2 = 2
BrickletPTC.WIRE_MODE_3 = 3
BrickletPTC.WIRE_MODE_4 = 4

short BrickletPTC.getWireMode()¶

Rückgabe:	mode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 2

Gibt die Leiter-Konfiguration zurück, wie von setWireMode() gesetzt.

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

Für mode:

BrickletPTC.WIRE_MODE_2 = 2
BrickletPTC.WIRE_MODE_3 = 3
BrickletPTC.WIRE_MODE_4 = 4

Fortgeschrittene Funktionen¶

int BrickletPTC.getResistance()¶

Rückgabe:	resistance – Typ: int, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1]

Gibt den Wert zurück, wie vom "MAX31865 Präzisions Delta-Sigma ADC" berechnet.

Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:

Pt100: Widerstand = (Wert * 390) / 32768
Pt1000: Widerstand = (Wert * 3900) / 32768

Wenn der Widerstand periodisch abgefragt werden soll, wird empfohlen den ResistanceCallback Callback zu nutzen und die Periode mit setResistanceCallbackPeriod() vorzugeben.

void BrickletPTC.setNoiseRejectionFilter(short filter)¶

Parameter:	filter – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.

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

Für filter:

BrickletPTC.FILTER_OPTION_50HZ = 0
BrickletPTC.FILTER_OPTION_60HZ = 1

short BrickletPTC.getNoiseRejectionFilter()¶

Rückgabe:	filter – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Einstellung des Entstörfilters zurück, wie von setNoiseRejectionFilter() gesetzt.

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

Für filter:

BrickletPTC.FILTER_OPTION_50HZ = 0
BrickletPTC.FILTER_OPTION_60HZ = 1

BrickletPTC.Identity BrickletPTC.getIdentity()¶

Rückgabeobjekt:

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 2¹⁶ - 1]

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 2¹⁶ - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

void BrickletPTC.setTemperatureCallbackPeriod(long period)¶

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

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

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

long BrickletPTC.getTemperatureCallbackPeriod()¶

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

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

void BrickletPTC.setResistanceCallbackPeriod(long period)¶

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

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

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

long BrickletPTC.getResistanceCallbackPeriod()¶

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

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

void BrickletPTC.setTemperatureCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Setzt den Schwellwert für den TemperatureReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

BrickletPTC.TemperatureCallbackThreshold BrickletPTC.getTemperatureCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

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

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

Für option:

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

void BrickletPTC.setResistanceCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Setzt den Schwellwert für den ResistanceReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

BrickletPTC.ResistanceCallbackThreshold BrickletPTC.getResistanceCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

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

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

Für option:

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

void BrickletPTC.setDebouncePeriod(long debounce)¶

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

Setzt die Periode mit welcher die Schwellwert Callback

TemperatureReachedCallback,
ResistanceReachedCallback

ausgelöst wird, wenn der Schwellwert

setTemperatureCallbackThreshold(),
setResistanceCallbackThreshold()

weiterhin erreicht bleibt.

long BrickletPTC.getDebouncePeriod()¶

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

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

void BrickletPTC.setSensorConnectedCallbackConfiguration(boolean enabled)¶

Parameter:	enabled – Typ: boolean, Standardwert: false

Wenn dieser Callback aktiviert ist, wird der SensorConnectedCallback Callback jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.

Neu in Version 2.0.2 (Plugin).

boolean BrickletPTC.getSensorConnectedCallbackConfiguration()¶

Rückgabe:	enabled – Typ: boolean, Standardwert: false

Gibt die Konfiguration zurück, wie von setSensorConnectedCallbackConfiguration() gesetzt.

Neu in Version 2.0.2 (Plugin).

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 BrickletPTC.TemperatureCallback¶

Event-Objekt:	temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

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

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

callback BrickletPTC.TemperatureReachedCallback¶

Event-Objekt:	temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setTemperatureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Temperatur des verbundenen 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 addTemperatureReachedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeTemperatureReachedCallback() wieder entfernt werden.

callback BrickletPTC.ResistanceCallback¶

Event-Objekt:	resistance – Typ: int, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit setResistanceCallbackPeriod(), ausgelöst. Der Parameter ist der Widerstand des verbundenen Sensors.

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

callback BrickletPTC.ResistanceReachedCallback¶

Event-Objekt:	resistance – Typ: int, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setResistanceCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Widerstand des verbundenen 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 addResistanceReachedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeResistanceReachedCallback() wieder entfernt werden.

callback BrickletPTC.SensorConnectedCallback¶

Event-Objekt:	connected – Typ: boolean

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setSensorConnectedCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie bei isSensorConnected().

Neu in Version 2.0.2 (Plugin).

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

In Octave kann diesem Callback mit addSensorConnectedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeSensorConnectedCallback() 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[] BrickletPTC.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 BrickletPTC.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:

BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22

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

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

Für functionId:

BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22

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

Diese Konstante wird verwendet um ein PTC 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 BrickletPTC.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines PTC Bricklet dar.