PHP - Load Cell Bricklet

This is the description of the PHP API bindings for the Load Cell Bricklet. General information and technical specifications for the Load Cell Bricklet are summarized in its hardware description.

An installation guide for the PHP API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletLoadCell.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLoadCell;

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

$ipcon = new IPConnection(); // Create IP connection
$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
$weight = $lc->getWeight();
echo "Weight: $weight g\n";

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Callback

Download (ExampleCallback.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletLoadCell.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLoadCell;

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

// Callback function for weight callback
function cb_weight($weight)
{
    echo "Weight: $weight g\n";
}

$ipcon = new IPConnection(); // Create IP connection
$lc = new BrickletLoadCell(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->registerCallback(BrickletLoadCell::CALLBACK_WEIGHT, 'cb_weight');

// 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);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

Threshold

Download (ExampleThreshold.php)

 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
37
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletLoadCell.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLoadCell;

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

// Callback function for weight reached callback
function cb_weightReached($weight)
{
    echo "Weight: $weight g\n";
}

$ipcon = new IPConnection(); // Create IP connection
$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);

// Register weight reached callback to function cb_weightReached
$lc->registerCallback(BrickletLoadCell::CALLBACK_WEIGHT_REACHED, 'cb_weightReached');

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

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API

Functions that return multiple values return them in an associative array.

Basic Functions

class BrickletLoadCell(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $load_cell – Type: BrickletLoadCell

Creates an object with the unique device ID $uid:

<?php   $load_cell = new BrickletLoadCell('YOUR_DEVICE_UID', $ipcon);   ?>

This object can then be used after the IP Connection is connected (see examples above).

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 CALLBACK_WEIGHT callback and set the period with setWeightCallbackPeriod().

void BrickletLoadCell::ledOn()

Turns the LED on.

void BrickletLoadCell::ledOff()

Turns the LED off.

bool BrickletLoadCell::isLEDOn()
Returns:
  • $on – Type: bool, 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(int $average)
Parameters:
  • $average – Type: int, 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.

int BrickletLoadCell::getMovingAverage()
Returns:
  • $average – Type: int, Range: [1 to 40], Default: 4

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

void BrickletLoadCell::calibrate(int $weight)
Parameters:
  • $weight – Type: int, 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(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 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
array BrickletLoadCell::getConfiguration()
Return Array:
  • '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:

  • BrickletLoadCell::RATE_10HZ = 0
  • BrickletLoadCell::RATE_80HZ = 1

For $gain:

  • BrickletLoadCell::GAIN_128X = 0
  • BrickletLoadCell::GAIN_64X = 1
  • BrickletLoadCell::GAIN_32X = 2
array BrickletLoadCell::getIdentity()
Return Array:
  • 'uid' – Type: string, Length: up to 8
  • 'connected_uid' – Type: string, Length: up to 8
  • 'position' – Type: string, Range: ['a' to 'h', 'i', 'z']
  • 'hardware_version' – Type: array(int, ...), Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, Range: [0 to 255]
  • 'firmware_version' – Type: array(int, ...), Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, Range: [0 to 255]
  • 'device_identifier' – 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as 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 BrickletLoadCell::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)
Parameters:
  • $callback_id – Type: int
  • $callback – Type: callable
  • $user_data – Type: mixed

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

void BrickletLoadCell::setWeightCallbackPeriod(int $period)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the CALLBACK_WEIGHT callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_WEIGHT callback is only triggered if the weight has changed since the last triggering.

int BrickletLoadCell::getWeightCallbackPeriod()
Returns:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setWeightCallbackPeriod().

void BrickletLoadCell::setWeightCallbackThreshold(string $option, int $min, int $max)
Parameters:
  • $option – Type: string, 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 CALLBACK_WEIGHT_REACHED callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the weight is outside the min and max values
'i' Callback is triggered when the weight is inside the min and max values
'<' Callback is triggered when the weight is smaller than the min value (max is ignored)
'>' Callback 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 = '>'
array BrickletLoadCell::getWeightCallbackThreshold()
Return Array:
  • 'option' – Type: string, 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(int $debounce)
Parameters:
  • $debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callback

is triggered, if the threshold

keeps being reached.

int BrickletLoadCell::getDebouncePeriod()
Returns:
  • $debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by setDebouncePeriod().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$load_cell->registerCallback(BrickletLoadCell::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures are described below.

Note

Using callbacks 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.

int BrickletLoadCell::CALLBACK_WEIGHT
<?php   void callback(int $weight [, mixed $user_data])   ?>
Callback Parameters:
  • $weight – Type: int, Unit: 1 g, Range: [-231 to 231 - 1]
  • $user_data – Type: mixed

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

The CALLBACK_WEIGHT callback is only triggered if the weight has changed since the last triggering.

int BrickletLoadCell::CALLBACK_WEIGHT_REACHED
<?php   void callback(int $weight [, mixed $user_data])   ?>
Callback Parameters:
  • $weight – Type: int, Unit: 1 g, Range: [-231 to 231 - 1]
  • $user_data – Type: mixed

This callback 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 callback 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.

array BrickletLoadCell::getAPIVersion()
Return Array:
  • $api_version – Type: array(int, ...), Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, 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.

bool BrickletLoadCell::getResponseExpected(int $function_id)
Parameters:
  • $function_id – Type: int, Range: See constants
Returns:
  • $response_expected – Type: bool

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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

  • 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(int $function_id, bool $response_expected)
Parameters:
  • $function_id – Type: int, Range: See constants
  • $response_expected – Type: bool

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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

  • 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(bool $response_expected)
Parameters:
  • $response_expected – Type: bool

Changes the response expected flag for all setter and callback 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::CALLBACK_ENUMERATE callback 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.