Deutsch
English
Menu
Software / API Bindings / Java / API Reference and Examples / Bricklets / Industrial Dual AC In Bricklet

Java - Industrial Dual AC In Bricklet

This is the description of the Java API bindings for the Industrial Dual AC In Bricklet. General information and technical specifications for the Industrial Dual AC In Bricklet are summarized in its hardware description.

An installation guide for the Java API bindings is part of their general description.

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

Creates an object with the unique device ID uid:

BrickletIndustrialDualACIn industrialDualACIn = new BrickletIndustrialDualACIn("YOUR_DEVICE_UID", ipcon);

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

boolean[] BrickletIndustrialDualACIn.getValue()
Returns:
  • value – Type: boolean[], Length: 2

Returns the input values as bools, true refers to "AC voltage detected" and false refers to no "AC voltage detected".

void BrickletIndustrialDualACIn.setChannelLEDConfig(int channel, int config)
Parameters:
  • channel – Type: int, Range: See constants
  • 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 channel:

  • BrickletIndustrialDualACIn.CHANNEL_0 = 0
  • BrickletIndustrialDualACIn.CHANNEL_1 = 1

For config:

  • BrickletIndustrialDualACIn.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDualACIn.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDualACIn.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDualACIn.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
int BrickletIndustrialDualACIn.getChannelLEDConfig(int channel)
Parameters:
  • channel – Type: int, Range: See constants
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 channel:

  • BrickletIndustrialDualACIn.CHANNEL_0 = 0
  • BrickletIndustrialDualACIn.CHANNEL_1 = 1

For config:

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

Advanced Functions

BrickletIndustrialDualACIn.SPITFPErrorCount BrickletIndustrialDualACIn.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 BrickletIndustrialDualACIn.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:

  • BrickletIndustrialDualACIn.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDualACIn.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDualACIn.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDualACIn.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialDualACIn.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:

  • BrickletIndustrialDualACIn.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDualACIn.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDualACIn.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDualACIn.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialDualACIn.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 BrickletIndustrialDualACIn.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!

BrickletIndustrialDualACIn.Identity BrickletIndustrialDualACIn.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 BrickletIndustrialDualACIn.setValueCallbackConfiguration(int channel, long period, boolean valueHasToChange)
Parameters:
  • channel – Type: int, Range: See constants
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

This listener can be configured per channel.

The period 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 following constants are available for this function:

For channel:

  • BrickletIndustrialDualACIn.CHANNEL_0 = 0
  • BrickletIndustrialDualACIn.CHANNEL_1 = 1
BrickletIndustrialDualACIn.ValueCallbackConfiguration BrickletIndustrialDualACIn.getValueCallbackConfiguration(int channel)
Parameters:
  • channel – Type: int, Range: See constants
Return Object:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

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

The following constants are available for this function:

For channel:

  • BrickletIndustrialDualACIn.CHANNEL_0 = 0
  • BrickletIndustrialDualACIn.CHANNEL_1 = 1
void BrickletIndustrialDualACIn.setAllValueCallbackConfiguration(long period, boolean valueHasToChange)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

The period 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.

BrickletIndustrialDualACIn.AllValueCallbackConfiguration BrickletIndustrialDualACIn.getAllValueCallbackConfiguration()
Return Object:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

Returns the listener configuration as set by setAllValueCallbackConfiguration().

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

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

void value(int channel, boolean changed, boolean value)
Parameters:
  • channel – Type: int, Range: See constants
  • changed – Type: boolean
  • value – Type: boolean

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:

For channel:

  • BrickletIndustrialDualACIn.CHANNEL_0 = 0
  • BrickletIndustrialDualACIn.CHANNEL_1 = 1
class BrickletIndustrialDualACIn.AllValueListener()

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

void allValue(boolean[] changed, boolean[] value)
Parameters:
  • changed – Type: boolean[], Length: 2
  • value – Type: boolean[], Length: 2

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.

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

  • BrickletIndustrialDualACIn.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDualACIn.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BrickletIndustrialDualACIn.FUNCTION_SET_CHANNEL_LED_CONFIG = 6
  • BrickletIndustrialDualACIn.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDualACIn.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDualACIn.FUNCTION_RESET = 243
  • BrickletIndustrialDualACIn.FUNCTION_WRITE_UID = 248
void BrickletIndustrialDualACIn.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:

  • BrickletIndustrialDualACIn.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDualACIn.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BrickletIndustrialDualACIn.FUNCTION_SET_CHANNEL_LED_CONFIG = 6
  • BrickletIndustrialDualACIn.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDualACIn.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDualACIn.FUNCTION_RESET = 243
  • BrickletIndustrialDualACIn.FUNCTION_WRITE_UID = 248
void BrickletIndustrialDualACIn.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 BrickletIndustrialDualACIn.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:

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

For status:

  • BrickletIndustrialDualACIn.BOOTLOADER_STATUS_OK = 0
  • BrickletIndustrialDualACIn.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIndustrialDualACIn.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIndustrialDualACIn.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIndustrialDualACIn.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIndustrialDualACIn.BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletIndustrialDualACIn.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:

  • BrickletIndustrialDualACIn.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDualACIn.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDualACIn.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDualACIn.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDualACIn.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletIndustrialDualACIn.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 BrickletIndustrialDualACIn.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 BrickletIndustrialDualACIn.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 BrickletIndustrialDualACIn.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 BrickletIndustrialDualACIn.DEVICE_IDENTIFIER

This constant is used to identify a Industrial Dual AC In 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 BrickletIndustrialDualACIn.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Dual AC In Bricklet.