Java - Sound Intensity Bricklet

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

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

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

    // Change XYZ to the UID of your Sound Intensity 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
        BrickletSoundIntensity si = new BrickletSoundIntensity(UID, ipcon); // Create device object

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

        // Get current intensity
        int intensity = si.getIntensity(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Intensity: " + intensity);

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

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

    // Change XYZ to the UID of your Sound Intensity 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
        BrickletSoundIntensity si = new BrickletSoundIntensity(UID, ipcon); // Create device object

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

        // Add intensity listener
        si.addIntensityListener(new BrickletSoundIntensity.IntensityListener() {
            public void intensity(int intensity) {
                System.out.println("Intensity: " + intensity);
            }
        });

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

        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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletSoundIntensity;

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

    // Change XYZ to the UID of your Sound Intensity 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
        BrickletSoundIntensity si = new BrickletSoundIntensity(UID, ipcon); // Create device object

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

        // Get threshold callbacks with a debounce time of 1 second (1000ms)
        si.setDebouncePeriod(1000);

        // Add intensity reached listener
        si.addIntensityReachedListener(new BrickletSoundIntensity.IntensityReachedListener() {
            public void intensityReached(int intensity) {
                System.out.println("Intensity: " + intensity);
            }
        });

        // Configure threshold for intensity "greater than 2000"
        si.setIntensityCallbackThreshold('>', 2000, 0);

        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

class BrickletSoundIntensity(String uid, IPConnection ipcon)

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

BrickletSoundIntensity soundIntensity = new BrickletSoundIntensity("YOUR_DEVICE_UID", ipcon);

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

int BrickletSoundIntensity.getIntensity()

Gibt die aktuelle Schallintensität zurück. Der Wertebereich ist von 0 bis 4095.

Der Wert entspricht der Hüllkurve des Signals der Mikrophonkapsel.

Wenn die Schallintensität periodisch abgefragt werden soll, wird empfohlen den IntensityListener Listener zu nutzen und die Periode mit setIntensityCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

short[] BrickletSoundIntensity.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.

boolean BrickletSoundIntensity.getResponseExpected(short 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.

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

  • BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_PERIOD = 2
  • BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD = 4
  • BrickletSoundIntensity.FUNCTION_SET_DEBOUNCE_PERIOD = 6
void BrickletSoundIntensity.setResponseExpected(short 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 Konstanten sind für diese Funktion verfügbar:

  • BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_PERIOD = 2
  • BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD = 4
  • BrickletSoundIntensity.FUNCTION_SET_DEBOUNCE_PERIOD = 6
void BrickletSoundIntensity.setResponseExpectedAll(boolean responseExpected)

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

BrickletSoundIntensity.Identity BrickletSoundIntensity.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, short[] hardwareVersion, short[] firmwareVersion und int deviceIdentifier.

Konfigurationsfunktionen für Listener

void BrickletSoundIntensity.setIntensityCallbackPeriod(long period)

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

The IntensityListener Listener wird nur ausgelöst, wenn sich die Intensität seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

long BrickletSoundIntensity.getIntensityCallbackPeriod()

Gibt die Periode zurück, wie von setIntensityCallbackPeriod() gesetzt.

void BrickletSoundIntensity.setIntensityCallbackThreshold(char option, int min, int max)

Setzt den Schwellwert für den IntensityReachedListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Listener ist inaktiv
'o' Listener wird ausgelöst, wenn die Intensität außerhalb der min und max Werte ist
'i' Listener wird ausgelöst, wenn die Intensität innerhalb der min und max Werte ist
'<' Listener wird ausgelöst, wenn die Intensität kleiner als der min Wert ist (max wird ignoriert)
'>' Listener wird ausgelöst, wenn die Intensität größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

  • BrickletSoundIntensity.THRESHOLD_OPTION_OFF = 'x'
  • BrickletSoundIntensity.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletSoundIntensity.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletSoundIntensity.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletSoundIntensity.THRESHOLD_OPTION_GREATER = '>'
BrickletSoundIntensity.IntensityCallbackThreshold BrickletSoundIntensity.getIntensityCallbackThreshold()

Gibt den Schwellwert zurück, wie von setIntensityCallbackThreshold() gesetzt.

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

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

Das zurückgegebene Objekt enthält die Public-Member-Variablen char option, int min und int max.

void BrickletSoundIntensity.setDebouncePeriod(long debounce)

Setzt die Periode in ms mit welcher der Schwellwert-Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

long BrickletSoundIntensity.getDebouncePeriod()

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() 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 BrickletSoundIntensity.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.

class BrickletSoundIntensity.IntensityListener()

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

void intensity(int intensity)

Dieser Listener wird mit der Periode, wie gesetzt mit setIntensityCallbackPeriod(), ausgelöst. Der Parameter ist gemessene Schallintensität.

Der IntensityListener Listener wird nur ausgelöst, wenn sich die Intensität seit der letzten Auslösung geändert hat.

class BrickletSoundIntensity.IntensityReachedListener()

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

void intensityReached(int intensity)

Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von setIntensityCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die gemessene Schallintensität.

Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

Konstanten

static final int BrickletSoundIntensity.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Sound Intensity 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.

static final String BrickletSoundIntensity.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Sound Intensity Bricklet dar.