Software / API Bindings / MATLAB/Octave / API Reference and Examples / Bricklets (Discontinued) / Voltage/Current Bricklet

Current Bricklet¶

This is the description of the MATLAB/Octave API bindings for the Voltage/Current Bricklet. General information and technical specifications for the Voltage/Current Bricklet are summarized in its hardware description.

An installation guide for the MATLAB/Octave API bindings is part of their general description.

Examples¶

The example code below is 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¶

Generally, every method of the MATLAB bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since the MATLAB bindings are based on Java and Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions¶

class BrickletVoltageCurrent(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	voltageCurrent – Type: BrickletVoltageCurrent

Creates an object with the unique device 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);

This object can then be used after the IP Connection is connected.

int BrickletVoltageCurrent.getCurrent()¶

Returns:	current – Type: int, Unit: 1 mA, Range: [-20000 to 20000]

Returns the current.

If you want to get the current periodically, it is recommended to use the CurrentCallback callback and set the period with setCurrentCallbackPeriod().

int BrickletVoltageCurrent.getVoltage()¶

Returns:	voltage – Type: int, Unit: 1 mV, Range: [0 to 36000]

Returns the voltage.

If you want to get the voltage periodically, it is recommended to use the VoltageCallback callback and set the period with setVoltageCallbackPeriod().

int BrickletVoltageCurrent.getPower()¶

Returns:	power – Type: int, Unit: 1 mW, Range: [0 to 720000]

Returns the power.

If you want to get the power periodically, it is recommended to use the PowerCallback callback and set the period with setPowerCallbackPeriod().

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

Parameters:	averaging – Type: short, Range: See constants, Default: 3 voltageConversionTime – Type: short, Range: See constants, Default: 4 currentConversionTime – Type: short, Range: See constants, Default: 4

Sets the configuration of the Voltage/Current Bricklet. It is possible to configure number of averages as well as voltage and current conversion time.

The following constants are available for this function:

For 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

For 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

For 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()¶

Return Object:	averaging – Type: short, Range: See constants, Default: 3 voltageConversionTime – Type: short, Range: See constants, Default: 4 currentConversionTime – Type: short, Range: See constants, Default: 4

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For 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

For 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

For 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

Advanced Functions¶

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

Parameters:	gainMultiplier – Type: int, Range: [0 to 2¹⁶ - 1] gainDivisor – Type: int, Range: [0 to 2¹⁶ - 1]

Since the shunt resistor that is used to measure the current is not perfectly precise, it needs to be calibrated by a multiplier and divisor if a very precise reading is needed.

For example, if you are expecting a measurement of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the multiplier to 1000 and the divisor to 1023.

BrickletVoltageCurrent.Calibration BrickletVoltageCurrent.getCalibration()¶

Return Object:	gainMultiplier – Type: int, Range: [0 to 2¹⁶ - 1] gainDivisor – Type: int, Range: [0 to 2¹⁶ - 1]

Returns the calibration as set by setCalibration().

BrickletVoltageCurrent.Identity BrickletVoltageCurrent.getIdentity()¶

Return Object:

Return Object:	uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connectedUid – Type: String, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardwareVersion – Type: short[], Length: 3

1: major – Type: short, Range: [0 to 255]
2: minor – Type: short, Range: [0 to 255]
3: revision – Type: short, Range: [0 to 255]

firmwareVersion – Type: short[], Length: 3

1: major – Type: short, Range: [0 to 255]
2: minor – Type: short, Range: [0 to 255]
3: revision – Type: short, Range: [0 to 255]

deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

void BrickletVoltageCurrent.setCurrentCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the CurrentCallback callback is triggered periodically. A value of 0 turns the callback off.

The CurrentCallback callback is only triggered if the current has changed since the last triggering.

long BrickletVoltageCurrent.getCurrentCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by setCurrentCallbackPeriod().

void BrickletVoltageCurrent.setVoltageCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the VoltageCallback callback is triggered periodically. A value of 0 turns the callback off.

The VoltageCallback callback is only triggered if the voltage has changed since the last triggering.

long BrickletVoltageCurrent.getVoltageCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by setVoltageCallbackPeriod().

void BrickletVoltageCurrent.setPowerCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the PowerCallback callback is triggered periodically. A value of 0 turns the callback off.

The PowerCallback callback is only triggered if the power has changed since the last triggering.

long BrickletVoltageCurrent.getPowerCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by getPowerCallbackPeriod().

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

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mA, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1 mA, Range: [-2³¹ to 2³¹ - 1], Default: 0

Sets the thresholds for the CurrentReachedCallback callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the current is outside the min and max values
'i'	Callback is triggered when the current is inside the min and max values
'<'	Callback is triggered when the current is smaller than the min value (max is ignored)
'>'	Callback is triggered when the current is greater than the min value (max is ignored)

The following constants are available for this function:

For 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()¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mA, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1 mA, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the threshold as set by setCurrentCallbackThreshold().

The following constants are available for this function:

For 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)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0

Sets the thresholds for the VoltageReachedCallback callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the voltage is outside the min and max values
'i'	Callback is triggered when the voltage is inside the min and max values
'<'	Callback is triggered when the voltage is smaller than the min value (max is ignored)
'>'	Callback is triggered when the voltage is greater than the min value (max is ignored)

The following constants are available for this function:

For 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()¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1 mV, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the threshold as set by setVoltageCallbackThreshold().

The following constants are available for this function:

For 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)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mW, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1 mW, Range: [-2³¹ to 2³¹ - 1], Default: 0

Sets the thresholds for the PowerReachedCallback callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the power is outside the min and max values
'i'	Callback is triggered when the power is inside the min and max values
'<'	Callback is triggered when the power is smaller than the min value (max is ignored)
'>'	Callback is triggered when the power is greater than the min value (max is ignored)

The following constants are available for this function:

For 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()¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mW, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1 mW, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the threshold as set by setPowerCallbackThreshold().

The following constants are available for this function:

For 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)¶

Parameters:	debounce – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Sets the period with which the threshold callbacks

CurrentReachedCallback,
VoltageReachedCallback,
PowerReachedCallback

are triggered, if the thresholds

setCurrentCallbackThreshold(),
setVoltageCallbackThreshold(),
setPowerCallbackThreshold()

keep being reached.

long BrickletVoltageCurrent.getDebouncePeriod()¶

Returns:	debounce – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Returns the debounce period as set by setDebouncePeriod().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

callback BrickletVoltageCurrent.CurrentCallback¶

Event Object:	current – Type: int, Unit: 1 mA, Range: [-20000 to 20000]

This callback is triggered periodically with the period that is set by setCurrentCallbackPeriod(). The parameter is the current of the sensor.

The CurrentCallback callback is only triggered if the current has changed since the last triggering.

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addCurrentCallback() function. An added callback function can be removed with the removeCurrentCallback() function.

callback BrickletVoltageCurrent.VoltageCallback¶

Event Object:	voltage – Type: int, Unit: 1 mV, Range: [0 to 36000]

This callback is triggered periodically with the period that is set by setVoltageCallbackPeriod(). The parameter is the voltage of the sensor.

The VoltageCallback callback is only triggered if the voltage has changed since the last triggering.

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addVoltageCallback() function. An added callback function can be removed with the removeVoltageCallback() function.

callback BrickletVoltageCurrent.PowerCallback¶

Event Object:	power – Type: int, Unit: 1 mW, Range: [0 to 720000]

This callback is triggered periodically with the period that is set by setPowerCallbackPeriod(). The parameter is the power of the sensor.

The PowerCallback callback is only triggered if the power has changed since the last triggering.

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addPowerCallback() function. An added callback function can be removed with the removePowerCallback() function.

callback BrickletVoltageCurrent.CurrentReachedCallback¶

Event Object:	current – Type: int, Unit: 1 mA, Range: [-20000 to 20000]

This callback is triggered when the threshold as set by setCurrentCallbackThreshold() is reached. The parameter is the current of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addCurrentReachedCallback() function. An added callback function can be removed with the removeCurrentReachedCallback() function.

callback BrickletVoltageCurrent.VoltageReachedCallback¶

Event Object:	voltage – Type: int, Unit: 1 mV, Range: [0 to 36000]

This callback is triggered when the threshold as set by setVoltageCallbackThreshold() is reached. The parameter is the voltage of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addVoltageReachedCallback() function. An added callback function can be removed with the removeVoltageReachedCallback() function.

callback BrickletVoltageCurrent.PowerReachedCallback¶

Event Object:	power – Type: int, Unit: 1 mA, Range: [-20000 to 20000]

This callback is triggered when the threshold as set by setPowerCallbackThreshold() is reached. The parameter is the power of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addPowerReachedCallback() function. An added callback function can be removed with the removePowerReachedCallback() function.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

short[] BrickletVoltageCurrent.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

boolean BrickletVoltageCurrent.getResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For 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)¶

Parameters:	responseExpected – Type: boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants¶

int BrickletVoltageCurrent.DEVICE_IDENTIFIER¶

This constant is used to identify a Voltage/Current Bricklet.

The getIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

String BrickletVoltageCurrent.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Voltage/Current Bricklet.