Java - Industrial Dual 0-20mA Bricklet 2.0

This is the description of the Java API bindings for the Industrial Dual 0-20mA Bricklet 2.0. General information and technical specifications for the Industrial Dual 0-20mA Bricklet 2.0 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)

 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.BrickletIndustrialDual020mAV2;

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 2.0
    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
        BrickletIndustrialDual020mAV2 id020 =
          new BrickletIndustrialDual020mAV2(UID, ipcon); // Create device object

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

        // Get current current from channel 0
        int current = id020.getCurrent(0); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Current (Channel 0): " + 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDual020mAV2;

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 2.0
    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
        BrickletIndustrialDual020mAV2 id020 =
          new BrickletIndustrialDual020mAV2(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 BrickletIndustrialDual020mAV2.CurrentListener() {
            public void current(int channel, int current) {
                System.out.println("Channel: " + channel);
                System.out.println("Current: " + current/1000000.0 + " mA");
                System.out.println("");
            }
        });

        // Set period for current (channel 0) callback to 1s (1000ms) without a threshold
        id020.setCurrentCallbackConfiguration(0, 1000, false, 'x', 0, 0);

        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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDual020mAV2;

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 2.0
    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
        BrickletIndustrialDual020mAV2 id020 =
          new BrickletIndustrialDual020mAV2(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 BrickletIndustrialDual020mAV2.CurrentListener() {
            public void current(int channel, int current) {
                System.out.println("Channel: " + channel);
                System.out.println("Current: " + current/1000000.0 + " mA");
                System.out.println("");
            }
        });

        // Configure threshold for current (channel 0) "greater than 10 mA"
        // with a debounce period of 10s (10000ms)
        id020.setCurrentCallbackConfiguration(0, 10000, false, '>', 10*1000000, 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

public class BrickletIndustrialDual020mAV2(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

BrickletIndustrialDual020mAV2 industrialDual020mAV2 = new BrickletIndustrialDual020mAV2("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected (see examples above).

public int getCurrent(int channel)

Returns the current of the specified channel. The value is in nA and between 0nA and 22505322nA (22.5mA).

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

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

If you want to get the value periodically, it is recommended to use the CurrentListener listener. You can set the listener configuration with setCurrentCallbackConfiguration().

public void setChannelLEDConfig(int channel, int config)

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:

  • BrickletIndustrialDual020mAV2.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDual020mAV2.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDual020mAV2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDual020mAV2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
public int getChannelLEDConfig(int channel)

Returns the channel LED configuration as set by setChannelLEDConfig()

The following constants are available for this function:

  • BrickletIndustrialDual020mAV2.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDual020mAV2.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDual020mAV2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDual020mAV2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
public void setChannelLEDStatusConfig(int channel, int min, int max, int config)

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 nA above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 10mA, the LED will turn on as soon as the current exceeds 10mA and turn off again if it goes below 10mA. For a negative threshold set the "max" parameter to the threshold value in nA below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 10mA, the LED will turn on as soon as the current goes below 10mA and the LED will turn off when the current exceeds 10mA.

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

By default the channel LED status config is set to intensity with min=4mA and max=20mA.

The following constants are available for this function:

  • BrickletIndustrialDual020mAV2.CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialDual020mAV2.CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1
public BrickletIndustrialDual020mAV2.ChannelLEDStatusConfig getChannelLEDStatusConfig(int channel)

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

The following constants are available for this function:

  • BrickletIndustrialDual020mAV2.CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialDual020mAV2.CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

The returned object has the public member variables int min, int max and int config.

Advanced Functions

public void setSampleRate(int rate)

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 default value is 3 (4 samples per second with 18 bit resolution).

The following constants are available for this function:

  • BrickletIndustrialDual020mAV2.SAMPLE_RATE_240_SPS = 0
  • BrickletIndustrialDual020mAV2.SAMPLE_RATE_60_SPS = 1
  • BrickletIndustrialDual020mAV2.SAMPLE_RATE_15_SPS = 2
  • BrickletIndustrialDual020mAV2.SAMPLE_RATE_4_SPS = 3
public int getSampleRate()

Returns the gain as set by setSampleRate().

The following constants are available for this function:

  • BrickletIndustrialDual020mAV2.SAMPLE_RATE_240_SPS = 0
  • BrickletIndustrialDual020mAV2.SAMPLE_RATE_60_SPS = 1
  • BrickletIndustrialDual020mAV2.SAMPLE_RATE_15_SPS = 2
  • BrickletIndustrialDual020mAV2.SAMPLE_RATE_4_SPS = 3
public void setGain(int gain)

Sets a gain between 1x and 8x. If you want to measure a very small current, you can increase the gain to get some more resolution.

Example: If you measure 0.5mA with a gain of 8x the return value will be 4mA.

The default gain is 1x.

The following constants are available for this function:

  • BrickletIndustrialDual020mAV2.GAIN_1X = 0
  • BrickletIndustrialDual020mAV2.GAIN_2X = 1
  • BrickletIndustrialDual020mAV2.GAIN_4X = 2
  • BrickletIndustrialDual020mAV2.GAIN_8X = 3
public int getGain()

Returns the gain as set by setGain().

The following constants are available for this function:

  • BrickletIndustrialDual020mAV2.GAIN_1X = 0
  • BrickletIndustrialDual020mAV2.GAIN_2X = 1
  • BrickletIndustrialDual020mAV2.GAIN_4X = 2
  • BrickletIndustrialDual020mAV2.GAIN_8X = 3
public int[] getAPIVersion()

Returns the version of the API definition (major, minor, revision) 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.

public boolean getResponseExpected(int functionId)

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 send and errors are silently ignored, because they cannot be detected.

See setResponseExpected() for the list of function ID constants available for this function.

public void setResponseExpected(int functionId, boolean responseExpected)

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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletIndustrialDual020mAV2.FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDual020mAV2.FUNCTION_SET_SAMPLE_RATE = 5
  • BrickletIndustrialDual020mAV2.FUNCTION_SET_GAIN = 7
  • BrickletIndustrialDual020mAV2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDual020mAV2.FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 11
  • BrickletIndustrialDual020mAV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDual020mAV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDual020mAV2.FUNCTION_RESET = 243
  • BrickletIndustrialDual020mAV2.FUNCTION_WRITE_UID = 248
public void setResponseExpectedAll(boolean responseExpected)

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

public BrickletIndustrialDual020mAV2.SPITFPErrorCount getSPITFPErrorCount()

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.

The returned object has the public member variables long errorCountAckChecksum, long errorCountMessageChecksum, long errorCountFrame and long errorCountOverflow.

public int setBootloaderMode(int mode)

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:

  • BrickletIndustrialDual020mAV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDual020mAV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDual020mAV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDual020mAV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDual020mAV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletIndustrialDual020mAV2.BOOTLOADER_STATUS_OK = 0
  • BrickletIndustrialDual020mAV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIndustrialDual020mAV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIndustrialDual020mAV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIndustrialDual020mAV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIndustrialDual020mAV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
public int getBootloaderMode()

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletIndustrialDual020mAV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDual020mAV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDual020mAV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDual020mAV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDual020mAV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
public void setWriteFirmwarePointer(long pointer)

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.

public int writeFirmware(int[] data)

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.

public void setStatusLEDConfig(int config)

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:

  • BrickletIndustrialDual020mAV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDual020mAV2.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDual020mAV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDual020mAV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
public int getStatusLEDConfig()

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletIndustrialDual020mAV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDual020mAV2.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDual020mAV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDual020mAV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
public int getChipTemperature()

Returns the temperature in °C 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.

public void 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!

public void writeUID(long uid)

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.

public long readUID()

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

public BrickletIndustrialDual020mAV2.Identity getIdentity()

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' or 'd'.

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

The returned object has the public member variables String uid, String connectedUid, char position, int[] hardwareVersion, int[] firmwareVersion and int deviceIdentifier.

Listener Configuration Functions

public void setCurrentCallbackConfiguration(int channel, long period, boolean valueHasToChange, char option, int min, int max)

The period in ms is the period with which the CurrentListener listener is triggered periodically. A value of 0 turns the listener off.

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

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

It is furthermore possible to constrain the listener with thresholds.

The option-parameter together with min/max sets a threshold for the CurrentListener listener.

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 listener is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDual020mAV2.THRESHOLD_OPTION_GREATER = '>'
public BrickletIndustrialDual020mAV2.CurrentCallbackConfiguration getCurrentCallbackConfiguration(int channel)

Returns the listener configuration as set by setCurrentCallbackConfiguration().

The following constants are available for this function:

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

The returned object has the public member variables long period, boolean valueHasToChange, char option, int min and int max.

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 BrickletIndustrialDual020mAV2.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.

public class BrickletIndustrialDual020mAV2.CurrentListener()

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

public void current(int channel, int current)

This listener is triggered periodically according to the configuration set by setCurrentCallbackConfiguration().

The parameter is the same as getCurrent().

Constants

public static final int BrickletIndustrialDual020mAV2.DEVICE_IDENTIFIER

This constant is used to identify a Industrial Dual 0-20mA Bricklet 2.0.

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

public static final String BrickletIndustrialDual020mAV2.DEVICE_DISPLAY_NAME

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