Java - Industrial Digital In 4 Bricklet 2.0¶

Simple¶

Download (ExampleSimple.java)

 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDigitalIn4V2;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletIndustrialDigitalIn4V2 idi4 =
          new BrickletIndustrialDigitalIn4V2(UID, ipcon); // Create device object

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

        // Get current value
        boolean[] value = idi4.getValue(); // Can throw com.tinkerforge.TimeoutException

        System.out.println("Channel 0: " + value[0]);
        System.out.println("Channel 1: " + value[1]);
        System.out.println("Channel 2: " + value[2]);
        System.out.println("Channel 3: " + value[3]);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Edge Count¶

Download (ExampleEdgeCount.java)

 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDigitalIn4V2;

public class ExampleEdgeCount {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletIndustrialDigitalIn4V2 idi4 =
          new 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(int i = 0; i < 10; i++) {
            Thread.sleep(1000);

            // Get current edge count
            long count = idi4.getEdgeCount(3, false); // Can throw com.tinkerforge.TimeoutException
            System.out.println("Count: " + count);
        }

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Callback¶

Download (ExampleCallback.java)

 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
41
42
43
44
45
46

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDigitalIn4V2;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletIndustrialDigitalIn4V2 idi4 =
          new BrickletIndustrialDigitalIn4V2(UID, ipcon); // Create device object

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

        // Add value listener
        idi4.addValueListener(new BrickletIndustrialDigitalIn4V2.ValueListener() {
            public void value(int channel, boolean changed, boolean value) {
                if(channel == BrickletIndustrialDigitalIn4V2.CHANNEL_0) {
                    System.out.println("Channel: 0");
                } else if(channel == BrickletIndustrialDigitalIn4V2.CHANNEL_1) {
                    System.out.println("Channel: 1");
                } else if(channel == BrickletIndustrialDigitalIn4V2.CHANNEL_2) {
                    System.out.println("Channel: 2");
                } else if(channel == BrickletIndustrialDigitalIn4V2.CHANNEL_3) {
                    System.out.println("Channel: 3");
                }

                System.out.println("Changed: " + changed);
                System.out.println("Value: " + value);
                System.out.println("");
            }
        });

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

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

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:

BrickletIndustrialDigitalIn4V2 industrialDigitalIn4V2 = new BrickletIndustrialDigitalIn4V2("YOUR_DEVICE_UID", ipcon);

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

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.

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.

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', 'z'] hardwareVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, 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 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.

Konfigurationsfunktionen für Listener¶

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 Listener kann pro Kanal konfiguriert werden.

Die Periode ist die Periode mit der der ValueListener Listener ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener 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 Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Listener 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 Listener-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 AllValueListener Listener ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener 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 Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Listener 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 Listener-Konfiguration zurück, wie mittels setAllValueCallbackConfiguration() gesetzt.

Listener¶

Listener können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit add*Listener() Funktionen eines Geräteobjekts durchgeführt werden.

Der Parameter ist ein Listener Klassen Objekt, z.B.:

device.addExampleListener(new BrickletIndustrialDigitalIn4V2.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

Die verfügbaren Listener Klassen mit den Methoden welche überschrieben werden können werden unterhalb beschrieben. Es ist möglich mehrere Listener hinzuzufügen und auch mit einem korrespondierenden remove*Listener() wieder zu entfernen.

class BrickletIndustrialDigitalIn4V2.ValueListener()¶

Dieser Listener kann mit der Funktion addValueListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeValueListener() wieder entfernt werden.

void value(int channel, boolean changed, boolean value)

Parameter:	channel – Typ: int, Wertebereich: Siehe Konstanten changed – Typ: boolean value – Typ: boolean

Dieser Listener 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 Listener 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

class BrickletIndustrialDigitalIn4V2.AllValueListener()¶

Dieser Listener kann mit der Funktion addAllValueListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeAllValueListener() wieder entfernt werden.

void allValue(boolean[] changed, boolean[] value)

Parameter:	changed – Typ: boolean[], Länge: 4 value – Typ: boolean[], Länge: 4

Dieser Listener 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 Listener geändert hat.

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.

short[] BrickletIndustrialDigitalIn4V2.getAPIVersion()¶

Rückgabeobjekt:	apiVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, 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(byte functionId)¶

Parameter:	functionId – Typ: byte, 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 Listeners 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(byte functionId, boolean responseExpected)¶

Parameter:	functionId – Typ: byte, 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 Listeners (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 Listeners diese Gerätes.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

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

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.EnumerateListener Listener 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.