Java - Hall Effect Bricklet¶

Simple¶

Download (ExampleSimple.java)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletHallEffect;

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

    // Change XYZ to the UID of your Hall Effect 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
        BrickletHallEffect he = new BrickletHallEffect(UID, ipcon); // Create device object

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

        // Get current edge count without reset
        long count = he.getEdgeCount(false); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Count: " + count);

        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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletHallEffect;

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

    // Change XYZ to the UID of your Hall Effect 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
        BrickletHallEffect he = new BrickletHallEffect(UID, ipcon); // Create device object

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

        // Add edge count listener
        he.addEdgeCountListener(new BrickletHallEffect.EdgeCountListener() {
            public void edgeCount(long count, boolean value) {
                System.out.println("Count: " + count);
            }
        });

        // Set period for edge count callback to 0.05s (50ms)
        // Note: The edge count callback is only called every 0.05 seconds
        //       if the edge count has changed since the last call!
        he.setEdgeCountCallbackPeriod(50);

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

Grundfunktionen¶

class BrickletHallEffect(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	hallEffect – Typ: BrickletHallEffect

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

BrickletHallEffect hallEffect = new BrickletHallEffect("YOUR_DEVICE_UID", ipcon);

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

boolean BrickletHallEffect.getValue()¶

Rückgabe:	value – Typ: boolean

Gibt true zurück wenn ein Magnetfeld mit 3,5 Millitesla oder größer detektiert wird.

long BrickletHallEffect.getEdgeCount(boolean resetCounter)¶

Parameter:	resetCounter – Typ: boolean
Rückgabe:	count – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers zurück. Die zu zählenden Flanken (steigend, fallend, beide) können mit setEdgeCountConfig() konfiguriert werden.

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

Fortgeschrittene Funktionen¶

void BrickletHallEffect.setEdgeCountConfig(short edgeType, short debounce)¶

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

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

• 0 = steigend
• 1 = fallend
• 2 = beide

Wird ein Magnet in die Nähe des Bricklets gebracht (>3,5 Millitesla) erzeugt dies ein low-Signal (fallende Flanke), wenn ein Magnet vom Bricklet entfernt (<2,5 Millitesla) wird entsteht ein high-Signal (steigende Flanke).

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

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

Für edgeType:

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

BrickletHallEffect.EdgeCountConfig BrickletHallEffect.getEdgeCountConfig()¶

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

Gibt den Flankentyp sowie die Entprellzeit zurück, wie von setEdgeCountConfig() gesetzt.

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

Für edgeType:

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

BrickletHallEffect.Identity BrickletHallEffect.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 BrickletHallEffect.setEdgeInterrupt(long edges)¶

Parameter:	edges – Typ: long, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Anzahl der zu zählenden Flanken bis ein Interrupt aufgerufen wird.

Wenn edges auf n gesetzt ist, wird der Interrupt nach jeder n-ten detektierten Flanke aufgerufen.

Wenn edges auf 0 gesetzt ist, wird der Interrupt deaktiviert.

long BrickletHallEffect.getEdgeInterrupt()¶

Rückgabe:	edges – Typ: long, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt edges zurück, wie von setEdgeInterrupt() gesetzt.

void BrickletHallEffect.setEdgeCountCallbackPeriod(long period)¶

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

Setzt die Periode mit welcher der EdgeCountListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

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

long BrickletHallEffect.getEdgeCountCallbackPeriod()¶

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

Gibt die Periode zurück, wie von setEdgeCountCallbackPeriod() 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 BrickletHallEffect.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 BrickletHallEffect.EdgeCountListener()¶

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

void edgeCount(long count, boolean value)

Parameter:	count – Typ: long, Wertebereich: [0 bis 232 - 1] value – Typ: boolean

Dieser Listener wird mit der Periode, wie gesetzt mit setEdgeCountCallbackPeriod(), ausgelöst. Die Parameter sind der aktuelle Zählerstand und der aktuelle Wert (siehe getValue() and getEdgeCount()).

Der EdgeCountListener Listener wird nur ausgelöst, wenn sich mindestens einer der beiden Werte seit der letzten Auslösung geändert hat.

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

• BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CONFIG = 3
• BrickletHallEffect.FUNCTION_SET_EDGE_INTERRUPT = 5
• BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7

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

• BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CONFIG = 3
• BrickletHallEffect.FUNCTION_SET_EDGE_INTERRUPT = 5
• BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7

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

Diese Konstante wird verwendet um ein Hall Effect 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 BrickletHallEffect.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Hall Effect Bricklet dar.