PHP - Distance IR Bricklet 2.0

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

 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/BrickletDistanceIRV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletDistanceIRV2;

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

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

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

// Get current distance
$distance = $dir->getDistance();
echo "Distance: " . $distance/10.0 . " cm\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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletDistanceIRV2;

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

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

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

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

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

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

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletDistanceIRV2;

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

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

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

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

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

// Configure threshold for distance "smaller than 30 cm"
// with a debounce period of 1s (1000ms)
$dir->setDistanceCallbackConfiguration(1000, FALSE, '<', 30*10, 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 BrickletDistanceIRV2(string $uid, IPConnection $ipcon)

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

<?php   $distance_ir_v2 = new BrickletDistanceIRV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletDistanceIRV2::getDistance()

Gibt die gemessene Entfernung des Sensors zurück. Der Wert ist in mm und die möglichen Entfernungsbereiche sind 40 bis 300, 100 bis 800 und 200 bis 1500, in Abhängigkeit vom gewählten IR Sensor.

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

int BrickletDistanceIRV2::getAnalogValue()

Gibt den Analogwert des Analog/Digital-Wandler zurück. Der Wert hat 21 Bit und einen Wertebereich von 0 bis 2097151.

Dieser Wert ist ein unverarbeiteter Rohwert. Wir haben sichergestellt, dass die Integrationszeit des ADCs kleiner ist als das Messintervall des Sensors (10ms vs 16,5ms). Dadurch ist sichergestellt das keine Informationen verloren gehen können.

Der Analogwert kann genutzt werden wenn eine eigene Kalibrierung oder Lookup-Tabelle benötigt wird.

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

void BrickletDistanceIRV2::setMovingAverageConfiguration(int $moving_average_length)

Setzt die Länge eines gleitenden Mittelwerts für die Distanz.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Desto kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-1000.

Einer neue Wert wird alle ~10ms gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von ca. 10s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

Der Standardwert ist 25.

int BrickletDistanceIRV2::getMovingAverageConfiguration()

Gibt die Moving Average-Konfiguration zurück, wie von setMovingAverageConfiguration() gesetzt.

void BrickletDistanceIRV2::setDistanceLEDConfig(int $config)

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

Der Standardwert ist 3 (Distanzanzeige).

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

  • BrickletDistanceIRV2::DISTANCE_LED_CONFIG_OFF = 0
  • BrickletDistanceIRV2::DISTANCE_LED_CONFIG_ON = 1
  • BrickletDistanceIRV2::DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDistanceIRV2::DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3
int BrickletDistanceIRV2::getDistanceLEDConfig()

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

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

  • BrickletDistanceIRV2::DISTANCE_LED_CONFIG_OFF = 0
  • BrickletDistanceIRV2::DISTANCE_LED_CONFIG_ON = 1
  • BrickletDistanceIRV2::DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDistanceIRV2::DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3
void BrickletDistanceIRV2::setSensorType(int $sensor)

Setzt den Sensor-Typ.

Das Bricklet kommt vorkonfiguriert mit dem korrektem Sensor und der Sensor-Typ wird im Flash gespeichert (d.h. das Bricklet behält die Einstellung auch wenn es vom Strom getrennt wird).

Die Einstellung kann im Brick Viewer vorgenommen werden. Diese Funktion sollte in einem externen Programm also nicht ausgeführt werden müssen.

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

  • BrickletDistanceIRV2::SENSOR_TYPE_2Y0A41 = 0
  • BrickletDistanceIRV2::SENSOR_TYPE_2Y0A21 = 1
  • BrickletDistanceIRV2::SENSOR_TYPE_2Y0A02 = 2
int BrickletDistanceIRV2::getSensorType()

Gibt den Sensor-Typ zurück, wie von setSensorType() gesetzt.

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

  • BrickletDistanceIRV2::SENSOR_TYPE_2Y0A41 = 0
  • BrickletDistanceIRV2::SENSOR_TYPE_2Y0A21 = 1
  • BrickletDistanceIRV2::SENSOR_TYPE_2Y0A02 = 2

Fortgeschrittene Funktionen

array BrickletDistanceIRV2::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 BrickletDistanceIRV2::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.

Siehe setResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

void BrickletDistanceIRV2::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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletDistanceIRV2::FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
  • BrickletDistanceIRV2::FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION = 6
  • BrickletDistanceIRV2::FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 9
  • BrickletDistanceIRV2::FUNCTION_SET_DISTANCE_LED_CONFIG = 11
  • BrickletDistanceIRV2::FUNCTION_SET_SENSOR_TYPE = 13
  • BrickletDistanceIRV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletDistanceIRV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletDistanceIRV2::FUNCTION_RESET = 243
  • BrickletDistanceIRV2::FUNCTION_WRITE_UID = 248
void BrickletDistanceIRV2::setResponseExpectedAll(bool $response_expected)

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

array BrickletDistanceIRV2::getSPITFPErrorCount()

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.

Das zurückgegebene Array enthält die Keys error_count_ack_checksum, error_count_message_checksum, error_count_frame und error_count_overflow.

int BrickletDistanceIRV2::setBootloaderMode(int $mode)

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

  • BrickletDistanceIRV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletDistanceIRV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletDistanceIRV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletDistanceIRV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletDistanceIRV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletDistanceIRV2::BOOTLOADER_STATUS_OK = 0
  • BrickletDistanceIRV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletDistanceIRV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletDistanceIRV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletDistanceIRV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletDistanceIRV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletDistanceIRV2::getBootloaderMode()

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

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

  • BrickletDistanceIRV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletDistanceIRV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletDistanceIRV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletDistanceIRV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletDistanceIRV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletDistanceIRV2::setWriteFirmwarePointer(int $pointer)

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 BrickletDistanceIRV2::writeFirmware(array $data)

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 BrickletDistanceIRV2::setStatusLEDConfig(int $config)

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:

  • BrickletDistanceIRV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletDistanceIRV2::STATUS_LED_CONFIG_ON = 1
  • BrickletDistanceIRV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDistanceIRV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletDistanceIRV2::getStatusLEDConfig()

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

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

  • BrickletDistanceIRV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletDistanceIRV2::STATUS_LED_CONFIG_ON = 1
  • BrickletDistanceIRV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDistanceIRV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletDistanceIRV2::getChipTemperature()

Gibt die Temperatur in °C, 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 BrickletDistanceIRV2::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.

void BrickletDistanceIRV2::writeUID(int $uid)

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 BrickletDistanceIRV2::readUID()

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

array BrickletDistanceIRV2::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 Bricklet.

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

Konfigurationsfunktionen für Callbacks

void BrickletDistanceIRV2::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 BrickletDistanceIRV2::setDistanceCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)

Die Periode in ms 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.

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

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

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

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

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

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

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

void BrickletDistanceIRV2::setAnalogValueCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)

Die Periode in ms ist die Periode mit der der CALLBACK_ANALOG_VALUE 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_ANALOG_VALUE 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.

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

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

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

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

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

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

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

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

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

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

Der Parameter ist der gleiche wie getDistance().

int BrickletDistanceIRV2::CALLBACK_ANALOG_VALUE
<?php   void callback(int $analog_value [, mixed $user_data])   ?>

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

Der Parameter ist der gleiche wie getAnalogValue().

Konstanten

int BrickletDistanceIRV2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Distance IR Bricklet 2.0 zu identifizieren.

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

string BrickletDistanceIRV2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Distance IR Bricklet 2.0 dar.