Deutsch
English
Menu
Software / API Bindings / MATLAB/Octave / API Referenz und Beispiele / Bricklets / Barometer Bricklet

MATLAB/Octave - Barometer Bricklet

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

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

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

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

    % Get current air pressure
    airPressure = b.getAirPressure();
    fprintf('Air Pressure: %g hPa\n', airPressure/1000.0);

    % Get current altitude
    altitude = b.getAltitude();
    fprintf('Altitude: %g m\n', altitude/100.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.BrickletBarometer;

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

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

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

    % Register air pressure callback to function cb_air_pressure
    set(b, 'AirPressureCallback', @(h, e) cb_air_pressure(e));

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

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

% Callback function for air pressure callback
function cb_air_pressure(e)
    fprintf('Air Pressure: %g hPa\n', e.airPressure/1000.0);
end

Threshold (MATLAB)

Download (matlab_example_threshold.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 matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletBarometer;

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

    ipcon = IPConnection(); % Create IP connection
    b = handle(BrickletBarometer(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)
    b.setDebouncePeriod(10000);

    % Register air pressure reached callback to function cb_air_pressure_reached
    set(b, 'AirPressureReachedCallback', @(h, e) cb_air_pressure_reached(e));

    % Configure threshold for air pressure "greater than 1025 hPa"
    b.setAirPressureCallbackThreshold('>', 1025*1000, 0);

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

% Callback function for air pressure reached callback
function cb_air_pressure_reached(e)
    fprintf('Air Pressure: %g hPa\n', e.airPressure/1000.0);
    fprintf('Enjoy the potentially good weather!\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
function octave_example_simple()
    more off;

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

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

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

    % Get current air pressure
    airPressure = b.getAirPressure();
    fprintf("Air Pressure: %g hPa\n", airPressure/1000.0);

    % Get current altitude
    altitude = b.getAltitude();
    fprintf("Altitude: %g m\n", altitude/100.0);

    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 Barometer Bricklet

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

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

    % Register air pressure callback to function cb_air_pressure
    b.addAirPressureCallback(@cb_air_pressure);

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

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

% Callback function for air pressure callback
function cb_air_pressure(e)
    fprintf("Air Pressure: %g hPa\n", e.airPressure/1000.0);
end

Threshold (Octave)

Download (octave_example_threshold.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
function octave_example_threshold()
    more off;

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

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    b = javaObject("com.tinkerforge.BrickletBarometer", 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)
    b.setDebouncePeriod(10000);

    % Register air pressure reached callback to function cb_air_pressure_reached
    b.addAirPressureReachedCallback(@cb_air_pressure_reached);

    % Configure threshold for air pressure "greater than 1025 hPa"
    b.setAirPressureCallbackThreshold(">", 1025*1000, 0);

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

% Callback function for air pressure reached callback
function cb_air_pressure_reached(e)
    fprintf("Air Pressure: %g hPa\n", e.airPressure/1000.0);
    fprintf("Enjoy the potentially good weather!\n");
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 BrickletBarometer(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • barometer – Typ: BrickletBarometer

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

In MATLAB:

import com.tinkerforge.BrickletBarometer;

barometer = BrickletBarometer("YOUR_DEVICE_UID", ipcon);

In Octave:

barometer = java_new("com.tinkerforge.BrickletBarometer", "YOUR_DEVICE_UID", ipcon);

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

int BrickletBarometer.getAirPressure()
Rückgabe:
  • airPressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000]

Gibt den Luftdruck des Luftdrucksensors zurück.

Wenn der Luftdruck periodisch abgefragt werden soll, wird empfohlen den AirPressureCallback Callback zu nutzen und die Periode mit setAirPressureCallbackPeriod() vorzugeben.

int BrickletBarometer.getAltitude()
Rückgabe:
  • altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

Gibt die relative Höhe des Luftdrucksensors zurück. Der Wert wird auf Basis der Differenz zwischen dem aktuellen Luftdruck und dem Referenzluftdruck berechnet, welcher mit setReferenceAirPressure() gesetzt werden kann.

Wenn die Höhe periodisch abgefragt werden soll, wird empfohlen den AltitudeCallback Callback zu nutzen und die Periode mit setAltitudeCallbackPeriod() vorzugeben.

void BrickletBarometer.setReferenceAirPressure(int airPressure)
Parameter:
  • airPressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [0, 10000 bis 1200000], Standardwert: 1013250

Setzt den Referenzluftdruck für die Höhenberechnung. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0cm aus. Als Abkürzung kann auch 0 übergeben werden, dadurch wird der Referenzluftdruck intern auf den aktuellen Luftdruckwert gesetzt.

Wohl bekannte Referenzluftdruckwerte, die in der Luftfahrt verwendet werden, sind QNH und QFE aus dem Q-Schlüssel.

int BrickletBarometer.getReferenceAirPressure()
Rückgabe:
  • airPressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000], Standardwert: 1013250

Gibt den Referenzluftdruckwert zurück, wie von setReferenceAirPressure() gesetzt.

Fortgeschrittene Funktionen

short BrickletBarometer.getChipTemperature()
Rückgabe:
  • temperature – Typ: short, Einheit: 1/100 °C, Wertebereich: [-4000 bis 8500]

Gibt die Temperatur des Luftdrucksensors zurück.

Diese Temperatur wird intern zur Temperaturkompensation der Luftdruckmessung verwendet. Sie ist nicht so genau wie die Temperatur die vom Temperature Bricklet oder dem Temperature IR Bricklet gemessen wird.

void BrickletBarometer.setAveraging(short movingAveragePressure, short averagePressure, short averageTemperature)
Parameter:
  • movingAveragePressure – Typ: short, Wertebereich: [0 bis 25], Standardwert: 25
  • averagePressure – Typ: short, Wertebereich: [0 bis 10], Standardwert: 10
  • averageTemperature – Typ: short, Wertebereich: [0 bis 255], Standardwert: 10

Setzt die unterschiedlichen Averaging-Parameter (Mittelwertbildung). Es ist möglich die Länge des Mittelwerts für Temperatur und Luftdruck anzugeben. Zusätzlich gibt kann die Länge für einen gleitenden Mittelwert für den Luftdruck angegeben werden. Der gleitende Mittelwert wird mit den Werten des normalen Mittelwerts berechnet. Es gibt keinen gleitenden Mittelwert für die Temperatur.

Wenn alle drei Parameter auf 0 gesetzt werden, ist das Averaging komplett aus. In diesem Fall gibt es viel Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung. Wir empfehlen das Averaging auszustellen wenn die Daten des Barometer Bricklets zusammen mit anderen Sensordaten fusioniert werden sollen.

Neu in Version 2.0.1 (Plugin).

BrickletBarometer.Averaging BrickletBarometer.getAveraging()
Rückgabeobjekt:
  • movingAveragePressure – Typ: short, Wertebereich: [0 bis 25], Standardwert: 25
  • averagePressure – Typ: short, Wertebereich: [0 bis 10], Standardwert: 10
  • averageTemperature – Typ: short, Wertebereich: [0 bis 255], Standardwert: 10

Gibt die Averaging-Konfiguration zurück, wie von setAveraging() gesetzt.

Neu in Version 2.0.1 (Plugin).

void BrickletBarometer.setI2CMode(short mode)
Parameter:
  • mode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den I2C Modus. Mögliche Modi sind:

  • 0: Fast (400kHz)
  • 1: Slow (100kHz)

Wenn Probleme mit offensichtlichen Ausreißern in den Barometer Bricklet Messungen auftreten, können diese eventuell aufgrund von elektromagnetischen Störungen sein. In diesem Fall kann es helfen die I2C Geschwindigkeit zu verringern.

Falls in einem System ein hoher Durchsatz an Nachrichten erwünscht ist, sollte die I2C Geschwindigkeit allerdings nicht verringert werden.

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

Für mode:

  • BrickletBarometer.I2C_MODE_FAST = 0
  • BrickletBarometer.I2C_MODE_SLOW = 1

Neu in Version 2.0.3 (Plugin).

short BrickletBarometer.getI2CMode()
Rückgabe:
  • mode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den I2C Modus zurück, wie von setI2CMode() gesetzt.

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

Für mode:

  • BrickletBarometer.I2C_MODE_FAST = 0
  • BrickletBarometer.I2C_MODE_SLOW = 1

Neu in Version 2.0.3 (Plugin).

BrickletBarometer.Identity BrickletBarometer.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 BrickletBarometer.setAirPressureCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

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

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

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

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

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

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

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

void BrickletBarometer.setAirPressureCallbackThreshold(char option, int min, int max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den AirPressureReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'
BrickletBarometer.AirPressureCallbackThreshold BrickletBarometer.getAirPressureCallbackThreshold()
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

  • BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'
void BrickletBarometer.setAltitudeCallbackThreshold(char option, int min, int max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert für den AltitudeReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'
BrickletBarometer.AltitudeCallbackThreshold BrickletBarometer.getAltitudeCallbackThreshold()
Rückgabeobjekt:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

  • BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'
void BrickletBarometer.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 BrickletBarometer.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 BrickletBarometer.AirPressureCallback
Event-Objekt:
  • airPressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000]

Dieser Callback wird mit der Periode, wie gesetzt mit setAirPressureCallbackPeriod(), ausgelöst. Der Parameter ist der Luftdruck des Luftdrucksensors.

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

callback BrickletBarometer.AltitudeCallback
Event-Objekt:
  • altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit setAltitudeCallbackPeriod(), ausgelöst. Der Parameter ist die Höhe des Luftdrucksensors.

Der AltitudeCallback Callback wird nur ausgelöst, wenn sich die Höhe 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 addAltitudeCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeAltitudeCallback() wieder entfernt werden.

callback BrickletBarometer.AirPressureReachedCallback
Event-Objekt:
  • airPressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setAirPressureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Luftdruck des Luftdrucksensors.

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

callback BrickletBarometer.AltitudeReachedCallback
Event-Objekt:
  • altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setAltitudeCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Höhe des Luftdrucksensors.

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 addAltitudeReachedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeAltitudeReachedCallback() 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[] BrickletBarometer.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 BrickletBarometer.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:

  • BrickletBarometer.FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
  • BrickletBarometer.FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
  • BrickletBarometer.FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
  • BrickletBarometer.FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
  • BrickletBarometer.FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletBarometer.FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
  • BrickletBarometer.FUNCTION_SET_AVERAGING = 20
  • BrickletBarometer.FUNCTION_SET_I2C_MODE = 22
void BrickletBarometer.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:

  • BrickletBarometer.FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
  • BrickletBarometer.FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
  • BrickletBarometer.FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
  • BrickletBarometer.FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
  • BrickletBarometer.FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletBarometer.FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
  • BrickletBarometer.FUNCTION_SET_AVERAGING = 20
  • BrickletBarometer.FUNCTION_SET_I2C_MODE = 22
void BrickletBarometer.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 BrickletBarometer.DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet dar.