Java - Industrial Digital In 4 Bricklet 2.0

This is the description of the Java API bindings for the Industrial Digital In 4 Bricklet 2.0. General information and technical specifications for the Industrial Digital In 4 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
29
30
31
32
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDigitalIn4V2;

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

    // Change XYZ to the UID of your Industrial Digital In 4 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
        BrickletIndustrialDigitalIn4V2 idi4 =
          new BrickletIndustrialDigitalIn4V2(UID, ipcon); // Create device object

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

        // Get current value
        boolean[] value = idi4.getValue(); // Can throw com.tinkerforge.TimeoutException

        System.out.println("Channel 0: " + value[0]);
        System.out.println("Channel 1: " + value[1]);
        System.out.println("Channel 2: " + value[2]);
        System.out.println("Channel 3: " + value[3]);

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

Edge Count

Download (ExampleEdgeCount.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.BrickletIndustrialDigitalIn4V2;

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

    // Change XYZ to the UID of your Industrial Digital In 4 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
        BrickletIndustrialDigitalIn4V2 idi4 =
          new BrickletIndustrialDigitalIn4V2(UID, ipcon); // Create device object

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

        // Configure rising edge count (channel 3) with 10ms debounce
        idi4.setEdgeCountConfiguration(3, 0, 10);

        // Get edge count 10 times with 1s delay
        for(int i = 0; i < 10; i++) {
            Thread.sleep(1000);

            // Get current edge count
            long count = idi4.getEdgeCount(3, false); // Can throw com.tinkerforge.TimeoutException
            System.out.println("Count: " + count);
        }

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

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

    // Change XYZ to the UID of your Industrial Digital In 4 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
        BrickletIndustrialDigitalIn4V2 idi4 =
          new BrickletIndustrialDigitalIn4V2(UID, ipcon); // Create device object

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

        // Add value listener
        idi4.addValueListener(new BrickletIndustrialDigitalIn4V2.ValueListener() {
            public void value(int channel, boolean changed, boolean value) {
                System.out.println("Channel: " + channel);
                System.out.println("Changed: " + changed);
                System.out.println("Value: " + value);
                System.out.println("");
            }
        });

        // Set period for value (channel 1) callback to 0.1s (100ms)
        idi4.setValueCallbackConfiguration(1, 100, false);

        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 BrickletIndustrialDigitalIn4V2(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

BrickletIndustrialDigitalIn4V2 industrialDigitalIn4V2 = new BrickletIndustrialDigitalIn4V2("YOUR_DEVICE_UID", ipcon);

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

public boolean[] getValue()

Returns the input value as bools, true refers to high and false refers to low.

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 is on if the channel is high and off otherwise.

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

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.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:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions

public long getEdgeCount(int channel, boolean resetCounter)

Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with setEdgeCountConfiguration().

If you set the reset counter to true, the count is set back to 0 directly after it is read.

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
public void setEdgeCountConfiguration(int channel, int edgeType, int debounce)

Configures the edge counter for a specific channel.

The edge type parameter configures if rising edges, falling edges or both are counted. Possible edge types are:

  • 0 = rising (default)
  • 1 = falling
  • 2 = both

The debounce time is given in ms.

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

Default values: 0 (edge type) and 100ms (debounce time)

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2
public BrickletIndustrialDigitalIn4V2.EdgeCountConfiguration getEdgeCountConfiguration(int channel)

Returns the edge type and debounce time for the selected channel as set by setEdgeCountConfiguration().

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2

The returned object has the public member variables int edgeType and int debounce.

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:

  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalIn4V2.FUNCTION_RESET = 243
  • BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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:

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

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDigitalIn4V2.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:

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

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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 setValueCallbackConfiguration(int channel, long period, boolean valueHasToChange)

This listener can be configured per channel.

The period in ms is the period with which the ValueListener 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.

The default value is (0, false).

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
public BrickletIndustrialDigitalIn4V2.ValueCallbackConfiguration getValueCallbackConfiguration(int channel)

Returns the listener configuration for the given channel as set by setValueCallbackConfiguration().

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

The returned object has the public member variables long period and boolean valueHasToChange.

public void setAllValueCallbackConfiguration(long period, boolean valueHasToChange)

The period in ms is the period with which the AllValueListener 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.

The default value is (0, false).

public BrickletIndustrialDigitalIn4V2.AllValueCallbackConfiguration getAllValueCallbackConfiguration()

Returns the listener configuration as set by setAllValueCallbackConfiguration().

The returned object has the public member variables long period and boolean valueHasToChange.

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

This listener can be added with the addValueListener() function. An added listener can be removed with the removeValueListener() function.

public void value(int channel, boolean changed, boolean value)

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

The parameters are the channel, a value-changed indicator and the actual value for the channel. The changed parameter is true if the value has changed since the last listener.

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
public class BrickletIndustrialDigitalIn4V2.AllValueListener()

This listener can be added with the addAllValueListener() function. An added listener can be removed with the removeAllValueListener() function.

public void allValue(boolean[] changed, boolean[] value)

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

The parameters are the same as getValue(). Additional the changed parameter is true if the value has changed since the last listener.

Constants

public static final int BrickletIndustrialDigitalIn4V2.DEVICE_IDENTIFIER

This constant is used to identify a Industrial Digital In 4 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 BrickletIndustrialDigitalIn4V2.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Digital In 4 Bricklet 2.0.