Java - Industrial Analog Out Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# Java - Industrial Analog Out Bricklet

Note

This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.

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)

     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

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

    public class ExampleSimpleCurrent {
        private static final String HOST = "localhost";
        private static final int PORT = 4223;
        private static final String UID = "XYZ"; // Change to your UID

        // 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 ao = 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
            ao.setCurrent(4500);
            ao.enable();

            System.out.println("Press key to exit"); System.in.read();
            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

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

    public class ExampleSimpleVoltage {
        private static final String HOST = "localhost";
        private static final int PORT = 4223;
        private static final String UID = "XYZ"; // Change to your UID

        // 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 ao = 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
            ao.setVoltage(3300);
            ao.enable();

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

  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 (see examples above).

public void `enable`()

  Enables the output of voltage and current.

  The default is disabled.

public void `disable`()

  Disables the output of voltage and current.

  The default is disabled.

public boolean `isEnabled`()

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

public void `setVoltage`(int voltage)

  Sets the output voltage in mV.

public int `getVoltage`()

  Returns the voltage as set by `setVoltage()`.

public void `setCurrent`(int current)

  Sets the output current in µA.

public int `getCurrent`()

  Returns the current as set by `setCurrent()`.

### Advanced Functions

public void `setConfiguration`(short voltageRange, short currentRange)

  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:

  - BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
  - BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1
  - BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
  - BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
  - BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2

public BrickletIndustrialAnalogOut.Configuration `getConfiguration`()

  Returns the configuration as set by `setConfiguration()`.

  The following constants are available for this function:

  - BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
  - BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1
  - BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
  - BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
  - BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2

  The returned object has the public member variables `short voltageRange` and `short currentRange`.

public short[] `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`(short 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`(short 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 and listeners it is always disabled.

  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:

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

public void `setResponseExpectedAll`(boolean responseExpected)

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

public BrickletIndustrialAnalogOut.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`, `short[] hardwareVersion`, `short[] firmwareVersion` and `int deviceIdentifier`.

### Constants

public static final int `BrickletIndustrialAnalogOut.DEVICE_IDENTIFIER`

  This constant is used to identify a Industrial Analog Out Bricklet.

  The `getIdentity()` function and the `EnumerateListener` listener of the IP Connection have a `deviceIdentifier` parameter to specify the Brick's or Bricklet's type.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.