PHP - Hall Effect Bricklet

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHallEffect;

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

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

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

// Get current edge count without reset
$count = $he->getEdgeCount(FALSE);
echo "Count: $count\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/BrickletHallEffect.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHallEffect;

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

// Callback function for edge count callback
function cb_edgeCount($count, $value)
{
    echo "Count: $count\n";
}

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

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

// Register edge count callback to function cb_edgeCount
$he->registerCallback(BrickletHallEffect::CALLBACK_EDGE_COUNT, 'cb_edgeCount');

// Set period for edge count callback to 0.05s (50ms)
// Note: The edge count callback is only called every 0.05 seconds
//       if the edge count has changed since the last call!
$he->setEdgeCountCallbackPeriod(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 BrickletHallEffect(string $uid, IPConnection $ipcon)

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

<?php   $hall_effect = new BrickletHallEffect('YOUR_DEVICE_UID', $ipcon);   ?>

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

bool BrickletHallEffect::getValue()

Gibt true zurück wenn ein Magnetfeld mit 35 Gauss (3,5mT) oder größer detektiert wird.

int BrickletHallEffect::getEdgeCount(bool $reset_counter)

Gibt den aktuellen Wert des Flankenzählers zurück. Die zu zählenden Flanken (steigend, fallend, beide) können mit setEdgeCountConfig() konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Fortgeschrittene Funktionen

void BrickletHallEffect::setEdgeCountConfig(int $edge_type, int $debounce)

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

  • 0 = steigend (Standard)
  • 1 = fallend
  • 2 = beide

Wird ein Magnet in die Nähe des Bricklets gebracht (>35 Gauss) erzeugt dies ein low-Signal (fallende Flanke), wenn ein Magnet vom Bricklet entfernt (<25 Gauss) wird entsteht ein high-Signal (steigende Flanke).

Die Entprellzeit (debounce) wird in ms angegeben.

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

Standardwerte: 0 (edge type) und 100ms (debounce).

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

  • BrickletHallEffect::EDGE_TYPE_RISING = 0
  • BrickletHallEffect::EDGE_TYPE_FALLING = 1
  • BrickletHallEffect::EDGE_TYPE_BOTH = 2
array BrickletHallEffect::getEdgeCountConfig()

Gibt den Flankentyp sowie die Entprellzeit zurück, wie von setEdgeCountConfig() gesetzt.

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

  • BrickletHallEffect::EDGE_TYPE_RISING = 0
  • BrickletHallEffect::EDGE_TYPE_FALLING = 1
  • BrickletHallEffect::EDGE_TYPE_BOTH = 2

Das zurückgegebene Array enthält die Keys edge_type und debounce.

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

  • BrickletHallEffect::FUNCTION_SET_EDGE_COUNT_CONFIG = 3
  • BrickletHallEffect::FUNCTION_SET_EDGE_INTERRUPT = 5
  • BrickletHallEffect::FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7
void BrickletHallEffect::setResponseExpectedAll(bool $response_expected)

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

array BrickletHallEffect::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 BrickletHallEffect::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 BrickletHallEffect::setEdgeInterrupt(int $edges)

Setzt die Anzahl der zu zählenden Flanken bis ein Interrupt aufgerufen wird.

Wenn edges auf n gesetzt ist, wird der Interrupt nach jeder n-ten detektierten Flanke aufgerufen.

Wenn edges auf 0 gesetzt ist, wird der Interrupt deaktiviert.

Standardwert ist 0.

int BrickletHallEffect::getEdgeInterrupt()

Gibt edges zurück, wie von setEdgeInterrupt() gesetzt.

void BrickletHallEffect::setEdgeCountCallbackPeriod(int $period)

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

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

Der Standardwert ist 0.

int BrickletHallEffect::getEdgeCountCallbackPeriod()

Gibt die Periode zurück, wie von setEdgeCountCallbackPeriod() 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";
}

$hall_effect->registerCallback(BrickletHallEffect::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 BrickletHallEffect::CALLBACK_EDGE_COUNT
<?php   void callback(int $count, bool $value [, mixed $user_data])   ?>

Dieser Callback wird mit der Periode, wie gesetzt mit setEdgeCountCallbackPeriod(), ausgelöst. Die Parameter sind der aktuelle Zählerstand und der aktuelle Wert (siehe getValue() and getEdgeCount()).

Der CALLBACK_EDGE_COUNT Callback wird nur ausgelöst, wenn sich mindestens einer der beiden Werte seit der letzten Auslösung geändert hat.

Konstanten

int BrickletHallEffect::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Hall Effect 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 BrickletHallEffect::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Hall Effect Bricklet dar.