PHP - Industrial Digital In 4 Bricklet 2.0

Dies ist die Beschreibung der PHP API Bindings für das Industrial Digital In 4 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Digital In 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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDigitalIn4V2;

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

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

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

// Get current value
$value = $idi4->getValue();

echo "Channel 0: " . $value[0] . "\n";
echo "Channel 1: " . $value[1] . "\n";
echo "Channel 2: " . $value[2] . "\n";
echo "Channel 3: " . $value[3] . "\n";

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

?>

Edge Count

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDigitalIn4V2;

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

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

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

// Configure rising edge count (channel 3) with 10ms debounce
$idi4->setEdgeCountConfiguration(3, 0, 10);

// Get edge count 10 times with 1s delay
for($i = 0; $i < 10; $i++) {
    sleep(1);

    // Get current edge count
    $count = $idi4->getEdgeCount(3, FALSE);
    echo "Count: $count\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
35
36
37
38
39
40
41
42
43
44
45
46
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialDigitalIn4V2;

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

// Callback function for value callback
function cb_value($channel, $changed, $value)
{
    if ($channel == BrickletIndustrialDigitalIn4V2::CHANNEL_0) {
        echo "Channel: 0\n";
    } elseif ($channel == BrickletIndustrialDigitalIn4V2::CHANNEL_1) {
        echo "Channel: 1\n";
    } elseif ($channel == BrickletIndustrialDigitalIn4V2::CHANNEL_2) {
        echo "Channel: 2\n";
    } elseif ($channel == BrickletIndustrialDigitalIn4V2::CHANNEL_3) {
        echo "Channel: 3\n";
    }

    echo "Changed: $changed\n";
    echo "Value: $value\n";
    echo "\n";
}

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

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

// Register value callback to function cb_value
$idi4->registerCallback(BrickletIndustrialDigitalIn4V2::CALLBACK_VALUE, 'cb_value');

// Set period for value (channel 1) callback to 0.1s (100ms)
$idi4->setValueCallbackConfiguration(1, 100, 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.

Grundfunktionen

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

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

<?php   $industrial_digital_in_4_v2 = new BrickletIndustrialDigitalIn4V2('YOUR_DEVICE_UID', $ipcon);   ?>

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

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

Gibt die Eingangswerte als Bools zurück, true bedeutet logisch 1 und false logisch 0.

void BrickletIndustrialDigitalIn4V2::setChannelLEDConfig(int $channel, int $config)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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:

Für $channel:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

Für $config:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
int BrickletIndustrialDigitalIn4V2::getChannelLEDConfig(int $channel)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $channel:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

Für $config:

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

Fortgeschrittene Funktionen

int BrickletIndustrialDigitalIn4V2::getEdgeCount(int $channel, bool $reset_counter)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
  • $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.

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

Für $channel:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
void BrickletIndustrialDigitalIn4V2::setEdgeCountConfiguration(int $channel, int $edge_type, int $debounce)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
  • $edge_type – Typ: int, Wertebereich: Siehe Konstanten
  • $debounce – Typ: int, Wertebereich: [0 bis 255]

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. Mögliche Flankentypen sind:

  • 0 = steigend (Standard)
  • 1 = fallend
  • 2 = beide

Die Entprellzeit (debounce) wird in ms angegeben.

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.

Standardwerte: 0 (edge type) und 100ms (debounce).

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

Für $channel:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

Für $edge_type:

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

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 $channel:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

Für $edge_type:

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

  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalIn4V2::FUNCTION_RESET = 243
  • BrickletIndustrialDigitalIn4V2::FUNCTION_WRITE_UID = 248
void BrickletIndustrialDigitalIn4V2::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:

  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalIn4V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalIn4V2::FUNCTION_RESET = 243
  • BrickletIndustrialDigitalIn4V2::FUNCTION_WRITE_UID = 248
void BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::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:

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

Für $status:

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

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

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

  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::setValueCallbackConfiguration(int $channel, int $period, bool $value_has_to_change)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
  • $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_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.

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

Für $channel:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
array BrickletIndustrialDigitalIn4V2::getValueCallbackConfiguration(int $channel)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
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 für den gegebenen Kanal zurück, wie mittels setValueCallbackConfiguration() gesetzt.

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

Für $channel:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
void BrickletIndustrialDigitalIn4V2::setAllValueCallbackConfiguration(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_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 BrickletIndustrialDigitalIn4V2::getAllValueCallbackConfiguration()
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 setAllValueCallbackConfiguration() 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";
}

$industrial_digital_in_4_v2->registerCallback(BrickletIndustrialDigitalIn4V2::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 BrickletIndustrialDigitalIn4V2::CALLBACK_VALUE
<?php   void callback(int $channel, bool $changed, bool $value [, mixed $user_data])   ?>
Callback-Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
  • $changed – Typ: bool
  • $value – Typ: bool
  • $user_data – Typ: mixed

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setValueCallbackConfiguration() 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.

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

Für $channel:

  • BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3
int BrickletIndustrialDigitalIn4V2::CALLBACK_ALL_VALUE
<?php   void callback(array $changed, array $value [, mixed $user_data])   ?>
Callback-Parameter:
  • $changed – Typ: array(bool, ...), Länge: 4
  • $value – Typ: array(bool, ...), Länge: 4
  • $user_data – Typ: mixed

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setAllValueCallbackConfiguration() 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.

Konstanten

int BrickletIndustrialDigitalIn4V2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Digital In 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 BrickletIndustrialDigitalIn4V2::DEVICE_DISPLAY_NAME

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