PHP - Motion Detector Bricklet 2.0¶

Indicator¶

Download (ExampleIndicator.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/BrickletMotionDetectorV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletMotionDetectorV2;

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

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

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

// Turn blue backlight LEDs on (maximum brightness)
$md->setIndicator(255, 255, 255);

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

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletMotionDetectorV2;

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

// 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 ~2 seconds)\n";
}

$ipcon = new IPConnection(); // Create IP connection
$md = new BrickletMotionDetectorV2(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(BrickletMotionDetectorV2::CALLBACK_MOTION_DETECTED,
                      'cb_motionDetected');

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

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

?>

Basic Functions¶

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

Parameters:	$uid – Type: string $ipcon – Type: IPConnection
Returns:	$motion_detector_v2 – Type: BrickletMotionDetectorV2

Creates an object with the unique device ID $uid:

<?php   $motion_detector_v2 = new BrickletMotionDetectorV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletMotionDetectorV2::getMotionDetected()¶

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

Returns 1 if a motion was detected. It returns 1 approx. for 1.8 seconds until the sensor checks for a new movement.

The following constants are available for this function:

For $motion:

• BrickletMotionDetectorV2::MOTION_NOT_DETECTED = 0
• BrickletMotionDetectorV2::MOTION_DETECTED = 1

void BrickletMotionDetectorV2::setSensitivity(int $sensitivity)¶

Parameters:	$sensitivity – Type: int, Range: [0 to 100], Default: 50

Sets the sensitivity of the PIR sensor. At full sensitivity (100), the Bricklet can detect motion in a range of approximately 12m.

The actual range depends on many things in the environment (e.g. reflections) and the size of the object to be detected. While a big person might be detected in a range of 10m a cat may only be detected at 2m distance with the same setting.

So you will have to find a good sensitivity for your application by trial and error.

int BrickletMotionDetectorV2::getSensitivity()¶

Returns:	$sensitivity – Type: int, Range: [0 to 100], Default: 50

Returns the sensitivity as set by setSensitivity().

void BrickletMotionDetectorV2::setIndicator(int $top_left, int $top_right, int $bottom)¶

Parameters:	$top_left – Type: int, Range: [0 to 255], Default: 0 $top_right – Type: int, Range: [0 to 255], Default: 0 $bottom – Type: int, Range: [0 to 255], Default: 0

Sets the blue backlight of the fresnel lens. The backlight consists of three LEDs. The brightness of each LED can be controlled with a 8-bit value (0-255). A value of 0 turns the LED off and a value of 255 turns the LED to full brightness.

array BrickletMotionDetectorV2::getIndicator()¶

Return Array:	'top_left' – Type: int, Range: [0 to 255], Default: 0 'top_right' – Type: int, Range: [0 to 255], Default: 0 'bottom' – Type: int, Range: [0 to 255], Default: 0

Returns the indicator configuration as set by setIndicator().

Advanced Functions¶

array BrickletMotionDetectorV2::getSPITFPErrorCount()¶

Return Array:	'error_count_ack_checksum' – Type: int, Range: [0 to 232 - 1] 'error_count_message_checksum' – Type: int, Range: [0 to 232 - 1] 'error_count_frame' – Type: int, Range: [0 to 232 - 1] 'error_count_overflow' – Type: int, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,
• message checksum errors,
• framing errors and
• overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

void BrickletMotionDetectorV2::setStatusLEDConfig(int $config)¶

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

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For $config:

• BrickletMotionDetectorV2::STATUS_LED_CONFIG_OFF = 0
• BrickletMotionDetectorV2::STATUS_LED_CONFIG_ON = 1
• BrickletMotionDetectorV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletMotionDetectorV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletMotionDetectorV2::getStatusLEDConfig()¶

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

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For $config:

• BrickletMotionDetectorV2::STATUS_LED_CONFIG_OFF = 0
• BrickletMotionDetectorV2::STATUS_LED_CONFIG_ON = 1
• BrickletMotionDetectorV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletMotionDetectorV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletMotionDetectorV2::getChipTemperature()¶

Returns:	$temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

void BrickletMotionDetectorV2::reset()¶

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

array BrickletMotionDetectorV2::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 BrickletMotionDetectorV2::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_v2->registerCallback(BrickletMotionDetectorV2::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures are described below.

int BrickletMotionDetectorV2::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 BrickletMotionDetectorV2::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 BrickletMotionDetectorV2::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 BrickletMotionDetectorV2::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:

• BrickletMotionDetectorV2::FUNCTION_SET_SENSITIVITY = 2
• BrickletMotionDetectorV2::FUNCTION_SET_INDICATOR = 4
• BrickletMotionDetectorV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletMotionDetectorV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletMotionDetectorV2::FUNCTION_RESET = 243
• BrickletMotionDetectorV2::FUNCTION_WRITE_UID = 248

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

• BrickletMotionDetectorV2::FUNCTION_SET_SENSITIVITY = 2
• BrickletMotionDetectorV2::FUNCTION_SET_INDICATOR = 4
• BrickletMotionDetectorV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletMotionDetectorV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletMotionDetectorV2::FUNCTION_RESET = 243
• BrickletMotionDetectorV2::FUNCTION_WRITE_UID = 248

void BrickletMotionDetectorV2::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.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

int BrickletMotionDetectorV2::setBootloaderMode(int $mode)¶

Parameters:	$mode – Type: int, Range: See constants
Returns:	$status – Type: int, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For $mode:

• BrickletMotionDetectorV2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletMotionDetectorV2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletMotionDetectorV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletMotionDetectorV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletMotionDetectorV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For $status:

• BrickletMotionDetectorV2::BOOTLOADER_STATUS_OK = 0
• BrickletMotionDetectorV2::BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletMotionDetectorV2::BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletMotionDetectorV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletMotionDetectorV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletMotionDetectorV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletMotionDetectorV2::getBootloaderMode()¶

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

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For $mode:

• BrickletMotionDetectorV2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletMotionDetectorV2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletMotionDetectorV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletMotionDetectorV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletMotionDetectorV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletMotionDetectorV2::setWriteFirmwarePointer(int $pointer)¶

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

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int BrickletMotionDetectorV2::writeFirmware(array $data)¶

Parameters:	$data – Type: array(int, ...), Length: 64, Range: [0 to 255]
Returns:	$status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

void BrickletMotionDetectorV2::writeUID(int $uid)¶

Parameters:	$uid – Type: int, Range: [0 to 232 - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

int BrickletMotionDetectorV2::readUID()¶

Returns:	$uid – Type: int, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

int BrickletMotionDetectorV2::DEVICE_IDENTIFIER¶

This constant is used to identify a Motion Detector Bricklet 2.0.

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 BrickletMotionDetectorV2::DEVICE_DISPLAY_NAME¶

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