Java - Current12 Bricklet¶

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.BrickletCurrent12;

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

    // Change XYZ to the UID of your Current12 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
        BrickletCurrent12 c = new BrickletCurrent12(UID, ipcon); // Create device object

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

        // Get current current
        short current = c.getCurrent(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Current: " + current/1000.0 + " A");

        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.BrickletCurrent12;

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

    // Change XYZ to the UID of your Current12 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
        BrickletCurrent12 c = new BrickletCurrent12(UID, ipcon); // Create device object

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

        // Add current listener
        c.addCurrentListener(new BrickletCurrent12.CurrentListener() {
            public void current(short current) {
                System.out.println("Current: " + current/1000.0 + " A");
            }
        });

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

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

    // Change XYZ to the UID of your Current12 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
        BrickletCurrent12 c = new BrickletCurrent12(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)
        c.setDebouncePeriod(10000);

        // Add current reached listener
        c.addCurrentReachedListener(new BrickletCurrent12.CurrentReachedListener() {
            public void currentReached(short current) {
                System.out.println("Current: " + current/1000.0 + " A");
            }
        });

        // Configure threshold for current "greater than 5 A"
        c.setCurrentCallbackThreshold('>', (short)(5*1000), (short)0);

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

Basic Functions¶

class BrickletCurrent12(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	current12 – Type: BrickletCurrent12

Creates an object with the unique device ID uid:

BrickletCurrent12 current12 = new BrickletCurrent12("YOUR_DEVICE_UID", ipcon);

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

short BrickletCurrent12.getCurrent()¶

Returns:	current – Type: short, Unit: 1 mA, Range: [-12500 to 12500]

Returns the current of the sensor.

If you want to get the current periodically, it is recommended to use the CurrentListener listener and set the period with setCurrentCallbackPeriod().

Advanced Functions¶

void BrickletCurrent12.calibrate()¶

Calibrates the 0 value of the sensor. You have to call this function when there is no current present.

The zero point of the current sensor is depending on the exact properties of the analog-to-digital converter, the length of the Bricklet cable and the temperature. Thus, if you change the Brick or the environment in which the Bricklet is used, you might have to recalibrate.

The resulting calibration will be saved on the EEPROM of the Current Bricklet.

boolean BrickletCurrent12.isOverCurrent()¶

Returns:	over – Type: boolean

Returns true if more than 12.5A were measured.

Note

To reset this value you have to power cycle the Bricklet.

int BrickletCurrent12.getAnalogValue()¶

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

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

Note

The value returned by getCurrent() is averaged over several samples to yield less noise, while getAnalogValue() gives back raw unfiltered analog values. The only reason to use getAnalogValue() is, if you need the full resolution of the 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().

BrickletCurrent12.Identity BrickletCurrent12.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 BrickletCurrent12.setCurrentCallbackPeriod(long period)¶

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

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

The CurrentListener listener is only triggered if the current has changed since the last triggering.

long BrickletCurrent12.getCurrentCallbackPeriod()¶

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

Returns the period as set by setCurrentCallbackPeriod().

void BrickletCurrent12.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 BrickletCurrent12.getAnalogValueCallbackPeriod()¶

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

Returns the period as set by setAnalogValueCallbackPeriod().

void BrickletCurrent12.setCurrentCallbackThreshold(char option, short min, short max)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: short, Unit: 1 mA, Range: [-215 to 215 - 1], Default: 0 max – Type: short, Unit: 1 mA, Range: [-215 to 215 - 1], Default: 0

Sets the thresholds for the CurrentReachedListener listener.

The following options are possible:

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

The following constants are available for this function:

For option:

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

BrickletCurrent12.CurrentCallbackThreshold BrickletCurrent12.getCurrentCallbackThreshold()¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: short, Unit: 1 mA, Range: [-215 to 215 - 1], Default: 0 max – Type: short, Unit: 1 mA, Range: [-215 to 215 - 1], Default: 0

Returns the threshold as set by setCurrentCallbackThreshold().

The following constants are available for this function:

For option:

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

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

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

BrickletCurrent12.AnalogValueCallbackThreshold BrickletCurrent12.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:

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

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

• CurrentReachedListener,
• AnalogValueReachedListener

are triggered, if the thresholds

• setCurrentCallbackThreshold(),
• setAnalogValueCallbackThreshold()

keep being reached.

long BrickletCurrent12.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 BrickletCurrent12.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 BrickletCurrent12.CurrentListener()¶

This listener can be added with the addCurrentListener() function. An added listener can be removed with the removeCurrentListener() function.

void current(short current)

Parameters:	current – Type: short, Unit: 1 mA, Range: [-12500 to 12500]

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

The CurrentListener listener is only triggered if the current has changed since the last triggering.

class BrickletCurrent12.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 current has changed since the last triggering.

class BrickletCurrent12.CurrentReachedListener()¶

This listener can be added with the addCurrentReachedListener() function. An added listener can be removed with the removeCurrentReachedListener() function.

void currentReached(short current)

Parameters:	current – Type: short, Unit: 1 mA, Range: [-12500 to 12500]

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

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

class BrickletCurrent12.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().

class BrickletCurrent12.OverCurrentListener()¶

This listener can be added with the addOverCurrentListener() function. An added listener can be removed with the removeOverCurrentListener() function.

void overCurrent()

This listener is triggered when an over current is measured (see isOverCurrent()).

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

• BrickletCurrent12.FUNCTION_CALIBRATE = 2
• BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
• BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
• BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
• BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
• BrickletCurrent12.FUNCTION_SET_DEBOUNCE_PERIOD = 13

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

• BrickletCurrent12.FUNCTION_CALIBRATE = 2
• BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
• BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
• BrickletCurrent12.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
• BrickletCurrent12.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
• BrickletCurrent12.FUNCTION_SET_DEBOUNCE_PERIOD = 13

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

This constant is used to identify a Current12 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 BrickletCurrent12.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Current12 Bricklet.