MQTT - Sound Intensity Bricklet

Dies ist die Beschreibung der MQTT 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 MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.txt)

1
2
3
4
5
6
# Change XYZ to the UID of your Sound Intensity Bricklet

setup:
    # Get current intensity
    subscribe to tinkerforge/response/sound_intensity_bricklet/XYZ/get_intensity
    publish '' to tinkerforge/request/sound_intensity_bricklet/XYZ/get_intensity

Callback

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your Sound Intensity Bricklet

setup:
    # Handle incoming intensity callbacks
    subscribe to tinkerforge/callback/sound_intensity_bricklet/XYZ/intensity
    publish '{"register": true}' to tinkerforge/register/sound_intensity_bricklet/XYZ/intensity # Register intensity callback
    
    # 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!
    publish '{"period": 50}' to tinkerforge/request/sound_intensity_bricklet/XYZ/set_intensity_callback_period

Threshold

Download (example-threshold.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Change XYZ to the UID of your Sound Intensity Bricklet

setup:
    # Get threshold callbacks with a debounce time of 1 second (1000ms)
    publish '{"debounce": 1000}' to tinkerforge/request/sound-intensity_bricklet/XYZ/set_debounce_period
    
    # Handle incoming intensity reached callbacks
    subscribe to tinkerforge/callback/sound_intensity_bricklet/XYZ/intensity_reached
    publish '{"register": true}' to tinkerforge/register/sound_intensity_bricklet/XYZ/intensity_reached # Register intensity_reached callback
    
    # Configure threshold for intensity "greater than 2000"
    publish '{"option": "greater", "min": 2000, "max": 0}' to tinkerforge/request/sound_intensity_bricklet/XYZ/set_intensity_callback_threshold

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als "_ERROR"-Attribut enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/sound_intensity_bricklet/<UID>/get_intensity
Response-Payload:
  • intensity -- int

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 register/sound_intensity_bricklet/<UID>/intensity Callback zu nutzen und die Periode mit request/sound_intensity_bricklet/<UID>/set_intensity_callback_period vorzugeben.

Fortgeschrittene Funktionen

request/sound_intensity_bricklet/<UID>/get_identity
Response-Payload:
  • uid -- string
  • connected_uid -- string
  • position -- char
  • hardware_version -- [int,int,int]
  • firmware_version -- [int,int,int]
  • device_identifier -- int (hat Symbole)
  • _display_name -- string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Sound Intensity.

Konfigurationsfunktionen für Callbacks

request/sound_intensity_bricklet/<UID>/set_intensity_callback_period
Request-Payload:
  • period -- int

Setzt die Periode in ms mit welcher der register/sound_intensity_bricklet/<UID>/intensity Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

The register/sound_intensity_bricklet/<UID>/intensity Callback wird nur ausgelöst, wenn sich die Intensität seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

request/sound_intensity_bricklet/<UID>/get_intensity_callback_period
Response-Payload:
  • period -- int

Gibt die Periode zurück, wie von request/sound_intensity_bricklet/<UID>/set_intensity_callback_period gesetzt.

request/sound_intensity_bricklet/<UID>/set_intensity_callback_threshold
Request-Payload:
  • option -- char (hat Symbole)
  • min -- int
  • max -- int

Setzt den Schwellwert für den register/sound_intensity_bricklet/<UID>/intensity_reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Intensität außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn die Intensität innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn die Intensität kleiner als der min Wert ist (max wird ignoriert)
'>' Callback 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 Symbole sind für diese Funktion verfügbar:

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/sound_intensity_bricklet/<UID>/get_intensity_callback_threshold
Response-Payload:
  • option -- char (hat Symbole)
  • min -- int
  • max -- int

Gibt den Schwellwert zurück, wie von request/sound_intensity_bricklet/<UID>/set_intensity_callback_threshold gesetzt.

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

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/sound_intensity_bricklet/<UID>/set_debounce_period
Request-Payload:
  • debounce -- int

Setzt die Periode in ms mit welcher der Schwellwert-Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

request/sound_intensity_bricklet/<UID>/get_debounce_period
Response-Payload:
  • debounce -- int

Gibt die Entprellperiode zurück, wie von request/sound_intensity_bricklet/<UID>/set_debounce_period gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

Bemerkung

Callbacks 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.

register/sound_intensity_bricklet/<UID>/intensity
Request-Payload:
  • register -- bool
Response-Payload:
  • intensity -- int

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/sound_intensity_bricklet/<UID>/intensity[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/sound_intensity_bricklet/<UID>/intensity[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/sound_intensity_bricklet/<UID>/set_intensity_callback_period, ausgelöst. Der Payload des Callbacks ist gemessene Schallintensität.

Der register/sound_intensity_bricklet/<UID>/intensity Callback wird nur ausgelöst, wenn sich die Intensität seit der letzten Auslösung geändert hat.

register/sound_intensity_bricklet/<UID>/intensity_reached
Request-Payload:
  • register -- bool
Response-Payload:
  • intensity -- int

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/sound_intensity_bricklet/<UID>/intensity_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/sound_intensity_bricklet/<UID>/intensity_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/sound_intensity_bricklet/<UID>/set_intensity_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die gemessene Schallintensität.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/sound_intensity_bricklet/<UID>/set_debounce_period gesetzt, ausgelöst.