Java - Industrial Dual Analog In 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDualAnalogInV2;

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 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
        BrickletIndustrialDualAnalogInV2 idai =
          new BrickletIndustrialDualAnalogInV2(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 0
        int voltage = idai.getVoltage(0); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Voltage (Channel 0): " + 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDualAnalogInV2;

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 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
        BrickletIndustrialDualAnalogInV2 idai =
          new BrickletIndustrialDualAnalogInV2(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 BrickletIndustrialDualAnalogInV2.VoltageListener() {
            public void voltage(int channel, int voltage) {
                System.out.println("Channel: " + channel);
                System.out.println("Voltage: " + voltage/1000.0 + " V");
                System.out.println("");
            }
        });

        // Set period for voltage (channel 0) callback to 1s (1000ms) without a threshold
        idai.setVoltageCallbackConfiguration(0, 1000, false, 'x', 0, 0);

        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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletIndustrialDualAnalogInV2;

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 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
        BrickletIndustrialDualAnalogInV2 idai =
          new BrickletIndustrialDualAnalogInV2(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 BrickletIndustrialDualAnalogInV2.VoltageListener() {
            public void voltage(int channel, int voltage) {
                System.out.println("Channel: " + channel);
                System.out.println("Voltage: " + voltage/1000.0 + " V");
                System.out.println("");
            }
        });

        // Configure threshold for voltage (channel 0) "greater than 10 V"
        // with a debounce period of 10s (10000ms)
        idai.setVoltageCallbackConfiguration(0, 10000, false, '>', 10*1000, 0);

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

Grundfunktionen¶

class BrickletIndustrialDualAnalogInV2(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	industrialDualAnalogInV2 – Typ: BrickletIndustrialDualAnalogInV2

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

BrickletIndustrialDualAnalogInV2 industrialDualAnalogInV2 = new BrickletIndustrialDualAnalogInV2("YOUR_DEVICE_UID", ipcon);

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

int BrickletIndustrialDualAnalogInV2.getVoltage(int channel)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

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

Wenn der Wert periodisch benötigt wird, kann auch der VoltageListener Listener verwendet werden. Der Listener wird mit der Funktion setVoltageCallbackConfiguration() konfiguriert.

void BrickletIndustrialDualAnalogInV2.setChannelLEDConfig(int channel, int config)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] 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 kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des gemessenen Wertes skaliert werden.

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

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

Für config:

• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_OFF = 0
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_ON = 1
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

int BrickletIndustrialDualAnalogInV2.getChannelLEDConfig(int channel)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
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 config:

• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_OFF = 0
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_ON = 1
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

void BrickletIndustrialDualAnalogInV2.setChannelLEDStatusConfig(int channel, int min, int max, int config)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] min – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 10000 config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

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

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in mV gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 10V wird die LED eingeschaltet sobald die gemessene Spannung über 10V steigt und wieder ausgeschaltet sobald der Strom unter 10V fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in mV gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 10mA wird die LED eingeschaltet sobald die gemessene Spannung unter 10V fällt und wieder ausgeschaltet sobald der Strom über 10V steigt.

Im Intensitätsmodus kann ein Bereich in mV angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=4V und max=20V: Die LED ist bei 4V und darunter aus, bei 20V und darüber an und zwischen 4V und 20V wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

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

Für config:

• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

BrickletIndustrialDualAnalogInV2.ChannelLEDStatusConfig BrickletIndustrialDualAnalogInV2.getChannelLEDStatusConfig(int channel)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabeobjekt:	min – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 10000 config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

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

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

Für config:

• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
• BrickletIndustrialDualAnalogInV2.CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen¶

void BrickletIndustrialDualAnalogInV2.setSampleRate(int rate)¶

Parameter:	rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 6

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.

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

Für rate:

• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_976_SPS = 0
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_488_SPS = 1
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_244_SPS = 2
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_122_SPS = 3
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_61_SPS = 4
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_4_SPS = 5
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_2_SPS = 6
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_1_SPS = 7

int BrickletIndustrialDualAnalogInV2.getSampleRate()¶

Rückgabe:	rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 6

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

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

Für rate:

• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_976_SPS = 0
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_488_SPS = 1
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_244_SPS = 2
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_122_SPS = 3
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_61_SPS = 4
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_4_SPS = 5
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_2_SPS = 6
• BrickletIndustrialDualAnalogInV2.SAMPLE_RATE_1_SPS = 7

void BrickletIndustrialDualAnalogInV2.setCalibration(int[] offset, int[] gain)¶

Parameter:	offset – Typ: int[], Länge: 2, Wertebereich: [-223 bis 223 - 1] gain – Typ: int[], Länge: 2, Wertebereich: [-223 bis 223 - 1]

Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.

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

BrickletIndustrialDualAnalogInV2.Calibration BrickletIndustrialDualAnalogInV2.getCalibration()¶

Rückgabeobjekt:	offset – Typ: int[], Länge: 2, Wertebereich: [-223 bis 223 - 1] gain – Typ: int[], Länge: 2, Wertebereich: [-223 bis 223 - 1]

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

int[] BrickletIndustrialDualAnalogInV2.getADCValues()¶

Rückgabe:	value – Typ: int[], Länge: 2, Wertebereich: [-223 bis 223 - 1]

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

int[] BrickletIndustrialDualAnalogInV2.getAllVoltages()¶

Rückgabe:	voltages – Typ: int[], Länge: 2, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

Gibt die Spannung aller Kanäle zurück.

Wenn der Wert periodisch benötigt wird, kann auch der AllVoltagesListener Listener verwendet werden. Der Listener wird mit der Funktion setAllVoltagesCallbackConfiguration() konfiguriert.

Neu in Version 2.0.6 (Plugin).

BrickletIndustrialDualAnalogInV2.SPITFPErrorCount BrickletIndustrialDualAnalogInV2.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 BrickletIndustrialDualAnalogInV2.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:

• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_OFF = 0
• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_ON = 1
• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletIndustrialDualAnalogInV2.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:

• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_OFF = 0
• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_ON = 1
• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDualAnalogInV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

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

BrickletIndustrialDualAnalogInV2.Identity BrickletIndustrialDualAnalogInV2.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 BrickletIndustrialDualAnalogInV2.setVoltageCallbackConfiguration(int channel, long period, boolean valueHasToChange, char option, int min, int max)¶

Parameter:

channel – Typ: int, Wertebereich: [0 bis 1] period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

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

Die folgenden Optionen sind möglich:

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

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

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

Für option:

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

BrickletIndustrialDualAnalogInV2.VoltageCallbackConfiguration BrickletIndustrialDualAnalogInV2.getVoltageCallbackConfiguration(int channel)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabeobjekt:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Listener-Konfiguration zurück, wie mittels setVoltageCallbackConfiguration() gesetzt.

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

Für option:

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

void BrickletIndustrialDualAnalogInV2.setAllVoltagesCallbackConfiguration(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 AllVoltagesListener 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Listener sofort ausgelöst, wenn ein 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 der Werte.

Neu in Version 2.0.6 (Plugin).

BrickletIndustrialDualAnalogInV2.AllVoltagesCallbackConfiguration BrickletIndustrialDualAnalogInV2.getAllVoltagesCallbackConfiguration()¶

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 setAllVoltagesCallbackConfiguration() gesetzt.

Neu in Version 2.0.6 (Plugin).

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 BrickletIndustrialDualAnalogInV2.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 BrickletIndustrialDualAnalogInV2.VoltageListener()¶

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

void voltage(int channel, int voltage)

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] voltage – Typ: int, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

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

Der Parameter ist der gleiche wie getVoltage().

class BrickletIndustrialDualAnalogInV2.AllVoltagesListener()¶

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

void allVoltages(int[] voltages)

Parameter:	voltages – Typ: int[], Länge: 2, Einheit: 1 mV, Wertebereich: [-35000 bis 35000]

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

Die Parameter sind der gleiche wie getAllVoltages().

Neu in Version 2.0.6 (Plugin).

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

• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_SAMPLE_RATE = 5
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CALIBRATION = 7
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CHANNEL_LED_CONFIG = 10
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION = 15
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialDualAnalogInV2.FUNCTION_RESET = 243
• BrickletIndustrialDualAnalogInV2.FUNCTION_WRITE_UID = 248

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

• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 2
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_SAMPLE_RATE = 5
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CALIBRATION = 7
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CHANNEL_LED_CONFIG = 10
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 12
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION = 15
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialDualAnalogInV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialDualAnalogInV2.FUNCTION_RESET = 243
• BrickletIndustrialDualAnalogInV2.FUNCTION_WRITE_UID = 248

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

• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_OK = 0
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletIndustrialDualAnalogInV2.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:

• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletIndustrialDualAnalogInV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletIndustrialDualAnalogInV2.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 BrickletIndustrialDualAnalogInV2.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 BrickletIndustrialDualAnalogInV2.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 BrickletIndustrialDualAnalogInV2.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 BrickletIndustrialDualAnalogInV2.DEVICE_IDENTIFIER¶

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

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