PHP - Tilt Bricklet¶

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
28
29
30
31
32
33
34

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTilt;

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

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

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

// Get current tilt state
$state = $t->getTiltState();

if ($state == BrickletTilt::TILT_STATE_CLOSED) {
    echo "Tilt State: Closed\n";
} elseif ($state == BrickletTilt::TILT_STATE_OPEN) {
    echo "Tilt State: Open\n";
} elseif ($state == BrickletTilt::TILT_STATE_CLOSED_VIBRATING) {
    echo "Tilt State: Closed Vibrating\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
37
38
39
40

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTilt;

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

// Callback function for tilt state callback
function cb_tiltState($state)
{
    if ($state == BrickletTilt::TILT_STATE_CLOSED) {
        echo "Tilt State: Closed\n";
    } elseif ($state == BrickletTilt::TILT_STATE_OPEN) {
        echo "Tilt State: Open\n";
    } elseif ($state == BrickletTilt::TILT_STATE_CLOSED_VIBRATING) {
        echo "Tilt State: Closed Vibrating\n";
    }
}

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

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

// Enable tilt state callback
$t->enableTiltStateCallback();

// Register tilt state callback to function cb_tiltState
$t->registerCallback(BrickletTilt::CALLBACK_TILT_STATE, 'cb_tiltState');

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

Grundfunktionen¶

class BrickletTilt(string $uid, IPConnection $ipcon)¶

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$tilt – Typ: BrickletTilt

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

<?php   $tilt = new BrickletTilt('YOUR_DEVICE_UID', $ipcon);   ?>

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

int BrickletTilt::getTiltState()¶

Rückgabe:	$state – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Tilt-Zustand zurück. Der Zustand kann folgende Werte annehmen:

• 0 = Closed: Der Ball im Neigungsschalter schließt den Stromkreis.
• 1 = Open: Der Ball im Neigungsschalter schließt den Stromkreis nicht.
• 2 = Closed Vibrating: Der Neigungsschalter ist in Bewegung (schnelle Änderungen zwischen open und close).

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

Für $state:

• BrickletTilt::TILT_STATE_CLOSED = 0
• BrickletTilt::TILT_STATE_OPEN = 1
• BrickletTilt::TILT_STATE_CLOSED_VIBRATING = 2

Fortgeschrittene Funktionen¶

array BrickletTilt::getIdentity()¶

Rückgabe-Array:

'uid' – Typ: string, Länge: bis zu 8 'connected_uid' – Typ: string, Länge: bis zu 8 'position' – Typ: string, Wertebereich: ['a' bis 'h', 'z'] 'hardware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'firmware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'device_identifier' – Typ: int, Wertebereich: [0 bis 216 - 1]

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.

Konfigurationsfunktionen für Callbacks¶

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

Parameter:	$callback_id – Typ: int $callback – Typ: callable $user_data – Typ: mixed

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 BrickletTilt::enableTiltStateCallback()¶

Aktiviert den CALLBACK_TILT_STATE Callback.

void BrickletTilt::disableTiltStateCallback()¶

Deaktiviert den CALLBACK_TILT_STATE Callback.

bool BrickletTilt::isTiltStateCallbackEnabled()¶

Rückgabe:	$enabled – Typ: bool, Standardwert: FALSE

Gibt true zurück wenn der CALLBACK_TILT_STATE Callback aktiviert ist.

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

$tilt->registerCallback(BrickletTilt::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen werden weiter unten beschrieben.

int BrickletTilt::CALLBACK_TILT_STATE¶

<?php   void callback(int $state [, mixed $user_data])   ?>

Callback-Parameter:	$state – Typ: int, Wertebereich: Siehe Konstanten $user_data – Typ: mixed

Dieser Callback übergibt den aktuellen Tilt-Status. Der Callback wird aufgerufen wenn sich der Status ändert.

Siehe getTiltState() für eine Beschreibung der Zustände.

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

Für $state:

• BrickletTilt::TILT_STATE_CLOSED = 0
• BrickletTilt::TILT_STATE_OPEN = 1
• BrickletTilt::TILT_STATE_CLOSED_VIBRATING = 2

Virtuelle Funktionen¶

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.

array BrickletTilt::getAPIVersion()¶

Rückgabe-Array:	$api_version – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255]

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.

bool BrickletTilt::getResponseExpected(int $function_id)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	$response_expected – Typ: bool

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:

• BrickletTilt::FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
• BrickletTilt::FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3

void BrickletTilt::setResponseExpected(int $function_id, bool $response_expected)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten $response_expected – Typ: bool

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

• BrickletTilt::FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
• BrickletTilt::FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3

void BrickletTilt::setResponseExpectedAll(bool $response_expected)¶

Parameter:	$response_expected – Typ: bool

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

Konstanten¶

int BrickletTilt::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Tilt 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 BrickletTilt::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Tilt Bricklet dar.