PHP - Laser Range Finder Bricklet

This is the description of the PHP API bindings for the Laser Range Finder Bricklet. General information and technical specifications for the Laser Range Finder 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
28
29
30
31
32
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLaserRangeFinder;

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

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

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

// Turn laser on and wait 250ms for very first measurement to be ready
$lrf->enableLaser();
usleep(250*1000);

// Get current distance
$distance = $lrf->getDistance();
echo "Distance: $distance cm\n";

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$lrf->disableLaser(); // Turn laser off
$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
37
38
39
40
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLaserRangeFinder;

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

// Callback function for distance callback
function cb_distance($distance)
{
    echo "Distance: $distance cm\n";
}

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

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

// Turn laser on and wait 250ms for very first measurement to be ready
$lrf->enableLaser();
usleep(250*1000);

// Register distance callback to function cb_distance
$lrf->registerCallback(BrickletLaserRangeFinder::CALLBACK_DISTANCE, 'cb_distance');

// Set period for distance callback to 0.2s (200ms)
// Note: The distance callback is only called every 0.2 seconds
//       if the distance has changed since the last call!
$lrf->setDistanceCallbackPeriod(200);

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
39
40
41
42
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLaserRangeFinder;

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

// Callback function for distance reached callback
function cb_distanceReached($distance)
{
    echo "Distance: $distance cm\n";
}

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

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

// Turn laser on and wait 250ms for very first measurement to be ready
$lrf->enableLaser();
usleep(250*1000);

// Get threshold callbacks with a debounce time of 10 seconds (10000ms)
$lrf->setDebouncePeriod(10000);

// Register distance reached callback to function cb_distanceReached
$lrf->registerCallback(BrickletLaserRangeFinder::CALLBACK_DISTANCE_REACHED,
                       'cb_distanceReached');

// Configure threshold for distance "greater than 20 cm"
$lrf->setDistanceCallbackThreshold('>', 20, 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 BrickletLaserRangeFinder(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $laser_range_finder = new BrickletLaserRangeFinder('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletLaserRangeFinder::getDistance()

Returns the measured distance. The value has a range of 0 to 4000 and is given in cm.

Sensor hardware version 1 (see getSensorHardwareVersion()) cannot measure distance and velocity at the same time. Therefore, the distance mode has to be enabled using setMode(). Sensor hardware version 3 can measure distance and velocity at the same time. Also the laser has to be enabled, see enableLaser().

If you want to get the distance periodically, it is recommended to use the CALLBACK_DISTANCE callback and set the period with setDistanceCallbackPeriod().

int BrickletLaserRangeFinder::getVelocity()

Returns the measured velocity. The value has a range of -12800 to 12700 and is given in 1/100 m/s.

Sensor hardware version 1 (see getSensorHardwareVersion()) cannot measure distance and velocity at the same time. Therefore, the velocity mode has to be enabled using setMode(). Sensor hardware version 3 can measure distance and velocity at the same time, but the velocity measurement only produces stables results if a fixed measurement rate (see setConfiguration()) is configured. Also the laser has to be enabled, see enableLaser().

If you want to get the velocity periodically, it is recommended to use the CALLBACK_VELOCITY callback and set the period with setVelocityCallbackPeriod().

void BrickletLaserRangeFinder::setMode(int $mode)

Note

This function is only available if you have a LIDAR-Lite sensor with hardware version 1. Use setConfiguration() for hardware version 3. You can check the sensor hardware version using getSensorHardwareVersion().

The LIDAR-Lite sensor (hardware version 1) has five different modes. One mode is for distance measurements and four modes are for velocity measurements with different ranges.

The following modes are available:

  • 0: Distance is measured with resolution 1.0 cm and range 0-400 cm
  • 1: Velocity is measured with resolution 0.1 m/s and range is 0-12.7 m/s
  • 2: Velocity is measured with resolution 0.25 m/s and range is 0-31.75 m/s
  • 3: Velocity is measured with resolution 0.5 m/s and range is 0-63.5 m/s
  • 4: Velocity is measured with resolution 1.0 m/s and range is 0-127 m/s

The default mode is 0 (distance is measured).

The following constants are available for this function:

  • BrickletLaserRangeFinder::MODE_DISTANCE = 0
  • BrickletLaserRangeFinder::MODE_VELOCITY_MAX_13MS = 1
  • BrickletLaserRangeFinder::MODE_VELOCITY_MAX_32MS = 2
  • BrickletLaserRangeFinder::MODE_VELOCITY_MAX_64MS = 3
  • BrickletLaserRangeFinder::MODE_VELOCITY_MAX_127MS = 4
int BrickletLaserRangeFinder::getMode()

Returns the mode as set by setMode().

The following constants are available for this function:

  • BrickletLaserRangeFinder::MODE_DISTANCE = 0
  • BrickletLaserRangeFinder::MODE_VELOCITY_MAX_13MS = 1
  • BrickletLaserRangeFinder::MODE_VELOCITY_MAX_32MS = 2
  • BrickletLaserRangeFinder::MODE_VELOCITY_MAX_64MS = 3
  • BrickletLaserRangeFinder::MODE_VELOCITY_MAX_127MS = 4
void BrickletLaserRangeFinder::enableLaser()

Activates the laser of the LIDAR.

We recommend that you wait 250ms after enabling the laser before the first call of getDistance() to ensure stable measurements.

void BrickletLaserRangeFinder::disableLaser()

Deactivates the laser of the LIDAR.

bool BrickletLaserRangeFinder::isLaserEnabled()

Returns true if the laser is enabled, false otherwise.

void BrickletLaserRangeFinder::setConfiguration(int $acquisition_count, bool $enable_quick_termination, int $threshold_value, int $measurement_frequency)

Note

This function is only available if you have a LIDAR-Lite sensor with hardware version 3. Use setMode() for hardware version 1. You can check the sensor hardware version using getSensorHardwareVersion().

The Aquisition Count defines the number of times the Laser Range Finder Bricklet will integrate acquisitions to find a correlation record peak. With a higher count, the Bricklet can measure longer distances. With a lower count, the rate increases. The allowed values are 1-255.

If you set Enable Quick Termination to true, the distance measurement will be terminated early if a high peak was already detected. This means that a higher measurement rate can be achieved and long distances can be measured at the same time. However, the chance of false-positive distance measurements increases.

Normally the distance is calculated with a detection algorithm that uses peak value, signal strength and noise. You can however also define a fixed Threshold Value. Set this to a low value if you want to measure the distance to something that has very little reflection (e.g. glass) and set it to a high value if you want to measure the distance to something with a very high reflection (e.g. mirror). Set this to 0 to use the default algorithm. The other allowed values are 1-255.

Set the Measurement Frequency in Hz to force a fixed measurement rate. If set to 0, the Laser Range Finder Bricklet will use the optimal frequency according to the other configurations and the actual measured distance. Since the rate is not fixed in this case, the velocity measurement is not stable. For a stable velocity measurement you should set a fixed measurement frequency. The lower the frequency, the higher is the resolution of the calculated velocity. The allowed values are 10Hz-500Hz (and 0 to turn the fixed frequency off).

The default values for Acquisition Count, Enable Quick Termination, Threshold Value and Measurement Frequency are 128, false, 0 and 0.

New in version 2.0.3 (Plugin).

array BrickletLaserRangeFinder::getConfiguration()

Returns the configuration as set by setConfiguration().

New in version 2.0.3 (Plugin).

The returned array has the keys acquisition_count, enable_quick_termination, threshold_value and measurement_frequency.

Advanced Functions

void BrickletLaserRangeFinder::setMovingAverage(int $distance_average_length, int $velocity_average_length)

Sets the length of a moving averaging for the distance and velocity.

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

The range for the averaging is 0-30.

The default value is 10.

array BrickletLaserRangeFinder::getMovingAverage()

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

The returned array has the keys distance_average_length and velocity_average_length.

int BrickletLaserRangeFinder::getSensorHardwareVersion()

Returns the LIDAR-Lite hardware version.

The following constants are available for this function:

  • BrickletLaserRangeFinder::VERSION_1 = 1
  • BrickletLaserRangeFinder::VERSION_3 = 3

New in version 2.0.3 (Plugin).

array BrickletLaserRangeFinder::getAPIVersion()

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.

bool BrickletLaserRangeFinder::getResponseExpected(int $function_id)

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.

See setResponseExpected() for the list of function ID constants available for this function.

void BrickletLaserRangeFinder::setResponseExpected(int $function_id, bool $response_expected)

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 function ID constants are available for this function:

  • BrickletLaserRangeFinder::FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 3
  • BrickletLaserRangeFinder::FUNCTION_SET_VELOCITY_CALLBACK_PERIOD = 5
  • BrickletLaserRangeFinder::FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 7
  • BrickletLaserRangeFinder::FUNCTION_SET_VELOCITY_CALLBACK_THRESHOLD = 9
  • BrickletLaserRangeFinder::FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletLaserRangeFinder::FUNCTION_SET_MOVING_AVERAGE = 13
  • BrickletLaserRangeFinder::FUNCTION_SET_MODE = 15
  • BrickletLaserRangeFinder::FUNCTION_ENABLE_LASER = 17
  • BrickletLaserRangeFinder::FUNCTION_DISABLE_LASER = 18
  • BrickletLaserRangeFinder::FUNCTION_SET_CONFIGURATION = 25
void BrickletLaserRangeFinder::setResponseExpectedAll(bool $response_expected)

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

array BrickletLaserRangeFinder::getIdentity()

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 array has the keys uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

void BrickletLaserRangeFinder::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)

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 BrickletLaserRangeFinder::setDistanceCallbackPeriod(int $period)

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

The CALLBACK_DISTANCE callback is only triggered if the distance value has changed since the last triggering.

The default value is 0.

int BrickletLaserRangeFinder::getDistanceCallbackPeriod()

Returns the period as set by setDistanceCallbackPeriod().

void BrickletLaserRangeFinder::setVelocityCallbackPeriod(int $period)

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

The CALLBACK_VELOCITY callback is only triggered if the velocity value has changed since the last triggering.

The default value is 0.

int BrickletLaserRangeFinder::getVelocityCallbackPeriod()

Returns the period as set by setVelocityCallbackPeriod().

void BrickletLaserRangeFinder::setDistanceCallbackThreshold(string $option, int $min, int $max)

Sets the thresholds for the CALLBACK_DISTANCE_REACHED callback.

The following options are possible:

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

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletLaserRangeFinder::THRESHOLD_OPTION_OFF = 'x'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_GREATER = '>'
array BrickletLaserRangeFinder::getDistanceCallbackThreshold()

Returns the threshold as set by setDistanceCallbackThreshold().

The following constants are available for this function:

  • BrickletLaserRangeFinder::THRESHOLD_OPTION_OFF = 'x'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_GREATER = '>'

The returned array has the keys option, min and max.

void BrickletLaserRangeFinder::setVelocityCallbackThreshold(string $option, int $min, int $max)

Sets the thresholds for the CALLBACK_VELOCITY_REACHED callback.

The following options are possible:

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

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletLaserRangeFinder::THRESHOLD_OPTION_OFF = 'x'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_GREATER = '>'
array BrickletLaserRangeFinder::getVelocityCallbackThreshold()

Returns the threshold as set by setVelocityCallbackThreshold().

The following constants are available for this function:

  • BrickletLaserRangeFinder::THRESHOLD_OPTION_OFF = 'x'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletLaserRangeFinder::THRESHOLD_OPTION_GREATER = '>'

The returned array has the keys option, min and max.

void BrickletLaserRangeFinder::setDebouncePeriod(int $debounce)

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

int BrickletLaserRangeFinder::getDebouncePeriod()

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";
}

$laser_range_finder->registerCallback(BrickletLaserRangeFinder::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 BrickletLaserRangeFinder::CALLBACK_DISTANCE
<?php   void callback(int $distance [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setDistanceCallbackPeriod(). The parameter is the distance value of the sensor.

The CALLBACK_DISTANCE callback is only triggered if the distance value has changed since the last triggering.

int BrickletLaserRangeFinder::CALLBACK_VELOCITY
<?php   void callback(int $velocity [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setVelocityCallbackPeriod(). The parameter is the velocity value of the sensor.

The CALLBACK_VELOCITY callback is only triggered if the velocity has changed since the last triggering.

int BrickletLaserRangeFinder::CALLBACK_DISTANCE_REACHED
<?php   void callback(int $distance [, mixed $user_data])   ?>

This callback is triggered when the threshold as set by setDistanceCallbackThreshold() is reached. The parameter is the distance value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

int BrickletLaserRangeFinder::CALLBACK_VELOCITY_REACHED
<?php   void callback(int $velocity [, mixed $user_data])   ?>

This callback is triggered when the threshold as set by setVelocityCallbackThreshold() is reached. The parameter is the velocity value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

Constants

int BrickletLaserRangeFinder::DEVICE_IDENTIFIER

This constant is used to identify a Laser Range Finder Bricklet.

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

string BrickletLaserRangeFinder::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Laser Range Finder Bricklet.