PHP - Industrial Digital Out 4 Bricklet

Dies ist die Beschreibung der PHP API Bindings für das Industrial Digital Out 4 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Digital Out 4 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
28
29
30
31
32
33
34
35
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDigitalOut4;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Industrial Digital Out 4 Bricklet

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

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

// Set pins alternating high/low 10 times with 100ms delay
for($i = 0; $i < 10; $i++) {
    usleep(100*1000);
    $ido4->setValue(1 << 0);
    usleep(100*1000);
    $ido4->setValue(1 << 1);
    usleep(100*1000);
    $ido4->setValue(1 << 2);
    usleep(100*1000);
    $ido4->setValue(1 << 3);
}

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

?>

API

Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.

Grundfunktionen

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

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

<?php   $industrial_digital_out_4 = new BrickletIndustrialDigitalOut4('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletIndustrialDigitalOut4::setValue(int $value_mask)
Parameter:
  • $value_mask – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt die Ausgabewerte mit einer Bitmaske (16Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Zum Beispiel: Der Wert 3 bzw. 0b0011 wird die Pins 0-1 auf logisch 1 und alle anderen auf logisch 0 setzen.

Falls keine Gruppen verwendet werden (siehe setGroup()), entsprechen die Pins der Beschriftung auf dem Industrial Digital Out 4 Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

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

int BrickletIndustrialDigitalOut4::getValue()
Rückgabe:
  • $value_mask – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Bitmaske zurück, wie von setValue() gesetzt.

void BrickletIndustrialDigitalOut4::setSelectedValues(int $selection_mask, int $value_mask)
Parameter:
  • $selection_mask – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $value_mask – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt die Ausgabewerte mit einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske ist 16 Bit lang. true bedeutet logisch 1 und false logisch 0.

Zum Beispiel: Die Werte (3, 1) bzw. (0b0011, 0b0001) werden den Pin 0 auf logisch 1 und den Pin 1 auf logisch 0 setzen. Alle anderen Pins bleiben unangetastet.

Falls keine Gruppen verwendet werden (siehe setGroup()), entsprechen die Pins der Beschriftung auf dem Industrial Digital Out 4 Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

Fortgeschrittene Funktionen

void BrickletIndustrialDigitalOut4::setMonoflop(int $selection_mask, int $value_mask, int $time)
Parameter:
  • $selection_mask – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $value_mask – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $time – Typ: int, Wertebereich: [0 bis 232 - 1]

Konfiguriert einen Monoflop für die Pins, wie mittels der Bitmaske des ersten Parameters festgelegt.

Der zweite Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Pins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Der dritte Parameter stellt die Zeit (in ms) dar, welche die Pins den Zustand halten sollen.

Wenn diese Funktion mit den Parametern (9, 1, 1500) bzw. (0b1001, 0b0001, 1500) aufgerufen wird: Pin 0 wird auf logisch 1 und Pin 3 auf logisch 0 gesetzt. Nach 1,5s wird Pin 0 wieder auf logisch 0 und Pin 3 auf logisch 1 gesetzt.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Digital Out 4 Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Pin wird die gesamte Zeit im Zustand logisch 1 sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Pin nach spätestens zwei Sekunden in den Zustand logisch 0 wechseln.

array BrickletIndustrialDigitalOut4::getMonoflop(int $pin)
Parameter:
  • $pin – Typ: int, Wertebereich: [0 bis 255]
Rückgabe-Array:
  • 'value' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'time' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'time_remaining' – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt (für den angegebenen Pin) 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.

void BrickletIndustrialDigitalOut4::setGroup(array $group)
Parameter:
  • $group – Typ: array(string, ...), Länge: 4

Setzt eine Gruppe von Digital Out 4 Bricklets die zusammenarbeiten sollen. Mögliche Gruppierungen können mit der Funktion getAvailableForGroup() gefunden werden.

Eine Gruppe besteht aus 4 Element. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Jedes Element kann entweder auf einen der Ports ('a' bis 'd') gesetzt werden oder falls nicht genutzt 'n' gesetzt werden.

Zum Beispiel: Falls zwei Digital Out 4 Bricklets mit Port A und Port B verbunden sind, könnte diese Funktion mit array('a', 'b', 'n', 'n') aufgerufen werden.

In diesem Fall wären die Pins von Port A den Werten 0-3 zugewiesen und die Pins von Port B den Werten 4-7. Es ist jetzt möglich mit der Funktion setValue() beide Bricklets gleichzeitig zu kontrollieren.

array BrickletIndustrialDigitalOut4::getGroup()
Rückgabe:
  • $group – Typ: array(string, ...), Länge: 4

Gibt die Gruppierung zurück, wie von setGroup() gesetzt.

int BrickletIndustrialDigitalOut4::getAvailableForGroup()
Rückgabe:
  • $available – Typ: int, Wertebereich: [0 bis 255]

Gibt eine Bitmaske von Ports zurück die für die Gruppierung zur Verfügung stehen. Zum Beispiel bedeutet der Wert 5 bzw. 0b0101: Port A und Port C sind mit Bricklets verbunden die zusammen gruppiert werden können.

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

  • BrickletIndustrialDigitalOut4::FUNCTION_SET_VALUE = 1
  • BrickletIndustrialDigitalOut4::FUNCTION_SET_MONOFLOP = 3
  • BrickletIndustrialDigitalOut4::FUNCTION_SET_GROUP = 5
  • BrickletIndustrialDigitalOut4::FUNCTION_SET_SELECTED_VALUES = 9
void BrickletIndustrialDigitalOut4::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:

  • BrickletIndustrialDigitalOut4::FUNCTION_SET_VALUE = 1
  • BrickletIndustrialDigitalOut4::FUNCTION_SET_MONOFLOP = 3
  • BrickletIndustrialDigitalOut4::FUNCTION_SET_GROUP = 5
  • BrickletIndustrialDigitalOut4::FUNCTION_SET_SELECTED_VALUES = 9
void BrickletIndustrialDigitalOut4::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 BrickletIndustrialDigitalOut4::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 BrickletIndustrialDigitalOut4::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.

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

$industrial_digital_out_4->registerCallback(BrickletIndustrialDigitalOut4::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 BrickletIndustrialDigitalOut4::CALLBACK_MONOFLOP_DONE
<?php   void callback(int $selection_mask, int $value_mask [, mixed $user_data])   ?>
Callback-Parameter:
  • $selection_mask – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $value_mask – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $user_data – Typ: mixed

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (der Zustand nach dem Monoflop).

Konstanten

int BrickletIndustrialDigitalOut4::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Digital Out 4 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 BrickletIndustrialDigitalOut4::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Digital Out 4 Bricklet dar.