This is the description of the Java API bindings for the Industrial Dual 0-20mA Bricklet. General information and technical specifications for the Industrial Dual 0-20mA Bricklet are summarized in its hardware description.
An installation guide for the Java API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
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.BrickletIndustrialDual020mA;
import com.tinkerforge.IPConnection;
public class ExampleSimple {
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
BrickletIndustrialDual020mA dual020 =
new BrickletIndustrialDual020mA(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current current from sensor 1 (unit is nA)
int current = dual020.getCurrent((short)1); // Can throw IPConnection.TimeoutException
System.out.println("Current (sensor 1): " + current/(1000.0*1000.0) + " mA");
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
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.BrickletIndustrialDual020mA;
import com.tinkerforge.IPConnection;
public class ExampleCallback {
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
BrickletIndustrialDual020mA dual020 =
new BrickletIndustrialDual020mA(UID, ipcon); // Create device object
ipcon.connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Set Period (sensor 1) for current callback to 1s (1000ms)
// Note: The current callback is only called every second if the
// current has changed since the last call!
dual020.setCurrentCallbackPeriod((short)1, 1000);
// Add and implement current listener (called if current changes)
dual020.addCurrentListener(new BrickletIndustrialDual020mA.CurrentListener() {
public void current(short sensor, int current) {
System.out.println("Current (sensor " + sensor + "): " +
current/(1000.0*1000.0) + " mA");
}
});
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
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.BrickletIndustrialDual020mA;
import com.tinkerforge.IPConnection;
public class ExampleThreshold {
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
BrickletIndustrialDual020mA dual020 =
new BrickletIndustrialDual020mA(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)
dual020.setDebouncePeriod(10000);
// Configure threshold (sensor 1) for "greater than 10mA" (unit is nA)
dual020.setCurrentCallbackThreshold((short)1, '>', 10*1000*1000, 0);
// Add and implement current reached listener (called if current is greater than 10mA)
dual020.addCurrentReachedListener(new BrickletIndustrialDual020mA.CurrentReachedListener() {
public void currentReached(short sensor, int current) {
System.out.println("Current (sensor " + sensor + ") is greater than 10mA: " +
current/(1000.0*1000.0));
}
});
System.out.println("Press key to exit"); System.in.read();
ipcon.disconnect();
}
}
|
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.
Two sensors can be connected to the Bricklet. Functions that are related directly to a sensor have a sensor parameter to specify one of the two sensors. Valid values for the sensor parameter are 0 and 1.
Creates an object with the unique device ID uid:
BrickletIndustrialDual020mA industrialDual020mA = new BrickletIndustrialDual020mA("YOUR_DEVICE_UID", ipcon);
This object can then be used after the IP Connection is connected (see examples above).
Returns the current of the specified sensor (0 or 1). The value is in nA and between 0nA and 22505322nA (22.5mA).
It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works probably.
If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.
If you want to get the current periodically, it is recommended to use the listener CurrentListener and set the period with setCurrentCallbackPeriod().
Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.
Value | Description |
---|---|
0 | 240 samples per second, 12 bit resolution |
1 | 60 samples per second, 14 bit resolution |
2 | 15 samples per second, 16 bit resolution |
3 | 4 samples per second, 18 bit resolution |
The default value is 3: 4 samples per second with 18 bit resolution.
The following constants are available for this function:
Returns the sample rate as set by setSampleRate().
The following constants are available for this function:
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.
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.
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:
Changes the response expected flag for all setter and listener configuration functions of this device at once.
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.
Sets the period in ms with which the CurrentListener listener is triggered periodically for the given sensor. A value of 0 turns the listener off.
CurrentListener is only triggered if the current has changed since the last triggering.
The default value is 0.
Returns the period as set by setCurrentCallbackPeriod().
Sets the thresholds for the CurrentReachedListener listener for the given sensor.
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 default value is ('x', 0, 0).
The following constants are available for this function:
Returns the threshold as set by setCurrentCallbackThreshold().
The following constants are available for this function:
The returned object has the public member variables char option, int min and int max.
Sets the period in ms with which the threshold listener
is triggered, if the threshold
keeps being reached.
The default value is 100.
Returns the debounce period as set by setDebouncePeriod().
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 BrickletIndustrialDual020mA.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.
This listener can be added with the addCurrentListener() function. An added listener can be removed with the removeCurrentListener() function.
This listener is triggered periodically with the period that is set by setCurrentCallbackPeriod(). The parameter is the current of the sensor.
CurrentListener is only triggered if the current has changed since the last triggering.
This listener can be added with the addCurrentReachedListener() function. An added listener can be removed with the removeCurrentReachedListener() function.
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().
This constant is used to identify a Industrial Dual 0-20mA 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.