PHP - Hall Effect Bricklet 2.0

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

Counter

Download (ExampleCounter.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/BrickletHallEffectV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHallEffectV2;

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

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

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

// Get current count without counter reset
$count = $he->getCounter(FALSE);
echo "Count: $count\n";

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Magnetic Flux Density

Download (ExampleMagneticFluxDensity.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/BrickletHallEffectV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHallEffectV2;

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

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

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

// Get current Magnetic Flux Density
$magnetic_flux_density = $he->getMagneticFluxDensity();
echo "Magnetic Flux Density: $magnetic_flux_density µT\n";

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Counter Callback

Download (ExampleCounterCallback.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/BrickletHallEffectV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHallEffectV2;

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

// Callback function for counter callback
function cb_counter($counter)
{
    echo "Counter: $counter\n";
}

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

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

// Configure counter with ±3000µT threshold and 10ms debounce
$he->setCounterConfig(3000, -3000, 10000);

// Register counter callback to function cb_counter
$he->registerCallback(BrickletHallEffectV2::CALLBACK_COUNTER, 'cb_counter');

// Set period for counter callback to 0.1s (100ms)
$he->setCounterCallbackConfiguration(100, TRUE);

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

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

<?php   $hall_effect_v2 = new BrickletHallEffectV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletHallEffectV2::getMagneticFluxDensity()

Gibt die magnetische Flussdichte (magnetische Induktion) in µT (Microtesla) zurück.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_MAGNETIC_FLUX_DENSITY Callback verwendet werden. Der Callback wird mit der Funktion setMagneticFluxDensityCallbackConfiguration() konfiguriert.

int BrickletHallEffectV2::getCounter(bool $reset_counter)

Gibt den aktuellen Wert des Zählers zurück.

Die Schwellwerte (low/high) in µT und Entprellzeit in µs können per setCounterConfig() eingestellt werden.

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

Wenn der Zähler periodisch benötigt wird, kann auch der CALLBACK_COUNTER Callback verwendet werden. Der Callback wird mit der Funktion setCounterCallbackConfiguration() konfiguriert.

void BrickletHallEffectV2::setCounterConfig(int $high_threshold, int $low_threshold, int $debounce)

Setzt einen unteren und einen oberen Schwellwert (threshold) in µT sowie eine Entprellzeit (debounce) in µs.

Wenn die gemessene magnetische Flussdichte über den oberen Schwellwert oder unter den unteren Schwellwert wandert, wird der Zählerstand des Zählers (siehe getCounter()) um 1 erhöht.

Die Entprellzeit ist die Minimalzeit zwischen zwei Zählererhöhungen.

Die Standardwerte sind

  • Unterer Schwellwert: 2000µT
  • Oberer Schwellwert: -2000µT
  • Entprellzeit: 100000µs (100ms)
array BrickletHallEffectV2::getCounterConfig()

Gibt die Zähler-Konfiguration zurück, wie von setCounterConfig() gesetzt.

Das zurückgegebene Array enthält die Keys high_threshold, low_threshold und debounce.

Fortgeschrittene Funktionen

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

  • BrickletHallEffectV2::FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 2
  • BrickletHallEffectV2::FUNCTION_SET_COUNTER_CONFIG = 6
  • BrickletHallEffectV2::FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION = 8
  • BrickletHallEffectV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletHallEffectV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletHallEffectV2::FUNCTION_RESET = 243
  • BrickletHallEffectV2::FUNCTION_WRITE_UID = 248
void BrickletHallEffectV2::setResponseExpectedAll(bool $response_expected)

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

array BrickletHallEffectV2::getSPITFPErrorCount()

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

Das zurückgegebene Array enthält die Keys error_count_ack_checksum, error_count_message_checksum, error_count_frame und error_count_overflow.

int BrickletHallEffectV2::setBootloaderMode(int $mode)

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • BrickletHallEffectV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletHallEffectV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletHallEffectV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletHallEffectV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletHallEffectV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletHallEffectV2::BOOTLOADER_STATUS_OK = 0
  • BrickletHallEffectV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletHallEffectV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletHallEffectV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletHallEffectV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletHallEffectV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletHallEffectV2::getBootloaderMode()

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

  • BrickletHallEffectV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletHallEffectV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletHallEffectV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletHallEffectV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletHallEffectV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletHallEffectV2::setWriteFirmwarePointer(int $pointer)

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int BrickletHallEffectV2::writeFirmware(array $data)

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

void BrickletHallEffectV2::setStatusLEDConfig(int $config)

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • BrickletHallEffectV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletHallEffectV2::STATUS_LED_CONFIG_ON = 1
  • BrickletHallEffectV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletHallEffectV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletHallEffectV2::getStatusLEDConfig()

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

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

  • BrickletHallEffectV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletHallEffectV2::STATUS_LED_CONFIG_ON = 1
  • BrickletHallEffectV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletHallEffectV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletHallEffectV2::getChipTemperature()

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

void BrickletHallEffectV2::reset()

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

void BrickletHallEffectV2::writeUID(int $uid)

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

int BrickletHallEffectV2::readUID()

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

array BrickletHallEffectV2::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 BrickletHallEffectV2::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 BrickletHallEffectV2::setMagneticFluxDensityCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)

Die Periode in ms ist die Periode mit der der CALLBACK_MAGNETIC_FLUX_DENSITY Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den CALLBACK_MAGNETIC_FLUX_DENSITY Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

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

Gibt die Callback-Konfiguration zurück, wie mittels setMagneticFluxDensityCallbackConfiguration() gesetzt.

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

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

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

void BrickletHallEffectV2::setCounterCallbackConfiguration(int $period, bool $value_has_to_change)

Die Periode in ms ist die Periode mit der der CALLBACK_COUNTER Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen der Werte.

Der Standardwert ist (0, false).

array BrickletHallEffectV2::getCounterCallbackConfiguration()

Gibt die Callback-Konfiguration zurück, wie mittels setCounterCallbackConfiguration() gesetzt.

Das zurückgegebene Array enthält die Keys period und value_has_to_change.

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_v2->registerCallback(BrickletHallEffectV2::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 BrickletHallEffectV2::CALLBACK_MAGNETIC_FLUX_DENSITY
<?php   void callback(int $magnetic_flux_density [, mixed $user_data])   ?>

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setMagneticFluxDensityCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getMagneticFluxDensity().

int BrickletHallEffectV2::CALLBACK_COUNTER
<?php   void callback(int $count [, mixed $user_data])   ?>

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setCounterCallbackConfiguration() gesetzten Konfiguration

Der Zählerstand ist der gleiche, der auch per getCounter() abgefragt werden kann.

Konstanten

int BrickletHallEffectV2::DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines Hall Effect Bricklet 2.0 dar.