PHP - Line Bricklet

Dies ist die Beschreibung der PHP API Bindings für das Line Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Line Bricklet 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)

 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

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

Grundfunktionen

class BrickletLine(string $uid, IPConnection $ipcon)

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

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

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

int BrickletLine::getReflectivity()

Gibt die aktuell gemessene Reflektivität zurück. Die Reflektivität ist ein Wert zwischen 0 (nicht reflektiv) und 4095 (sehr reflektiv).

Normalerweise hat schwarz eine geringe Reflektivität während weiß eine hohe Reflektivität hat.

Wenn die Reflektivität periodisch abgefragt werden soll, wird empfohlen den CALLBACK_REFLECTIVITY Callback zu nutzen und die Periode mit setReflectivityCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

array BrickletLine::getAPIVersion()

Gibt die Version der API Definition (Major, Minor, Revision) 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 BrickletLine::getResponseExpected(int $function_id)

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:

  • 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)

Ä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.

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:

  • 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)

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

array BrickletLine::getIdentity()

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 kann 'a', 'b', 'c' oder 'd' sein.

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

Das zurückgegebene Array enthält die Keys uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

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

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 BrickletLine::setReflectivityCallbackPeriod(int $period)

Setzt die Periode in ms mit welcher der CALLBACK_REFLECTIVITY Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CALLBACK_REFLECTIVITY Callback wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

int BrickletLine::getReflectivityCallbackPeriod()

Gibt die Periode zurück, wie von setReflectivityCallbackPeriod() gesetzt.

void BrickletLine::setReflectivityCallbackThreshold(string $option, int $min, int $max)

Setzt den Schwellwert für den CALLBACK_REFLECTIVITY_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Reflektivität außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Reflektivität innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Reflektivität kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Reflektivität größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

  • 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()

Gibt den Schwellwert zurück, wie von setReflectivityCallbackThreshold() gesetzt.

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

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

Das zurückgegebene Array enthält die Keys option, min und max.

void BrickletLine::setDebouncePeriod(int $debounce)

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

int BrickletLine::getDebouncePeriod()

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

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

$line->registerCallback(BrickletLine::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 BrickletLine::CALLBACK_REFLECTIVITY
<?php   void callback(int $reflectivity [, mixed $user_data])   ?>

Dieser Callback wird mit der Periode, wie gesetzt mit setReflectivityCallbackPeriod(), ausgelöst. Der Parameter ist die Reflektivität des Sensors.

Der CALLBACK_REFLECTIVITY Callback wird nur ausgelöst, wenn sich die Reflektivität seit der letzten Auslösung geändert hat.

int BrickletLine::CALLBACK_REFLECTIVITY_REACHED
<?php   void callback(int $reflectivity [, mixed $user_data])   ?>

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setReflectivityCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Reflektivität des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

Konstanten

int BrickletLine::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Line Bricklet 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 BrickletLine::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Line Bricklet dar.