Java - Industrial Dual Analog In Bricklet

Dies ist die Beschreibung der Java API Bindings für das Industrial Dual Analog In Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual Analog In Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Java API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDualAnalogIn;

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

    // Change XYZ to the UID of your Industrial Dual Analog In 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
        BrickletIndustrialDualAnalogIn idai =
          new BrickletIndustrialDualAnalogIn(UID, ipcon); // Create device object

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

        // Get current voltage from channel 1
        int voltage = idai.getVoltage((short)1); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Voltage (Channel 1): " + voltage/1000.0 + " V");

        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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDualAnalogIn;

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

    // Change XYZ to the UID of your Industrial Dual Analog In 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
        BrickletIndustrialDualAnalogIn idai =
          new BrickletIndustrialDualAnalogIn(UID, ipcon); // Create device object

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

        // Add voltage listener
        idai.addVoltageListener(new BrickletIndustrialDualAnalogIn.VoltageListener() {
            public void voltage(short channel, int voltage) {
                System.out.println("Channel: " + channel);
                System.out.println("Voltage: " + voltage/1000.0 + " V");
                System.out.println("");
            }
        });

        // Set period for voltage (channel 1) callback to 1s (1000ms)
        // Note: The voltage (channel 1) callback is only called every second
        //       if the voltage (channel 1) has changed since the last call!
        idai.setVoltageCallbackPeriod((short)1, 1000);

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

Threshold

Download (ExampleThreshold.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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDualAnalogIn;

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

    // Change XYZ to the UID of your Industrial Dual Analog In 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
        BrickletIndustrialDualAnalogIn idai =
          new BrickletIndustrialDualAnalogIn(UID, ipcon); // Create device object

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

        // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        idai.setDebouncePeriod(10000);

        // Add voltage reached listener
        idai.addVoltageReachedListener(new BrickletIndustrialDualAnalogIn.VoltageReachedListener() {
            public void voltageReached(short channel, int voltage) {
                System.out.println("Channel: " + channel);
                System.out.println("Voltage: " + voltage/1000.0 + " V");
                System.out.println("");
            }
        });

        // Configure threshold for voltage (channel 1) "greater than 10 V"
        idai.setVoltageCallbackThreshold((short)1, '>', 10*1000, 0);

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

API

Prinzipiell kann jede Methode der Java 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 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.

Das Bricklet hat zwei Eingangskanäle. Funktionen die sich direkt auf einen der Kanäle beziehen haben einen channel Parameter, um den Kanal anzugeben. Gültige Werte für das channel Parameter sind 0 und 1.

Grundfunktionen

public class BrickletIndustrialDualAnalogIn(String uid, IPConnection ipcon)

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

BrickletIndustrialDualAnalogIn industrialDualAnalogIn = new BrickletIndustrialDualAnalogIn("YOUR_DEVICE_UID", ipcon);

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

public int getVoltage(short channel)

Gibt die Spannung für den übergebenen Kanal in mV zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den VoltageListener Listener zu nutzen und die Periode mit setVoltageCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

public void setSampleRate(short rate)

Setzt die Abtastrate. Der Wertebereich der verfügbare Abtastraten liegt zwischen 1 Wert pro Sekunde und 976 Werte pro Sekunde. Ein Verringern der Abtastrate wird auch das Rauschen auf den Daten verringern.

Der Standardwert ist 6 (2 Werte pro Sekunde).

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

  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_976_SPS = 0
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_488_SPS = 1
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_244_SPS = 2
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_122_SPS = 3
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_61_SPS = 4
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_4_SPS = 5
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_2_SPS = 6
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_1_SPS = 7
public short getSampleRate()

Gibt die Abtastrate zurück, wie von setSampleRate() gesetzt.

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

  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_976_SPS = 0
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_488_SPS = 1
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_244_SPS = 2
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_122_SPS = 3
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_61_SPS = 4
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_4_SPS = 5
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_2_SPS = 6
  • BrickletIndustrialDualAnalogIn.SAMPLE_RATE_1_SPS = 7
public void setCalibration(int[] offset, int[] gain)

Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.

Siehe MCP3911 Datenblatt 7.7 und 7.8. Das Industrial Dual Analog In Bricklet wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.

public BrickletIndustrialDualAnalogIn.Calibration getCalibration()

Gibt die Kalibrierung zurück, wie von setCalibration() gesetzt.

Das zurückgegebene Objekt enthält die Public-Member-Variablen int[] offset und int[] gain.

public int[] getADCValues()

Gibt die ADC-Werte des MCP3911 ICs zurück. Diese Funktion wird für die Kalibrierung benötigt, siehe setCalibration().

public short[] getAPIVersion()

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.

public boolean getResponseExpected(short functionId)

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.

Siehe setResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

public void setResponseExpected(short functionId, boolean responseExpected)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_SAMPLE_RATE = 8
  • BrickletIndustrialDualAnalogIn.FUNCTION_SET_CALIBRATION = 10
public void setResponseExpectedAll(boolean responseExpected)

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

public BrickletIndustrialDualAnalogIn.Identity getIdentity()

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.

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, short[] hardwareVersion, short[] firmwareVersion und int deviceIdentifier.

Konfigurationsfunktionen für Listener

public void setVoltageCallbackPeriod(short channel, long period)

Setzt die Periode in ms mit welcher der VoltageListener Listener für den übergebenen Kanal ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

Der VoltageListener Listener wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

public long getVoltageCallbackPeriod(short channel)

Gibt die Periode zurück, wie von setVoltageCallbackPeriod() gesetzt.

public void setVoltageCallbackThreshold(short channel, char option, int min, int max)

Setzt den Schwellwert des VoltageReachedListener Listeners für den übergebenen Kanal.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Listener ist inaktiv
'o' Listener wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist
'i' Listener wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist
'<' Listener wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert)
'>' Listener wird ausgelöst, wenn die Spannung größer als der min Wert ist (max wird ignoriert)

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

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

  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_GREATER = '>'
public BrickletIndustrialDualAnalogIn.VoltageCallbackThreshold getVoltageCallbackThreshold(short channel)

Gibt den Schwellwert zurück, wie von setVoltageCallbackThreshold() gesetzt.

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

  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_OFF = 'x'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletIndustrialDualAnalogIn.THRESHOLD_OPTION_GREATER = '>'

Das zurückgegebene Objekt enthält die Public-Member-Variablen char option, int min und int max.

public void setDebouncePeriod(long debounce)

Setzt die Periode in ms mit welcher der Schwellwert Listener

  • VoltageReachedListener

ausgelöst werden, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

public long getDebouncePeriod()

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() 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 BrickletIndustrialDualAnalogIn.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.

Bemerkung

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

public class BrickletIndustrialDualAnalogIn.VoltageListener()

Dieser Listener kann mit der Funktion addVoltageListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeVoltageListener() wieder entfernt werden.

public void voltage(short channel, int voltage)

Dieser Listener wird mit der Periode, wie gesetzt mit setVoltageCallbackPeriod(), ausgelöst. Der Parameter ist die Spannung des Kanals.

Der VoltageListener Listener wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

public class BrickletIndustrialDualAnalogIn.VoltageReachedListener()

Dieser Listener kann mit der Funktion addVoltageReachedListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeVoltageReachedListener() wieder entfernt werden.

public void voltageReached(short channel, int voltage)

Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von setVoltageCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Spannung des Kanals.

Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

Konstanten

public static final int BrickletIndustrialDualAnalogIn.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Dual Analog In 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.

public static final String BrickletIndustrialDualAnalogIn.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Dual Analog In Bricklet dar.