Deutsch
English
Menu
Software / API Bindings / Perl / API Referenz und Beispiele / Bricklets (Abgekündigt) / Industrial Analog Out Bricklet

Perl - Industrial Analog Out Bricklet

Dies ist die Beschreibung der Perl 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 Perl API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple Current

Download (example_simple_current.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletIndustrialAnalogOut;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Industrial Analog Out Bricklet

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $iao = Tinkerforge::BrickletIndustrialAnalogOut->new(&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->set_current(4500);
$iao->enable();

print "Press key to exit\n";
<STDIN>;

$iao->disable();

$ipcon->disconnect();

Simple Voltage

Download (example_simple_voltage.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletIndustrialAnalogOut;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Industrial Analog Out Bricklet

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $iao = Tinkerforge::BrickletIndustrialAnalogOut->new(&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->set_voltage(3300);
$iao->enable();

print "Press key to exit\n";
<STDIN>;

$iao->disable();

$ipcon->disconnect();

API

Allgemein kann jede Subroutine der Perl Bindings Fehler als Tinkerforge::Error Objekt mittels croak() melden. Das Objekt hat eine get_code() und eine get_message() Subroutine. Es sind verschiedene Fehlercodes definiert:

  • Error->ALREADY_CONNECTED = 11
  • Error->NOT_CONNECTED = 12
  • Error->CONNECT_FAILED = 13
  • Error->INVALID_FUNCTION_ID = 21
  • Error->TIMEOUT = 31
  • Error->INVALID_PARAMETER = 41
  • Error->FUNCTION_NOT_SUPPORTED = 42
  • Error->UNKNOWN_ERROR = 43
  • Error->STREAM_OUT_OF_SYNC = 51
  • Error->INVALID_UID = 61
  • Error->NON_ASCII_CHAR_IN_SECRET = 71
  • Error->WRONG_DEVICE_TYPE = 81
  • Error->DEVICE_REPLACED = 82
  • Error->WRONG_RESPONSE_LENGTH = 83

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletIndustrialAnalogOut->new($uid, $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:

$industrial_analog_out = BrickletIndustrialAnalogOut->new("YOUR_DEVICE_UID", $ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletIndustrialAnalogOut->enable()
Rückgabe:
  • undef

Aktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

BrickletIndustrialAnalogOut->disable()
Rückgabe:
  • undef

Deaktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

BrickletIndustrialAnalogOut->is_enabled()
Rückgabe:
  • $enabled – Typ: bool, Standardwert: 0

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

BrickletIndustrialAnalogOut->set_voltage($voltage)
Parameter:
  • $voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 10000]
Rückgabe:
  • undef

Setzt die Ausgangsspannung.

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

BrickletIndustrialAnalogOut->get_voltage()
Rückgabe:
  • $voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 10000]

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

BrickletIndustrialAnalogOut->set_current($current)
Parameter:
  • $current – Typ: int, Einheit: 1 µA, Wertebereich: [0 bis 24000]
Rückgabe:
  • undef

Setzt den Ausgangsstrom.

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

BrickletIndustrialAnalogOut->get_current()
Rückgabe:
  • $current – Typ: int, Einheit: 1 µA, Wertebereich: [0 bis 24000]

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

Fortgeschrittene Funktionen

BrickletIndustrialAnalogOut->set_configuration($voltage_range, $current_range)
Parameter:
  • $voltage_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
  • $current_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • undef

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

  • 0V bis 5V
  • 0V bis 10V

Einstellbare Stromwertebereiche sind:

  • 4mA bis 20mA
  • 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
BrickletIndustrialAnalogOut->get_configuration()
Rückgabe-Array:
  • 0: $voltage_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
  • 1: $current_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von set_configuration() 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
BrickletIndustrialAnalogOut->get_identity()
Rückgabe-Array:
  • 0: $uid – Typ: string, Länge: bis zu 8
  • 1: $connected_uid – Typ: string, Länge: bis zu 8
  • 2: $position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
  • 3: \@hardware_version – Typ: [int, ...], Länge: 3
    • 0: $major – Typ: int, Wertebereich: [0 bis 255]
    • 1: $minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: $revision – Typ: int, Wertebereich: [0 bis 255]
  • 4: \@firmware_version – Typ: [int, ...], Länge: 3
    • 0: $major – Typ: int, Wertebereich: [0 bis 255]
    • 1: $minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: $revision – Typ: int, Wertebereich: [0 bis 255]
  • 5: $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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletIndustrialAnalogOut->get_api_version()
Rückgabe-Array:
  • 0: \@api_version – Typ: [int, ...], Länge: 3
    • 0: $major – Typ: int, Wertebereich: [0 bis 255]
    • 1: $minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: $revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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.

BrickletIndustrialAnalogOut->get_response_expected($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 set_response_expected(). 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
BrickletIndustrialAnalogOut->set_response_expected($function_id, $response_expected)
Parameter:
  • $function_id – Typ: int, Wertebereich: Siehe Konstanten
  • $response_expected – Typ: bool
Rückgabe:
  • undef

Ä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
BrickletIndustrialAnalogOut->set_response_expected_all($response_expected)
Parameter:
  • $response_expected – Typ: bool
Rückgabe:
  • undef

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

Konstanten

BrickletIndustrialAnalogOut->DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Analog Out Bricklet zu identifizieren.

Die get_identity() Funktion und der IPConnection->CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletIndustrialAnalogOut->DEVICE_DISPLAY_NAME

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