Java - Industrial Analog Out Bricklet 2.0¶

Simple Current¶

Download (ExampleSimpleCurrent.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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialAnalogOutV2;

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 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
        BrickletIndustrialAnalogOutV2 iao =
          new BrickletIndustrialAnalogOutV2(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.setEnabled(true);

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

        iao.setEnabled(false);

        ipcon.disconnect();
    }
}

Simple Voltage¶

Download (ExampleSimpleVoltage.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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialAnalogOutV2;

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 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
        BrickletIndustrialAnalogOutV2 iao =
          new BrickletIndustrialAnalogOutV2(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.setEnabled(true);

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

        iao.setEnabled(false);

        ipcon.disconnect();
    }
}

Basic Functions¶

class BrickletIndustrialAnalogOutV2(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	industrialAnalogOutV2 – Type: BrickletIndustrialAnalogOutV2

Creates an object with the unique device ID uid:

BrickletIndustrialAnalogOutV2 industrialAnalogOutV2 = new BrickletIndustrialAnalogOutV2("YOUR_DEVICE_UID", ipcon);

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

void BrickletIndustrialAnalogOutV2.setEnabled(boolean enabled)¶

Parameters:	enabled – Type: boolean, Default: false

Enables/disables the output of voltage and current.

boolean BrickletIndustrialAnalogOutV2.getEnabled()¶

Returns:	enabled – Type: boolean, Default: false

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

void BrickletIndustrialAnalogOutV2.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 BrickletIndustrialAnalogOutV2.getVoltage()¶

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

Returns the voltage as set by setVoltage().

void BrickletIndustrialAnalogOutV2.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 BrickletIndustrialAnalogOutV2.getCurrent()¶

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

Returns the current as set by setCurrent().

void BrickletIndustrialAnalogOutV2.setOutLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

You can turn the Out LED off, on or show a heartbeat. You can also set the LED to "Out 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 output value (voltage or current).

You can configure the channel status behavior with setOutLEDStatusConfig().

The following constants are available for this function:

For config:

• BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_OFF = 0
• BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_ON = 1
• BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_OUT_STATUS = 3

int BrickletIndustrialAnalogOutV2.getOutLEDConfig()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the Out LED configuration as set by setOutLEDConfig()

The following constants are available for this function:

For config:

• BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_OFF = 0
• BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_ON = 1
• BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialAnalogOutV2.OUT_LED_CONFIG_SHOW_OUT_STATUS = 3

void BrickletIndustrialAnalogOutV2.setOutLEDStatusConfig(int min, int max, int config)¶

Parameters:	min – Type: int, Range: [0 to 24000], Default: 0 max – Type: int, Range: [0 to 24000], Default: 10000 config – Type: int, Range: See constants, Default: 1

Sets the Out LED status config. This config is used if the Out LED is configured as "Out Status", see setOutLEDConfig().

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

In intensity mode you can define a range mV or µA that is used to scale the brightness of the LED. Example with min=2V, max=8V: The LED is off at 2V and below, on at 8V and above and the brightness is linearly scaled between the values 2V and 8V. If the min value is greater than the max value, the LED brightness is scaled the other way around.

The following constants are available for this function:

For config:

• BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_THRESHOLD = 0
• BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_INTENSITY = 1

BrickletIndustrialAnalogOutV2.OutLEDStatusConfig BrickletIndustrialAnalogOutV2.getOutLEDStatusConfig()¶

Return Object:	min – Type: int, Range: [0 to 24000], Default: 0 max – Type: int, Range: [0 to 24000], Default: 10000 config – Type: int, Range: See constants, Default: 1

Returns the Out LED status configuration as set by setOutLEDStatusConfig().

The following constants are available for this function:

For config:

• BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_THRESHOLD = 0
• BrickletIndustrialAnalogOutV2.OUT_LED_STATUS_CONFIG_INTENSITY = 1

Advanced Functions¶

void BrickletIndustrialAnalogOutV2.setConfiguration(int voltageRange, int currentRange)¶

Parameters:	voltageRange – Type: int, Range: See constants, Default: 1 currentRange – Type: int, 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:

• BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_5V = 0
• BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_10V = 1

For currentRange:

• BrickletIndustrialAnalogOutV2.CURRENT_RANGE_4_TO_20MA = 0
• BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_20MA = 1
• BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_24MA = 2

BrickletIndustrialAnalogOutV2.Configuration BrickletIndustrialAnalogOutV2.getConfiguration()¶

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

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For voltageRange:

• BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_5V = 0
• BrickletIndustrialAnalogOutV2.VOLTAGE_RANGE_0_TO_10V = 1

For currentRange:

• BrickletIndustrialAnalogOutV2.CURRENT_RANGE_4_TO_20MA = 0
• BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_20MA = 1
• BrickletIndustrialAnalogOutV2.CURRENT_RANGE_0_TO_24MA = 2

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

• BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_OFF = 0
• BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_ON = 1
• BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletIndustrialAnalogOutV2.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:

• BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_OFF = 0
• BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_ON = 1
• BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialAnalogOutV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletIndustrialAnalogOutV2.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 BrickletIndustrialAnalogOutV2.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!

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

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

• BrickletIndustrialAnalogOutV2.FUNCTION_SET_ENABLED = 1
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_VOLTAGE = 3
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_CURRENT = 5
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_CONFIGURATION = 7
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_OUT_LED_CONFIG = 9
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialAnalogOutV2.FUNCTION_RESET = 243
• BrickletIndustrialAnalogOutV2.FUNCTION_WRITE_UID = 248

void BrickletIndustrialAnalogOutV2.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:

• BrickletIndustrialAnalogOutV2.FUNCTION_SET_ENABLED = 1
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_VOLTAGE = 3
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_CURRENT = 5
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_CONFIGURATION = 7
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_OUT_LED_CONFIG = 9
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialAnalogOutV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialAnalogOutV2.FUNCTION_RESET = 243
• BrickletIndustrialAnalogOutV2.FUNCTION_WRITE_UID = 248

void BrickletIndustrialAnalogOutV2.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 BrickletIndustrialAnalogOutV2.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:

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

For status:

• BrickletIndustrialAnalogOutV2.BOOTLOADER_STATUS_OK = 0
• BrickletIndustrialAnalogOutV2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletIndustrialAnalogOutV2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletIndustrialAnalogOutV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletIndustrialAnalogOutV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletIndustrialAnalogOutV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletIndustrialAnalogOutV2.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:

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

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

This constant is used to identify a Industrial Analog Out 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 BrickletIndustrialAnalogOutV2.DEVICE_DISPLAY_NAME¶

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