Java - Industrial Digital In 4 Bricklet¶

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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDigitalIn4;

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
    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
        BrickletIndustrialDigitalIn4 idi4 =
          new BrickletIndustrialDigitalIn4(UID, ipcon); // Create device object

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

        // Get current value as bitmask
        int valueMask = idi4.getValue(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Value Mask: " + Integer.toBinaryString(valueMask));

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

Interrupt¶

Download (ExampleInterrupt.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.BrickletIndustrialDigitalIn4;

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

    // Change XYZ to the UID of your Industrial Digital In 4 Bricklet
    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
        BrickletIndustrialDigitalIn4 idi4 =
          new BrickletIndustrialDigitalIn4(UID, ipcon); // Create device object

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

        // Add interrupt listener
        idi4.addInterruptListener(new BrickletIndustrialDigitalIn4.InterruptListener() {
            public void interrupt(int interruptMask, int valueMask) {
                System.out.println("Interrupt Mask: " + Integer.toBinaryString(interruptMask));
                System.out.println("Value Mask: " + Integer.toBinaryString(valueMask));
                System.out.println("");
            }
        });

        // Enable interrupt on pin 0
        idi4.setInterrupt(1 << 0);

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

Grundfunktionen¶

class BrickletIndustrialDigitalIn4(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	industrialDigitalIn4 – Typ: BrickletIndustrialDigitalIn4

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

BrickletIndustrialDigitalIn4 industrialDigitalIn4 = new BrickletIndustrialDigitalIn4("YOUR_DEVICE_UID", ipcon);

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

int BrickletIndustrialDigitalIn4.getValue()¶

Rückgabe:	valueMask – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Ausgabewerte mit einer Bitmaske zurück. Die Bitmaske ist 16Bit lang. true bedeutet logisch 1 und false logisch 0.

Zum Beispiel: Der Wert 3 bzw. 0b0011 bedeutet, dass die Pins 0-1 auf logisch 1 und alle anderen auf logisch 0 sind.

Falls keine Gruppen verwendet werden (siehe setGroup()), entsprechen die Pins der Beschriftung auf dem Industrial Digital In 4 Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

long BrickletIndustrialDigitalIn4.getEdgeCount(short pin, boolean resetCounter)¶

Parameter:	pin – Typ: short, Wertebereich: [0 bis 3] 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 Pin zurück. Die zu zählenden Flanken können mit setEdgeCountConfig() konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Die Flankenzähler benutzen die Gruppierung, wie von setGroup() gesetzt.

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen¶

void BrickletIndustrialDigitalIn4.setGroup(char[] group)¶

Parameter:	group – Typ: char[], Länge: 4, Wertebereich: ['a' bis 'd', 'n']

Setzt eine Gruppe von Digital In 4 Bricklets die zusammenarbeiten sollen. Mögliche Gruppierungen können mit der Funktion getAvailableForGroup() gefunden werden.

Eine Gruppe besteht aus 4 Element. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Jedes Element kann entweder auf einen der Ports ('a' bis 'd') gesetzt werden oder falls nicht genutzt 'n' gesetzt werden.

Zum Beispiel: Falls zwei Digital In 4 Bricklets mit Port A und Port B verbunden sind, könnte diese Funktion mit ['a', 'b', 'n', 'n'] aufgerufen werden.

In diesem Fall wären die Pins von Port A den Werten 0-3 zugewiesen und die Pins von Port B den Werten 4-7. Es ist jetzt möglich mit der Funktion getValue() beide Bricklets gleichzeitig auszulesen.

Änderungen an der Gruppeneinteilung setzt die Konfiguration und Zählerwerte aller Flankenzähler zurück.

char[] BrickletIndustrialDigitalIn4.getGroup()¶

Rückgabe:	group – Typ: char[], Länge: 4, Wertebereich: ['a' bis 'd', 'n']

Gibt die Gruppierung zurück, wie von setGroup() gesetzt.

short BrickletIndustrialDigitalIn4.getAvailableForGroup()¶

Rückgabe:	available – Typ: short, Wertebereich: [0 bis 15]

Gibt eine Bitmaske von Ports zurück die für die Gruppierung zur Verfügung stehen. Zum Beispiel bedeutet der Wert 5 bzw. 0b0101: Port A und Port C sind mit Bricklets verbunden die zusammen gruppiert werden können.

void BrickletIndustrialDigitalIn4.setEdgeCountConfig(int selectionMask, short edgeType, short debounce)¶

Parameter:	selectionMask – Typ: int, Wertebereich: [0 bis 216 - 1] edgeType – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: short, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Konfiguriert den Flankenzähler für die ausgewählten Pins. Eine Bitmaske von 9 bzw. 0b1001 aktiviert den Flankenzähler für die Pins 0 und 3.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Pins die als Eingang konfiguriert sind. 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 Flankenzähler benutzen die Gruppierung, wie von setGroup() gesetzt.

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

Für edgeType:

• BrickletIndustrialDigitalIn4.EDGE_TYPE_RISING = 0
• BrickletIndustrialDigitalIn4.EDGE_TYPE_FALLING = 1
• BrickletIndustrialDigitalIn4.EDGE_TYPE_BOTH = 2

Neu in Version 2.0.1 (Plugin).

BrickletIndustrialDigitalIn4.EdgeCountConfig BrickletIndustrialDigitalIn4.getEdgeCountConfig(short pin)¶

Parameter:	pin – Typ: short, Wertebereich: [0 bis 255]
Rückgabeobjekt:	edgeType – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: short, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Pin zurück, wie von setEdgeCountConfig() gesetzt.

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

Für edgeType:

• BrickletIndustrialDigitalIn4.EDGE_TYPE_RISING = 0
• BrickletIndustrialDigitalIn4.EDGE_TYPE_FALLING = 1
• BrickletIndustrialDigitalIn4.EDGE_TYPE_BOTH = 2

Neu in Version 2.0.1 (Plugin).

BrickletIndustrialDigitalIn4.Identity BrickletIndustrialDigitalIn4.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 BrickletIndustrialDigitalIn4.setDebouncePeriod(long debounce)¶

Parameter:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Entprellperiode der InterruptListener Listener.

Beispiel: Wenn dieser Wert auf 100 gesetzt wird, erhält man den Interrupt maximal alle 100ms. Dies ist notwendig falls etwas prellendes an das Digital In 4 Bricklet angeschlossen ist, wie z.B. einen Schalter.

long BrickletIndustrialDigitalIn4.getDebouncePeriod()¶

Rückgabe:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

void BrickletIndustrialDigitalIn4.setInterrupt(int interruptMask)¶

Parameter:	interruptMask – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt durch eine Bitmaske die Pins für welche der Interrupt aktiv ist. Interrupts werden ausgelöst bei Änderung des Spannungspegels eines Pins, z.B. ein Wechsel von logisch 1 zu logisch 0 und logisch 0 zu logisch 1.

Beispiel: Eine Interrupt Bitmaske von 9 bzw. 0b1001 aktiviert den Interrupt für die Pins 0 und 3.

Die Interrupts benutzen die Gruppierung, wie von setGroup() gesetzt.

Der Interrupt wird mit dem InterruptListener Listener zugestellt.

int BrickletIndustrialDigitalIn4.getInterrupt()¶

Rückgabe:	interruptMask – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Interrupt Bitmaske zurück, wie von setInterrupt() 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 BrickletIndustrialDigitalIn4.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 BrickletIndustrialDigitalIn4.InterruptListener()¶

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

void interrupt(int interruptMask, int valueMask)

Parameter:	interruptMask – Typ: int, Wertebereich: [0 bis 216 - 1] valueMask – Typ: int, Wertebereich: [0 bis 216 - 1]

Dieser Listener wird ausgelöst sobald eine Änderung des Spannungspegels detektiert wird, an Pins für welche der Interrupt mit setInterrupt() aktiviert wurde.

Die Rückgabewerte sind eine Bitmaske der aufgetretenen Interrupts und der aktuellen Zustände.

Beispiele:

• (1, 1) bzw. (0b0001, 0b0001) bedeutet, dass ein Interrupt am Pin 0 aufgetreten ist und aktuell Pin 0 logisch 1 ist und die Pins 1-3 logisch 0 sind.
• (9, 14) bzw. (0b1001, 0b1110) bedeutet, dass Interrupts an den Pins 0 und 3 aufgetreten sind und aktuell Pin 0 logisch 0 ist und die Pins 1-3 logisch 1 sind.

Die Interrupts benutzen die Gruppierung, wie von setGroup() gesetzt.

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[] BrickletIndustrialDigitalIn4.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 BrickletIndustrialDigitalIn4.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:

• BrickletIndustrialDigitalIn4.FUNCTION_SET_GROUP = 2
• BrickletIndustrialDigitalIn4.FUNCTION_SET_DEBOUNCE_PERIOD = 5
• BrickletIndustrialDigitalIn4.FUNCTION_SET_INTERRUPT = 7
• BrickletIndustrialDigitalIn4.FUNCTION_SET_EDGE_COUNT_CONFIG = 11

void BrickletIndustrialDigitalIn4.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:

• BrickletIndustrialDigitalIn4.FUNCTION_SET_GROUP = 2
• BrickletIndustrialDigitalIn4.FUNCTION_SET_DEBOUNCE_PERIOD = 5
• BrickletIndustrialDigitalIn4.FUNCTION_SET_INTERRUPT = 7
• BrickletIndustrialDigitalIn4.FUNCTION_SET_EDGE_COUNT_CONFIG = 11

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

Konstanten¶

int BrickletIndustrialDigitalIn4.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Digital In 4 Bricklet 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 BrickletIndustrialDigitalIn4.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Industrial Digital In 4 Bricklet dar.