Java - Analog In Bricklet 2.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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletAnalogInV2;

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

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

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

        // Get current voltage
        int voltage = ai.getVoltage(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Voltage: " + 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletAnalogInV2;

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

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

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

        // Add voltage listener
        ai.addVoltageListener(new BrickletAnalogInV2.VoltageListener() {
            public void voltage(int voltage) {
                System.out.println("Voltage: " + voltage/1000.0 + " V");
            }
        });

        // Set period for voltage callback to 1s (1000ms)
        // Note: The voltage callback is only called every second
        //       if the voltage has changed since the last call!
        ai.setVoltageCallbackPeriod(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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletAnalogInV2;

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

    // Change XYZ to the UID of your Analog In 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
        BrickletAnalogInV2 ai = new BrickletAnalogInV2(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)
        ai.setDebouncePeriod(10000);

        // Add voltage reached listener
        ai.addVoltageReachedListener(new BrickletAnalogInV2.VoltageReachedListener() {
            public void voltageReached(int voltage) {
                System.out.println("Voltage: " + voltage/1000.0 + " V");
            }
        });

        // Configure threshold for voltage "smaller than 5 V"
        ai.setVoltageCallbackThreshold('<', 5*1000, 0);

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

Basic Functions¶

class BrickletAnalogInV2(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	analogInV2 – Type: BrickletAnalogInV2

Creates an object with the unique device ID uid:

BrickletAnalogInV2 analogInV2 = new BrickletAnalogInV2("YOUR_DEVICE_UID", ipcon);

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

int BrickletAnalogInV2.getVoltage()¶

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

Returns the measured voltage. The resolution is approximately 10mV.

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

Advanced Functions¶

int BrickletAnalogInV2.getAnalogValue()¶

Returns:	value – Type: int, Range: [0 to 212 - 1]

Returns the value as read by a 12-bit analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the AnalogValueListener listener and set the period with setAnalogValueCallbackPeriod().

void BrickletAnalogInV2.setMovingAverage(short average)¶

Parameters:	average – Type: short, Range: [1 to 50], Default: 50

Sets the length of a moving averaging for the voltage.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

short BrickletAnalogInV2.getMovingAverage()¶

Returns:	average – Type: short, Range: [1 to 50], Default: 50

Returns the length of the moving average as set by setMovingAverage().

BrickletAnalogInV2.Identity BrickletAnalogInV2.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 BrickletAnalogInV2.setVoltageCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

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

long BrickletAnalogInV2.getVoltageCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setVoltageCallbackPeriod().

void BrickletAnalogInV2.setAnalogValueCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the AnalogValueListener listener is triggered periodically. A value of 0 turns the listener off.

The AnalogValueListener listener is only triggered if the analog value has changed since the last triggering.

long BrickletAnalogInV2.getAnalogValueCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setAnalogValueCallbackPeriod().

void BrickletAnalogInV2.setVoltageCallbackThreshold(char option, int min, int max)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0 max – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the VoltageReachedListener listener.

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

For option:

• BrickletAnalogInV2.THRESHOLD_OPTION_OFF = 'x'
• BrickletAnalogInV2.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletAnalogInV2.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletAnalogInV2.THRESHOLD_OPTION_SMALLER = '<'
• BrickletAnalogInV2.THRESHOLD_OPTION_GREATER = '>'

BrickletAnalogInV2.VoltageCallbackThreshold BrickletAnalogInV2.getVoltageCallbackThreshold()¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0 max – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by setVoltageCallbackThreshold().

The following constants are available for this function:

For option:

• BrickletAnalogInV2.THRESHOLD_OPTION_OFF = 'x'
• BrickletAnalogInV2.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletAnalogInV2.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletAnalogInV2.THRESHOLD_OPTION_SMALLER = '<'
• BrickletAnalogInV2.THRESHOLD_OPTION_GREATER = '>'

void BrickletAnalogInV2.setAnalogValueCallbackThreshold(char option, int min, int max)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Range: [0 to 216 - 1], Default: 0 max – Type: int, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the AnalogValueReachedListener listener.

The following options are possible:

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

The following constants are available for this function:

For option:

• BrickletAnalogInV2.THRESHOLD_OPTION_OFF = 'x'
• BrickletAnalogInV2.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletAnalogInV2.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletAnalogInV2.THRESHOLD_OPTION_SMALLER = '<'
• BrickletAnalogInV2.THRESHOLD_OPTION_GREATER = '>'

BrickletAnalogInV2.AnalogValueCallbackThreshold BrickletAnalogInV2.getAnalogValueCallbackThreshold()¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Range: [0 to 216 - 1], Default: 0 max – Type: int, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by setAnalogValueCallbackThreshold().

The following constants are available for this function:

For option:

• BrickletAnalogInV2.THRESHOLD_OPTION_OFF = 'x'
• BrickletAnalogInV2.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletAnalogInV2.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletAnalogInV2.THRESHOLD_OPTION_SMALLER = '<'
• BrickletAnalogInV2.THRESHOLD_OPTION_GREATER = '>'

void BrickletAnalogInV2.setDebouncePeriod(long debounce)¶

Parameters:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold listeners

• VoltageReachedListener,
• AnalogValueReachedListener

are triggered, if the thresholds

• setVoltageCallbackThreshold(),
• setAnalogValueCallbackThreshold()

keep being reached.

long BrickletAnalogInV2.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 BrickletAnalogInV2.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.

class BrickletAnalogInV2.VoltageListener()¶

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

void voltage(int voltage)

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

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

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

class BrickletAnalogInV2.AnalogValueListener()¶

This listener can be added with the addAnalogValueListener() function. An added listener can be removed with the removeAnalogValueListener() function.

void analogValue(int value)

Parameters:	value – Type: int, Range: [0 to 212 - 1]

This listener is triggered periodically with the period that is set by setAnalogValueCallbackPeriod(). The parameter is the analog value of the sensor.

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

class BrickletAnalogInV2.VoltageReachedListener()¶

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

void voltageReached(int voltage)

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

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

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

class BrickletAnalogInV2.AnalogValueReachedListener()¶

This listener can be added with the addAnalogValueReachedListener() function. An added listener can be removed with the removeAnalogValueReachedListener() function.

void analogValueReached(int value)

Parameters:	value – Type: int, Range: [0 to 212 - 1]

This listener is triggered when the threshold as set by setAnalogValueCallbackThreshold() is reached. The parameter is the analog value of the sensor.

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

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

• BrickletAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
• BrickletAnalogInV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
• BrickletAnalogInV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletAnalogInV2.FUNCTION_SET_DEBOUNCE_PERIOD = 11
• BrickletAnalogInV2.FUNCTION_SET_MOVING_AVERAGE = 13

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

• BrickletAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
• BrickletAnalogInV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
• BrickletAnalogInV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletAnalogInV2.FUNCTION_SET_DEBOUNCE_PERIOD = 11
• BrickletAnalogInV2.FUNCTION_SET_MOVING_AVERAGE = 13

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

This constant is used to identify a Analog In 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 BrickletAnalogInV2.DEVICE_DISPLAY_NAME¶

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