PHP - IO-16 Bricklet 2.0

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

Output

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIO16V2;

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

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

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

// Configure channel 7 as output low
$io->setConfiguration(7, 'o', FALSE);

// Set channel 7 alternating high/low 10 times with 100 ms delay
for($i = 0; $i < 10; $i++) {
    usleep(100*1000);
    $io->setSelectedValue(7, TRUE);
    usleep(100*1000);
    $io->setSelectedValue(7, FALSE);
}

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

?>

Interrupt

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIO16V2;

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

// Callback function for input value callback
function cb_inputValue($channel, $changed, $value)
{
    echo "Channel: $channel\n";
    echo "Changed: $changed\n";
    echo "Value: $value\n";
    echo "\n";
}

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

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

// Register input value callback to function cb_inputValue
$io->registerCallback(BrickletIO16V2::CALLBACK_INPUT_VALUE, 'cb_inputValue');

// Set period for input value (channel 4) callback to 0.5s (500ms)
$io->setInputValueCallbackConfiguration(4, 500, FALSE);

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.

Das Bricklet hat sechzehn Kanäle die in der API von 0 bis 15 benannt sind. Die entsprechenden Anschlüsse auf dem Bricklet sind mit A0 bis A7 für die Kanäle 0 bis 7 und B0 bis B7 für die Kanäle 8 bis 15 benannt.

Grundfunktionen

class BrickletIO16V2(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $io16_v2 – Typ: BrickletIO16V2

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

<?php   $io16_v2 = new BrickletIO16V2('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletIO16V2::setValue(array $value)
Parameter:
  • $value – Typ: array(bool, ...), Länge: 16

Setzt den Zustand aller sechzehn Kanäle. Der Wert true bzw. false erzeugen logisch 1 bzw. logisch 0 auf dem entsprechenden Kanal.

Mittels setSelectedValue() können auch einzelnen Kanäle gesetzt werden.

Beispiel: (True, True, False, False, ..., False) setzt die Kanäle 0-1 auf logisch 1 und die Kanäle 2-15 auf logisch 0.

Alle laufenden Monoflop Timer werden abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert sind. Pull-Up Widerstände können mit setConfiguration() zugeschaltet werden.

array BrickletIO16V2::getValue()
Rückgabe:
  • $value – Typ: array(bool, ...), Länge: 16

Gibt die aktuell gemessenen Zustände zurück. Diese Funktion gibt die Zustände aller Kanäle zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.

void BrickletIO16V2::setSelectedValue(int $channel, bool $value)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 15]
  • $value – Typ: bool

Setzt den Ausgabewert des ausgewählten Kanals ohne die anderen Kanäle zu beeinflussen.

Ein laufender Monoflop Timer für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert sind. Pull-Up Widerstände können mit setConfiguration() zugeschaltet werden.

void BrickletIO16V2::setConfiguration(int $channel, string $direction, bool $value)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 15]
  • $direction – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'i'
  • $value – Typ: bool, Standardwert: TRUE

Konfiguriert den Zustand und die Richtung eines angegebenen Kanals. Mögliche Richtungen sind 'i' und 'o' für Ein- und Ausgang.

Wenn die Richtung als Ausgang konfiguriert ist, ist der Zustand entweder logisch 1 oder logisch 0 (gesetzt als true oder false).

Wenn die Richtung als Eingang konfiguriert ist, ist der Zustand entweder Pull-Up oder Standard (gesetzt als true oder false).

Beispiele:

  • (0, 'i', true) setzt Kanal-0 als Eingang mit Pull-Up.
  • (1, 'i', false) setzt Kanal-1 als Standard Eingang (potentialfrei wenn nicht verbunden).
  • (2, 'o', true) setzt Kanal-2 als Ausgang im Zustand logisch 1.
  • (3, 'o', false) setzt Kanal-3 als Ausgang im Zustand logisch 0.

Ein laufender Monoflop Timer für den angegebenen Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

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

Für $direction:

  • BrickletIO16V2::DIRECTION_IN = 'i'
  • BrickletIO16V2::DIRECTION_OUT = 'o'
array BrickletIO16V2::getConfiguration(int $channel)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 15]
Rückgabe-Array:
  • 'direction' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'i'
  • 'value' – Typ: bool, Standardwert: TRUE

Gibt die Kanal-Konfiguration zurück, wie von setConfiguration() gesetzt.

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

Für $direction:

  • BrickletIO16V2::DIRECTION_IN = 'i'
  • BrickletIO16V2::DIRECTION_OUT = 'o'

Fortgeschrittene Funktionen

void BrickletIO16V2::setMonoflop(int $channel, bool $value, int $time)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 15]
  • $value – Typ: bool
  • $time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Konfiguriert einen Monoflop für den angegebenen Kanal.

Der zweite Parameter ist eine der gewünschten Zustände des festgelegten Kanals. Eine true bedeutet Relais geschlossen und ein *false bedeutet Relais offen.

Der dritte Parameter ist die Zeit die der Kanal den Zustand halten sollen.

Wenn diese Funktion mit den Parametern (0, 1, 1500) aufgerufen wird, wird Kanal 0 geschlossen und nach 1,5s wieder geöffnet.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-16 Bricklet 2.0 ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Kanal wird die gesamte Zeit im Zustand geschlossen sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Kanal nach spätestens zwei Sekunden in den Zustand geöffnet wechseln.

array BrickletIO16V2::getMonoflop(int $channel)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 15]
Rückgabe-Array:
  • 'value' – Typ: bool
  • 'time' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
  • 'time_remaining' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt (für den angegebenen Kanal) den aktuellen Zustand und die Zeit, wie von setMonoflop() gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

int BrickletIO16V2::getEdgeCount(int $channel, bool $reset_counter)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 15]
  • $reset_counter – Typ: bool
Rückgabe:
  • $count – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Kanal zurück. Die zu zählenden Flanken können mit setEdgeCountConfiguration() konfiguriert werden.

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

void BrickletIO16V2::setEdgeCountConfiguration(int $channel, int $edge_type, int $debounce)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 15]
  • $edge_type – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • $debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Konfiguriert den Flankenzähler für einen bestimmten Kanal.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Kanäle die als Eingang konfiguriert sind. Mögliche Flankentypen sind:

  • 0 = steigend
  • 1 = fallend
  • 2 = beide

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.

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

Für $edge_type:

  • BrickletIO16V2::EDGE_TYPE_RISING = 0
  • BrickletIO16V2::EDGE_TYPE_FALLING = 1
  • BrickletIO16V2::EDGE_TYPE_BOTH = 2
array BrickletIO16V2::getEdgeCountConfiguration(int $channel)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 15]
Rückgabe-Array:
  • 'edge_type' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • 'debounce' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Kanals zurück, wie von setEdgeCountConfiguration() gesetzt.

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

Für $edge_type:

  • BrickletIO16V2::EDGE_TYPE_RISING = 0
  • BrickletIO16V2::EDGE_TYPE_FALLING = 1
  • BrickletIO16V2::EDGE_TYPE_BOTH = 2
array BrickletIO16V2::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 BrickletIO16V2::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 Bootloader- 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:

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

Für $status:

  • BrickletIO16V2::BOOTLOADER_STATUS_OK = 0
  • BrickletIO16V2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIO16V2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIO16V2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIO16V2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIO16V2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletIO16V2::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:

  • BrickletIO16V2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIO16V2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIO16V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIO16V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIO16V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletIO16V2::setWriteFirmwarePointer(int $pointer)
Parameter:
  • $pointer – Typ: int, Einheit: 1 B, 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 BrickletIO16V2::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 BrickletIO16V2::setStatusLEDConfig(int $config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

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

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

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

Für $config:

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

Gibt die Temperatur, 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 BrickletIO16V2::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 BrickletIO16V2::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 BrickletIO16V2::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 BrickletIO16V2::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', 'i', '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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 BrickletIO16V2::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 BrickletIO16V2::setInputValueCallbackConfiguration(int $channel, int $period, bool $value_has_to_change)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 15]
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $value_has_to_change – Typ: bool, Standardwert: FALSE

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode ist die Periode mit der der CALLBACK_INPUT_VALUE 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.

array BrickletIO16V2::getInputValueCallbackConfiguration(int $channel)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 15]
Rückgabe-Array:
  • 'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 'value_has_to_change' – Typ: bool, Standardwert: FALSE

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

void BrickletIO16V2::setAllInputValueCallbackConfiguration(int $period, bool $value_has_to_change)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $value_has_to_change – Typ: bool, Standardwert: FALSE

Die Periode ist die Periode mit der der CALLBACK_ALL_INPUT_VALUE 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.

array BrickletIO16V2::getAllInputValueCallbackConfiguration()
Rückgabe-Array:
  • 'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 'value_has_to_change' – Typ: bool, Standardwert: FALSE

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

$io16_v2->registerCallback(BrickletIO16V2::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 BrickletIO16V2::CALLBACK_INPUT_VALUE
<?php   void callback(int $channel, bool $changed, bool $value [, mixed $user_data])   ?>
Callback-Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 15]
  • $changed – Typ: bool
  • $value – Typ: bool
  • $user_data – Typ: mixed

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

Die Parameter sind der Kanal, Changed und der Wert. Der changed-Parameter ist True wenn sich der Wert seit dem letzten Callback geändert hat.

int BrickletIO16V2::CALLBACK_ALL_INPUT_VALUE
<?php   void callback(array $changed, array $value [, mixed $user_data])   ?>
Callback-Parameter:
  • $changed – Typ: array(bool, ...), Länge: 16
  • $value – Typ: array(bool, ...), Länge: 16
  • $user_data – Typ: mixed

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

Die Parameter sind der gleiche wie getValue(). Zusätzlich ist der changed-Parameter True wenn sich der Wert seit dem letzten Callback geändert hat.

int BrickletIO16V2::CALLBACK_MONOFLOP_DONE
<?php   void callback(int $channel, bool $value [, mixed $user_data])   ?>
Callback-Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 15]
  • $value – Typ: bool
  • $user_data – Typ: mixed

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten den Kanal und den aktuellen Zustand des Kanals (der Zustand nach dem Monoflop).

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

  • BrickletIO16V2::FUNCTION_SET_VALUE = 1
  • BrickletIO16V2::FUNCTION_SET_SELECTED_VALUE = 3
  • BrickletIO16V2::FUNCTION_SET_CONFIGURATION = 4
  • BrickletIO16V2::FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION = 6
  • BrickletIO16V2::FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION = 8
  • BrickletIO16V2::FUNCTION_SET_MONOFLOP = 10
  • BrickletIO16V2::FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 13
  • BrickletIO16V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIO16V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIO16V2::FUNCTION_RESET = 243
  • BrickletIO16V2::FUNCTION_WRITE_UID = 248
void BrickletIO16V2::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:

  • BrickletIO16V2::FUNCTION_SET_VALUE = 1
  • BrickletIO16V2::FUNCTION_SET_SELECTED_VALUE = 3
  • BrickletIO16V2::FUNCTION_SET_CONFIGURATION = 4
  • BrickletIO16V2::FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION = 6
  • BrickletIO16V2::FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION = 8
  • BrickletIO16V2::FUNCTION_SET_MONOFLOP = 10
  • BrickletIO16V2::FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 13
  • BrickletIO16V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIO16V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIO16V2::FUNCTION_RESET = 243
  • BrickletIO16V2::FUNCTION_WRITE_UID = 248
void BrickletIO16V2::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 BrickletIO16V2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein IO-16 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 BrickletIO16V2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines IO-16 Bricklet 2.0 dar.