Java - Voltage/Current 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.BrickletVoltageCurrentV2;

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

    // Change XYZ to the UID of your Voltage/Current 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
        BrickletVoltageCurrentV2 vc =
          new BrickletVoltageCurrentV2(UID, ipcon); // Create device object

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

        // Get current voltage
        int voltage = vc.getVoltage(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Voltage: " + voltage/1000.0 + " V");

        // Get current current
        int current = vc.getCurrent(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Current: " + current/1000.0 + " A");

        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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletVoltageCurrentV2;

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

    // Change XYZ to the UID of your Voltage/Current 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
        BrickletVoltageCurrentV2 vc =
          new BrickletVoltageCurrentV2(UID, ipcon); // Create device object

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

        // Add current listener
        vc.addCurrentListener(new BrickletVoltageCurrentV2.CurrentListener() {
            public void current(int current) {
                System.out.println("Current: " + current/1000.0 + " A");
            }
        });

        // Set period for current callback to 1s (1000ms) without a threshold
        vc.setCurrentCallbackConfiguration(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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletVoltageCurrentV2;

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

    // Change XYZ to the UID of your Voltage/Current 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
        BrickletVoltageCurrentV2 vc =
          new BrickletVoltageCurrentV2(UID, ipcon); // Create device object

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

        // Add power listener
        vc.addPowerListener(new BrickletVoltageCurrentV2.PowerListener() {
            public void power(int power) {
                System.out.println("power: " + power/1000.0 + " W");
            }
        });

        // Configure threshold for power "greater than 10 W"
        // with a debounce period of 1s (1000ms)
        vc.setPowerCallbackConfiguration(1000, false, '>', 10*1000, 0);

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

Grundfunktionen¶

class BrickletVoltageCurrentV2(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	voltageCurrentV2 – Typ: BrickletVoltageCurrentV2

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

BrickletVoltageCurrentV2 voltageCurrentV2 = new BrickletVoltageCurrentV2("YOUR_DEVICE_UID", ipcon);

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

int BrickletVoltageCurrentV2.getCurrent()¶

Rückgabe:	current – Typ: int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Gibt die gemessenen Stromstärke zurück.

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

int BrickletVoltageCurrentV2.getVoltage()¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Gibt die gemessenen Spannung zurück.

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

int BrickletVoltageCurrentV2.getPower()¶

Rückgabe:	power – Typ: int, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Gibt die gemessenen Leistung zurück.

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

void BrickletVoltageCurrentV2.setConfiguration(int averaging, int voltageConversionTime, int currentConversionTime)¶

Parameter:	averaging – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3 voltageConversionTime – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4 currentConversionTime – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4

Setzt die Konfiguration des Voltage/Current Bricklet 2.0. Es ist möglich die Anzahl für die Durchschnittsbildung, und die Wandlungszeit für Spannung und Stromstärke zu definieren.

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

Für averaging:

• BrickletVoltageCurrentV2.AVERAGING_1 = 0
• BrickletVoltageCurrentV2.AVERAGING_4 = 1
• BrickletVoltageCurrentV2.AVERAGING_16 = 2
• BrickletVoltageCurrentV2.AVERAGING_64 = 3
• BrickletVoltageCurrentV2.AVERAGING_128 = 4
• BrickletVoltageCurrentV2.AVERAGING_256 = 5
• BrickletVoltageCurrentV2.AVERAGING_512 = 6
• BrickletVoltageCurrentV2.AVERAGING_1024 = 7

Für voltageConversionTime:

• BrickletVoltageCurrentV2.CONVERSION_TIME_140US = 0
• BrickletVoltageCurrentV2.CONVERSION_TIME_204US = 1
• BrickletVoltageCurrentV2.CONVERSION_TIME_332US = 2
• BrickletVoltageCurrentV2.CONVERSION_TIME_588US = 3
• BrickletVoltageCurrentV2.CONVERSION_TIME_1_1MS = 4
• BrickletVoltageCurrentV2.CONVERSION_TIME_2_116MS = 5
• BrickletVoltageCurrentV2.CONVERSION_TIME_4_156MS = 6
• BrickletVoltageCurrentV2.CONVERSION_TIME_8_244MS = 7

Für currentConversionTime:

• BrickletVoltageCurrentV2.CONVERSION_TIME_140US = 0
• BrickletVoltageCurrentV2.CONVERSION_TIME_204US = 1
• BrickletVoltageCurrentV2.CONVERSION_TIME_332US = 2
• BrickletVoltageCurrentV2.CONVERSION_TIME_588US = 3
• BrickletVoltageCurrentV2.CONVERSION_TIME_1_1MS = 4
• BrickletVoltageCurrentV2.CONVERSION_TIME_2_116MS = 5
• BrickletVoltageCurrentV2.CONVERSION_TIME_4_156MS = 6
• BrickletVoltageCurrentV2.CONVERSION_TIME_8_244MS = 7

BrickletVoltageCurrentV2.Configuration BrickletVoltageCurrentV2.getConfiguration()¶

Rückgabeobjekt:	averaging – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3 voltageConversionTime – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4 currentConversionTime – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4

Gibt die Konfiguration zurück, wie von setConfiguration() gesetzt.

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

Für averaging:

• BrickletVoltageCurrentV2.AVERAGING_1 = 0
• BrickletVoltageCurrentV2.AVERAGING_4 = 1
• BrickletVoltageCurrentV2.AVERAGING_16 = 2
• BrickletVoltageCurrentV2.AVERAGING_64 = 3
• BrickletVoltageCurrentV2.AVERAGING_128 = 4
• BrickletVoltageCurrentV2.AVERAGING_256 = 5
• BrickletVoltageCurrentV2.AVERAGING_512 = 6
• BrickletVoltageCurrentV2.AVERAGING_1024 = 7

Für voltageConversionTime:

• BrickletVoltageCurrentV2.CONVERSION_TIME_140US = 0
• BrickletVoltageCurrentV2.CONVERSION_TIME_204US = 1
• BrickletVoltageCurrentV2.CONVERSION_TIME_332US = 2
• BrickletVoltageCurrentV2.CONVERSION_TIME_588US = 3
• BrickletVoltageCurrentV2.CONVERSION_TIME_1_1MS = 4
• BrickletVoltageCurrentV2.CONVERSION_TIME_2_116MS = 5
• BrickletVoltageCurrentV2.CONVERSION_TIME_4_156MS = 6
• BrickletVoltageCurrentV2.CONVERSION_TIME_8_244MS = 7

Für currentConversionTime:

• BrickletVoltageCurrentV2.CONVERSION_TIME_140US = 0
• BrickletVoltageCurrentV2.CONVERSION_TIME_204US = 1
• BrickletVoltageCurrentV2.CONVERSION_TIME_332US = 2
• BrickletVoltageCurrentV2.CONVERSION_TIME_588US = 3
• BrickletVoltageCurrentV2.CONVERSION_TIME_1_1MS = 4
• BrickletVoltageCurrentV2.CONVERSION_TIME_2_116MS = 5
• BrickletVoltageCurrentV2.CONVERSION_TIME_4_156MS = 6
• BrickletVoltageCurrentV2.CONVERSION_TIME_8_244MS = 7

Fortgeschrittene Funktionen¶

void BrickletVoltageCurrentV2.setCalibration(int voltageMultiplier, int voltageDivisor, int currentMultiplier, int currentDivisor)¶

Parameter:	voltageMultiplier – Typ: int, Wertebereich: [0 bis 216 - 1] voltageDivisor – Typ: int, Wertebereich: [0 bis 216 - 1] currentMultiplier – Typ: int, Wertebereich: [0 bis 216 - 1] currentDivisor – Typ: int, Wertebereich: [0 bis 216 - 1]

Da der ADC und der Shunt-Widerstand für die Messungen verwendet werden nicht perfekt sind, ist es nötig einen Multiplikator und einen Divisor zu setzen falls sehr genaue Messwerte nötig sind.

Zum Beispiel: Wenn eine Messung von 1000mA erwartet wird, das Voltage/Current Bricklet 2.0 aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden. Das gleiches gilt für die Spannung.

Die Kalibrierung wird in den EEPROM des Voltage/Current Bricklet gespeichert und muss nur einmal gesetzt werden.

BrickletVoltageCurrentV2.Calibration BrickletVoltageCurrentV2.getCalibration()¶

Rückgabeobjekt:	voltageMultiplier – Typ: int, Wertebereich: [0 bis 216 - 1] voltageDivisor – Typ: int, Wertebereich: [0 bis 216 - 1] currentMultiplier – Typ: int, Wertebereich: [0 bis 216 - 1] currentDivisor – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

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

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

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

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

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

Parameter:	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 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der CurrentListener 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 CurrentListener 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:

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

BrickletVoltageCurrentV2.CurrentCallbackConfiguration BrickletVoltageCurrentV2.getCurrentCallbackConfiguration()¶

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 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

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

void BrickletVoltageCurrentV2.setVoltageCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

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

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

BrickletVoltageCurrentV2.VoltageCallbackConfiguration BrickletVoltageCurrentV2.getVoltageCallbackConfiguration()¶

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:

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

void BrickletVoltageCurrentV2.setPowerCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameter:	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 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der PowerListener 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 PowerListener 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:

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

BrickletVoltageCurrentV2.PowerCallbackConfiguration BrickletVoltageCurrentV2.getPowerCallbackConfiguration()¶

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 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

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

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 BrickletVoltageCurrentV2.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 BrickletVoltageCurrentV2.CurrentListener()¶

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

void current(int current)

Parameter:	current – Typ: int, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

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

Der Parameter ist der gleiche wie getCurrent().

class BrickletVoltageCurrentV2.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 voltage)

Parameter:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 36000]

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

Der Parameter ist der gleiche wie getVoltage().

class BrickletVoltageCurrentV2.PowerListener()¶

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

void power(int power)

Parameter:	power – Typ: int, Einheit: 1 mW, Wertebereich: [0 bis 720000]

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

Der Parameter ist der gleiche wie getPower().

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

• BrickletVoltageCurrentV2.FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
• BrickletVoltageCurrentV2.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 6
• BrickletVoltageCurrentV2.FUNCTION_SET_POWER_CALLBACK_CONFIGURATION = 10
• BrickletVoltageCurrentV2.FUNCTION_SET_CONFIGURATION = 13
• BrickletVoltageCurrentV2.FUNCTION_SET_CALIBRATION = 15
• BrickletVoltageCurrentV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletVoltageCurrentV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletVoltageCurrentV2.FUNCTION_RESET = 243
• BrickletVoltageCurrentV2.FUNCTION_WRITE_UID = 248

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

• BrickletVoltageCurrentV2.FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
• BrickletVoltageCurrentV2.FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION = 6
• BrickletVoltageCurrentV2.FUNCTION_SET_POWER_CALLBACK_CONFIGURATION = 10
• BrickletVoltageCurrentV2.FUNCTION_SET_CONFIGURATION = 13
• BrickletVoltageCurrentV2.FUNCTION_SET_CALIBRATION = 15
• BrickletVoltageCurrentV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletVoltageCurrentV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletVoltageCurrentV2.FUNCTION_RESET = 243
• BrickletVoltageCurrentV2.FUNCTION_WRITE_UID = 248

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

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

Für status:

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

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

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

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

Diese Konstante wird verwendet um ein Voltage/Current 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 BrickletVoltageCurrentV2.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet 2.0 dar.