Software / API Bindings / Java / API Reference and Examples / Bricklets (Discontinued) / Industrial Analog Out Bricklet

Java - Industrial Analog Out Bricklet¶

This is the description of the Java API bindings for the Industrial Analog Out Bricklet. General information and technical specifications for the Industrial Analog Out Bricklet 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 Current¶

Download (ExampleSimpleCurrent.java)

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialAnalogOut;

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

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

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

        // Set output current to 4.5mA
        iao.setCurrent(4500);
        iao.enable();

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

        iao.disable();

        ipcon.disconnect();
    }
}

Simple Voltage¶

Download (ExampleSimpleVoltage.java)

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialAnalogOut;

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

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

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

        // Set output voltage to 3.3V
        iao.setVoltage(3300);
        iao.enable();

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

        iao.disable();

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

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	industrialAnalogOut – Type: BrickletIndustrialAnalogOut

Creates an object with the unique device ID uid:

BrickletIndustrialAnalogOut industrialAnalogOut = new BrickletIndustrialAnalogOut("YOUR_DEVICE_UID", ipcon);

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

void BrickletIndustrialAnalogOut.enable()¶

Enables the output of voltage and current.

The default is disabled.

void BrickletIndustrialAnalogOut.disable()¶

Disables the output of voltage and current.

The default is disabled.

boolean BrickletIndustrialAnalogOut.isEnabled()¶

Returns:	enabled – Type: boolean, Default: false

Returns true if output of voltage and current is enabled, false otherwise.

void BrickletIndustrialAnalogOut.setVoltage(int voltage)¶

Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 10000]

Sets the output voltage.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

int BrickletIndustrialAnalogOut.getVoltage()¶

Returns:	voltage – Type: int, Unit: 1 mV, Range: [0 to 10000]

Returns the voltage as set by setVoltage().

void BrickletIndustrialAnalogOut.setCurrent(int current)¶

Parameters:	current – Type: int, Unit: 1 µA, Range: [0 to 24000]

Sets the output current.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

int BrickletIndustrialAnalogOut.getCurrent()¶

Returns:	current – Type: int, Unit: 1 µA, Range: [0 to 24000]

Returns the current as set by setCurrent().

Advanced Functions¶

void BrickletIndustrialAnalogOut.setConfiguration(short voltageRange, short currentRange)¶

Parameters:	voltageRange – Type: short, Range: See constants, Default: 1 currentRange – Type: short, Range: See constants, Default: 0

Configures the voltage and current range.

Possible voltage ranges are:

0V to 5V
0V to 10V

Possible current ranges are:

4mA to 20mA
0mA to 20mA
0mA to 24mA

The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.

The following constants are available for this function:

For voltageRange:

BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1

For currentRange:

BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2

BrickletIndustrialAnalogOut.Configuration BrickletIndustrialAnalogOut.getConfiguration()¶

Return Object:	voltageRange – Type: short, Range: See constants, Default: 1 currentRange – Type: short, Range: See constants, Default: 0

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For voltageRange:

BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1

For currentRange:

BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2

BrickletIndustrialAnalogOut.Identity BrickletIndustrialAnalogOut.getIdentity()¶

Return Object:

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 2¹⁶ - 1]

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 2¹⁶ - 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.

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

BrickletIndustrialAnalogOut.FUNCTION_ENABLE = 1
BrickletIndustrialAnalogOut.FUNCTION_DISABLE = 2
BrickletIndustrialAnalogOut.FUNCTION_SET_VOLTAGE = 4
BrickletIndustrialAnalogOut.FUNCTION_SET_CURRENT = 6
BrickletIndustrialAnalogOut.FUNCTION_SET_CONFIGURATION = 8

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

The following constants are available for this function:

For functionId:

BrickletIndustrialAnalogOut.FUNCTION_ENABLE = 1
BrickletIndustrialAnalogOut.FUNCTION_DISABLE = 2
BrickletIndustrialAnalogOut.FUNCTION_SET_VOLTAGE = 4
BrickletIndustrialAnalogOut.FUNCTION_SET_CURRENT = 6
BrickletIndustrialAnalogOut.FUNCTION_SET_CONFIGURATION = 8

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

This constant is used to identify a Industrial Analog Out 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 BrickletIndustrialAnalogOut.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Analog Out Bricklet.