Software / API Bindings / MATLAB/Octave / API Reference and Examples / Bricklets / Industrial Dual Analog In Bricklet 2.0

MATLAB/Octave - Industrial Dual Analog In Bricklet 2.0¶

This is the description of the MATLAB/Octave API bindings for the Industrial Dual Analog In Bricklet 2.0. General information and technical specifications for the Industrial Dual Analog In Bricklet 2.0 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.BrickletIndustrialDualAnalogInV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Industrial Dual Analog In Bricklet 2.0

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

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

    % Get current voltage from channel 0
    voltage = idai.getVoltage(0);
    fprintf('Voltage (Channel 0): %g V\n', voltage/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.BrickletIndustrialDualAnalogInV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Industrial Dual Analog In Bricklet 2.0

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

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

    % Register voltage callback to function cb_voltage
    set(idai, 'VoltageCallback', @(h, e) cb_voltage(e));

    % Set period for voltage (channel 0) callback to 1s (1000ms) without a threshold
    idai.setVoltageCallbackConfiguration(0, 1000, false, 'x', 0, 0);

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

% Callback function for voltage callback
function cb_voltage(e)
    fprintf('Channel: %i\n', e.channel);
    fprintf('Voltage: %g V\n', e.voltage/1000.0);
    fprintf('\n');
end

Threshold (MATLAB)¶

Download (matlab_example_threshold.m)

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

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Industrial Dual Analog In Bricklet 2.0

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

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

    % Register voltage callback to function cb_voltage
    set(idai, 'VoltageCallback', @(h, e) cb_voltage(e));

    % Configure threshold for voltage (channel 0) "greater than 10 V"
    % with a debounce period of 10s (10000ms)
    idai.setVoltageCallbackConfiguration(0, 10000, false, '>', 10*1000, 0);

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

% Callback function for voltage callback
function cb_voltage(e)
    fprintf('Channel: %i\n', e.channel);
    fprintf('Voltage: %g V\n', e.voltage/1000.0);
    fprintf('\n');
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 Industrial Dual Analog In Bricklet 2.0

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

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

    % Get current voltage from channel 0
    voltage = idai.getVoltage(0);
    fprintf("Voltage (Channel 0): %g V\n", voltage/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 Industrial Dual Analog In Bricklet 2.0

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

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

    % Register voltage callback to function cb_voltage
    idai.addVoltageCallback(@cb_voltage);

    % Set period for voltage (channel 0) callback to 1s (1000ms) without a threshold
    idai.setVoltageCallbackConfiguration(0, 1000, false, "x", 0, 0);

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

% Callback function for voltage callback
function cb_voltage(e)
    fprintf("Channel: %d\n", e.channel);
    fprintf("Voltage: %g V\n", e.voltage/1000.0);
    fprintf("\n");
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 Industrial Dual Analog In Bricklet 2.0

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

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

    % Register voltage callback to function cb_voltage
    idai.addVoltageCallback(@cb_voltage);

    % Configure threshold for voltage (channel 0) "greater than 10 V"
    % with a debounce period of 10s (10000ms)
    idai.setVoltageCallbackConfiguration(0, 10000, false, ">", 10*1000, 0);

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

% Callback function for voltage callback
function cb_voltage(e)
    fprintf("Channel: %d\n", e.channel);
    fprintf("Voltage: %g V\n", e.voltage/1000.0);
    fprintf("\n");
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.

The Bricklet has two input channel. Functions that are related directly to a channel have a channel parameter to specify one of the two channels. Valid values for the channel parameter are 0 and 1.

Basic Functions¶

class BrickletIndustrialDualAnalogInV2(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	industrialDualAnalogInV2 – Type: BrickletIndustrialDualAnalogInV2

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletIndustrialDualAnalogInV2;

industrialDualAnalogInV2 = BrickletIndustrialDualAnalogInV2('YOUR_DEVICE_UID', ipcon);

In Octave:

industrialDualAnalogInV2 = java_new("com.tinkerforge.BrickletIndustrialDualAnalogInV2", "YOUR_DEVICE_UID", ipcon);

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

int BrickletIndustrialDualAnalogInV2.getVoltage(int channel)¶

Parameters:	channel – Type: int, Range: [0 to 1]
Returns:	voltage – Type: int, Unit: 1 mV, Range: [-35000 to 35000]

Returns the voltage for the given channel.

If you want to get the value periodically, it is recommended to use the VoltageCallback callback. You can set the callback configuration with setVoltageCallbackConfiguration().

void BrickletIndustrialDualAnalogInV2.setChannelLEDConfig(int channel, int config)¶

Parameters:	channel – Type: int, Range: [0 to 1] config – Type: int, Range: See constants, Default: 3

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value.

You can configure the channel status behavior with setChannelLEDStatusConfig().

By default all channel LEDs are configured as "Channel Status".

The following constants are available for this function:

For config:

BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_OFF = 0
BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_ON = 1
BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int BrickletIndustrialDualAnalogInV2.getChannelLEDConfig(int channel)¶

Parameters:	channel – Type: int, Range: [0 to 1]
Returns:	config – Type: int, Range: See constants, Default: 3

Returns the channel LED configuration as set by setChannelLEDConfig()

The following constants are available for this function:

For config:

BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_OFF = 0
BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_ON = 1
BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

void BrickletIndustrialDualAnalogInV2.setChannelLEDStatusConfig(int channel, int min, int max, int config)¶

Parameters:	channel – Type: int, Range: [0 to 1] 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: 10000 config – Type: int, Range: See constants, Default: 1

Sets the channel LED status config. This config is used if the channel LED is configured as "Channel Status", see setChannelLEDConfig().

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the "min" parameter to the threshold value in mV above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 10V, the LED will turn on as soon as the voltage exceeds 10V and turn off again if it goes below 10V. For a negative threshold set the "max" parameter to the threshold value in mV below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 10V, the LED will turn on as soon as the voltage goes below 10V and the LED will turn off when the voltage exceeds 10V.

In intensity mode you can define a range in mV that is used to scale the brightness of the LED. Example with min=4V, max=20V: The LED is off at 4V, on at 20V and the brightness is linearly scaled between the values 4V and 20V. If the min value is greater than the max value, the LED brightness is scaled the other way around.

The following constants are available for this function:

For config:

BrickletIndustrialDualAnalogInV2.CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
BrickletIndustrialDualAnalogInV2.CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

BrickletIndustrialDualAnalogInV2.ChannelLEDStatusConfig BrickletIndustrialDualAnalogInV2.getChannelLEDStatusConfig(int channel)¶

Parameters:	channel – Type: int, Range: [0 to 1]
Return Object:	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: 10000 config – Type: int, Range: See constants, Default: 1

Returns the channel LED status configuration as set by setChannelLEDStatusConfig().

The following constants are available for this function:

For config:

BrickletIndustrialDualAnalogInV2.CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
BrickletIndustrialDualAnalogInV2.CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Advanced Functions¶

void BrickletIndustrialDualAnalogInV2.setSampleRate(int rate)¶

Parameters:	rate – Type: int, Range: See constants, Default: 6

Sets the sample rate. The sample rate can be between 1 sample per second and 976 samples per second. Decreasing the sample rate will also decrease the noise on the data.

The following constants are available for this function:

For rate:

BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_976_SPS = 0
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_488_SPS = 1
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_244_SPS = 2
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_122_SPS = 3
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_61_SPS = 4
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_4_SPS = 5
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_2_SPS = 6
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_1_SPS = 7

int BrickletIndustrialDualAnalogInV2.getSampleRate()¶

Returns:	rate – Type: int, Range: See constants, Default: 6

Returns the sample rate as set by setSampleRate().

The following constants are available for this function:

For rate:

BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_976_SPS = 0
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_488_SPS = 1
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_244_SPS = 2
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_122_SPS = 3
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_61_SPS = 4
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_4_SPS = 5
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_2_SPS = 6
BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_1_SPS = 7

void BrickletIndustrialDualAnalogInV2.setCalibration(int[] offset, int[] gain)¶

Parameters:	offset – Type: int[], Length: 2, Range: [-2²³ to 2²³ - 1] gain – Type: int[], Length: 2, Range: [-2²³ to 2²³ - 1]

Sets offset and gain of MCP3911 internal calibration registers.

See MCP3911 datasheet 7.7 and 7.8. The Industrial Dual Analog In Bricklet 2.0 is already factory calibrated by Tinkerforge. It should not be necessary for you to use this function

BrickletIndustrialDualAnalogInV2.Calibration BrickletIndustrialDualAnalogInV2.getCalibration()¶

Return Object:	offset – Type: int[], Length: 2, Range: [-2²³ to 2²³ - 1] gain – Type: int[], Length: 2, Range: [-2²³ to 2²³ - 1]

Returns the calibration as set by setCalibration().

int[] BrickletIndustrialDualAnalogInV2.getADCValues()¶

Returns:	value – Type: int[], Length: 2, Range: [-2²³ to 2²³ - 1]

Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see setCalibration().

int[] BrickletIndustrialDualAnalogInV2.getAllVoltages()¶

Returns:	voltages – Type: int[], Length: 2, Unit: 1 mV, Range: [-35000 to 35000]

Returns the voltages for all channels.

If you want to get the value periodically, it is recommended to use the AllVoltagesCallback callback. You can set the callback configuration with setAllVoltagesCallbackConfiguration().

New in version 2.0.6 (Plugin).

BrickletIndustrialDualAnalogInV2.SPITFPErrorCount BrickletIndustrialDualAnalogInV2.getSPITFPErrorCount()¶

Return Object:	errorCountAckChecksum – Type: long, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: long, Range: [0 to 2³² - 1] errorCountFrame – Type: long, Range: [0 to 2³² - 1] errorCountOverflow – Type: long, Range: [0 to 2³² - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

ACK checksum errors,
message checksum errors,
framing errors and
overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

void BrickletIndustrialDualAnalogInV2.setStatusLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_ON = 1
BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletIndustrialDualAnalogInV2.getStatusLEDConfig()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For config:

BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_OFF = 0
BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_ON = 1
BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletIndustrialDualAnalogInV2.getChipTemperature()¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

void BrickletIndustrialDualAnalogInV2.reset()¶

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletIndustrialDualAnalogInV2.Identity BrickletIndustrialDualAnalogInV2.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 BrickletIndustrialDualAnalogInV2.setVoltageCallbackConfiguration(int channel, long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	channel – Type: int, Range: [0 to 1] period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false 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

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the VoltageCallback callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

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

BrickletIndustrialDualAnalogInV2.VoltageCallbackConfiguration BrickletIndustrialDualAnalogInV2.getVoltageCallbackConfiguration(int channel)¶

Parameters:	channel – Type: int, Range: [0 to 1]
Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false 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 callback configuration as set by setVoltageCallbackConfiguration().

The following constants are available for this function:

For option:

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

void BrickletIndustrialDualAnalogInV2.setAllVoltagesCallbackConfiguration(long period, boolean valueHasToChange)¶

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

The period is the period with which the AllVoltagesCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after at least one of the values has changed. If the values didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

New in version 2.0.6 (Plugin).

BrickletIndustrialDualAnalogInV2.AllVoltagesCallbackConfiguration BrickletIndustrialDualAnalogInV2.getAllVoltagesCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by setAllVoltagesCallbackConfiguration().

New in version 2.0.6 (Plugin).

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 BrickletIndustrialDualAnalogInV2.VoltageCallback¶

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

This callback is triggered periodically according to the configuration set by setVoltageCallbackConfiguration().

The parameter is the same as getVoltage().

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 BrickletIndustrialDualAnalogInV2.AllVoltagesCallback¶

Event Object:	voltages – Type: int[], Length: 2, Unit: 1 mV, Range: [-35000 to 35000]

This callback is triggered periodically according to the configuration set by setAllVoltagesCallbackConfiguration().

The parameters are the same as getAllVoltages().

New in version 2.0.6 (Plugin).

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 addAllVoltagesCallback() function. An added callback function can be removed with the removeAllVoltagesCallback() 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[] BrickletIndustrialDualAnalogInV2.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 BrickletIndustrialDualAnalogInV2.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:

BrickletIndustrialDualAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_SAMPLE_RATE = 5
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CALIBRATION = 7
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CHANNEL_LED_CONFIG = 10
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION = 15
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialDualAnalogInV2.FUNCTION_RESET = 243
BrickletIndustrialDualAnalogInV2.FUNCTION_WRITE_UID = 248

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

BrickletIndustrialDualAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_SAMPLE_RATE = 5
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CALIBRATION = 7
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CHANNEL_LED_CONFIG = 10
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION = 15
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletIndustrialDualAnalogInV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletIndustrialDualAnalogInV2.FUNCTION_RESET = 243
BrickletIndustrialDualAnalogInV2.FUNCTION_WRITE_UID = 248

void BrickletIndustrialDualAnalogInV2.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

int BrickletIndustrialDualAnalogInV2.setBootloaderMode(int mode)¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_OK = 0
BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletIndustrialDualAnalogInV2.getBootloaderMode()¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For mode:

BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletIndustrialDualAnalogInV2.setWriteFirmwarePointer(long pointer)¶

Parameters:	pointer – Type: long, Unit: 1 B, Range: [0 to 2³² - 1]

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int BrickletIndustrialDualAnalogInV2.writeFirmware(int[] data)¶

Parameters:	data – Type: int[], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

void BrickletIndustrialDualAnalogInV2.writeUID(long uid)¶

Parameters:	uid – Type: long, Range: [0 to 2³² - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

long BrickletIndustrialDualAnalogInV2.readUID()¶

Returns:	uid – Type: long, Range: [0 to 2³² - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

int BrickletIndustrialDualAnalogInV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Dual Analog In Bricklet 2.0.

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 BrickletIndustrialDualAnalogInV2.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Dual Analog In Bricklet 2.0.