PHP - Industrial Digital Out 4 Bricklet 2.0

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDigitalOut4V2;

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

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

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

// Set channels alternating high/low 10 times with 100 ms delay
for($i = 0; $i < 10; $i++) {
    usleep(100*1000);
    $ido4->setValue(array(TRUE, FALSE, FALSE, FALSE));
    usleep(100*1000);
    $ido4->setValue(array(FALSE, TRUE, FALSE, FALSE));
    usleep(100*1000);
    $ido4->setValue(array(FALSE, FALSE, TRUE, FALSE));
    usleep(100*1000);
    $ido4->setValue(array(FALSE, FALSE, FALSE, TRUE));
}

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

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

<?php   $industrial_digital_out_4_v2 = new BrickletIndustrialDigitalOut4V2('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletIndustrialDigitalOut4V2::setValue(array $value)

Setzt den Zustand aller vier 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.

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

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

array BrickletIndustrialDigitalOut4V2::getValue()

Gibt die aktuellen Zustände der Kanäle zurück.

void BrickletIndustrialDigitalOut4V2::setSelectedValue(int $channel, bool $value)

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

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

void BrickletIndustrialDigitalOut4V2::setChannelLEDConfig(int $channel, int $config)

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

Standardmäßig sind die LEDs für alle Kanäle auf Kanalstatus konfiguriert.

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

  • BrickletIndustrialDigitalOut4V2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalOut4V2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalOut4V2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalOut4V2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
int BrickletIndustrialDigitalOut4V2::getChannelLEDConfig(int $channel)

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

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

  • BrickletIndustrialDigitalOut4V2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalOut4V2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalOut4V2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalOut4V2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Fortgeschrittene Funktionen

void BrickletIndustrialDigitalOut4V2::setMonoflop(int $channel, bool $value, int $time)

Der erste Parameter ist der gewünschte Zustand des Kanals (true bedeutet high und false low). Der zweite Parameter stellt die Zeit (in ms) dar, in welcher der Kanal den Zustand halten soll.

Wenn diese Funktion mit den Parametern (true, 1500) aufgerufen wird: Der Kanal wird angeschaltet und nach 1,5s wieder ausgeschaltet.

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

Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-4 Bricklet 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 eingeschaltet sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Kanal nach spätestens zwei Sekunden ausschalten.

array BrickletIndustrialDigitalOut4V2::getMonoflop(int $channel)

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.

Das zurückgegebene Array enthält die Keys value, time und time_remaining.

void BrickletIndustrialDigitalOut4V2::setPWMConfiguration(int $channel, int $frequency, int $duty_cycle)

Aktiviert ein PWM auf dem angegebenen Kanal. Die Frequenz wird in 1/10Hz angegeben und die Duty Cycle in 1/100%.

Um die PWM wieder auszustellen, kann die Frequenz auf 0 gesetzt werden oder eine andere Funktion aufgerufen werden die Einstellungen am Kanal verändert (z.B. setSelectedValue()).

Der Maximale Duty Cycle-Wert beträgt 10000 (100%). Der auf dem Industrial Digital Out 4 Bricklet 2.0 verwendete Optokoppler hat eine Anstiegszeit und Abfallzeit von jeweils 11.5us bei einer Spannung von 24V. Dadurch ist ergibt sich ein maximaler Frequenzwert von ca. 400000 (40kHz).

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

Die Standardwerte sind 0, 0.

array BrickletIndustrialDigitalOut4V2::getPWMConfiguration(int $channel)

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

Das zurückgegebene Array enthält die Keys frequency und duty_cycle.

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

  • BrickletIndustrialDigitalOut4V2::FUNCTION_SET_VALUE = 1
  • BrickletIndustrialDigitalOut4V2::FUNCTION_SET_SELECTED_VALUE = 3
  • BrickletIndustrialDigitalOut4V2::FUNCTION_SET_MONOFLOP = 4
  • BrickletIndustrialDigitalOut4V2::FUNCTION_SET_CHANNEL_LED_CONFIG = 7
  • BrickletIndustrialDigitalOut4V2::FUNCTION_SET_PWM_CONFIGURATION = 9
  • BrickletIndustrialDigitalOut4V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalOut4V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalOut4V2::FUNCTION_RESET = 243
  • BrickletIndustrialDigitalOut4V2::FUNCTION_WRITE_UID = 248
void BrickletIndustrialDigitalOut4V2::setResponseExpectedAll(bool $response_expected)

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

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

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

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

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

  • BrickletIndustrialDigitalOut4V2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDigitalOut4V2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDigitalOut4V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDigitalOut4V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDigitalOut4V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletIndustrialDigitalOut4V2::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 BrickletIndustrialDigitalOut4V2::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 BrickletIndustrialDigitalOut4V2::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:

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

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

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

  • BrickletIndustrialDigitalOut4V2::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalOut4V2::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalOut4V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalOut4V2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialDigitalOut4V2::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 BrickletIndustrialDigitalOut4V2::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 BrickletIndustrialDigitalOut4V2::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 BrickletIndustrialDigitalOut4V2::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 BrickletIndustrialDigitalOut4V2::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 BrickletIndustrialDigitalOut4V2::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.

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_v2->registerCallback(BrickletIndustrialDigitalOut4V2::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 BrickletIndustrialDigitalOut4V2::CALLBACK_MONOFLOP_DONE
<?php   void callback(int $channel, bool $value [, mixed $user_data])   ?>

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).

Konstanten

int BrickletIndustrialDigitalOut4V2::DEVICE_IDENTIFIER

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

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