MATLAB/Octave - Load Cell Bricklet 2.0¶

Simple (MATLAB)¶

Download (matlab_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLoadCellV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Load Cell Bricklet 2.0

    ipcon = IPConnection(); % Create IP connection
    lc = handle(BrickletLoadCellV2(UID, ipcon), 'CallbackProperties'); % Create device object

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

    % Get current weight
    weight = lc.getWeight();
    fprintf('Weight: %i g\n', weight);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)¶

Download (matlab_example_callback.m)

 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

function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLoadCellV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Load Cell Bricklet 2.0

    ipcon = IPConnection(); % Create IP connection
    lc = handle(BrickletLoadCellV2(UID, ipcon), 'CallbackProperties'); % Create device object

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

    % Register weight callback to function cb_weight
    set(lc, 'WeightCallback', @(h, e) cb_weight(e));

    % Set period for weight callback to 1s (1000ms) without a threshold
    lc.setWeightCallbackConfiguration(1000, false, 'x', 0, 0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for weight callback
function cb_weight(e)
    fprintf('Weight: %i g\n', e.weight);
end

Threshold (MATLAB)¶

Download (matlab_example_threshold.m)

 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

function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletLoadCellV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Load Cell Bricklet 2.0

    ipcon = IPConnection(); % Create IP connection
    lc = handle(BrickletLoadCellV2(UID, ipcon), 'CallbackProperties'); % Create device object

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

    % Register weight callback to function cb_weight
    set(lc, 'WeightCallback', @(h, e) cb_weight(e));

    % Configure threshold for weight "greater than 200 g"
    % with a debounce period of 1s (1000ms)
    lc.setWeightCallbackConfiguration(1000, false, '>', 200, 0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for weight callback
function cb_weight(e)
    fprintf('Weight: %i g\n', e.weight);
end

Simple (Octave)¶

Download (octave_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Load Cell Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    lc = javaObject("com.tinkerforge.BrickletLoadCellV2", UID, ipcon); % Create device object

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

    % Get current weight
    weight = lc.getWeight();
    fprintf("Weight: %d g\n", weight);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Callback (Octave)¶

Download (octave_example_callback.m)

 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

function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Load Cell Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    lc = javaObject("com.tinkerforge.BrickletLoadCellV2", UID, ipcon); % Create device object

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

    % Register weight callback to function cb_weight
    lc.addWeightCallback(@cb_weight);

    % Set period for weight callback to 1s (1000ms) without a threshold
    lc.setWeightCallbackConfiguration(1000, false, "x", 0, 0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for weight callback
function cb_weight(e)
    fprintf("Weight: %d g\n", e.weight);
end

Threshold (Octave)¶

Download (octave_example_threshold.m)

 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

function octave_example_threshold()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Load Cell Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    lc = javaObject("com.tinkerforge.BrickletLoadCellV2", UID, ipcon); % Create device object

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

    % Register weight callback to function cb_weight
    lc.addWeightCallback(@cb_weight);

    % Configure threshold for weight "greater than 200 g"
    % with a debounce period of 1s (1000ms)
    lc.setWeightCallbackConfiguration(1000, false, ">", 200, 0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for weight callback
function cb_weight(e)
    fprintf("Weight: %d g\n", e.weight);
end

Basic Functions¶

class BrickletLoadCellV2(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	loadCellV2 – Type: BrickletLoadCellV2

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletLoadCellV2;

loadCellV2 = BrickletLoadCellV2('YOUR_DEVICE_UID', ipcon);

In Octave:

loadCellV2 = java_new("com.tinkerforge.BrickletLoadCellV2", "YOUR_DEVICE_UID", ipcon);

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

int BrickletLoadCellV2.getWeight()¶

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

Returns the currently measured weight.

If you want to get the value periodically, it is recommended to use the WeightCallback callback. You can set the callback configuration with setWeightCallbackConfiguration().

void BrickletLoadCellV2.setInfoLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 0

Configures the info LED to be either turned off, turned on, or blink in heartbeat mode.

The following constants are available for this function:

For config:

• BrickletLoadCellV2.INFO_LED_CONFIG_OFF = 0
• BrickletLoadCellV2.INFO_LED_CONFIG_ON = 1
• BrickletLoadCellV2.INFO_LED_CONFIG_SHOW_HEARTBEAT = 2

int BrickletLoadCellV2.getInfoLEDConfig()¶

Returns:	config – Type: int, Range: See constants, Default: 0

Returns the LED configuration as set by setInfoLEDConfig()

The following constants are available for this function:

For config:

• BrickletLoadCellV2.INFO_LED_CONFIG_OFF = 0
• BrickletLoadCellV2.INFO_LED_CONFIG_ON = 1
• BrickletLoadCellV2.INFO_LED_CONFIG_SHOW_HEARTBEAT = 2

void BrickletLoadCellV2.tare()¶

Sets the currently measured weight as tare weight.

Advanced Functions¶

void BrickletLoadCellV2.setMovingAverage(int average)¶

Parameters:	average – Type: int, Range: [1 to 100], 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.

int BrickletLoadCellV2.getMovingAverage()¶

Returns:	average – Type: int, Range: [1 to 100], Default: 4

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

void BrickletLoadCellV2.calibrate(long weight)¶

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

To calibrate your Load Cell Bricklet 2.0 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 flash 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 BrickletLoadCellV2.setConfiguration(int rate, int gain)¶

Parameters:	rate – Type: int, Range: See constants, Default: 0 gain – Type: int, 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 following constants are available for this function:

For rate:

• BrickletLoadCellV2.RATE_10HZ = 0
• BrickletLoadCellV2.RATE_80HZ = 1

For gain:

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

BrickletLoadCellV2.Configuration BrickletLoadCellV2.getConfiguration()¶

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

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For rate:

• BrickletLoadCellV2.RATE_10HZ = 0
• BrickletLoadCellV2.RATE_80HZ = 1

For gain:

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

BrickletLoadCellV2.SPITFPErrorCount BrickletLoadCellV2.getSPITFPErrorCount()¶

Return Object:	errorCountAckChecksum – Type: long, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1] errorCountFrame – Type: long, Range: [0 to 232 - 1] errorCountOverflow – Type: long, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,
• message checksum errors,
• framing errors and
• overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

void BrickletLoadCellV2.setStatusLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

• BrickletLoadCellV2.STATUS_LED_CONFIG_OFF = 0
• BrickletLoadCellV2.STATUS_LED_CONFIG_ON = 1
• BrickletLoadCellV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletLoadCellV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletLoadCellV2.getStatusLEDConfig()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For config:

• BrickletLoadCellV2.STATUS_LED_CONFIG_OFF = 0
• BrickletLoadCellV2.STATUS_LED_CONFIG_ON = 1
• BrickletLoadCellV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletLoadCellV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletLoadCellV2.getChipTemperature()¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

void BrickletLoadCellV2.reset()¶

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletLoadCellV2.Identity BrickletLoadCellV2.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 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: 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.

Callback Configuration Functions¶

void BrickletLoadCellV2.setWeightCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false 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

The period is the period with which the WeightCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the WeightCallback callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

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

BrickletLoadCellV2.WeightCallbackConfiguration BrickletLoadCellV2.getWeightCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false 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 callback configuration as set by setWeightCallbackConfiguration().

The following constants are available for this function:

For option:

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

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields are described below.

callback BrickletLoadCellV2.WeightCallback¶

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

This callback is triggered periodically according to the configuration set by setWeightCallbackConfiguration().

The parameter is the same as getWeight().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addWeightCallback() function. An added callback function can be removed with the removeWeightCallback() function.

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[] BrickletLoadCellV2.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: 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 BrickletLoadCellV2.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 callback 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:

• BrickletLoadCellV2.FUNCTION_SET_WEIGHT_CALLBACK_CONFIGURATION = 2
• BrickletLoadCellV2.FUNCTION_SET_MOVING_AVERAGE = 5
• BrickletLoadCellV2.FUNCTION_SET_INFO_LED_CONFIG = 7
• BrickletLoadCellV2.FUNCTION_CALIBRATE = 9
• BrickletLoadCellV2.FUNCTION_TARE = 10
• BrickletLoadCellV2.FUNCTION_SET_CONFIGURATION = 11
• BrickletLoadCellV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletLoadCellV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletLoadCellV2.FUNCTION_RESET = 243
• BrickletLoadCellV2.FUNCTION_WRITE_UID = 248

void BrickletLoadCellV2.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 callback 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:

• BrickletLoadCellV2.FUNCTION_SET_WEIGHT_CALLBACK_CONFIGURATION = 2
• BrickletLoadCellV2.FUNCTION_SET_MOVING_AVERAGE = 5
• BrickletLoadCellV2.FUNCTION_SET_INFO_LED_CONFIG = 7
• BrickletLoadCellV2.FUNCTION_CALIBRATE = 9
• BrickletLoadCellV2.FUNCTION_TARE = 10
• BrickletLoadCellV2.FUNCTION_SET_CONFIGURATION = 11
• BrickletLoadCellV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletLoadCellV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletLoadCellV2.FUNCTION_RESET = 243
• BrickletLoadCellV2.FUNCTION_WRITE_UID = 248

void BrickletLoadCellV2.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

int BrickletLoadCellV2.setBootloaderMode(int mode)¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

• BrickletLoadCellV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletLoadCellV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletLoadCellV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletLoadCellV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletLoadCellV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletLoadCellV2.BOOTLOADER_STATUS_OK = 0
• BrickletLoadCellV2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletLoadCellV2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletLoadCellV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletLoadCellV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletLoadCellV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletLoadCellV2.getBootloaderMode()¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For mode:

• BrickletLoadCellV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletLoadCellV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletLoadCellV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletLoadCellV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletLoadCellV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletLoadCellV2.setWriteFirmwarePointer(long pointer)¶

Parameters:	pointer – Type: long, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int BrickletLoadCellV2.writeFirmware(int[] data)¶

Parameters:	data – Type: int[], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

void BrickletLoadCellV2.writeUID(long uid)¶

Parameters:	uid – Type: long, Range: [0 to 232 - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

long BrickletLoadCellV2.readUID()¶

Returns:	uid – Type: long, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

int BrickletLoadCellV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Load Cell Bricklet 2.0.

The getIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

String BrickletLoadCellV2.DEVICE_DISPLAY_NAME¶

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