Modbus - Sound Intensity Bricklet

Dies ist die Beschreibung des Modbus Protokolls für das Sound Intensity Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Sound Intensity Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletSoundIntensity.get_intensity
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • intensity – Typ: uint16, Wertebereich: [0 bis 216 - 1]

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 CALLBACK_INTENSITY Callback zu nutzen und die Periode mit set_intensity_callback_period vorzugeben.

Fortgeschrittene Funktionen

BrickletSoundIntensity.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char
  • hardware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, 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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickletSoundIntensity.set_intensity_callback_period
Funktions-ID:
  • 2
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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

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

BrickletSoundIntensity.get_intensity_callback_period
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_intensity_callback_period gesetzt.

BrickletSoundIntensity.set_intensity_callback_threshold
Funktions-ID:
  • 4
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • max – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort

Setzt den Schwellwert für den CALLBACK_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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletSoundIntensity.get_intensity_callback_threshold
Funktions-ID:
  • 5
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • max – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Gibt den Schwellwert zurück, wie von set_intensity_callback_threshold gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletSoundIntensity.set_debounce_period
Funktions-ID:
  • 6
Anfrage:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der Schwellwert-Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

BrickletSoundIntensity.get_debounce_period
Funktions-ID:
  • 7
Anfrage:
  • keine Nutzdaten
Antwort:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set_debounce_period gesetzt.

Callbacks

BrickletSoundIntensity.CALLBACK_INTENSITY
Funktions-ID:
  • 8
Antwort:
  • intensity – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_intensity_callback_period, ausgelöst. Der Rückgabewert ist gemessene Schallintensität.

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

BrickletSoundIntensity.CALLBACK_INTENSITY_REACHED
Funktions-ID:
  • 9
Antwort:
  • intensity – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_intensity_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die gemessene Schallintensität.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set_debounce_period gesetzt, ausgelöst.