PHP - Motion Detector Bricklet¶

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
37
38
39
40
41
42

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletMotionDetector;

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

// Callback function for motion detected callback
function cb_motionDetected()
{
    echo "Motion Detected\n";
}

// Callback function for detection cycle ended callback
function cb_detectionCycleEnded()
{
    echo "Detection Cycle Ended (next detection possible in ~3 seconds)\n";
}

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

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

// Register motion detected callback to function cb_motionDetected
$md->registerCallback(BrickletMotionDetector::CALLBACK_MOTION_DETECTED,
                      'cb_motionDetected');

// Register detection cycle ended callback to function cb_detectionCycleEnded
$md->registerCallback(BrickletMotionDetector::CALLBACK_DETECTION_CYCLE_ENDED,
                      'cb_detectionCycleEnded');

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

?>

Basic Functions¶

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

Parameters:	$uid – Type: string $ipcon – Type: IPConnection
Returns:	$motion_detector – Type: BrickletMotionDetector

Creates an object with the unique device ID $uid:

<?php   $motion_detector = new BrickletMotionDetector('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletMotionDetector::getMotionDetected()¶

Returns:	$motion – Type: int, Range: See constants

Returns 1 if a motion was detected. How long this returns 1 after a motion was detected can be adjusted with one of the small potentiometers on the Motion Detector Bricklet, see here.

There is also a blue LED on the Bricklet that is on as long as the Bricklet is in the "motion detected" state.

The following constants are available for this function:

For $motion:

• BrickletMotionDetector::MOTION_NOT_DETECTED = 0
• BrickletMotionDetector::MOTION_DETECTED = 1

Advanced Functions¶

void BrickletMotionDetector::setStatusLEDConfig(int $config)¶

Parameters:	$config – Type: int, Range: See constants, Default: 2

Sets the status led configuration.

By default the status LED turns on if a motion is detected and off is no motion is detected.

You can also turn the LED permanently on/off.

The following constants are available for this function:

For $config:

• BrickletMotionDetector::STATUS_LED_CONFIG_OFF = 0
• BrickletMotionDetector::STATUS_LED_CONFIG_ON = 1
• BrickletMotionDetector::STATUS_LED_CONFIG_SHOW_STATUS = 2

New in version 2.0.1 (Plugin).

int BrickletMotionDetector::getStatusLEDConfig()¶

Returns:	$config – Type: int, Range: See constants, Default: 2

Returns the configuration as set by setStatusLEDConfig().

The following constants are available for this function:

For $config:

• BrickletMotionDetector::STATUS_LED_CONFIG_OFF = 0
• BrickletMotionDetector::STATUS_LED_CONFIG_ON = 1
• BrickletMotionDetector::STATUS_LED_CONFIG_SHOW_STATUS = 2

New in version 2.0.1 (Plugin).

array BrickletMotionDetector::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 BrickletMotionDetector::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";
}

$motion_detector->registerCallback(BrickletMotionDetector::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures are described below.

int BrickletMotionDetector::CALLBACK_MOTION_DETECTED¶

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

Callback Parameters:	$user_data – Type: mixed

This callback is called after a motion was detected.

int BrickletMotionDetector::CALLBACK_DETECTION_CYCLE_ENDED¶

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

Callback Parameters:	$user_data – Type: mixed

This callback is called when the detection cycle ended. When this callback is called, a new motion can be detected again after approximately 2 seconds.

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 BrickletMotionDetector::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 BrickletMotionDetector::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:

• BrickletMotionDetector::FUNCTION_SET_STATUS_LED_CONFIG = 4

void BrickletMotionDetector::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:

• BrickletMotionDetector::FUNCTION_SET_STATUS_LED_CONFIG = 4

void BrickletMotionDetector::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 BrickletMotionDetector::DEVICE_IDENTIFIER¶

This constant is used to identify a Motion Detector 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 BrickletMotionDetector::DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Motion Detector Bricklet.