Java - Motion Detector Bricklet 2.0

Dies ist die Beschreibung der Java API Bindings für das Motion Detector Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Motion Detector Bricklet 2.0 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).

Indicator

Download (ExampleIndicator.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.BrickletMotionDetectorV2;

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

    // Change XYZ to the UID of your Motion Detector 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
        BrickletMotionDetectorV2 md =
          new BrickletMotionDetectorV2(UID, ipcon); // Create device object

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

        // Turn blue backlight LEDs on (maximum brightness)
        md.setIndicator(255, 255, 255);

        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.BrickletMotionDetectorV2;

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

    // Change XYZ to the UID of your Motion Detector 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
        BrickletMotionDetectorV2 md =
          new BrickletMotionDetectorV2(UID, ipcon); // Create device object

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

        // Add motion detected listener
        md.addMotionDetectedListener(new BrickletMotionDetectorV2.MotionDetectedListener() {
            public void motionDetected() {
                System.out.println("Motion Detected");
            }
        });

        // Add detection cycle ended listener
        md.addDetectionCycleEndedListener(new BrickletMotionDetectorV2.DetectionCycleEndedListener() {
            public void detectionCycleEnded() {
                System.out.println("Detection Cycle Ended (next detection possible in ~2 seconds)");
            }
        });

        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.

Grundfunktionen

public class BrickletMotionDetectorV2(String uid, IPConnection ipcon)

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

BrickletMotionDetectorV2 motionDetectorV2 = new BrickletMotionDetectorV2("YOUR_DEVICE_UID", ipcon);

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

public int getMotionDetected()

Gibt 1 zurück wenn eine Bewegung detektiert wurde. 1 wird für ca. 1,8 Sekunden zurückgegeben bevor der Sensor wieder erneut eine Bewegung detektieren kann.

Auf dem Bricklet selbst ist eine blaue LED, die leuchtet solange das Bricklet im "Bewegung detektiert" Zustand ist.

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

  • BrickletMotionDetectorV2.MOTION_NOT_DETECTED = 0
  • BrickletMotionDetectorV2.MOTION_DETECTED = 1
public void setSensitivity(int sensitivity)

Setzt die Empfindlichkeit des PIR Sensors. Der Wertebereich ist 0-100. Bei maximaler Empfindlichkeit (100) kann das Bricklet Bewegung bin in ca. 12m Entfernung erkennen.

Die wirkliche Entfernung hängt von vielen Dingen in der Umgebung ab (z.B. Ruflektionen) und der Größe des zu erkennenden Objekts. Während eine große Person bei 10m erkannt werden kann, wird eine Katze vielleicht erst an 2m erkannt mit den gleichen Einstellungen.

Daher muss die passenden Empfindlichkeit je nach Anwendung experimentell bestimmt werden

Der Standardwert ist 50.

public int getSensitivity()

Gibt die Empfindlichkeit zurück, wie von setSensitivity() gesetzt.

public void setIndicator(int topLeft, int topRight, int bottom)

Stellt die blaue Beleuchtung der Fresnel-Linse ein. Die Beleuchtung besteht aus drei LEDs. Die Helligkeit jeder LED kann einzeln mit einem 8-Bit Wert (0-255) eingestellt werden. Ein Wert von 0 deaktiviert die LED und ein Wert von 255 aktiviert die LED mit voller Helligkeit.

Der Standardwert ist 0, 0, 0.

public BrickletMotionDetectorV2.Indicator getIndicator()

Gibt die Indikatorkonfiguration zurück, wie von setIndicator() gesetzt.

Das zurückgegebene Objekt enthält die Public-Member-Variablen int topLeft, int topRight und int bottom.

Fortgeschrittene Funktionen

public int[] 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(int 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(int 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:

  • BrickletMotionDetectorV2.FUNCTION_SET_SENSITIVITY = 2
  • BrickletMotionDetectorV2.FUNCTION_SET_INDICATOR = 4
  • BrickletMotionDetectorV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletMotionDetectorV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletMotionDetectorV2.FUNCTION_RESET = 243
  • BrickletMotionDetectorV2.FUNCTION_WRITE_UID = 248
public void setResponseExpectedAll(boolean responseExpected)

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

public BrickletMotionDetectorV2.SPITFPErrorCount getSPITFPErrorCount()

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.

Das zurückgegebene Objekt enthält die Public-Member-Variablen long errorCountAckChecksum, long errorCountMessageChecksum, long errorCountFrame und long errorCountOverflow.

public int setBootloaderMode(int mode)

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

  • BrickletMotionDetectorV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletMotionDetectorV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletMotionDetectorV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletMotionDetectorV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletMotionDetectorV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletMotionDetectorV2.BOOTLOADER_STATUS_OK = 0
  • BrickletMotionDetectorV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletMotionDetectorV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletMotionDetectorV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletMotionDetectorV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletMotionDetectorV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
public int getBootloaderMode()

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

  • BrickletMotionDetectorV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletMotionDetectorV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletMotionDetectorV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletMotionDetectorV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletMotionDetectorV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
public void setWriteFirmwarePointer(long pointer)

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.

public int writeFirmware(int[] data)

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.

public void setStatusLEDConfig(int config)

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:

  • BrickletMotionDetectorV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletMotionDetectorV2.STATUS_LED_CONFIG_ON = 1
  • BrickletMotionDetectorV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletMotionDetectorV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
public int getStatusLEDConfig()

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

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

  • BrickletMotionDetectorV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletMotionDetectorV2.STATUS_LED_CONFIG_ON = 1
  • BrickletMotionDetectorV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletMotionDetectorV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
public int getChipTemperature()

Gibt die Temperatur in °C, 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.

public void 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.

public void writeUID(long uid)

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.

public long readUID()

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

public BrickletMotionDetectorV2.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, int[] hardwareVersion, int[] firmwareVersion und int deviceIdentifier.

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 BrickletMotionDetectorV2.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 BrickletMotionDetectorV2.MotionDetectedListener()

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

public void motionDetected()

Dieser Listener wird aufgerufen nachdem eine Bewegung detektiert wurde.

public class BrickletMotionDetectorV2.DetectionCycleEndedListener()

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

public void detectionCycleEnded()

Dieser Listener wird aufgerufen wenn ein Bewegungserkennungszyklus beendet ist. Wenn dieser Listener aufgerufen wurde kann wieder eine weitere Bewegung erkannt werden nach ungefähr 2 Sekunden.

Konstanten

public static final int BrickletMotionDetectorV2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Motion Detector 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.

public static final String BrickletMotionDetectorV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Motion Detector Bricklet 2.0 dar.