Deutsch
English
Menu
Software / API Bindings / Java / API Reference and Examples / Bricklets / Industrial Digital Out 4 Bricklet 2.0

Java - Industrial Digital Out 4 Bricklet 2.0

This is the description of the Java API bindings for the Industrial Digital Out 4 Bricklet 2.0. General information and technical specifications for the Industrial Digital Out 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
33
34
35
36
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDigitalOut4V2;

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

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

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

        // Set channels alternating high/low 10 times with 100 ms delay
        for(int i = 0; i < 10; i++) {
            Thread.sleep(100);
            ido4.setValue(new boolean[]{true, false, false, false});
            Thread.sleep(100);
            ido4.setValue(new boolean[]{false, true, false, false});
            Thread.sleep(100);
            ido4.setValue(new boolean[]{false, false, true, false});
            Thread.sleep(100);
            ido4.setValue(new boolean[]{false, false, false, true});
        }

        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 BrickletIndustrialDigitalOut4V2(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • industrialDigitalOut4V2 – Type: BrickletIndustrialDigitalOut4V2

Creates an object with the unique device ID uid:

BrickletIndustrialDigitalOut4V2 industrialDigitalOut4V2 = new BrickletIndustrialDigitalOut4V2("YOUR_DEVICE_UID", ipcon);

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

void BrickletIndustrialDigitalOut4V2.setValue(boolean[] value)
Parameters:
  • value – Type: boolean[], Length: 4

Sets the output value of all four channels. A value of true or false outputs logic 1 or logic 0 respectively on the corresponding channel.

Use setSelectedValue() to change only one output channel state.

All running monoflop timers and PWMs will be aborted if this function is called.

For example: (True, True, False, False) will turn the channels 0-1 high and the channels 2-3 low.

boolean[] BrickletIndustrialDigitalOut4V2.getValue()
Returns:
  • value – Type: boolean[], Length: 4

Returns the logic levels that are currently output on the channels.

void BrickletIndustrialDigitalOut4V2.setSelectedValue(int channel, boolean value)
Parameters:
  • channel – Type: int, Range: [0 to 3]
  • value – Type: boolean

Sets the output value of a specific channel without affecting the other channels.

A running monoflop timer or PWM for the specified channel will be aborted if this function is called.

void BrickletIndustrialDigitalOut4V2.setChannelLEDConfig(int channel, int config)
Parameters:
  • channel – Type: int, Range: [0 to 3]
  • config – Type: int, Range: See constants, Default: 3

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED 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:

For config:

  • BrickletIndustrialDigitalOut4V2.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalOut4V2.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalOut4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalOut4V2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
int BrickletIndustrialDigitalOut4V2.getChannelLEDConfig(int channel)
Parameters:
  • channel – Type: int, Range: [0 to 3]
Returns:
  • config – Type: int, Range: See constants, Default: 3

Returns the channel LED configuration as set by setChannelLEDConfig()

The following constants are available for this function:

For config:

  • BrickletIndustrialDigitalOut4V2.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalOut4V2.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalOut4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalOut4V2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions

void BrickletIndustrialDigitalOut4V2.setMonoflop(int channel, boolean value, long time)
Parameters:
  • channel – Type: int, Range: [0 to 3]
  • value – Type: boolean
  • time – Type: long, Unit: 1 ms, Range: [0 to 232 - 1]

The first parameter is the desired state of the channel (true means output high and false means output low). The second parameter indicates the time that the channel should hold the state.

If this function is called with the parameters (true, 1500): The channel will turn on and in 1.5s it will turn off again.

A PWM for the selected channel will be aborted if this function is called.

A monoflop can be used as a failsafe mechanism. For example: Lets assume you have a RS485 bus and a IO-4 Bricklet is connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The channel will be high all the time. If now the RS485 connection is lost, the channel will turn low in at most two seconds.

BrickletIndustrialDigitalOut4V2.Monoflop BrickletIndustrialDigitalOut4V2.getMonoflop(int channel)
Parameters:
  • channel – Type: int, Range: [0 to 3]
Return Object:
  • value – Type: boolean
  • time – Type: long, Unit: 1 ms, Range: [0 to 232 - 1]
  • timeRemaining – Type: long, Unit: 1 ms, Range: [0 to 232 - 1]

Returns (for the given channel) the current value and the time as set by setMonoflop() as well as the remaining time until the value flips.

If the timer is not running currently, the remaining time will be returned as 0.

void BrickletIndustrialDigitalOut4V2.setPWMConfiguration(int channel, long frequency, int dutyCycle)
Parameters:
  • channel – Type: int, Range: [0 to 3]
  • frequency – Type: long, Unit: 1/10 Hz, Range: [0 to 232 - 1], Default: 0
  • dutyCycle – Type: int, Unit: 1/100 %, Range: [0 to 10000], Default: 0

Activates a PWM for the given channel.

To turn the PWM off again, you can set the frequency to 0 or any other function that changes a value of the channel (e.g. setSelectedValue()).

The optocoupler of the Industrial Digital Out 4 Bricklet 2.0 has a rise time and fall time of 11.5us (each) at 24V. So the maximum useful frequency value is about 400000 (40kHz).

A running monoflop timer for the given channel will be aborted if this function is called.

BrickletIndustrialDigitalOut4V2.PWMConfiguration BrickletIndustrialDigitalOut4V2.getPWMConfiguration(int channel)
Parameters:
  • channel – Type: int, Range: [0 to 3]
Return Object:
  • frequency – Type: long, Unit: 1/10 Hz, Range: [0 to 232 - 1], Default: 0
  • dutyCycle – Type: int, Unit: 1/100 %, Range: [0 to 10000], Default: 0

Returns the PWM configuration as set by setPWMConfiguration().

BrickletIndustrialDigitalOut4V2.SPITFPErrorCount BrickletIndustrialDigitalOut4V2.getSPITFPErrorCount()
Return Object:
  • errorCountAckChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: long, Range: [0 to 232 - 1]

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

The errors are divided into

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

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

void BrickletIndustrialDigitalOut4V2.setStatusLEDConfig(int config)
Parameters:
  • config – Type: int, Range: See constants, Default: 3

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

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

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

The following constants are available for this function:

For config:

  • BrickletIndustrialDigitalOut4V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalOut4V2.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalOut4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalOut4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialDigitalOut4V2.getStatusLEDConfig()
Returns:
  • config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For config:

  • BrickletIndustrialDigitalOut4V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalOut4V2.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalOut4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalOut4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialDigitalOut4V2.getChipTemperature()
Returns:
  • temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

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

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

void BrickletIndustrialDigitalOut4V2.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!

BrickletIndustrialDigitalOut4V2.Identity BrickletIndustrialDigitalOut4V2.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.

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

This listener can be added with the addMonoflopDoneListener() function. An added listener can be removed with the removeMonoflopDoneListener() function.

void monoflopDone(int channel, boolean value)
Parameters:
  • channel – Type: int, Range: [0 to 3]
  • value – Type: boolean

This listener is triggered whenever a monoflop timer reaches 0. The parameters contain the channel and the current value of the channel (the value after the monoflop).

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

  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_VALUE = 1
  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_SELECTED_VALUE = 3
  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_MONOFLOP = 4
  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 7
  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_PWM_CONFIGURATION = 9
  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalOut4V2.FUNCTION_RESET = 243
  • BrickletIndustrialDigitalOut4V2.FUNCTION_WRITE_UID = 248
void BrickletIndustrialDigitalOut4V2.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:

  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_VALUE = 1
  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_SELECTED_VALUE = 3
  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_MONOFLOP = 4
  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 7
  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_PWM_CONFIGURATION = 9
  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalOut4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalOut4V2.FUNCTION_RESET = 243
  • BrickletIndustrialDigitalOut4V2.FUNCTION_WRITE_UID = 248
void BrickletIndustrialDigitalOut4V2.setResponseExpectedAll(boolean responseExpected)
Parameters:
  • responseExpected – Type: boolean

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

Internal Functions

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

int BrickletIndustrialDigitalOut4V2.setBootloaderMode(int mode)
Parameters:
  • mode – Type: int, Range: See constants
Returns:
  • status – Type: int, Range: See constants

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

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

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

The following constants are available for this function:

For mode:

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

For status:

  • BrickletIndustrialDigitalOut4V2.BOOTLOADER_STATUS_OK = 0
  • BrickletIndustrialDigitalOut4V2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIndustrialDigitalOut4V2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIndustrialDigitalOut4V2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIndustrialDigitalOut4V2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIndustrialDigitalOut4V2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletIndustrialDigitalOut4V2.getBootloaderMode()
Returns:
  • mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For mode:

  • BrickletIndustrialDigitalOut4V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDigitalOut4V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDigitalOut4V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDigitalOut4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDigitalOut4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletIndustrialDigitalOut4V2.setWriteFirmwarePointer(long pointer)
Parameters:
  • pointer – Type: long, Unit: 1 B, Range: [0 to 232 - 1]

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

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

int BrickletIndustrialDigitalOut4V2.writeFirmware(int[] data)
Parameters:
  • data – Type: int[], Length: 64, Range: [0 to 255]
Returns:
  • status – Type: int, Range: [0 to 255]

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

You can only write firmware in bootloader mode.

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

void BrickletIndustrialDigitalOut4V2.writeUID(long uid)
Parameters:
  • uid – Type: long, Range: [0 to 232 - 1]

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

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

long BrickletIndustrialDigitalOut4V2.readUID()
Returns:
  • uid – Type: long, Range: [0 to 232 - 1]

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

Constants

int BrickletIndustrialDigitalOut4V2.DEVICE_IDENTIFIER

This constant is used to identify a Industrial Digital Out 4 Bricklet 2.0.

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 BrickletIndustrialDigitalOut4V2.DEVICE_DISPLAY_NAME

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