Java - Industrial Dual Analog In Bricklet

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

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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDualAnalogIn;

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

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

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

        // Get current voltage from channel 1
        int voltage = idai.getVoltage((short)1); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Voltage (Channel 1): " + voltage/1000.0 + " V");

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

Callback

Download (ExampleCallback.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
37
38
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDualAnalogIn;

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

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

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

        // Add voltage listener
        idai.addVoltageListener(new BrickletIndustrialDualAnalogIn.VoltageListener() {
            public void voltage(short channel, int voltage) {
                System.out.println("Channel: " + channel);
                System.out.println("Voltage: " + voltage/1000.0 + " V");
                System.out.println("");
            }
        });

        // Set period for voltage (channel 1) callback to 1s (1000ms)
        // Note: The voltage (channel 1) callback is only called every second
        //       if the voltage (channel 1) has changed since the last call!
        idai.setVoltageCallbackPeriod((short)1, 1000);

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

Threshold

Download (ExampleThreshold.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
37
38
39
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDualAnalogIn;

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

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

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

        // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        idai.setDebouncePeriod(10000);

        // Add voltage reached listener
        idai.addVoltageReachedListener(new BrickletIndustrialDualAnalogIn.VoltageReachedListener() {
            public void voltageReached(short channel, int voltage) {
                System.out.println("Channel: " + channel);
                System.out.println("Voltage: " + voltage/1000.0 + " V");
                System.out.println("");
            }
        });

        // Configure threshold for voltage (channel 1) "greater than 10 V"
        idai.setVoltageCallbackThreshold((short)1, '>', 10*1000, 0);

        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.

The Bricklet has two input channel. Functions that are related directly to a channel have a channel parameter to specify one of the two channels. Valid values for the channel parameter are 0 and 1.

Basic Functions

class BrickletIndustrialDualAnalogIn(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • industrialDualAnalogIn – Type: BrickletIndustrialDualAnalogIn

Creates an object with the unique device ID uid:

BrickletIndustrialDualAnalogIn industrialDualAnalogIn = new BrickletIndustrialDualAnalogIn("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected (see examples above).

int BrickletIndustrialDualAnalogIn.getVoltage(short channel)
Parameters:
  • channel – Type: short, Range: [0 to 255]
Returns:
  • voltage – Type: int, Range: [-231 to 231 - 1]

Returns the voltage for the given channel in mV.

If you want to get the voltage periodically, it is recommended to use the VoltageListener listener and set the period with setVoltageCallbackPeriod().

Advanced Functions

void BrickletIndustrialDualAnalogIn.setSampleRate(short rate)
Parameters:
  • rate – Type: short, Range: See constants

Sets the sample rate. The sample rate can be between 1 sample per second and 976 samples per second. Decreasing the sample rate will also decrease the noise on the data.

The default value is 6 (2 samples per second).

The following constants are available for this function:

For rate:

  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_976_SPS = 0
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_488_SPS = 1
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_244_SPS = 2
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_122_SPS = 3
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_61_SPS = 4
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_4_SPS = 5
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_2_SPS = 6
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_1_SPS = 7
short BrickletIndustrialDualAnalogIn.getSampleRate()
Returns:
  • rate – Type: short, Range: See constants

Returns the sample rate as set by setSampleRate().

The following constants are available for this function:

For rate:

  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_976_SPS = 0
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_488_SPS = 1
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_244_SPS = 2
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_122_SPS = 3
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_61_SPS = 4
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_4_SPS = 5
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_2_SPS = 6
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_1_SPS = 7
void BrickletIndustrialDualAnalogIn.setCalibration(int[] offset, int[] gain)
Parameters:
  • offset – Type: int[], Length: 2, Range: [-231 to 231 - 1]
  • gain – Type: int[], Length: 2, Range: [-231 to 231 - 1]

Sets offset and gain of MCP3911 internal calibration registers.

See MCP3911 datasheet 7.7 and 7.8. The Industrial Dual Analog In Bricklet is already factory calibrated by Tinkerforge. It should not be necessary for you to use this function

BrickletIndustrialDualAnalogIn.Calibration BrickletIndustrialDualAnalogIn.getCalibration()
Return Object:
  • offset – Type: int[], Length: 2, Range: [-231 to 231 - 1]
  • gain – Type: int[], Length: 2, Range: [-231 to 231 - 1]

Returns the calibration as set by setCalibration().

int[] BrickletIndustrialDualAnalogIn.getADCValues()
Returns:
  • value – Type: int[], Length: 2, Range: [-231 to 231 - 1]

Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see setCalibration().

short[] BrickletIndustrialDualAnalogIn.getAPIVersion()
Returns:
  • apiVersion – Type: short[], Length: 3, Range: [0 to 255]

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.

boolean BrickletIndustrialDualAnalogIn.getResponseExpected(short functionId)
Parameters:
  • functionId – Type: short, 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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_SAMPLE_RATE = 8
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_CALIBRATION = 10
void BrickletIndustrialDualAnalogIn.setResponseExpected(short functionId, boolean responseExpected)
Parameters:
  • functionId – Type: short, 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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_SAMPLE_RATE = 8
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_CALIBRATION = 10
void BrickletIndustrialDualAnalogIn.setResponseExpectedAll(boolean responseExpected)
Parameters:
  • responseExpected – Type: boolean

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

BrickletIndustrialDualAnalogIn.Identity BrickletIndustrialDualAnalogIn.getIdentity()
Return Object:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char
  • hardwareVersion – Type: short[], Length: 3, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3, 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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Listener Configuration Functions

void BrickletIndustrialDualAnalogIn.setVoltageCallbackPeriod(short channel, long period)
Parameters:
  • channel – Type: short, Range: [0 to 255]
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the VoltageListener listener is triggered periodically for the given channel. A value of 0 turns the listener off.

The VoltageListener listener is only triggered if the voltage has changed since the last triggering.

long BrickletIndustrialDualAnalogIn.getVoltageCallbackPeriod(short channel)
Parameters:
  • channel – Type: short, Range: [0 to 255]
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setVoltageCallbackPeriod().

void BrickletIndustrialDualAnalogIn.setVoltageCallbackThreshold(short channel, char option, int min, int max)
Parameters:
  • channel – Type: short, Range: [0 to 255]
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Range: [-231 to 231 - 1]
  • max – Type: int, Range: [-231 to 231 - 1]

Sets the thresholds for the VoltageReachedListener listener for the given channel.

The following options are possible:

Option Description
'x' Listener is turned off
'o' Listener is triggered when the voltage is outside the min and max values
'i' Listener is triggered when the voltage is inside the min and max values
'<' Listener is triggered when the voltage is smaller than the min value (max is ignored)
'>' Listener is triggered when the voltage is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

For option:

  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_GREATER = '>'
BrickletIndustrialDualAnalogIn.VoltageCallbackThreshold BrickletIndustrialDualAnalogIn.getVoltageCallbackThreshold(short channel)
Parameters:
  • channel – Type: short, Range: [0 to 255]
Return Object:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Range: [-231 to 231 - 1]
  • max – Type: int, Range: [-231 to 231 - 1]

Returns the threshold as set by setVoltageCallbackThreshold().

The following constants are available for this function:

For option:

  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_GREATER = '>'
void BrickletIndustrialDualAnalogIn.setDebouncePeriod(long debounce)
Parameters:
  • debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold listener

is triggered, if the threshold

keeps being reached.

long BrickletIndustrialDualAnalogIn.getDebouncePeriod()
Returns:
  • debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by setDebouncePeriod().

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 BrickletIndustrialDualAnalogIn.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 BrickletIndustrialDualAnalogIn.VoltageListener()

This listener can be added with the addVoltageListener() function. An added listener can be removed with the removeVoltageListener() function.

void voltage(short channel, int voltage)
Parameters:
  • channel – Type: short, Range: [0 to 255]
  • voltage – Type: int, Range: [-231 to 231 - 1]

This listener is triggered periodically with the period that is set by setVoltageCallbackPeriod(). The parameter is the voltage of the channel.

The VoltageListener listener is only triggered if the voltage has changed since the last triggering.

class BrickletIndustrialDualAnalogIn.VoltageReachedListener()

This listener can be added with the addVoltageReachedListener() function. An added listener can be removed with the removeVoltageReachedListener() function.

void voltageReached(short channel, int voltage)
Parameters:
  • channel – Type: short, Range: [0 to 255]
  • voltage – Type: int, Range: [-231 to 231 - 1]

This listener is triggered when the threshold as set by setVoltageCallbackThreshold() is reached. The parameter is the voltage of the channel.

If the threshold keeps being reached, the listener is triggered periodically with the period as set by setDebouncePeriod().

Constants

int BrickletIndustrialDualAnalogIn.DEVICE_IDENTIFIER

This constant is used to identify a Industrial Dual Analog 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 BrickletIndustrialDualAnalogIn.DEVICE_DISPLAY_NAME

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