Current Bricklet¶

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

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

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

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

    % Get current voltage
    voltage = vc.getVoltage();
    fprintf('Voltage: %g V\n', voltage/1000.0);

    % Get current current
    current = vc.getCurrent();
    fprintf('Current: %g A\n', current/1000.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.BrickletVoltageCurrent;

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

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

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

    % Register current callback to function cb_current
    set(vc, 'CurrentCallback', @(h, e) cb_current(e));

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

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

% Callback function for current callback
function cb_current(e)
    fprintf('Current: %g A\n', e.current/1000.0);
end

Threshold (MATLAB)¶

Download (matlab_example_threshold.m)

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

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

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

    % Register power reached callback to function cb_power_reached
    set(vc, 'PowerReachedCallback', @(h, e) cb_power_reached(e));

    % Configure threshold for power "greater than 10 W"
    vc.setPowerCallbackThreshold('>', 10*1000, 0);

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

% Callback function for power reached callback
function cb_power_reached(e)
    fprintf('Power: %g W\n', e.power/1000.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 Voltage/Current Bricklet

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

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

    % Get current voltage
    voltage = vc.getVoltage();
    fprintf("Voltage: %g V\n", voltage/1000.0);

    % Get current current
    current = vc.getCurrent();
    fprintf("Current: %g A\n", current/1000.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 Voltage/Current Bricklet

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

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

    % Register current callback to function cb_current
    vc.addCurrentCallback(@cb_current);

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

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

% Callback function for current callback
function cb_current(e)
    fprintf("Current: %g A\n", e.current/1000.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 Voltage/Current Bricklet

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

    % Register power reached callback to function cb_power_reached
    vc.addPowerReachedCallback(@cb_power_reached);

    % Configure threshold for power "greater than 10 W"
    vc.setPowerCallbackThreshold(">", 10*1000, 0);

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

% Callback function for power reached callback
function cb_power_reached(e)
    fprintf("Power: %g W\n", e.power/1000.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 BrickletVoltageCurrent(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	voltageCurrent – Typ: BrickletVoltageCurrent

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

In MATLAB:

import com.tinkerforge.BrickletVoltageCurrent;

voltageCurrent = BrickletVoltageCurrent("YOUR_DEVICE_UID", ipcon);

In Octave:

voltageCurrent = java_new("com.tinkerforge.BrickletVoltageCurrent", "YOUR_DEVICE_UID", ipcon);

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

int BrickletVoltageCurrent.getCurrent()¶

Rückgabe:	current – Typ: int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Gibt die gemessenen Stromstärke zurück.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den CurrentCallback Callback zu nutzen und die Periode mit setCurrentCallbackPeriod() vorzugeben.

int BrickletVoltageCurrent.getVoltage()¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Gibt die gemessenen Spannung zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den VoltageCallback Callback zu nutzen und die Periode mit setVoltageCallbackPeriod() vorzugeben.

int BrickletVoltageCurrent.getPower()¶

Rückgabe:	power – Typ: int, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Gibt die gemessenen Leistung zurück.

Wenn die Leistung periodisch abgefragt werden soll, wird empfohlen den PowerCallback Callback zu nutzen und die Periode mit setPowerCallbackPeriod() vorzugeben.

void BrickletVoltageCurrent.setConfiguration(short averaging, short voltageConversionTime, short currentConversionTime)¶

Parameter:	averaging – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3 voltageConversionTime – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 4 currentConversionTime – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 4

Setzt die Konfiguration des Voltage/Current Bricklet. Es ist möglich die Anzahl für die Durchschnittsbildung, und die Wandlungszeit für Spannung und Stromstärke zu definieren.

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

Für averaging:

BrickletVoltageCurrent.AVERAGING_1 = 0
BrickletVoltageCurrent.AVERAGING_4 = 1
BrickletVoltageCurrent.AVERAGING_16 = 2
BrickletVoltageCurrent.AVERAGING_64 = 3
BrickletVoltageCurrent.AVERAGING_128 = 4
BrickletVoltageCurrent.AVERAGING_256 = 5
BrickletVoltageCurrent.AVERAGING_512 = 6
BrickletVoltageCurrent.AVERAGING_1024 = 7

Für voltageConversionTime:

BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

Für currentConversionTime:

BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

BrickletVoltageCurrent.Configuration BrickletVoltageCurrent.getConfiguration()¶

Rückgabeobjekt:	averaging – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 3 voltageConversionTime – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 4 currentConversionTime – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 4

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

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

Für averaging:

BrickletVoltageCurrent.AVERAGING_1 = 0
BrickletVoltageCurrent.AVERAGING_4 = 1
BrickletVoltageCurrent.AVERAGING_16 = 2
BrickletVoltageCurrent.AVERAGING_64 = 3
BrickletVoltageCurrent.AVERAGING_128 = 4
BrickletVoltageCurrent.AVERAGING_256 = 5
BrickletVoltageCurrent.AVERAGING_512 = 6
BrickletVoltageCurrent.AVERAGING_1024 = 7

Für voltageConversionTime:

BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

Für currentConversionTime:

BrickletVoltageCurrent.CONVERSION_TIME_140US = 0
BrickletVoltageCurrent.CONVERSION_TIME_204US = 1
BrickletVoltageCurrent.CONVERSION_TIME_332US = 2
BrickletVoltageCurrent.CONVERSION_TIME_588US = 3
BrickletVoltageCurrent.CONVERSION_TIME_1_1MS = 4
BrickletVoltageCurrent.CONVERSION_TIME_2_116MS = 5
BrickletVoltageCurrent.CONVERSION_TIME_4_156MS = 6
BrickletVoltageCurrent.CONVERSION_TIME_8_244MS = 7

Fortgeschrittene Funktionen¶

void BrickletVoltageCurrent.setCalibration(int gainMultiplier, int gainDivisor)¶

Parameter:	gainMultiplier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] gainDivisor – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Da der Shunt-Widerstand über den die Stromstärke gemessen wird keine perfekte Genauigkeit hat, ist es nötig einen Multiplikator und einen Divisor zu setzen, falls sehr genaue Messwerte nötig sind.

Zum Beispiel: Wenn eine Messung von 1000mA erwartet wird, das Voltage/Current Bricklet aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden.

BrickletVoltageCurrent.Calibration BrickletVoltageCurrent.getCalibration()¶

Rückgabeobjekt:	gainMultiplier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] gainDivisor – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die Kalibrierung zurück, wie von setCalibration() gesetzt.

BrickletVoltageCurrent.Identity BrickletVoltageCurrent.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 BrickletVoltageCurrent.setCurrentCallbackPeriod(long period)¶

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

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

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

long BrickletVoltageCurrent.getCurrentCallbackPeriod()¶

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

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

void BrickletVoltageCurrent.setVoltageCallbackPeriod(long period)¶

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

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

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

long BrickletVoltageCurrent.getVoltageCallbackPeriod()¶

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

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

void BrickletVoltageCurrent.setPowerCallbackPeriod(long period)¶

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

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

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

long BrickletVoltageCurrent.getPowerCallbackPeriod()¶

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

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

void BrickletVoltageCurrent.setCurrentCallbackThreshold(char option, int min, int max)¶

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

Setzt den Schwellwert für den CurrentReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

BrickletVoltageCurrent.CurrentCallbackThreshold BrickletVoltageCurrent.getCurrentCallbackThreshold()¶

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

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

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

Für option:

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

void BrickletVoltageCurrent.setVoltageCallbackThreshold(char option, int min, int max)¶

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

Setzt den Schwellwert für den VoltageReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

BrickletVoltageCurrent.VoltageCallbackThreshold BrickletVoltageCurrent.getVoltageCallbackThreshold()¶

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

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

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

Für option:

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

void BrickletVoltageCurrent.setPowerCallbackThreshold(char option, int min, int max)¶

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

Setzt den Schwellwert für den PowerReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

BrickletVoltageCurrent.PowerCallbackThreshold BrickletVoltageCurrent.getPowerCallbackThreshold()¶

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

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

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

Für option:

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

void BrickletVoltageCurrent.setDebouncePeriod(long debounce)¶

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

Setzt die Periode mit welcher die Schwellwert Callbacks

CurrentReachedCallback,
VoltageReachedCallback,
PowerReachedCallback

ausgelöst werden, wenn die Schwellwerte

setCurrentCallbackThreshold(),
setVoltageCallbackThreshold(),
setPowerCallbackThreshold()

weiterhin erreicht bleiben.

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

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 BrickletVoltageCurrent.CurrentCallback¶

Event-Objekt:	current – Typ: int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Dieser Callback wird mit der Periode, wie gesetzt mit setCurrentCallbackPeriod(), ausgelöst. Der Parameter ist die Stromstärke des Sensors.

Der CurrentCallback Callback wird nur ausgelöst, wenn sich die Stromstärke 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 addCurrentCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeCurrentCallback() wieder entfernt werden.

callback BrickletVoltageCurrent.VoltageCallback¶

Event-Objekt:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

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

Der VoltageCallback Callback wird nur ausgelöst, wenn sich die Spannung 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 addVoltageCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeVoltageCallback() wieder entfernt werden.

callback BrickletVoltageCurrent.PowerCallback¶

Event-Objekt:	power – Typ: int, Einheit: 1 mW, Wertebereich: [0 bis 720000]

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

Der PowerCallback Callback wird nur ausgelöst, wenn sich die Leistung 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 addPowerCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removePowerCallback() wieder entfernt werden.

callback BrickletVoltageCurrent.CurrentReachedCallback¶

Event-Objekt:	current – Typ: int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setCurrentCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Stromstärke 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 addCurrentReachedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeCurrentReachedCallback() wieder entfernt werden.

callback BrickletVoltageCurrent.VoltageReachedCallback¶

Event-Objekt:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

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

callback BrickletVoltageCurrent.PowerReachedCallback¶

Event-Objekt:	power – Typ: int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setPowerCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Spannung 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 addPowerReachedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removePowerReachedCallback() 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[] BrickletVoltageCurrent.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 BrickletVoltageCurrent.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:

BrickletVoltageCurrent.FUNCTION_SET_CONFIGURATION = 4
BrickletVoltageCurrent.FUNCTION_SET_CALIBRATION = 6
BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
BrickletVoltageCurrent.FUNCTION_SET_DEBOUNCE_PERIOD = 20

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

BrickletVoltageCurrent.FUNCTION_SET_CONFIGURATION = 4
BrickletVoltageCurrent.FUNCTION_SET_CALIBRATION = 6
BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
BrickletVoltageCurrent.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
BrickletVoltageCurrent.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
BrickletVoltageCurrent.FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
BrickletVoltageCurrent.FUNCTION_SET_DEBOUNCE_PERIOD = 20

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

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