PHP - Industrial Analog Out Bricklet 2.0

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

Download (ExampleSimpleCurrent.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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialAnalogOutV2;

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

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

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

// Set output current to 4.5mA
$iao->setCurrent(4500);
$iao->setEnabled(TRUE);

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

?>

Simple Voltage

Download (ExampleSimpleVoltage.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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialAnalogOutV2;

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

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

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

// Set output voltage to 3.3V
$iao->setVoltage(3300);
$iao->setEnabled(TRUE);

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

?>

API

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

Grundfunktionen

class BrickletIndustrialAnalogOutV2(string $uid, IPConnection $ipcon)

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

<?php   $industrial_analog_out_v2 = new BrickletIndustrialAnalogOutV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletIndustrialAnalogOutV2::setEnabled(bool $enabled)

Aktiviert/deaktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

bool BrickletIndustrialAnalogOutV2::getEnabled()

Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.

void BrickletIndustrialAnalogOutV2::setVoltage(int $voltage)

Setzt die Ausgangsspannung in mV.

Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.

int BrickletIndustrialAnalogOutV2::getVoltage()

Gibt die Spannung zurück, wie von setVoltage() gesetzt.

void BrickletIndustrialAnalogOutV2::setCurrent(int $current)

Setzt den Ausgangsstrom in µA.

Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.

int BrickletIndustrialAnalogOutV2::getCurrent()

Gibt die Spannung zurück, wie von setCurrent() gesetzt.

void BrickletIndustrialAnalogOutV2::setOutLEDConfig(int $config)

Die Out LED kann an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der "Out-Status" angezeigt werden. Falls Out-Status gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des Ausgabewertes (Spannung oder Strom) skaliert werden.

Das Verhalten des Out-Status kann mittels setOutLEDStatusConfig() eingestellt werden.

Standardmäßig ist die LED auf Out-Status konfiguriert.

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

  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_OFF = 0
  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_ON = 1
  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_SHOW_OUT_STATUS = 3
int BrickletIndustrialAnalogOutV2::getOutLEDConfig()

Gibt die Out-LED-Konfiguration zurück, wie von setOutLEDConfig() gesetzt.

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

  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_OFF = 0
  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_ON = 1
  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_SHOW_OUT_STATUS = 3
void BrickletIndustrialAnalogOutV2::setOutLEDStatusConfig(int $min, int $max, int $config)

Setzt die Out-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Out-LED auf Out-Status eingestellt ist, siehe setOutLEDConfig().

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss das "min" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert über 5V steigt und wieder ausgeschaltet sobald der Ausgabewert unter 5V fällt. Für einen negativen Schwellwert muss das "max" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert unter 5V fällt und wieder ausgeschaltet sobald der Ausgabewert über 5V steigt.

Im Intensitätsmodus kann ein Bereich in mV oder µA angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=2V und max=8V: Die LED ist bei 2V und darunter aus, bei 8V und darüber an und zwischen 2V und 8V wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

Standardwerte: Intensitätsmodus mit min=0V und max=10V.

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

  • BrickletIndustrialAnalogOutV2::OUT_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialAnalogOutV2::OUT_LED_STATUS_CONFIG_INTENSITY = 1
array BrickletIndustrialAnalogOutV2::getOutLEDStatusConfig()

Gibt die Out-LED-Status-Konfiguration zurück, wie von setOutLEDStatusConfig() gesetzt.

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

  • BrickletIndustrialAnalogOutV2::OUT_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialAnalogOutV2::OUT_LED_STATUS_CONFIG_INTENSITY = 1

Das zurückgegebene Array enthält die Keys min, max und config.

Fortgeschrittene Funktionen

void BrickletIndustrialAnalogOutV2::setConfiguration(int $voltage_range, int $current_range)

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

  • 0V bis 5V
  • 0V bis 10V (Standard)

Einstellbare Stromwertebereiche sind:

  • 4mA bis 20mA (Standard)
  • 0mA bis 20mA
  • 0mA bis 24mA

Die Auflösung ist immer 12 Bit. Dass heißt, die Genauigkeit erhöht sich bei kleineren Wertebereichen.

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

  • BrickletIndustrialAnalogOutV2::VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOutV2::VOLTAGE_RANGE_0_TO_10V = 1
  • BrickletIndustrialAnalogOutV2::CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOutV2::CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOutV2::CURRENT_RANGE_0_TO_24MA = 2
array BrickletIndustrialAnalogOutV2::getConfiguration()

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

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

  • BrickletIndustrialAnalogOutV2::VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOutV2::VOLTAGE_RANGE_0_TO_10V = 1
  • BrickletIndustrialAnalogOutV2::CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOutV2::CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOutV2::CURRENT_RANGE_0_TO_24MA = 2

Das zurückgegebene Array enthält die Keys voltage_range und current_range.

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

  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_ENABLED = 1
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_VOLTAGE = 3
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_CURRENT = 5
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_CONFIGURATION = 7
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_OUT_LED_CONFIG = 9
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialAnalogOutV2::FUNCTION_RESET = 243
  • BrickletIndustrialAnalogOutV2::FUNCTION_WRITE_UID = 248
void BrickletIndustrialAnalogOutV2::setResponseExpectedAll(bool $response_expected)

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

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

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

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

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

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

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

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

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

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

Konstanten

int BrickletIndustrialAnalogOutV2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Analog Out 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 BrickletIndustrialAnalogOutV2::DEVICE_DISPLAY_NAME

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