PHP - Sound Intensity Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletSoundIntensity.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletSoundIntensity;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Sound Intensity Bricklet

$ipcon = new IPConnection(); // Create IP connection
$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
$intensity = $si->getIntensity();
echo "Intensity: $intensity\n";

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Callback

Download (ExampleCallback.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletSoundIntensity.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletSoundIntensity;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Sound Intensity Bricklet

// Callback function for intensity callback
function cb_intensity($intensity)
{
    echo "Intensity: $intensity\n";
}

$ipcon = new IPConnection(); // Create IP connection
$si = new BrickletSoundIntensity(UID, $ipcon); // Create device object

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

// Register intensity callback to function cb_intensity
$si->registerCallback(BrickletSoundIntensity::CALLBACK_INTENSITY, 'cb_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);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

Threshold

Download (ExampleThreshold.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletSoundIntensity.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletSoundIntensity;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Sound Intensity Bricklet

// Callback function for intensity reached callback
function cb_intensityReached($intensity)
{
    echo "Intensity: $intensity\n";
}

$ipcon = new IPConnection(); // Create IP connection
$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);

// Register intensity reached callback to function cb_intensityReached
$si->registerCallback(BrickletSoundIntensity::CALLBACK_INTENSITY_REACHED,
                      'cb_intensityReached');

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

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API

Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.

Grundfunktionen

class BrickletSoundIntensity(string $uid, IPConnection $ipcon)

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

<?php   $sound_intensity = 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 CALLBACK_INTENSITY Callback zu nutzen und die Periode mit setIntensityCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

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

bool BrickletSoundIntensity::getResponseExpected(int $function_id)

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

void BrickletSoundIntensity::setResponseExpected(int $function_id, bool $response_expected)

Ä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 Callbacks (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:

  • BrickletSoundIntensity::FUNCTION_SET_INTENSITY_CALLBACK_PERIOD = 2
  • BrickletSoundIntensity::FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD = 4
  • BrickletSoundIntensity::FUNCTION_SET_DEBOUNCE_PERIOD = 6
void BrickletSoundIntensity::setResponseExpectedAll(bool $response_expected)

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

array 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 Array enthält die Keys uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

void BrickletSoundIntensity::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)

Registriert die $function für die gegebene $callback_id. Die optionalen $user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

void BrickletSoundIntensity::setIntensityCallbackPeriod(int $period)

Setzt die Periode in ms 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.

Der Standardwert ist 0.

int BrickletSoundIntensity::getIntensityCallbackPeriod()

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

void BrickletSoundIntensity::setIntensityCallbackThreshold(string $option, int $min, int $max)

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 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 = '>'
array 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 Array enthält die Keys option, min und max.

void BrickletSoundIntensity::setDebouncePeriod(int $debounce)

Setzt die Periode in ms mit welcher der Schwellwert-Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

int BrickletSoundIntensity::getDebouncePeriod()

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion registerCallback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite die Callback-Funktion:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$sound_intensity->registerCallback(BrickletSoundIntensity::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen werden weiter unten beschrieben.

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.

int BrickletSoundIntensity::CALLBACK_INTENSITY
<?php   void callback(int $intensity [, mixed $user_data])   ?>

Dieser Callback wird mit der Periode, wie gesetzt mit setIntensityCallbackPeriod(), ausgelöst. Der Parameter 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.

int BrickletSoundIntensity::CALLBACK_INTENSITY_REACHED
<?php   void callback(int $intensity [, mixed $user_data])   ?>

Dieser Callback 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 Callback mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

Konstanten

int BrickletSoundIntensity::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Sound Intensity Bricklet zu identifizieren.

Die getIdentity() Funktion und der CALLBACK_ENUMERATE Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickletSoundIntensity::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Sound Intensity Bricklet dar.