Java - Load Cell 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.BrickletLoadCell;

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

    // Change XYZ to the UID of your Load Cell 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
        BrickletLoadCell lc = new BrickletLoadCell(UID, ipcon); // Create device object

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

        // Get current weight
        int weight = lc.getWeight(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Weight: " + weight + " g");

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

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

    // Change XYZ to the UID of your Load Cell 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
        BrickletLoadCell lc = new BrickletLoadCell(UID, ipcon); // Create device object

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

        // Add weight listener
        lc.addWeightListener(new BrickletLoadCell.WeightListener() {
            public void weight(int weight) {
                System.out.println("Weight: " + weight + " g");
            }
        });

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

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

    // Change XYZ to the UID of your Load Cell 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
        BrickletLoadCell lc = new BrickletLoadCell(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 1 second (1000ms)
        lc.setDebouncePeriod(1000);

        // Add weight reached listener
        lc.addWeightReachedListener(new BrickletLoadCell.WeightReachedListener() {
            public void weightReached(int weight) {
                System.out.println("Weight: " + weight + " g");
            }
        });

        // Configure threshold for weight "greater than 200 g"
        lc.setWeightCallbackThreshold('>', 200, 0);

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

Basic Functions¶

class BrickletLoadCell(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	loadCell – Type: BrickletLoadCell

Creates an object with the unique device ID uid:

BrickletLoadCell loadCell = new BrickletLoadCell("YOUR_DEVICE_UID", ipcon);

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

int BrickletLoadCell.getWeight()¶

Returns:	weight – Type: int, Unit: 1 g, Range: [-231 to 231 - 1]

Returns the currently measured weight.

If you want to get the weight periodically, it is recommended to use the WeightListener listener and set the period with setWeightCallbackPeriod().

void BrickletLoadCell.ledOn()¶

Turns the LED on.

void BrickletLoadCell.ledOff()¶

Turns the LED off.

boolean BrickletLoadCell.isLEDOn()¶

Returns:	on – Type: boolean, Default: false

Returns true if the led is on, false otherwise.

void BrickletLoadCell.tare()¶

Sets the currently measured weight as tare weight.

Advanced Functions¶

void BrickletLoadCell.setMovingAverage(short average)¶

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

Sets the length of a moving averaging for the weight value.

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

short BrickletLoadCell.getMovingAverage()¶

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

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

void BrickletLoadCell.calibrate(long weight)¶

Parameters:	weight – Type: long, Unit: 1 g, Range: [0 to 232 - 1]

To calibrate your Load Cell Bricklet you have to

• empty the scale and call this function with 0 and
• add a known weight to the scale and call this function with the weight.

The calibration is saved in the EEPROM of the Bricklet and only needs to be done once.

We recommend to use the Brick Viewer for calibration, you don't need to call this function in your source code.

void BrickletLoadCell.setConfiguration(short rate, short gain)¶

Parameters:	rate – Type: short, Range: See constants, Default: 0 gain – Type: short, Range: See constants, Default: 0

The measurement rate and gain are configurable.

The rate can be either 10Hz or 80Hz. A faster rate will produce more noise. It is additionally possible to add a moving average (see setMovingAverage()) to the measurements.

The gain can be 128x, 64x or 32x. It represents a measurement range of ±20mV, ±40mV and ±80mV respectively. The Load Cell Bricklet uses an excitation voltage of 5V and most load cells use an output of 2mV/V. That means the voltage range is ±15mV for most load cells (i.e. gain of 128x is best). If you don't know what all of this means you should keep it at 128x, it will most likely be correct.

The configuration is saved in the EEPROM of the Bricklet and only needs to be done once.

We recommend to use the Brick Viewer for configuration, you don't need to call this function in your source code.

The following constants are available for this function:

For rate:

• BrickletLoadCell.RATE_10HZ = 0
• BrickletLoadCell.RATE_80HZ = 1

For gain:

• BrickletLoadCell.GAIN_128X = 0
• BrickletLoadCell.GAIN_64X = 1
• BrickletLoadCell.GAIN_32X = 2

BrickletLoadCell.Configuration BrickletLoadCell.getConfiguration()¶

Return Object:	rate – Type: short, Range: See constants, Default: 0 gain – Type: short, Range: See constants, Default: 0

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For rate:

• BrickletLoadCell.RATE_10HZ = 0
• BrickletLoadCell.RATE_80HZ = 1

For gain:

• BrickletLoadCell.GAIN_128X = 0
• BrickletLoadCell.GAIN_64X = 1
• BrickletLoadCell.GAIN_32X = 2

BrickletLoadCell.Identity BrickletLoadCell.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 BrickletLoadCell.setWeightCallbackPeriod(long period)¶

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

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

The WeightListener listener is only triggered if the weight has changed since the last triggering.

long BrickletLoadCell.getWeightCallbackPeriod()¶

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

Returns the period as set by setWeightCallbackPeriod().

void BrickletLoadCell.setWeightCallbackThreshold(char option, int min, int max)¶

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

Sets the thresholds for the WeightReachedListener listener.

The following options are possible:

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

The following constants are available for this function:

For option:

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

BrickletLoadCell.WeightCallbackThreshold BrickletLoadCell.getWeightCallbackThreshold()¶

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

Returns the threshold as set by setWeightCallbackThreshold().

The following constants are available for this function:

For option:

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

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

• WeightReachedListener

is triggered, if the threshold

• setWeightCallbackThreshold()

keeps being reached.

long BrickletLoadCell.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 BrickletLoadCell.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 BrickletLoadCell.WeightListener()¶

This listener can be added with the addWeightListener() function. An added listener can be removed with the removeWeightListener() function.

void weight(int weight)

Parameters:	weight – Type: int, Unit: 1 g, Range: [-231 to 231 - 1]

This listener is triggered periodically with the period that is set by setWeightCallbackPeriod(). The parameter is the weight as measured by the load cell.

The WeightListener listener is only triggered if the weight has changed since the last triggering.

class BrickletLoadCell.WeightReachedListener()¶

This listener can be added with the addWeightReachedListener() function. An added listener can be removed with the removeWeightReachedListener() function.

void weightReached(int weight)

Parameters:	weight – Type: int, Unit: 1 g, Range: [-231 to 231 - 1]

This listener is triggered when the threshold as set by setWeightCallbackThreshold() is reached. The parameter is the weight as measured by the load cell.

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

• BrickletLoadCell.FUNCTION_SET_WEIGHT_CALLBACK_PERIOD = 2
• BrickletLoadCell.FUNCTION_SET_WEIGHT_CALLBACK_THRESHOLD = 4
• BrickletLoadCell.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletLoadCell.FUNCTION_SET_MOVING_AVERAGE = 8
• BrickletLoadCell.FUNCTION_LED_ON = 10
• BrickletLoadCell.FUNCTION_LED_OFF = 11
• BrickletLoadCell.FUNCTION_CALIBRATE = 13
• BrickletLoadCell.FUNCTION_TARE = 14
• BrickletLoadCell.FUNCTION_SET_CONFIGURATION = 15

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

• BrickletLoadCell.FUNCTION_SET_WEIGHT_CALLBACK_PERIOD = 2
• BrickletLoadCell.FUNCTION_SET_WEIGHT_CALLBACK_THRESHOLD = 4
• BrickletLoadCell.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletLoadCell.FUNCTION_SET_MOVING_AVERAGE = 8
• BrickletLoadCell.FUNCTION_LED_ON = 10
• BrickletLoadCell.FUNCTION_LED_OFF = 11
• BrickletLoadCell.FUNCTION_CALIBRATE = 13
• BrickletLoadCell.FUNCTION_TARE = 14
• BrickletLoadCell.FUNCTION_SET_CONFIGURATION = 15

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

This constant is used to identify a Load Cell 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 BrickletLoadCell.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Load Cell Bricklet.