Perl - Industrial Dual 0-20mA Bricklet 2.0

Dies ist die Beschreibung der Perl API Bindings für das Industrial Dual 0-20mA Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual 0-20mA Bricklet 2.0 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

Download (example_simple.pl)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletIndustrialDual020mAV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $id020 = Tinkerforge::BrickletIndustrialDual020mAV2->new(&UID, $ipcon); # Create device object

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

# Get current current from channel 0
my $current = $id020->get_current(0);
print "Current (Channel 0): " . $current/1000000.0 . " mA\n";

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Callback

Download (example_callback.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
27
28
29
30
31
32
33
34
35
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletIndustrialDual020mAV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0

# Callback subroutine for current callback
sub cb_current
{
    my ($channel, $current) = @_;

    print "Channel: $channel\n";
    print "Current: " . $current/1000000.0 . " mA\n";
    print "\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $id020 = Tinkerforge::BrickletIndustrialDual020mAV2->new(&UID, $ipcon); # Create device object

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

# Register current callback to subroutine cb_current
$id020->register_callback($id020->CALLBACK_CURRENT, 'cb_current');

# Set period for current (channel 0) callback to 1s (1000ms) without a threshold
$id020->set_current_callback_configuration(0, 1000, 0, 'x', 0, 0);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Threshold

Download (example_threshold.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
27
28
29
30
31
32
33
34
35
36
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletIndustrialDual020mAV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0

# Callback subroutine for current callback
sub cb_current
{
    my ($channel, $current) = @_;

    print "Channel: $channel\n";
    print "Current: " . $current/1000000.0 . " mA\n";
    print "\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $id020 = Tinkerforge::BrickletIndustrialDual020mAV2->new(&UID, $ipcon); # Create device object

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

# Register current callback to subroutine cb_current
$id020->register_callback($id020->CALLBACK_CURRENT, 'cb_current');

# Configure threshold for current (channel 0) "greater than 10 mA"
# with a debounce period of 10s (10000ms)
$id020->set_current_callback_configuration(0, 10000, 0, '>', 10*1000000, 0);

print "Press key to exit\n";
<STDIN>;
$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

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletIndustrialDual020mAV2->new($uid, $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $industrial_dual_0_20ma_v2 – Typ: BrickletIndustrialDual020mAV2

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

$industrial_dual_0_20ma_v2 = BrickletIndustrialDual020mAV2->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletIndustrialDual020mAV2->get_current($channel)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • $current – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die gemessenen Stromstärke des spezifizierten Kanals zurück. Der Wert ist in nA und im Bereich von 0nA bis 22505322nA (22,5mA).

Es ist möglich zu erkennen ob ein IEC 60381-1-kompatibler Sensor angeschlossen ist und ob er funktionsfähig ist.

Falls die zurückgegebene Stromstärke kleiner als 4mA ist, ist wahrscheinlich kein Sensor angeschlossen oder der Sensor ist defekt. Falls die zurückgegebene Stromstärke über 20mA ist, besteht entweder ein Kurzschluss oder der Sensor ist defekt. Somit ist erkennbar ob ein Sensor angeschlossen und funktionsfähig ist.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_CURRENT Callback verwendet werden. Der Callback wird mit der Funktion set_current_callback_configuration() konfiguriert.

BrickletIndustrialDual020mAV2->set_channel_led_config($channel, $config)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 255]
  • $config – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

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 kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des gemessenen Wertes skaliert werden.

Das Verhalten des Kanalstatus kann mittels set_channel_led_status_config() eingestellt werden.

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

  • BrickletIndustrialDual020mAV2->CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDual020mAV2->CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDual020mAV2->CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDual020mAV2->CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
BrickletIndustrialDual020mAV2->get_channel_led_config($channel)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $config:

  • BrickletIndustrialDual020mAV2->CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDual020mAV2->CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDual020mAV2->CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDual020mAV2->CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
BrickletIndustrialDual020mAV2->set_channel_led_status_config($channel, $min, $max, $config)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 255]
  • $min – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • $max – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • $config – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

Setzt die Kanal-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Kanal-LED auf Kanalstatus eingestellt ist, siehe set_channel_led_config().

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 nA gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 10mA wird die LED eingeschaltet sobald der gemessene Strom über 10mA steigt und wieder ausgeschaltet sobald der Strom unter 10mA fällt. Für einen negativen Schwellwert muss das "max" Parameter auf den gewünschten Schwellwert in nA gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 10mA wird die LED eingeschaltet sobald der gemessene Strom unter 10mA fällt und wieder ausgeschaltet sobald der Strom über 10mA steigt.

Im Intensitätsmodus kann ein Bereich in nA angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=4mA und max=20mA: Die LED ist bei 4mA und darunter aus, bei 20mA und darüber an und zwischen 4mA und 20mA 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=4mA und max=20mA.

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

Für $config:

  • BrickletIndustrialDual020mAV2->CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialDual020mAV2->CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1
BrickletIndustrialDual020mAV2->get_channel_led_status_config($channel)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 255]
Rückgabe-Array:
  • 0: $min – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 1: $max – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 2: $config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $config:

  • BrickletIndustrialDual020mAV2->CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialDual020mAV2->CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen

BrickletIndustrialDual020mAV2->set_sample_rate($rate)
Parameter:
  • $rate – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

Setzt die Abtastrate auf 240, 60, 15 oder 4 Samples pro Sekunde. Die Auflösung für die Raten sind 12, 14, 16 und 18 Bit respektive.

Wert Beschreibung
0 240 Samples pro Sekunde, 12 Bit Auflösung
1 60 Samples pro Sekunde, 14 Bit Auflösung
2 15 Samples pro Sekunde, 16 Bit Auflösung
3 4 Samples pro Sekunde, 18 Bit Auflösung

Der Standardwert ist 3 (4 Samples pro Sekunde mit 18 Bit Auflösung).

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

Für $rate:

  • BrickletIndustrialDual020mAV2->SAMPLE_RATE_240_SPS = 0
  • BrickletIndustrialDual020mAV2->SAMPLE_RATE_60_SPS = 1
  • BrickletIndustrialDual020mAV2->SAMPLE_RATE_15_SPS = 2
  • BrickletIndustrialDual020mAV2->SAMPLE_RATE_4_SPS = 3
BrickletIndustrialDual020mAV2->get_sample_rate()
Rückgabe:
  • $rate – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Verstärkung zurück, wie von set_sample_rate() gesetzt.

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

Für $rate:

  • BrickletIndustrialDual020mAV2->SAMPLE_RATE_240_SPS = 0
  • BrickletIndustrialDual020mAV2->SAMPLE_RATE_60_SPS = 1
  • BrickletIndustrialDual020mAV2->SAMPLE_RATE_15_SPS = 2
  • BrickletIndustrialDual020mAV2->SAMPLE_RATE_4_SPS = 3
BrickletIndustrialDual020mAV2->set_gain($gain)
Parameter:
  • $gain – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

Setzt den Gain zwischen 1x und 8x. Wenn ein sehr kleiner Strom gemessen werden soll, dann kann der Gain hochgesetzt werden, um die Auflösung zu verbessern.

Beispiel: Wenn 0,5mA gememsen werden mit einem Gain von 8x dann wird 4mA zurückgegeben.

Der Standardwert ist 1x.

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

Für $gain:

  • BrickletIndustrialDual020mAV2->GAIN_1X = 0
  • BrickletIndustrialDual020mAV2->GAIN_2X = 1
  • BrickletIndustrialDual020mAV2->GAIN_4X = 2
  • BrickletIndustrialDual020mAV2->GAIN_8X = 3
BrickletIndustrialDual020mAV2->get_gain()
Rückgabe:
  • $gain – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Verstärkung zurück, wie von set_gain() gesetzt.

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

Für $gain:

  • BrickletIndustrialDual020mAV2->GAIN_1X = 0
  • BrickletIndustrialDual020mAV2->GAIN_2X = 1
  • BrickletIndustrialDual020mAV2->GAIN_4X = 2
  • BrickletIndustrialDual020mAV2->GAIN_8X = 3
BrickletIndustrialDual020mAV2->get_api_version()
Rückgabe:
  • @api_version – Typ: [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.

BrickletIndustrialDual020mAV2->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:

  • BrickletIndustrialDual020mAV2->FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDual020mAV2->FUNCTION_SET_SAMPLE_RATE = 5
  • BrickletIndustrialDual020mAV2->FUNCTION_SET_GAIN = 7
  • BrickletIndustrialDual020mAV2->FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDual020mAV2->FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 11
  • BrickletIndustrialDual020mAV2->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDual020mAV2->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDual020mAV2->FUNCTION_RESET = 243
  • BrickletIndustrialDual020mAV2->FUNCTION_WRITE_UID = 248
BrickletIndustrialDual020mAV2->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:

  • BrickletIndustrialDual020mAV2->FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDual020mAV2->FUNCTION_SET_SAMPLE_RATE = 5
  • BrickletIndustrialDual020mAV2->FUNCTION_SET_GAIN = 7
  • BrickletIndustrialDual020mAV2->FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDual020mAV2->FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 11
  • BrickletIndustrialDual020mAV2->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDual020mAV2->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDual020mAV2->FUNCTION_RESET = 243
  • BrickletIndustrialDual020mAV2->FUNCTION_WRITE_UID = 248
BrickletIndustrialDual020mAV2->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.

BrickletIndustrialDual020mAV2->get_spitfp_error_count()
Rückgabe-Array:
  • 0: $error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: $error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 2: $error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 3: $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.

BrickletIndustrialDual020mAV2->set_bootloader_mode($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:

  • BrickletIndustrialDual020mAV2->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDual020mAV2->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDual020mAV2->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDual020mAV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDual020mAV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für $status:

  • BrickletIndustrialDual020mAV2->BOOTLOADER_STATUS_OK = 0
  • BrickletIndustrialDual020mAV2->BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIndustrialDual020mAV2->BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIndustrialDual020mAV2->BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIndustrialDual020mAV2->BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIndustrialDual020mAV2->BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletIndustrialDual020mAV2->get_bootloader_mode()
Rückgabe:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $mode:

  • BrickletIndustrialDual020mAV2->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDual020mAV2->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDual020mAV2->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDual020mAV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDual020mAV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletIndustrialDual020mAV2->set_write_firmware_pointer($pointer)
Parameter:
  • $pointer – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • undef

Setzt den Firmware-Pointer für write_firmware(). 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.

BrickletIndustrialDual020mAV2->write_firmware(@data)
Parameter:
  • @data – Typ: [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 set_write_firmware_pointer() 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.

BrickletIndustrialDual020mAV2->set_status_led_config($config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • undef

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:

  • BrickletIndustrialDual020mAV2->STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDual020mAV2->STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDual020mAV2->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDual020mAV2->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletIndustrialDual020mAV2->get_status_led_config()
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $config:

  • BrickletIndustrialDual020mAV2->STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDual020mAV2->STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDual020mAV2->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDual020mAV2->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletIndustrialDual020mAV2->get_chip_temperature()
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.

BrickletIndustrialDual020mAV2->reset()
Rückgabe:
  • undef

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.

BrickletIndustrialDual020mAV2->write_uid($uid)
Parameter:
  • $uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • undef

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.

BrickletIndustrialDual020mAV2->read_uid()
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.

BrickletIndustrialDual020mAV2->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
  • 3: @hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 4: @firmware_version – Typ: [int, ...], Länge: 3, 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 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

BrickletIndustrialDual020mAV2->register_callback($callback_id, $function)
Parameter:
  • $callback_id – Typ: int
  • $function – Typ: string
Rückgabe:
  • undef

Registriert den $function Namen für die gegebene $callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletIndustrialDual020mAV2->set_current_callback_configuration($channel, $period, $value_has_to_change, $option, $min, $max)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 255]
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $value_has_to_change – Typ: bool, Standardwert: 0
  • $option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • $max – Typ: int, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • undef

Die Periode ist die Periode mit der der CALLBACK_CURRENT 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.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_CURRENT Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

Für $option:

  • BrickletIndustrialDual020mAV2->THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDual020mAV2->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDual020mAV2->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDual020mAV2->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDual020mAV2->THRESHOLD_OPTION_GREATER = '>'
BrickletIndustrialDual020mAV2->get_current_callback_configuration($channel)
Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 255]
Rückgabe-Array:
  • 0: $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 1: $value_has_to_change – Typ: bool, Standardwert: 0
  • 2: $option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 3: $min – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 4: $max – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die Callback-Konfiguration zurück, wie mittels set_current_callback_configuration() gesetzt.

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

Für $option:

  • BrickletIndustrialDual020mAV2->THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDual020mAV2->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDual020mAV2->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDual020mAV2->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDual020mAV2->THRESHOLD_OPTION_GREATER = '>'

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter ist der Name der Callback-Funktion:

sub my_callback
{
    print "@_[0]";
}

$industrial_dual_0_20ma_v2->register_callback(BrickletIndustrialDual020mAV2->CALLBACK_EXAMPLE, 'my_callback')

Die Callback Funktion wird dann von einem internen Thread der IP Connection aufgerufen werden. Im Gegensatz zu vielen anderen Programmiersprachen werden Variablen nicht automatisch zwischen Threads geteilt. Wenn eine Variable gleichzeitig in einer Callback Funktion und dem Rest des Programms genutzt werden soll, dann muss diese als :shared markiert werden. Siehe dazu auch die Dokumentation des threads::shared Perl Moduls für weitere Details.

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickletIndustrialDual020mAV2->CALLBACK_CURRENT
Callback-Parameter:
  • $channel – Typ: int, Wertebereich: [0 bis 255]
  • $current – Typ: int, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_current_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie get_current().

Konstanten

BrickletIndustrialDual020mAV2->DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Dual 0-20mA Bricklet 2.0 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.

BrickletIndustrialDual020mAV2->DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Dual 0-20mA Bricklet 2.0 dar.