Software / API Bindings / PHP / API Referenz und Beispiele / Bricklets / Laser Range Finder Bricklet 2.0

PHP - Laser Range Finder Bricklet 2.0¶

Dies ist die Beschreibung der PHP API Bindings für das Laser Range Finder Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Laser Range Finder Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die PHP API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (ExampleSimple.php)

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLaserRangeFinderV2;

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

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

// Turn laser off
$lrf->setEnable(FALSE);

$ipcon->disconnect();

?>

Callback¶

Download (ExampleCallback.php)

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLaserRangeFinderV2;

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

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

$ipcon = new IPConnection(); // Create IP connection
$lrf = new BrickletLaserRangeFinderV2(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->setEnable(TRUE);
usleep(250*1000);

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

// Set period for distance callback to 0.2s (200ms) without a threshold
$lrf->setDistanceCallbackConfiguration(200, FALSE, 'x', 0, 0);

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

?>

Threshold¶

Download (ExampleThreshold.php)

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLaserRangeFinderV2;

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

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

$ipcon = new IPConnection(); // Create IP connection
$lrf = new BrickletLaserRangeFinderV2(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->setEnable(TRUE);
usleep(250*1000);

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

// Configure threshold for distance "greater than 20 cm"
// with a debounce period of 1s (1000ms)
$lrf->setDistanceCallbackConfiguration(1000, FALSE, '>', 20, 0);

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

?>

API¶

Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.

Grundfunktionen¶

class BrickletLaserRangeFinderV2(string $uid, IPConnection $ipcon)¶

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$laser_range_finder_v2 – Typ: BrickletLaserRangeFinderV2

Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid:

<?php   $laser_range_finder_v2 = new BrickletLaserRangeFinderV2('YOUR_DEVICE_UID', $ipcon);   ?>

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

int BrickletLaserRangeFinderV2::getDistance()¶

Rückgabe:	$distance – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 4000]

Gibt die gemessene Distanz zurück.

Der Laser muss aktiviert werden, siehe setEnable().

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_DISTANCE Callback verwendet werden. Der Callback wird mit der Funktion setDistanceCallbackConfiguration() konfiguriert.

int BrickletLaserRangeFinderV2::getVelocity()¶

Rückgabe:	$velocity – Typ: int, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Gibt die gemessene Geschwindigkeit zurück.

Die Geschwindigkeitsmessung liefert nur dann stabile Werte, wenn eine feste Messfrequenz (siehe setConfiguration()) eingestellt ist. Zusätzlich muss der Laser aktiviert werden, siehe setEnable().

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_VELOCITY Callback verwendet werden. Der Callback wird mit der Funktion setVelocityCallbackConfiguration() konfiguriert.

void BrickletLaserRangeFinderV2::setEnable(bool $enable)¶

Parameter:	$enable – Typ: bool, Standardwert: FALSE

Aktiviert den Laser des LIDAR wenn auf true gesetzt.

Wir empfehlen nach dem Aktivieren des Lasers 250ms zu warten bis zum ersten Aufruf von getDistance() um stabile Messwerte zu garantieren.

bool BrickletLaserRangeFinderV2::getEnable()¶

Rückgabe:	$enable – Typ: bool, Standardwert: FALSE

Gibt den Wert zurück wie von setEnable() gesetzt.

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

Parameter:	$acquisition_count – Typ: int, Wertebereich: [1 bis 255], Standardwert: 128 $enable_quick_termination – Typ: bool, Standardwert: FALSE $threshold_value – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0 $measurement_frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0

Der Parameter Acquisition Count definiert die Anzahl der Datenerfassungen die integriert werden, um eine Korrelation zu finden. Mit einer größeren Anzahl kann das Bricklet höhere Distanzen messen, mit einer kleineren Anzahl ist die Messrate höher. Erlaubte Werte sind 1-255.

Wenn der Parameter Enable Quick Termination auf true gesetzt wird, wird die Distanzmessung abgeschlossen, sobald das erste mal ein hoher Peak erfasst wird. Dadurch kann eine höhere Messrate erreicht werden wobei gleichzeitig Messungen mit langer Distanz möglich sind. Die Wahrscheinlichkeit einer Falschmessung erhöht sich allerdings.

Normalerweise wird die Distanz mit Hilfe eines Detektionsalgorithmus berechnet. Dieser verwendet Peak-Werte, Signalstärke und Rauschen. Es ist möglich stattdessen über den Parameter Threshold Value einen festen Schwellwert zu setzen der zur Distanzbestimmung genutzt werden soll. Um den Abstand zu einem Objekt mit sehr niedriger Reflektivität zu messen (z.B. Glas) kann der Wert niedrig gesetzt werden. Um den Abstand zu einem Objekt mit sehr hoher Reflektivität zu messen (z.B. Spiegel) kann der Wert sehr hoch gesetzt werden. Mit einem Wert von 0 wird der Standardalgorithmus genutzt. Ansonsten ist der erlaubte Wertebereich 1-255.

Der Measurement Frequency Parameter wird gesetzt. Er erzwingt eine feste Messfrequenz. Wenn der Wert auf 0 gesetzt wird, nutzt das Laser Range Finder Bricklet die optimale Frequenz je nach Konfiguration und aktuell gemessener Distanz. Da die Messrate in diesem Fall nicht fest ist, ist die Geschwindigkeitsmessung nicht stabil. Für eine stabile Geschwindigkeitsmessung sollte eine feste Messfrequenz eingestellt werden. Je niedriger die Frequenz ist, desto größer ist die Auflösung der Geschwindigkeitsmessung. Der erlaubte Wertbereich ist 10Hz-500Hz (und 0 um die feste Messfrequenz auszustellen).

Die Standardwerte für Acquisition Count, Enable Quick Termination, Threshold Value und Measurement Frequency sind 128, false, 0 und 0.

array BrickletLaserRangeFinderV2::getConfiguration()¶

Rückgabe-Array:	'acquisition_count' – Typ: int, Wertebereich: [1 bis 255], Standardwert: 128 'enable_quick_termination' – Typ: bool, Standardwert: FALSE 'threshold_value' – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0 'measurement_frequency' – Typ: int, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0

Gibt die Konfiguration zurück, wie von setConfiguration() gesetzt.

void BrickletLaserRangeFinderV2::setDistanceLEDConfig(int $config)¶

Parameter:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Konfiguriert die Distanz-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED die Distanz anzuzeigen (heller = Objekt näher).

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $config:

BrickletLaserRangeFinderV2::DISTANCE_LED_CONFIG_OFF = 0
BrickletLaserRangeFinderV2::DISTANCE_LED_CONFIG_ON = 1
BrickletLaserRangeFinderV2::DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletLaserRangeFinderV2::DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

int BrickletLaserRangeFinderV2::getDistanceLEDConfig()¶

Rückgabe:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von setDistanceLEDConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $config:

BrickletLaserRangeFinderV2::DISTANCE_LED_CONFIG_OFF = 0
BrickletLaserRangeFinderV2::DISTANCE_LED_CONFIG_ON = 1
BrickletLaserRangeFinderV2::DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletLaserRangeFinderV2::DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3

Fortgeschrittene Funktionen¶

void BrickletLaserRangeFinderV2::setMovingAverage(int $distance_average_length, int $velocity_average_length)¶

Parameter:	$distance_average_length – Typ: int, Wertebereich: [0 bis 255], Standardwert: 10 $velocity_average_length – Typ: int, Wertebereich: [0 bis 255], Standardwert: 10

Setzt die Länge eines gleitenden Mittelwerts für die Entfernung und Geschwindigkeit.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

array BrickletLaserRangeFinderV2::getMovingAverage()¶

Rückgabe-Array:	'distance_average_length' – Typ: int, Wertebereich: [0 bis 255], Standardwert: 10 'velocity_average_length' – Typ: int, Wertebereich: [0 bis 255], Standardwert: 10

Gibt die Länge des gleitenden Mittelwerts zurück, wie von setMovingAverage() gesetzt.

void BrickletLaserRangeFinderV2::setOffsetCalibration(int $offset)¶

Parameter:	$offset – Typ: int, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 28767]

Der Offset wird auf die Distanz addiert. Es wird in nicht-flüchtigen Speicher gespeichert und muss nur einmal gesetzt werden.

Der Offset wird für das Bricklet pro Sensor von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte also nicht notwendig sein.

Wenn der Offset re-kalibriert werden soll muss er zuerst auf 0 gesetzt. Danach kann der Offset wieder gesetzt werden in dem die Differenz zu einer bekannte Distanz gemessen wird.

int BrickletLaserRangeFinderV2::getOffsetCalibration()¶

Rückgabe:	$offset – Typ: int, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 28767]

Gibt den Offset-Wert zurück, wie von setOffsetCalibration() gesetzt.

array BrickletLaserRangeFinderV2::getSPITFPErrorCount()¶

Rückgabe-Array:	'error_count_ack_checksum' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'error_count_message_checksum' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'error_count_frame' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'error_count_overflow' – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

void BrickletLaserRangeFinderV2::setStatusLEDConfig(int $config)¶

Parameter:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $config:

BrickletLaserRangeFinderV2::STATUS_LED_CONFIG_OFF = 0
BrickletLaserRangeFinderV2::STATUS_LED_CONFIG_ON = 1
BrickletLaserRangeFinderV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletLaserRangeFinderV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletLaserRangeFinderV2::getStatusLEDConfig()¶

Rückgabe:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $config:

BrickletLaserRangeFinderV2::STATUS_LED_CONFIG_OFF = 0
BrickletLaserRangeFinderV2::STATUS_LED_CONFIG_ON = 1
BrickletLaserRangeFinderV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletLaserRangeFinderV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletLaserRangeFinderV2::getChipTemperature()¶

Rückgabe:	$temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

void BrickletLaserRangeFinderV2::reset()¶

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

array BrickletLaserRangeFinderV2::getIdentity()¶

Rückgabe-Array:

Rückgabe-Array:	'uid' – Typ: string, Länge: bis zu 8 'connected_uid' – Typ: string, Länge: bis zu 8 'position' – Typ: string, Wertebereich: ['a' bis 'h', 'z'] 'hardware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'firmware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'device_identifier' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

'uid' – Typ: string, Länge: bis zu 8
'connected_uid' – Typ: string, Länge: bis zu 8
'position' – Typ: string, Wertebereich: ['a' bis 'h', 'z']
'hardware_version' – Typ: array(int, ...), Länge: 3

0: $major – Typ: int, Wertebereich: [0 bis 255]
1: $minor – Typ: int, Wertebereich: [0 bis 255]
2: $revision – Typ: int, Wertebereich: [0 bis 255]

'firmware_version' – Typ: array(int, ...), Länge: 3

0: $major – Typ: int, Wertebereich: [0 bis 255]
1: $minor – Typ: int, Wertebereich: [0 bis 255]
2: $revision – Typ: int, Wertebereich: [0 bis 255]

'device_identifier' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

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

Parameter:	$callback_id – Typ: int $callback – Typ: callable $user_data – Typ: mixed

Registriert die $function für die gegebene $callback_id. Die optionalen $user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

void BrickletLaserRangeFinderV2::setDistanceCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)¶

Parameter:

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 $value_has_to_change – Typ: bool, Standardwert: FALSE $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x' $min – Typ: int, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 $max – Typ: int, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
$value_has_to_change – Typ: bool, Standardwert: FALSE
$option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
$min – Typ: int, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
$max – Typ: int, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

Die Periode ist die Periode mit der der CALLBACK_DISTANCE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_DISTANCE Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $option:

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

array BrickletLaserRangeFinderV2::getDistanceCallbackConfiguration()¶

Rückgabe-Array:

Rückgabe-Array:	'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 'value_has_to_change' – Typ: bool, Standardwert: FALSE 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x' 'min' – Typ: int, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 'max' – Typ: int, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
'value_has_to_change' – Typ: bool, Standardwert: FALSE
'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
'min' – Typ: int, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
'max' – Typ: int, Einheit: 1 cm, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels setDistanceCallbackConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $option:

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

void BrickletLaserRangeFinderV2::setVelocityCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)¶

Parameter:

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 $value_has_to_change – Typ: bool, Standardwert: FALSE $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x' $min – Typ: int, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 $max – Typ: int, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
$value_has_to_change – Typ: bool, Standardwert: FALSE
$option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
$min – Typ: int, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
$max – Typ: int, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

Die Periode ist die Periode mit der der CALLBACK_VELOCITY Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_VELOCITY Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $option:

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

array BrickletLaserRangeFinderV2::getVelocityCallbackConfiguration()¶

Rückgabe-Array:

Rückgabe-Array:	'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 'value_has_to_change' – Typ: bool, Standardwert: FALSE 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x' 'min' – Typ: int, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0 'max' – Typ: int, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
'value_has_to_change' – Typ: bool, Standardwert: FALSE
'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
'min' – Typ: int, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0
'max' – Typ: int, Einheit: 1 cm/s, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels setVelocityCallbackConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $option:

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

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion registerCallback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite die Callback-Funktion:

<?php

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

$laser_range_finder_v2->registerCallback(BrickletLaserRangeFinderV2::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

int BrickletLaserRangeFinderV2::CALLBACK_DISTANCE¶

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

Callback-Parameter:	$distance – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 4000] $user_data – Typ: mixed

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setDistanceCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getDistance().

int BrickletLaserRangeFinderV2::CALLBACK_VELOCITY¶

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

Callback-Parameter:	$velocity – Typ: int, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700] $user_data – Typ: mixed

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setVelocityCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getVelocity().

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

array BrickletLaserRangeFinderV2::getAPIVersion()¶

Rückgabe-Array:	$api_version – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

bool BrickletLaserRangeFinderV2::getResponseExpected(int $function_id)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	$response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels setResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $function_id:

BrickletLaserRangeFinderV2::FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
BrickletLaserRangeFinderV2::FUNCTION_SET_VELOCITY_CALLBACK_CONFIGURATION = 6
BrickletLaserRangeFinderV2::FUNCTION_SET_ENABLE = 9
BrickletLaserRangeFinderV2::FUNCTION_SET_CONFIGURATION = 11
BrickletLaserRangeFinderV2::FUNCTION_SET_MOVING_AVERAGE = 13
BrickletLaserRangeFinderV2::FUNCTION_SET_OFFSET_CALIBRATION = 15
BrickletLaserRangeFinderV2::FUNCTION_SET_DISTANCE_LED_CONFIG = 17
BrickletLaserRangeFinderV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletLaserRangeFinderV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletLaserRangeFinderV2::FUNCTION_RESET = 243
BrickletLaserRangeFinderV2::FUNCTION_WRITE_UID = 248

void BrickletLaserRangeFinderV2::setResponseExpected(int $function_id, bool $response_expected)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten $response_expected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $function_id:

BrickletLaserRangeFinderV2::FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
BrickletLaserRangeFinderV2::FUNCTION_SET_VELOCITY_CALLBACK_CONFIGURATION = 6
BrickletLaserRangeFinderV2::FUNCTION_SET_ENABLE = 9
BrickletLaserRangeFinderV2::FUNCTION_SET_CONFIGURATION = 11
BrickletLaserRangeFinderV2::FUNCTION_SET_MOVING_AVERAGE = 13
BrickletLaserRangeFinderV2::FUNCTION_SET_OFFSET_CALIBRATION = 15
BrickletLaserRangeFinderV2::FUNCTION_SET_DISTANCE_LED_CONFIG = 17
BrickletLaserRangeFinderV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletLaserRangeFinderV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletLaserRangeFinderV2::FUNCTION_RESET = 243
BrickletLaserRangeFinderV2::FUNCTION_WRITE_UID = 248

void BrickletLaserRangeFinderV2::setResponseExpectedAll(bool $response_expected)¶

Parameter:	$response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int BrickletLaserRangeFinderV2::setBootloaderMode(int $mode)¶

Parameter:	$mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	$status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $mode:

BrickletLaserRangeFinderV2::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletLaserRangeFinderV2::BOOTLOADER_MODE_FIRMWARE = 1
BrickletLaserRangeFinderV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletLaserRangeFinderV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletLaserRangeFinderV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für $status:

BrickletLaserRangeFinderV2::BOOTLOADER_STATUS_OK = 0
BrickletLaserRangeFinderV2::BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletLaserRangeFinderV2::BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletLaserRangeFinderV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletLaserRangeFinderV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletLaserRangeFinderV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletLaserRangeFinderV2::getBootloaderMode()¶

Rückgabe:	$mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $mode:

BrickletLaserRangeFinderV2::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletLaserRangeFinderV2::BOOTLOADER_MODE_FIRMWARE = 1
BrickletLaserRangeFinderV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletLaserRangeFinderV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletLaserRangeFinderV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletLaserRangeFinderV2::setWriteFirmwarePointer(int $pointer)¶

Parameter:	$pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int BrickletLaserRangeFinderV2::writeFirmware(array $data)¶

Parameter:	$data – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	$status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

void BrickletLaserRangeFinderV2::writeUID(int $uid)¶

Parameter:	$uid – Typ: int, Wertebereich: [0 bis 2³² - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

int BrickletLaserRangeFinderV2::readUID()¶

Rückgabe:	$uid – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

int BrickletLaserRangeFinderV2::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Laser Range Finder Bricklet 2.0 zu identifizieren.

Die getIdentity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickletLaserRangeFinderV2::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Laser Range Finder Bricklet 2.0 dar.