Java - Industrial Dual 0-20mA Bricklet¶

Simple¶

Download (ExampleSimple.java)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDual020mA;

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

    // Change XYZ to the UID of your Industrial Dual 0-20mA 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
        BrickletIndustrialDual020mA id020 =
          new BrickletIndustrialDual020mA(UID, ipcon); // Create device object

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

        // Get current current from sensor 1
        int current = id020.getCurrent((short)1); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Current (Sensor 1): " + current/1000000.0 + " mA");

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

Callback¶

Download (ExampleCallback.java)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDual020mA;

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

    // Change XYZ to the UID of your Industrial Dual 0-20mA 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
        BrickletIndustrialDual020mA id020 =
          new BrickletIndustrialDual020mA(UID, ipcon); // Create device object

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

        // Add current listener
        id020.addCurrentListener(new BrickletIndustrialDual020mA.CurrentListener() {
            public void current(short sensor, int current) {
                System.out.println("Sensor: " + sensor);
                System.out.println("Current: " + current/1000000.0 + " mA");
                System.out.println("");
            }
        });

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

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

Threshold¶

Download (ExampleThreshold.java)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDual020mA;

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

    // Change XYZ to the UID of your Industrial Dual 0-20mA 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
        BrickletIndustrialDual020mA id020 =
          new BrickletIndustrialDual020mA(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)
        id020.setDebouncePeriod(10000);

        // Add current reached listener
        id020.addCurrentReachedListener(new BrickletIndustrialDual020mA.CurrentReachedListener() {
            public void currentReached(short sensor, int current) {
                System.out.println("Sensor: " + sensor);
                System.out.println("Current: " + current/1000000.0 + " mA");
                System.out.println("");
            }
        });

        // Configure threshold for current (sensor 1) "greater than 10 mA"
        id020.setCurrentCallbackThreshold((short)1, '>', 10*1000000, 0);

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

Basic Functions¶

class BrickletIndustrialDual020mA(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	industrialDual020mA – Type: BrickletIndustrialDual020mA

Creates an object with the unique device ID uid:

BrickletIndustrialDual020mA industrialDual020mA = new BrickletIndustrialDual020mA("YOUR_DEVICE_UID", ipcon);

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

int BrickletIndustrialDual020mA.getCurrent(short sensor)¶

Parameters:	sensor – Type: short, Range: [0 to 1]
Returns:	current – Type: int, Unit: 1 nA, Range: [0 to 22505322]

Returns the current of the specified sensor.

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works properly.

If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.

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

Advanced Functions¶

void BrickletIndustrialDual020mA.setSampleRate(short rate)¶

Parameters:	rate – Type: short, Range: See constants, Default: 3

Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.

Value	Description
0	240 samples per second, 12 bit resolution
1	60 samples per second, 14 bit resolution
2	15 samples per second, 16 bit resolution
3	4 samples per second, 18 bit resolution

The following constants are available for this function:

For rate:

• BrickletIndustrialDual020mA.SAMPLE_RATE_240_SPS = 0
• BrickletIndustrialDual020mA.SAMPLE_RATE_60_SPS = 1
• BrickletIndustrialDual020mA.SAMPLE_RATE_15_SPS = 2
• BrickletIndustrialDual020mA.SAMPLE_RATE_4_SPS = 3

short BrickletIndustrialDual020mA.getSampleRate()¶

Returns:	rate – Type: short, Range: See constants, Default: 3

Returns the sample rate as set by setSampleRate().

The following constants are available for this function:

For rate:

• BrickletIndustrialDual020mA.SAMPLE_RATE_240_SPS = 0
• BrickletIndustrialDual020mA.SAMPLE_RATE_60_SPS = 1
• BrickletIndustrialDual020mA.SAMPLE_RATE_15_SPS = 2
• BrickletIndustrialDual020mA.SAMPLE_RATE_4_SPS = 3

BrickletIndustrialDual020mA.Identity BrickletIndustrialDual020mA.getIdentity()¶

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 216 - 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 BrickletIndustrialDual020mA.setCurrentCallbackPeriod(short sensor, long period)¶

Parameters:	sensor – Type: short, Range: [0 to 1] period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the CurrentListener listener is triggered periodically for the given sensor. A value of 0 turns the listener off.

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

long BrickletIndustrialDual020mA.getCurrentCallbackPeriod(short sensor)¶

Parameters:	sensor – Type: short, Range: [0 to 1]
Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setCurrentCallbackPeriod().

void BrickletIndustrialDual020mA.setCurrentCallbackThreshold(short sensor, char option, int min, int max)¶

Parameters:	sensor – Type: short, Range: [0 to 1] option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0

Sets the thresholds for the CurrentReachedListener listener for the given sensor.

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:

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

BrickletIndustrialDual020mA.CurrentCallbackThreshold BrickletIndustrialDual020mA.getCurrentCallbackThreshold(short sensor)¶

Parameters:	sensor – Type: short, Range: [0 to 1]
Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0 max – Type: int, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by setCurrentCallbackThreshold().

The following constants are available for this function:

For option:

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

void BrickletIndustrialDual020mA.setDebouncePeriod(long debounce)¶

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

Sets the period with which the threshold listener

• CurrentReachedListener

is triggered, if the threshold

• setCurrentCallbackThreshold()

keeps being reached.

long BrickletIndustrialDual020mA.getDebouncePeriod()¶

Returns:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 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 BrickletIndustrialDual020mA.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.

class BrickletIndustrialDual020mA.CurrentListener()¶

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

void current(short sensor, int current)

Parameters:	sensor – Type: short, Range: [0 to 1] current – Type: int, Unit: 1 nA, Range: [0 to 22505322]

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 BrickletIndustrialDual020mA.CurrentReachedListener()¶

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

void currentReached(short sensor, int current)

Parameters:	sensor – Type: short, Range: [0 to 1] current – Type: int, Unit: 1 nA, Range: [0 to 22505322]

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

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[] BrickletIndustrialDual020mA.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 BrickletIndustrialDual020mA.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:

• BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
• BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
• BrickletIndustrialDual020mA.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletIndustrialDual020mA.FUNCTION_SET_SAMPLE_RATE = 8

void BrickletIndustrialDual020mA.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.

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:

• BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
• BrickletIndustrialDual020mA.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
• BrickletIndustrialDual020mA.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletIndustrialDual020mA.FUNCTION_SET_SAMPLE_RATE = 8

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

This constant is used to identify a Industrial Dual 0-20mA 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 BrickletIndustrialDual020mA.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Industrial Dual 0-20mA Bricklet.