PHP - Rotary Poti Bricklet

Dies ist die Beschreibung der PHP API Bindings für das Rotary Poti Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Rotary Poti 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/BrickletRotaryPoti.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletRotaryPoti;

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

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

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

// Get current position
$position = $rp->getPosition();
echo "Position: $position\n"; // Range: -150 to 150

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletRotaryPoti;

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

// Callback function for position callback
function cb_position($position)
{
    echo "Position: $position\n"; // Range: -150 to 150
}

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

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

// Register position callback to function cb_position
$rp->registerCallback(BrickletRotaryPoti::CALLBACK_POSITION, 'cb_position');

// Set period for position callback to 0.05s (50ms)
// Note: The position callback is only called every 0.05 seconds
//       if the position has changed since the last call!
$rp->setPositionCallbackPeriod(50);

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 BrickletRotaryPoti(string $uid, IPConnection $ipcon)

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

<?php   $rotary_poti = new BrickletRotaryPoti('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletRotaryPoti::getPosition()

Gibt die Position des Drehpotentiometers zurück. Der Wertebereich ist in Grad und ist von -150° (links gedreht) und 150° (rechts gedreht).

Wenn die Position periodisch abgefragt werden soll, wird empfohlen den CALLBACK_POSITION Callback zu nutzen und die Periode mit setPositionCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

int BrickletRotaryPoti::getAnalogValue()

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von getPosition() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während getAnalogValue() unverarbeitete Analogwerte zurück gibt. Der einzige Grund getAnalogValue() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit setAnalogValueCallbackPeriod() vorzugeben.

array BrickletRotaryPoti::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 BrickletRotaryPoti::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 BrickletRotaryPoti::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:

  • BrickletRotaryPoti::FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
  • BrickletRotaryPoti::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletRotaryPoti::FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
  • BrickletRotaryPoti::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletRotaryPoti::FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletRotaryPoti::setResponseExpectedAll(bool $response_expected)

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

array BrickletRotaryPoti::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 BrickletRotaryPoti::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 BrickletRotaryPoti::setPositionCallbackPeriod(int $period)

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

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

Der Standardwert ist 0.

int BrickletRotaryPoti::getPositionCallbackPeriod()

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

void BrickletRotaryPoti::setAnalogValueCallbackPeriod(int $period)

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

Der CALLBACK_ANALOG_VALUE Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

int BrickletRotaryPoti::getAnalogValueCallbackPeriod()

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

void BrickletRotaryPoti::setPositionCallbackThreshold(string $option, int $min, int $max)

Setzt den Schwellwert für den CALLBACK_POSITION_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Position außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn die Position innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn die Position kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Position 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:

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

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

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

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

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

void BrickletRotaryPoti::setAnalogValueCallbackThreshold(string $option, int $min, int $max)

Setzt den Schwellwert für den CALLBACK_ANALOG_VALUE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Analogwert außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn der Analogwert innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Analogwert 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:

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

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

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

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

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

void BrickletRotaryPoti::setDebouncePeriod(int $debounce)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

int BrickletRotaryPoti::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";
}

$rotary_poti->registerCallback(BrickletRotaryPoti::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 BrickletRotaryPoti::CALLBACK_POSITION
<?php   void callback(int $position [, mixed $user_data])   ?>

Dieser Callback wird mit der Periode, wie gesetzt mit setPositionCallbackPeriod(), ausgelöst. Der Parameter ist die Position des Drehpotentiometers.

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

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

Dieser Callback wird mit der Periode, wie gesetzt mit setAnalogValueCallbackPeriod(), ausgelöst. Der Parameter ist der Analogwert des Drehpotentiometers.

Der CALLBACK_ANALOG_VALUE Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

int BrickletRotaryPoti::CALLBACK_POSITION_REACHED
<?php   void callback(int $position [, mixed $user_data])   ?>

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setPositionCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Position des Drehpotentiometers.

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

int BrickletRotaryPoti::CALLBACK_ANALOG_VALUE_REACHED
<?php   void callback(int $value [, mixed $user_data])   ?>

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert des Drehpotentiometers.

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

Konstanten

int BrickletRotaryPoti::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Rotary Poti 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 BrickletRotaryPoti::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Rotary Poti Bricklet dar.