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

Java - Voltage/Current Bricklet¶

This is the description of the Java 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 Java API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.0).

Simple¶

Download (ExampleSimple.java)

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletVoltageCurrent;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Voltage/Current Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletVoltageCurrent vc = new BrickletVoltageCurrent(UID, ipcon); // Create device object

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

        // Get current voltage
        int voltage = vc.getVoltage(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Voltage: " + voltage/1000.0 + " V");

        // Get current current
        int current = vc.getCurrent(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Current: " + current/1000.0 + " A");

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Callback¶

Download (ExampleCallback.java)

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletVoltageCurrent;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Voltage/Current Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletVoltageCurrent vc = new BrickletVoltageCurrent(UID, ipcon); // Create device object

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

        // Add current listener
        vc.addCurrentListener(new BrickletVoltageCurrent.CurrentListener() {
            public void current(int current) {
                System.out.println("Current: " + current/1000.0 + " A");
            }
        });

        // 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);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Threshold¶

Download (ExampleThreshold.java)

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletVoltageCurrent;

public class ExampleThreshold {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Voltage/Current Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletVoltageCurrent vc = new 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);

        // Add power reached listener
        vc.addPowerReachedListener(new BrickletVoltageCurrent.PowerReachedListener() {
            public void powerReached(int power) {
                System.out.println("Power: " + power/1000.0 + " W");
            }
        });

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

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

API¶

Generally, every method of the Java 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 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:

BrickletVoltageCurrent voltageCurrent = new 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 CurrentListener listener 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 VoltageListener listener 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 PowerListener listener 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 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: 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

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

firmwareVersion – Type: short[], Length: 3

0: major – Type: short, Range: [0 to 255]
1: minor – Type: short, Range: [0 to 255]
2: 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.

Listener 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 CurrentListener listener is triggered periodically. A value of 0 turns the listener off.

The CurrentListener listener 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 VoltageListener listener is triggered periodically. A value of 0 turns the listener off.

The VoltageListener listener 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 PowerListener listener is triggered periodically. A value of 0 turns the listener off.

The PowerListener listener 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 CurrentReachedListener listener.

The following options are possible:

Option	Description
'x'	Listener is turned off
'o'	Listener is triggered when the current is outside the min and max values
'i'	Listener is triggered when the current is inside the min and max values
'<'	Listener is triggered when the current is smaller than the min value (max is ignored)
'>'	Listener 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 VoltageReachedListener listener.

The following options are possible:

Option	Description
'x'	Listener is turned off
'o'	Listener is triggered when the voltage is outside the min and max values
'i'	Listener is triggered when the voltage is inside the min and max values
'<'	Listener is triggered when the voltage is smaller than the min value (max is ignored)
'>'	Listener 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 PowerReachedListener listener.

The following options are possible:

Option	Description
'x'	Listener is turned off
'o'	Listener is triggered when the power is outside the min and max values
'i'	Listener is triggered when the power is inside the min and max values
'<'	Listener is triggered when the power is smaller than the min value (max is ignored)
'>'	Listener 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 listeners

CurrentReachedListener,
VoltageReachedListener,
PowerReachedListener

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().

Listeners¶

Listeners can be registered to receive time critical or recurring data from the device. The registration is done with add*Listener() functions of the device object.

The parameter is a listener class object, for example:

device.addExampleListener(new BrickletVoltageCurrent.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

The available listener classes with inherent methods to be overwritten are described below. It is possible to add several listeners and to remove them with the corresponding remove*Listener() function.

Note

Using listeners 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.

class BrickletVoltageCurrent.CurrentListener()¶

This listener can be added with the addCurrentListener() function. An added listener can be removed with the removeCurrentListener() function.

void current(int current)

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

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

The CurrentListener listener is only triggered if the current has changed since the last triggering.

class BrickletVoltageCurrent.VoltageListener()¶

This listener can be added with the addVoltageListener() function. An added listener can be removed with the removeVoltageListener() function.

void voltage(int voltage)

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

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

The VoltageListener listener is only triggered if the voltage has changed since the last triggering.

class BrickletVoltageCurrent.PowerListener()¶

This listener can be added with the addPowerListener() function. An added listener can be removed with the removePowerListener() function.

void power(int power)

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

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

The PowerListener listener is only triggered if the power has changed since the last triggering.

class BrickletVoltageCurrent.CurrentReachedListener()¶

This listener can be added with the addCurrentReachedListener() function. An added listener can be removed with the removeCurrentReachedListener() function.

void currentReached(int current)

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

This listener 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 listener is triggered periodically with the period as set by setDebouncePeriod().

class BrickletVoltageCurrent.VoltageReachedListener()¶

This listener can be added with the addVoltageReachedListener() function. An added listener can be removed with the removeVoltageReachedListener() function.

void voltageReached(int voltage)

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

This listener 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 listener is triggered periodically with the period as set by setDebouncePeriod().

class BrickletVoltageCurrent.PowerReachedListener()¶

This listener can be added with the addPowerReachedListener() function. An added listener can be removed with the removePowerReachedListener() function.

void powerReached(int power)

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

This listener 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 listener is triggered periodically with the period as set by setDebouncePeriod().

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 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: 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 listener 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 listener 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 listener 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.EnumerateListener listener 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.