MATLAB/Octave - Industrial Digital In 4 Bricklet 2.0

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (MATLAB)

Download (matlab_example_simple.m)

 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
function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletIndustrialDigitalIn4V2;

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

    ipcon = IPConnection(); % Create IP connection
    idi4 = handle(BrickletIndustrialDigitalIn4V2(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current value
    value = idi4.getValue();

    fprintf('Channel 0: %i\n', value(1));
    fprintf('Channel 1: %i\n', value(2));
    fprintf('Channel 2: %i\n', value(3));
    fprintf('Channel 3: %i\n', value(4));

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Edge Count (MATLAB)

Download (matlab_example_edge_count.m)

 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
function matlab_example_edge_count()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletIndustrialDigitalIn4V2;

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

    ipcon = IPConnection(); % Create IP connection
    idi4 = handle(BrickletIndustrialDigitalIn4V2(UID, ipcon), 'CallbackProperties'); % 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:9
        pause(1);

        % Get current edge count
        count = idi4.getEdgeCount(3, false);
        fprintf('Count: %i\n', count);
    end

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)

Download (matlab_example_callback.m)

 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
function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletIndustrialDigitalIn4V2;

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

    ipcon = IPConnection(); % Create IP connection
    idi4 = handle(BrickletIndustrialDigitalIn4V2(UID, ipcon), 'CallbackProperties'); % 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
    set(idi4, 'ValueCallback', @(h, e) cb_value(e));

    % Set period for value (channel 1) callback to 0.1s (100ms)
    idi4.setValueCallbackConfiguration(1, 100, false);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for value callback
function cb_value(e)
    if e.channel == com.tinkerforge.BrickletIndustrialDigitalIn4V2.CHANNEL_0
        fprintf('Channel: 0\n');
    elseif e.channel == com.tinkerforge.BrickletIndustrialDigitalIn4V2.CHANNEL_1
        fprintf('Channel: 1\n');
    elseif e.channel == com.tinkerforge.BrickletIndustrialDigitalIn4V2.CHANNEL_2
        fprintf('Channel: 2\n');
    elseif e.channel == com.tinkerforge.BrickletIndustrialDigitalIn4V2.CHANNEL_3
        fprintf('Channel: 3\n');
    end

    fprintf('Changed: %i\n', e.changed);
    fprintf('Value: %i\n', e.value);
    fprintf('\n');
end

Simple (Octave)

Download (octave_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    idi4 = javaObject("com.tinkerforge.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();

    fprintf("Channel 0: %d\n", value(1));
    fprintf("Channel 1: %d\n", value(2));
    fprintf("Channel 2: %d\n", value(3));
    fprintf("Channel 3: %d\n", value(4));

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Edge Count (Octave)

Download (octave_example_edge_count.m)

 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
function octave_example_edge_count()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    idi4 = javaObject("com.tinkerforge.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:9
        pause(1);

        % Get current edge count
        count = idi4.getEdgeCount(3, false);
        fprintf("Count: %d\n", java2int(count));
    end

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

Callback (Octave)

Download (octave_example_callback.m)

 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
function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    idi4 = javaObject("com.tinkerforge.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.addValueCallback(@cb_value);

    % Set period for value (channel 1) callback to 0.1s (100ms)
    idi4.setValueCallbackConfiguration(1, 100, false);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for value callback
function cb_value(e)
    if e.channel == 0
        fprintf("Channel: 0\n");
    elseif e.channel == 1
        fprintf("Channel: 1\n");
    elseif e.channel == 2
        fprintf("Channel: 2\n");
    elseif e.channel == 3
        fprintf("Channel: 3\n");
    end

    fprintf("Changed: %d\n", e.changed);
    fprintf("Value: %d\n", e.value);
    fprintf("\n");
end

API

Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletIndustrialDigitalIn4V2(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • industrialDigitalIn4V2 – Typ: BrickletIndustrialDigitalIn4V2

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid.

In MATLAB:

import com.tinkerforge.BrickletIndustrialDigitalIn4V2;

industrialDigitalIn4V2 = BrickletIndustrialDigitalIn4V2("YOUR_DEVICE_UID", ipcon);

In Octave:

industrialDigitalIn4V2 = java_new("com.tinkerforge.BrickletIndustrialDigitalIn4V2", "YOUR_DEVICE_UID", ipcon);

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

boolean[] BrickletIndustrialDigitalIn4V2.getValue()
Rückgabe:
  • value – Typ: boolean[], 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, Standardwert: 3

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, Standardwert: 3

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

long BrickletIndustrialDigitalIn4V2.getEdgeCount(int channel, boolean resetCounter)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
  • resetCounter – Typ: boolean
Rückgabe:
  • count – Typ: long, 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 edgeType, int debounce)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
  • edgeType – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

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
  • 1 = fallend
  • 2 = beide

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.

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

  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2
BrickletIndustrialDigitalIn4V2.EdgeCountConfiguration BrickletIndustrialDigitalIn4V2.getEdgeCountConfiguration(int channel)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabeobjekt:
  • edgeType – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

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

  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2
BrickletIndustrialDigitalIn4V2.SPITFPErrorCount BrickletIndustrialDigitalIn4V2.getSPITFPErrorCount()
Rückgabeobjekt:
  • errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: long, 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 Bootloader- 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(long pointer)
Parameter:
  • pointer – Typ: long, Einheit: 1 B, 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(int[] 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 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, Standardwert: 3

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, Standardwert: 3

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, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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(long uid)
Parameter:
  • uid – Typ: long, 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.

long BrickletIndustrialDigitalIn4V2.readUID()
Rückgabe:
  • uid – Typ: long, 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.

BrickletIndustrialDigitalIn4V2.Identity BrickletIndustrialDigitalIn4V2.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: int[], Länge: 3
    • 1: major – Typ: int, Wertebereich: [0 bis 255]
    • 2: minor – Typ: int, Wertebereich: [0 bis 255]
    • 3: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: int[], Länge: 3
    • 1: major – Typ: int, Wertebereich: [0 bis 255]
    • 2: minor – Typ: int, Wertebereich: [0 bis 255]
    • 3: revision – Typ: int, Wertebereich: [0 bis 255]
  • deviceIdentifier – 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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.

Konfigurationsfunktionen für Callbacks

void BrickletIndustrialDigitalIn4V2.setValueCallbackConfiguration(int channel, long period, boolean valueHasToChange)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode ist die Periode mit der der ValueCallback 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
BrickletIndustrialDigitalIn4V2.ValueCallbackConfiguration BrickletIndustrialDigitalIn4V2.getValueCallbackConfiguration(int channel)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabeobjekt:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, 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(long period, boolean valueHasToChange)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false

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

BrickletIndustrialDigitalIn4V2.AllValueCallbackConfiguration BrickletIndustrialDigitalIn4V2.getAllValueCallbackConfiguration()
Rückgabeobjekt:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, 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 wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb 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.

callback BrickletIndustrialDigitalIn4V2.ValueCallback
Event-Objekt:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
  • changed – Typ: boolean
  • value – Typ: boolean

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

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addValueCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeValueCallback() wieder entfernt werden.

callback BrickletIndustrialDigitalIn4V2.AllValueCallback
Event-Objekt:
  • changed – Typ: boolean[], Länge: 4
  • value – Typ: boolean[], Länge: 4

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.

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addAllValueCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeAllValueCallback() wieder entfernt werden.

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.

int[] BrickletIndustrialDigitalIn4V2.getAPIVersion()
Rückgabeobjekt:
  • apiVersion – Typ: int[], Länge: 3
    • 1: major – Typ: int, Wertebereich: [0 bis 255]
    • 2: minor – Typ: int, Wertebereich: [0 bis 255]
    • 3: 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.

boolean BrickletIndustrialDigitalIn4V2.getResponseExpected(int functionId)
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

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

  • 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 functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

Ä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 functionId:

  • 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(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

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

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.EnumerateCallback 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.