PHP - Piezo Buzzer Bricklet¶

Beep¶

Download (ExampleBeep.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

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletPiezoBuzzer;

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

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

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

// Make 2 second beep
$pb->beep(2000);

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

?>

Morse Code¶

Download (ExampleMorseCode.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

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletPiezoBuzzer;

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

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

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

// Morse SOS
$pb->morseCode('... --- ...');

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

?>

Basic Functions¶

class BrickletPiezoBuzzer(string $uid, IPConnection $ipcon)¶

Parameters:	$uid – Type: string $ipcon – Type: IPConnection
Returns:	$piezo_buzzer – Type: BrickletPiezoBuzzer

Creates an object with the unique device ID $uid:

<?php   $piezo_buzzer = new BrickletPiezoBuzzer('YOUR_DEVICE_UID', $ipcon);   ?>

This object can then be used after the IP Connection is connected.

void BrickletPiezoBuzzer::beep(int $duration)¶

Parameters:	$duration – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]

Beeps for the given duration.

void BrickletPiezoBuzzer::morseCode(string $morse)¶

Parameters:	$morse – Type: string, Length: up to 60

Sets morse code that will be played by the piezo buzzer. The morse code is given as a string consisting of "." (dot), "-" (minus) and " " (space) for dits, dahs and pauses. Every other character is ignored.

For example: If you set the string "...---...", the piezo buzzer will beep nine times with the durations "short short short long long long short short short".

Advanced Functions¶

array BrickletPiezoBuzzer::getIdentity()¶

Return Array:

'uid' – Type: string, Length: up to 8 'connected_uid' – Type: string, Length: up to 8 'position' – Type: string, Range: ['a' to 'h', 'z'] 'hardware_version' – Type: array(int, ...), Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255] 'firmware_version' – Type: array(int, ...), Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255] 'device_identifier' – Type: int, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

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

Parameters:	$callback_id – Type: int $callback – Type: callable $user_data – Type: mixed

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

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

$piezo_buzzer->registerCallback(BrickletPiezoBuzzer::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures are described below.

int BrickletPiezoBuzzer::CALLBACK_BEEP_FINISHED¶

<?php   void callback([mixed $user_data])   ?>

Callback Parameters:	$user_data – Type: mixed

This callback is triggered if a beep set by beep() is finished

int BrickletPiezoBuzzer::CALLBACK_MORSE_CODE_FINISHED¶

<?php   void callback([mixed $user_data])   ?>

Callback Parameters:	$user_data – Type: mixed

This callback is triggered if the playback of the morse code set by morseCode() is finished.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

array BrickletPiezoBuzzer::getAPIVersion()¶

Return Array:	$api_version – Type: array(int, ...), Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

bool BrickletPiezoBuzzer::getResponseExpected(int $function_id)¶

Parameters:	$function_id – Type: int, Range: See constants
Returns:	$response_expected – Type: bool

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

• BrickletPiezoBuzzer::FUNCTION_BEEP = 1
• BrickletPiezoBuzzer::FUNCTION_MORSE_CODE = 2

void BrickletPiezoBuzzer::setResponseExpected(int $function_id, bool $response_expected)¶

Parameters:	$function_id – Type: int, Range: See constants $response_expected – Type: bool

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

• BrickletPiezoBuzzer::FUNCTION_BEEP = 1
• BrickletPiezoBuzzer::FUNCTION_MORSE_CODE = 2

void BrickletPiezoBuzzer::setResponseExpectedAll(bool $response_expected)¶

Parameters:	$response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants¶

int BrickletPiezoBuzzer::DEVICE_IDENTIFIER¶

This constant is used to identify a Piezo Buzzer Bricklet.

The getIdentity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

string BrickletPiezoBuzzer::DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Piezo Buzzer Bricklet.