PHP - Line Bricklet

This is the description of the PHP API bindings for the Line Bricklet. General information and technical specifications for the Line 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/BrickletLine.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLine;

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

$ipcon = new IPConnection(); // Create IP connection
$l = new BrickletLine(UID, $ipcon); // Create device object

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

// Get current reflectivity
$reflectivity = $l->getReflectivity();
echo "Reflectivity: $reflectivity\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/BrickletLine.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLine;

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

// Callback function for reflectivity callback
function cb_reflectivity($reflectivity)
{
    echo "Reflectivity: $reflectivity\n";
}

$ipcon = new IPConnection(); // Create IP connection
$l = new BrickletLine(UID, $ipcon); // Create device object

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

// Register reflectivity callback to function cb_reflectivity
$l->registerCallback(BrickletLine::CALLBACK_REFLECTIVITY, 'cb_reflectivity');

// Set period for reflectivity callback to 1s (1000ms)
// Note: The reflectivity callback is only called every second
//       if the reflectivity has changed since the last call!
$l->setReflectivityCallbackPeriod(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
38
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLine;

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

// Callback function for reflectivity reached callback
function cb_reflectivityReached($reflectivity)
{
    echo "Reflectivity: $reflectivity\n";
}

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

// Register reflectivity reached callback to function cb_reflectivityReached
$l->registerCallback(BrickletLine::CALLBACK_REFLECTIVITY_REACHED,
                     'cb_reflectivityReached');

// Configure threshold for reflectivity "greater than 2000"
$l->setReflectivityCallbackThreshold('>', 2000, 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 BrickletLine(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $line – Type: BrickletLine

Creates an object with the unique device ID $uid:

<?php   $line = new BrickletLine('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletLine::getReflectivity()
Returns:
  • $reflectivity – Type: int, Range: [0 to 4095]

Returns the currently measured reflectivity. The reflectivity is a value between 0 (not reflective) and 4095 (very reflective).

Usually black has a low reflectivity while white has a high reflectivity.

If you want to get the reflectivity periodically, it is recommended to use the CALLBACK_REFLECTIVITY callback and set the period with setReflectivityCallbackPeriod().

Advanced Functions

array BrickletLine::getIdentity()
Return Array:
  • 'uid' – Type: string, Length: up to 8
  • 'connected_uid' – Type: string, Length: up to 8
  • 'position' – Type: string, Range: ['a' to '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 BrickletLine::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 BrickletLine::setReflectivityCallbackPeriod(int $period)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The CALLBACK_REFLECTIVITY callback is only triggered if the reflectivity has changed since the last triggering.

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

Returns the period as set by setReflectivityCallbackPeriod().

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

The following options are possible:

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

The following constants are available for this function:

For $option:

  • BrickletLine::THRESHOLD_OPTION_OFF = 'x'
  • BrickletLine::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLine::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLine::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLine::THRESHOLD_OPTION_GREATER = '>'
array BrickletLine::getReflectivityCallbackThreshold()
Return Array:
  • 'option' – Type: string, 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 setReflectivityCallbackThreshold().

The following constants are available for this function:

For $option:

  • BrickletLine::THRESHOLD_OPTION_OFF = 'x'
  • BrickletLine::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLine::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLine::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLine::THRESHOLD_OPTION_GREATER = '>'
void BrickletLine::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 BrickletLine::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";
}

$line->registerCallback(BrickletLine::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 BrickletLine::CALLBACK_REFLECTIVITY
<?php   void callback(int $reflectivity [, mixed $user_data])   ?>
Callback Parameters:
  • $reflectivity – Type: int, Range: [0 to 4095]
  • $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setReflectivityCallbackPeriod(). The parameter is the reflectivity of the sensor.

The CALLBACK_REFLECTIVITY callback is only triggered if the reflectivity has changed since the last triggering.

int BrickletLine::CALLBACK_REFLECTIVITY_REACHED
<?php   void callback(int $reflectivity [, mixed $user_data])   ?>
Callback Parameters:
  • $reflectivity – Type: int, Range: [0 to 4095]
  • $user_data – Type: mixed

This callback is triggered when the threshold as set by setReflectivityCallbackThreshold() is reached. The parameter is the reflectivity of the sensor.

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 BrickletLine::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 BrickletLine::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:

  • BrickletLine::FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD = 2
  • BrickletLine::FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD = 4
  • BrickletLine::FUNCTION_SET_DEBOUNCE_PERIOD = 6
void BrickletLine::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:

  • BrickletLine::FUNCTION_SET_REFLECTIVITY_CALLBACK_PERIOD = 2
  • BrickletLine::FUNCTION_SET_REFLECTIVITY_CALLBACK_THRESHOLD = 4
  • BrickletLine::FUNCTION_SET_DEBOUNCE_PERIOD = 6
void BrickletLine::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 BrickletLine::DEVICE_IDENTIFIER

This constant is used to identify a Line 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 BrickletLine::DEVICE_DISPLAY_NAME

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