PHP - Analog In Bricklet 2.0

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAnalogInV2;

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

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

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

// Get current voltage
$voltage = $ai->getVoltage();
echo "Voltage: " . $voltage/1000.0 . " V\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/BrickletAnalogInV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAnalogInV2;

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

// Callback function for voltage callback
function cb_voltage($voltage)
{
    echo "Voltage: " . $voltage/1000.0 . " V\n";
}

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

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

// Register voltage callback to function cb_voltage
$ai->registerCallback(BrickletAnalogInV2::CALLBACK_VOLTAGE, 'cb_voltage');

// Set period for voltage callback to 1s (1000ms)
// Note: The voltage callback is only called every second
//       if the voltage has changed since the last call!
$ai->setVoltageCallbackPeriod(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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAnalogInV2;

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

// Callback function for voltage reached callback
function cb_voltageReached($voltage)
{
    echo "Voltage: " . $voltage/1000.0 . " V\n";
}

$ipcon = new IPConnection(); // Create IP connection
$ai = new BrickletAnalogInV2(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 10 seconds (10000ms)
$ai->setDebouncePeriod(10000);

// Register voltage reached callback to function cb_voltageReached
$ai->registerCallback(BrickletAnalogInV2::CALLBACK_VOLTAGE_REACHED, 'cb_voltageReached');

// Configure threshold for voltage "smaller than 5 V"
$ai->setVoltageCallbackThreshold('<', 5*1000, 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 BrickletAnalogInV2(string $uid, IPConnection $ipcon)

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

<?php   $analog_in_v2 = new BrickletAnalogInV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletAnalogInV2::getVoltage()

Gibt die gemessene Spannung zurück. Der Wert ist in mV und im Bereich von 0 bis 42V. Die Auflösung ca. 10mV.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den CALLBACK_VOLTAGE Callback zu nutzen und die Periode mit setVoltageCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

int BrickletAnalogInV2::getAnalogValue()

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

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

void BrickletAnalogInV2::setMovingAverage(int $average)

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

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

Der Wertebereich liegt bei 1-50.

Der Standardwert ist 50.

int BrickletAnalogInV2::getMovingAverage()

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

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

  • BrickletAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
  • BrickletAnalogInV2::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletAnalogInV2::FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
  • BrickletAnalogInV2::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletAnalogInV2::FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletAnalogInV2::FUNCTION_SET_MOVING_AVERAGE = 13
void BrickletAnalogInV2::setResponseExpectedAll(bool $response_expected)

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

array BrickletAnalogInV2::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 BrickletAnalogInV2::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 BrickletAnalogInV2::setVoltageCallbackPeriod(int $period)

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

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

Der Standardwert ist 0.

int BrickletAnalogInV2::getVoltageCallbackPeriod()

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

void BrickletAnalogInV2::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 BrickletAnalogInV2::getAnalogValueCallbackPeriod()

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

void BrickletAnalogInV2::setVoltageCallbackThreshold(string $option, int $min, int $max)

Setzt den Schwellwert für den CALLBACK_VOLTAGE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

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

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

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

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

void BrickletAnalogInV2::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 des min und max Wertes ist
'i' Callback wird ausgelöst wenn der Analogwert innerhalb des min und max Wertes 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:

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

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

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

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

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

void BrickletAnalogInV2::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 BrickletAnalogInV2::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";
}

$analog_in_v2->registerCallback(BrickletAnalogInV2::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 BrickletAnalogInV2::CALLBACK_VOLTAGE
<?php   void callback(int $voltage [, mixed $user_data])   ?>

Dieser Callback wird mit der Periode, wie gesetzt mit setVoltageCallbackPeriod(), ausgelöst. Der Parameter ist die gemessene Spannung des Sensors.

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

int BrickletAnalogInV2::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 Sensors.

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

int BrickletAnalogInV2::CALLBACK_VOLTAGE_REACHED
<?php   void callback(int $voltage [, mixed $user_data])   ?>

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von setVoltageCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die gemessene Spannung des Sensors.

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

int BrickletAnalogInV2::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 Sensors.

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

Konstanten

int BrickletAnalogInV2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Analog In 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 BrickletAnalogInV2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Analog In Bricklet 2.0 dar.