Java - Analog Out 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletAnalogOut;

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

    // Change XYZ to the UID of your Analog Out 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
        BrickletAnalogOut ao = new BrickletAnalogOut(UID, ipcon); // Create device object

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

        // Set output voltage to 3.3V
        ao.setVoltage(3300);

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

Grundfunktionen¶

class BrickletAnalogOut(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	analogOut – Typ: BrickletAnalogOut

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

BrickletAnalogOut analogOut = new BrickletAnalogOut("YOUR_DEVICE_UID", ipcon);

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

void BrickletAnalogOut.setVoltage(int voltage)¶

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

Setzt die Spannung. Dieser Funktionsaufruf setzt den Modus auf 0 (siehe setMode()).

int BrickletAnalogOut.getVoltage()¶

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

Gibt die Spannung zurück, wie von setVoltage() gesetzt.

void BrickletAnalogOut.setMode(short mode)¶

Parameter:	mode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt den Modus des Analogwertes. Mögliche Modi:

• 0: normaler Modus (Analogwert, wie von setVoltage() gesetzt, wird ausgegeben.)
• 1: 1k Ohm Widerstand gegen Masse
• 2: 100k Ohm Widerstand gegen Masse
• 3: 500k Ohm Widerstand gegen Masse

Setzten des Modus auf 0 resultiert in einer Ausgabespannung von 0 V. Es kann über einen Aufruf von setVoltage() direkt auf eine höhere Ausgabespannung gewechselt werden .

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

Für mode:

• BrickletAnalogOut.MODE_ANALOG_VALUE = 0
• BrickletAnalogOut.MODE_1K_TO_GROUND = 1
• BrickletAnalogOut.MODE_100K_TO_GROUND = 2
• BrickletAnalogOut.MODE_500K_TO_GROUND = 3

short BrickletAnalogOut.getMode()¶

Rückgabe:	mode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt den Modus zurück, wie von setMode() gesetzt.

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

Für mode:

• BrickletAnalogOut.MODE_ANALOG_VALUE = 0
• BrickletAnalogOut.MODE_1K_TO_GROUND = 1
• BrickletAnalogOut.MODE_100K_TO_GROUND = 2
• BrickletAnalogOut.MODE_500K_TO_GROUND = 3

Fortgeschrittene Funktionen¶

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

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

• BrickletAnalogOut.FUNCTION_SET_VOLTAGE = 1
• BrickletAnalogOut.FUNCTION_SET_MODE = 3

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

• BrickletAnalogOut.FUNCTION_SET_VOLTAGE = 1
• BrickletAnalogOut.FUNCTION_SET_MODE = 3

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

Diese Konstante wird verwendet um ein Analog Out 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 BrickletAnalogOut.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Analog Out Bricklet dar.