PHP - PTC Bricklet 2.0

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletPTCV2;

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

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

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

// Get current temperature
$temperature = $ptc->getTemperature();
echo "Temperature: " . $temperature/100.0 . " °C\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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletPTCV2;

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

// Callback function for temperature callback
function cb_temperature($temperature)
{
    echo "Temperature: " . $temperature/100.0 . " °C\n";
}

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

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

// Register temperature callback to function cb_temperature
$ptc->registerCallback(BrickletPTCV2::CALLBACK_TEMPERATURE, 'cb_temperature');

// Set period for temperature callback to 1s (1000ms) without a threshold
$ptc->setTemperatureCallbackConfiguration(1000, FALSE, 'x', 0, 0);

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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletPTCV2;

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

// Callback function for temperature callback
function cb_temperature($temperature)
{
    echo "Temperature: " . $temperature/100.0 . " °C\n";
}

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

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

// Register temperature callback to function cb_temperature
$ptc->registerCallback(BrickletPTCV2::CALLBACK_TEMPERATURE, 'cb_temperature');

// Configure threshold for temperature "greater than 30 °C"
// with a debounce period of 1s (1000ms)
$ptc->setTemperatureCallbackConfiguration(1000, FALSE, '>', 30*100, 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 BrickletPTCV2(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $ptc_v2 – Typ: BrickletPTCV2

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

<?php   $ptc_v2 = new BrickletPTCV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletPTCV2::getTemperature()
Rückgabe:
  • $temperature – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die Temperatur des verbundenen Sensors zurück. Der Wertebereich ist von -246 bis 849 °C und wird in °C/100 angegeben, z.B. bedeutet ein Wert von 4223 eine gemessene Temperatur von 42,23 °C.

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

int BrickletPTCV2::getResistance()
Rückgabe:
  • $resistance – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt den Wert zurück, wie vom "MAX31865 Präzisions-Delta-Sigma ADC" berechnet.

Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:

  • Pt100: Widerstand = (Wert * 390) / 32768
  • Pt1000: Widerstand = (Wert * 3900) / 32768

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

bool BrickletPTCV2::isSensorConnected()
Rückgabe:
  • $connected – Typ: bool

Gibt true zurück wenn ein Sensor korrekt verbunden ist.

Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.

Zum automatischen übertragen des Status kann auch der CALLBACK_SENSOR_CONNECTED Callback verwendet werden. Der Callback wird mit der Funktion setSensorConnectedCallbackConfiguration() konfiguriert.

void BrickletPTCV2::setWireMode(int $mode)
Parameter:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten

Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.

Der Standardwert ist 2 = 2-Leiter.

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

Für $mode:

  • BrickletPTCV2::WIRE_MODE_2 = 2
  • BrickletPTCV2::WIRE_MODE_3 = 3
  • BrickletPTCV2::WIRE_MODE_4 = 4
int BrickletPTCV2::getWireMode()
Rückgabe:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Leiter-Konfiguration zurück, wie von setWireMode() gesetzt.

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

Für $mode:

  • BrickletPTCV2::WIRE_MODE_2 = 2
  • BrickletPTCV2::WIRE_MODE_3 = 3
  • BrickletPTCV2::WIRE_MODE_4 = 4
void BrickletPTCV2::setMovingAverageConfiguration(int $moving_average_length_resistance, int $moving_average_length_temperature)
Parameter:
  • $moving_average_length_resistance – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $moving_average_length_temperature – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt die Länge eines gleitenden Mittelwerts für den Widerstand und die Temperatur.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-1000.

Einer neue Wert wird alle 20ms gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von 20s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

Der Standardwert ist 1 für den Widerstand und 40 für die Temperatur. Die Standardwerte entsprechen den nicht-änderbaren Mittelwert-Einstellungen des alten PTC Bricklet 1.0.

array BrickletPTCV2::getMovingAverageConfiguration()
Rückgabe-Array:
  • 'moving_average_length_resistance' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'moving_average_length_temperature' – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Moving Average-Konfiguration zurück, wie von setMovingAverageConfiguration() gesetzt.

Fortgeschrittene Funktionen

void BrickletPTCV2::setNoiseRejectionFilter(int $filter)
Parameter:
  • $filter – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.

Der Standardwert ist 0 = 50Hz.

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

Für $filter:

  • BrickletPTCV2::FILTER_OPTION_50HZ = 0
  • BrickletPTCV2::FILTER_OPTION_60HZ = 1
int BrickletPTCV2::getNoiseRejectionFilter()
Rückgabe:
  • $filter – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Einstellung des Entstörfilters zurück, wie von setNoiseRejectionFilter() gesetzt.

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

Für $filter:

  • BrickletPTCV2::FILTER_OPTION_50HZ = 0
  • BrickletPTCV2::FILTER_OPTION_60HZ = 1
array BrickletPTCV2::getAPIVersion()
Rückgabe:
  • $api_version – Typ: array(int, ...), Länge: 3, Wertebereich: [0 bis 255]

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

  • BrickletPTCV2::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
  • BrickletPTCV2::FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION = 6
  • BrickletPTCV2::FUNCTION_SET_NOISE_REJECTION_FILTER = 9
  • BrickletPTCV2::FUNCTION_SET_WIRE_MODE = 12
  • BrickletPTCV2::FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 14
  • BrickletPTCV2::FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 16
  • BrickletPTCV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletPTCV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletPTCV2::FUNCTION_RESET = 243
  • BrickletPTCV2::FUNCTION_WRITE_UID = 248
void BrickletPTCV2::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:

  • BrickletPTCV2::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
  • BrickletPTCV2::FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION = 6
  • BrickletPTCV2::FUNCTION_SET_NOISE_REJECTION_FILTER = 9
  • BrickletPTCV2::FUNCTION_SET_WIRE_MODE = 12
  • BrickletPTCV2::FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 14
  • BrickletPTCV2::FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 16
  • BrickletPTCV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletPTCV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletPTCV2::FUNCTION_RESET = 243
  • BrickletPTCV2::FUNCTION_WRITE_UID = 248
void BrickletPTCV2::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.

array BrickletPTCV2::getSPITFPErrorCount()
Rückgabe-Array:
  • 'error_count_ack_checksum' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'error_count_message_checksum' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'error_count_frame' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'error_count_overflow' – Typ: int, Wertebereich: [0 bis 232 - 1]

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.

int BrickletPTCV2::setBootloaderMode(int $mode)
Parameter:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $status – Typ: int, Wertebereich: Siehe Konstanten

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:

Für $mode:

  • BrickletPTCV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletPTCV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletPTCV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletPTCV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletPTCV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für $status:

  • BrickletPTCV2::BOOTLOADER_STATUS_OK = 0
  • BrickletPTCV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletPTCV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletPTCV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletPTCV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletPTCV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletPTCV2::getBootloaderMode()
Rückgabe:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $mode:

  • BrickletPTCV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletPTCV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletPTCV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletPTCV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletPTCV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletPTCV2::setWriteFirmwarePointer(int $pointer)
Parameter:
  • $pointer – Typ: int, Wertebereich: [0 bis 232 - 1]

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 BrickletPTCV2::writeFirmware(array $data)
Parameter:
  • $data – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • $status – Typ: int, Wertebereich: [0 bis 255]

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 BrickletPTCV2::setStatusLEDConfig(int $config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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:

Für $config:

  • BrickletPTCV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletPTCV2::STATUS_LED_CONFIG_ON = 1
  • BrickletPTCV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletPTCV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletPTCV2::getStatusLEDConfig()
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $config:

  • BrickletPTCV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletPTCV2::STATUS_LED_CONFIG_ON = 1
  • BrickletPTCV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletPTCV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletPTCV2::getChipTemperature()
Rückgabe:
  • $temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

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 BrickletPTCV2::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 BrickletPTCV2::writeUID(int $uid)
Parameter:
  • $uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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 BrickletPTCV2::readUID()
Rückgabe:
  • $uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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

array BrickletPTCV2::getIdentity()
Rückgabe-Array:
  • 'uid' – Typ: string, Länge: bis zu 8
  • 'connected_uid' – Typ: string, Länge: bis zu 8
  • 'position' – Typ: string
  • 'hardware_version' – Typ: array(int, ...), Länge: 3, Wertebereich: [0 bis 255]
  • 'firmware_version' – Typ: array(int, ...), Länge: 3, 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 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.

Konfigurationsfunktionen für Callbacks

void BrickletPTCV2::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 BrickletPTCV2::setTemperatureCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $value_has_to_change – Typ: bool, Standardwert: FALSE
  • $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • $max – Typ: int, Wertebereich: [-231 bis 231 - 1]

Die Periode ist die Periode mit der der CALLBACK_TEMPERATURE 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_TEMPERATURE 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:

Für $option:

  • BrickletPTCV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTCV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTCV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTCV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTCV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletPTCV2::getTemperatureCallbackConfiguration()
Rückgabe-Array:
  • 'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 'value_has_to_change' – Typ: bool, Standardwert: FALSE
  • 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 'min' – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 'max' – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

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

Für $option:

  • BrickletPTCV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTCV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTCV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTCV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTCV2::THRESHOLD_OPTION_GREATER = '>'
void BrickletPTCV2::setResistanceCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $value_has_to_change – Typ: bool, Standardwert: FALSE
  • $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • $max – Typ: int, Wertebereich: [-231 bis 231 - 1]

Die Periode ist die Periode mit der der CALLBACK_RESISTANCE 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_RESISTANCE 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:

Für $option:

  • BrickletPTCV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTCV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTCV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTCV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTCV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletPTCV2::getResistanceCallbackConfiguration()
Rückgabe-Array:
  • 'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 'value_has_to_change' – Typ: bool, Standardwert: FALSE
  • 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 'min' – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 'max' – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

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

Für $option:

  • BrickletPTCV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTCV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTCV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTCV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTCV2::THRESHOLD_OPTION_GREATER = '>'
void BrickletPTCV2::setSensorConnectedCallbackConfiguration(bool $enabled)
Parameter:
  • $enabled – Typ: bool

Wenn dieser Callback aktiviert ist, wird der CALLBACK_SENSOR_CONNECTED Callback jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.

Standardmäßig ist dieser Callback deaktiviert.

bool BrickletPTCV2::getSensorConnectedCallbackConfiguration()
Rückgabe:
  • $enabled – Typ: bool

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

$ptc_v2->registerCallback(BrickletPTCV2::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 BrickletPTCV2::CALLBACK_TEMPERATURE
<?php   void callback(int $temperature [, mixed $user_data])   ?>
Callback-Parameter:
  • $temperature – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getTemperature().

int BrickletPTCV2::CALLBACK_RESISTANCE
<?php   void callback(int $resistance [, mixed $user_data])   ?>
Callback-Parameter:
  • $resistance – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getResistance().

int BrickletPTCV2::CALLBACK_SENSOR_CONNECTED
<?php   void callback(bool $connected [, mixed $user_data])   ?>
Callback-Parameter:
  • $connected – Typ: bool
  • $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie bei isSensorConnected().

Konstanten

int BrickletPTCV2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein PTC 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 BrickletPTCV2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines PTC Bricklet 2.0 dar.