PHP - Industrial Analog Out Bricklet

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialAnalogOut;

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

$ipcon = new IPConnection(); // Create IP connection
$iao = new BrickletIndustrialAnalogOut(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->enable();

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$iao->disable();
$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/BrickletIndustrialAnalogOut.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialAnalogOut;

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

$ipcon = new IPConnection(); // Create IP connection
$iao = new BrickletIndustrialAnalogOut(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->enable();

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

?>

API

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

Grundfunktionen

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

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

<?php   $industrial_analog_out = new BrickletIndustrialAnalogOut('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletIndustrialAnalogOut::enable()

Aktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

void BrickletIndustrialAnalogOut::disable()

Deaktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

bool BrickletIndustrialAnalogOut::isEnabled()
Rückgabe:
  • $enabled – Typ: bool

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

void BrickletIndustrialAnalogOut::setVoltage(int $voltage)
Parameter:
  • $voltage – Typ: int, Wertebereich: [0 bis 216 - 1]

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 BrickletIndustrialAnalogOut::getVoltage()
Rückgabe:
  • $voltage – Typ: int, Wertebereich: [0 bis 216 - 1]

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

void BrickletIndustrialAnalogOut::setCurrent(int $current)
Parameter:
  • $current – Typ: int, Wertebereich: [0 bis 216 - 1]

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 BrickletIndustrialAnalogOut::getCurrent()
Rückgabe:
  • $current – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Fortgeschrittene Funktionen

void BrickletIndustrialAnalogOut::setConfiguration(int $voltage_range, int $current_range)
Parameter:
  • $voltage_range – Typ: int, Wertebereich: Siehe Konstanten
  • $current_range – Typ: int, Wertebereich: Siehe Konstanten

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:

Für $voltage_range:

  • BrickletIndustrialAnalogOut::VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOut::VOLTAGE_RANGE_0_TO_10V = 1

Für $current_range:

  • BrickletIndustrialAnalogOut::CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOut::CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOut::CURRENT_RANGE_0_TO_24MA = 2
array BrickletIndustrialAnalogOut::getConfiguration()
Rückgabe-Array:
  • 'voltage_range' – Typ: int, Wertebereich: Siehe Konstanten
  • 'current_range' – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $voltage_range:

  • BrickletIndustrialAnalogOut::VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOut::VOLTAGE_RANGE_0_TO_10V = 1

Für $current_range:

  • BrickletIndustrialAnalogOut::CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOut::CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOut::CURRENT_RANGE_0_TO_24MA = 2
array BrickletIndustrialAnalogOut::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 BrickletIndustrialAnalogOut::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:

  • BrickletIndustrialAnalogOut::FUNCTION_ENABLE = 1
  • BrickletIndustrialAnalogOut::FUNCTION_DISABLE = 2
  • BrickletIndustrialAnalogOut::FUNCTION_SET_VOLTAGE = 4
  • BrickletIndustrialAnalogOut::FUNCTION_SET_CURRENT = 6
  • BrickletIndustrialAnalogOut::FUNCTION_SET_CONFIGURATION = 8
void BrickletIndustrialAnalogOut::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:

  • BrickletIndustrialAnalogOut::FUNCTION_ENABLE = 1
  • BrickletIndustrialAnalogOut::FUNCTION_DISABLE = 2
  • BrickletIndustrialAnalogOut::FUNCTION_SET_VOLTAGE = 4
  • BrickletIndustrialAnalogOut::FUNCTION_SET_CURRENT = 6
  • BrickletIndustrialAnalogOut::FUNCTION_SET_CONFIGURATION = 8
void BrickletIndustrialAnalogOut::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 BrickletIndustrialAnalogOut::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.

Konstanten

int BrickletIndustrialAnalogOut::DEVICE_IDENTIFIER

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

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