Dies ist die Beschreibung der PHP API Bindings für das Accelerometer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die PHP API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 | <?php
require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletAccelerometer.php');
use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAccelerometer;
const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Accelerometer Bricklet
$ipcon = new IPConnection(); // Create IP connection
$a = new BrickletAccelerometer(UID, $ipcon); // Create device object
$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current acceleration
$acceleration = $a->getAcceleration();
echo "Acceleration [X]: " . $acceleration['x']/1000.0 . " g\n";
echo "Acceleration [Y]: " . $acceleration['y']/1000.0 . " g\n";
echo "Acceleration [Z]: " . $acceleration['z']/1000.0 . " g\n";
echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();
?>
|
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 37 38 39 | <?php
require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletAccelerometer.php');
use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAccelerometer;
const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Accelerometer Bricklet
// Callback function for acceleration callback
function cb_acceleration($x, $y, $z)
{
echo "Acceleration [X]: " . $x/1000.0 . " g\n";
echo "Acceleration [Y]: " . $y/1000.0 . " g\n";
echo "Acceleration [Z]: " . $z/1000.0 . " g\n";
echo "\n";
}
$ipcon = new IPConnection(); // Create IP connection
$a = new BrickletAccelerometer(UID, $ipcon); // Create device object
$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Register acceleration callback to function cb_acceleration
$a->registerCallback(BrickletAccelerometer::CALLBACK_ACCELERATION, 'cb_acceleration');
// Set period for acceleration callback to 1s (1000ms)
// Note: The acceleration callback is only called every second
// if the acceleration has changed since the last call!
$a->setAccelerationCallbackPeriod(1000);
echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever
?>
|
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 39 40 41 | <?php
require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletAccelerometer.php');
use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAccelerometer;
const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Accelerometer Bricklet
// Callback function for acceleration reached callback
function cb_accelerationReached($x, $y, $z)
{
echo "Acceleration [X]: " . $x/1000.0 . " g\n";
echo "Acceleration [Y]: " . $y/1000.0 . " g\n";
echo "Acceleration [Z]: " . $z/1000.0 . " g\n";
echo "\n";
}
$ipcon = new IPConnection(); // Create IP connection
$a = new BrickletAccelerometer(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)
$a->setDebouncePeriod(10000);
// Register acceleration reached callback to function cb_accelerationReached
$a->registerCallback(BrickletAccelerometer::CALLBACK_ACCELERATION_REACHED,
'cb_accelerationReached');
// Configure threshold for acceleration "greater than 2 g, 2 g, 2 g"
$a->setAccelerationCallbackThreshold('>', 2*1000, 0, 2*1000, 0, 2*1000, 0);
echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever
?>
|
Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.
BrickletAccelerometer
(string $uid, IPConnection $ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid
:
<?php $accelerometer = new BrickletAccelerometer('YOUR_DEVICE_UID', $ipcon); ?>
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletAccelerometer::
getAcceleration
()¶Rückgabe-Array: |
|
---|
Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte
haben die Einheit gₙ/1000 (1gₙ = 9,80665m/s²). Der Wertebereich
wird mit setConfiguration()
konfiguriert.
Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen
den CALLBACK_ACCELERATION
Callback zu nutzen und die Periode mit
setAccelerationCallbackPeriod()
vorzugeben.
BrickletAccelerometer::
getTemperature
()¶Rückgabe: |
|
---|
Gibt die Temperatur des Beschleunigungssensors zurück.
BrickletAccelerometer::
ledOn
()¶Aktiviert die LED auf dem Bricklet.
BrickletAccelerometer::
ledOff
()¶Deaktiviert die LED auf dem Bricklet.
BrickletAccelerometer::
isLEDOn
()¶Rückgabe: |
|
---|
Gibt true zurück wenn die LED aktiviert ist, false sonst.
BrickletAccelerometer::
setConfiguration
(int $data_rate, int $full_scale, int $filter_bandwidth)¶Parameter: |
|
---|
Konfiguriert die Datenrate, den Wertebereich und die Filterbandbreite. Mögliche Konfigurationswerte sind:
Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $data_rate:
Für $full_scale:
Für $filter_bandwidth:
BrickletAccelerometer::
getConfiguration
()¶Rückgabe-Array: |
|
---|
Gibt die Konfiguration zurück, wie von setConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $data_rate:
Für $full_scale:
Für $filter_bandwidth:
BrickletAccelerometer::
getIdentity
()¶Rückgabe-Array: |
|
---|
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.
BrickletAccelerometer::
registerCallback
(int $callback_id, callable $callback, mixed $user_data=NULL)¶Parameter: |
|
---|
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.
BrickletAccelerometer::
setAccelerationCallbackPeriod
(int $period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der CALLBACK_ACCELERATION
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_ACCELERATION
Callback wird nur ausgelöst, wenn sich die Acceleration
seit der letzten Auslösung geändert hat.
BrickletAccelerometer::
getAccelerationCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setAccelerationCallbackPeriod()
gesetzt.
BrickletAccelerometer::
setAccelerationCallbackThreshold
(string $option, int $min_x, int $max_x, int $min_y, int $max_y, int $min_z, int $max_z)¶Parameter: |
|
---|
Setzt den Schwellwert für den CALLBACK_ACCELERATION_REACHED
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Beschleunigung außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Beschleunigung innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Beschleunigung kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Beschleunigung größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $option:
BrickletAccelerometer::
getAccelerationCallbackThreshold
()¶Rückgabe-Array: |
|
---|
Gibt den Schwellwert zurück, wie von setAccelerationCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $option:
BrickletAccelerometer::
setDebouncePeriod
(int $debounce)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
BrickletAccelerometer::
getDebouncePeriod
()¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von setDebouncePeriod()
gesetzt.
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";
}
$accelerometer->registerCallback(BrickletAccelerometer::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.
BrickletAccelerometer::
CALLBACK_ACCELERATION
¶<?php void callback(int $x, int $y, int $z [, mixed $user_data]) ?>
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
setAccelerationCallbackPeriod()
, ausgelöst. Die Parameter
sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich
wird mit setConfiguration()
konfiguriert.
Der CALLBACK_ACCELERATION
Callback wird nur ausgelöst, wenn sich die Beschleunigung
seit der letzten Auslösung geändert hat.
BrickletAccelerometer::
CALLBACK_ACCELERATION_REACHED
¶<?php void callback(int $x, int $y, int $z [, mixed $user_data]) ?>
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
setAccelerationCallbackThreshold()
gesetzt, erreicht wird.
Die Parameter sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich
wird mit setConfiguration()
konfiguriert.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit setDebouncePeriod()
gesetzt, ausgelöst.
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.
BrickletAccelerometer::
getAPIVersion
()¶Rückgabe-Array: |
|
---|
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.
BrickletAccelerometer::
getResponseExpected
(int $function_id)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
BrickletAccelerometer::
setResponseExpected
(int $function_id, bool $response_expected)¶Parameter: |
|
---|
Ä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:
Für $function_id:
BrickletAccelerometer::
setResponseExpectedAll
(bool $response_expected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletAccelerometer::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Accelerometer 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.
BrickletAccelerometer::
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet dar.