PHP - Tilt Bricklet

This is the description of the PHP API bindings for the Tilt Bricklet. General information and technical specifications for the Tilt Bricklet are summarized in its hardware description.

An installation guide for the PHP API bindings is part of their general description.

Examples

The example code below is 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
28
29
30
31
32
33
34
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTilt;

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

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

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

// Get current tilt state
$state = $t->getTiltState();

if ($state == BrickletTilt::TILT_STATE_CLOSED) {
    echo "Tilt State: Closed\n";
} elseif ($state == BrickletTilt::TILT_STATE_OPEN) {
    echo "Tilt State: Open\n";
} elseif ($state == BrickletTilt::TILT_STATE_CLOSED_VIBRATING) {
    echo "Tilt State: Closed Vibrating\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
37
38
39
40
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTilt;

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

// Callback function for tilt state callback
function cb_tiltState($state)
{
    if ($state == BrickletTilt::TILT_STATE_CLOSED) {
        echo "Tilt State: Closed\n";
    } elseif ($state == BrickletTilt::TILT_STATE_OPEN) {
        echo "Tilt State: Open\n";
    } elseif ($state == BrickletTilt::TILT_STATE_CLOSED_VIBRATING) {
        echo "Tilt State: Closed Vibrating\n";
    }
}

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

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

// Enable tilt state callback
$t->enableTiltStateCallback();

// Register tilt state callback to function cb_tiltState
$t->registerCallback(BrickletTilt::CALLBACK_TILT_STATE, 'cb_tiltState');

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

?>

API

Functions that return multiple values return them in an associative array.

Basic Functions

class BrickletTilt(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $tilt – Type: BrickletTilt

Creates an object with the unique device ID $uid:

<?php   $tilt = new BrickletTilt('YOUR_DEVICE_UID', $ipcon);   ?>

This object can then be used after the IP Connection is connected (see examples above).

int BrickletTilt::getTiltState()
Returns:
  • $state – Type: int, Range: See constants

Returns the current tilt state. The state can either be

  • 0 = Closed: The ball in the tilt switch closes the circuit.
  • 1 = Open: The ball in the tilt switch does not close the circuit.
  • 2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).
Tilt states

The following constants are available for this function:

For $state:

  • BrickletTilt::TILT_STATE_CLOSED = 0
  • BrickletTilt::TILT_STATE_OPEN = 1
  • BrickletTilt::TILT_STATE_CLOSED_VIBRATING = 2

Advanced Functions

array BrickletTilt::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', 'i', '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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as 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 BrickletTilt::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.

void BrickletTilt::enableTiltStateCallback()

Enables the CALLBACK_TILT_STATE callback.

void BrickletTilt::disableTiltStateCallback()

Disables the CALLBACK_TILT_STATE callback.

bool BrickletTilt::isTiltStateCallbackEnabled()
Returns:
  • $enabled – Type: bool, Default: FALSE

Returns true if the CALLBACK_TILT_STATE callback is enabled.

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";
}

$tilt->registerCallback(BrickletTilt::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

int BrickletTilt::CALLBACK_TILT_STATE
<?php   void callback(int $state [, mixed $user_data])   ?>
Callback Parameters:
  • $state – Type: int, Range: See constants
  • $user_data – Type: mixed

This callback provides the current tilt state. It is called every time the state changes.

See getTiltState() for a description of the states.

The following constants are available for this function:

For $state:

  • BrickletTilt::TILT_STATE_CLOSED = 0
  • BrickletTilt::TILT_STATE_OPEN = 1
  • BrickletTilt::TILT_STATE_CLOSED_VIBRATING = 2

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 BrickletTilt::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 BrickletTilt::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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

  • BrickletTilt::FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
  • BrickletTilt::FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3
void BrickletTilt::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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

  • BrickletTilt::FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
  • BrickletTilt::FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3
void BrickletTilt::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 BrickletTilt::DEVICE_IDENTIFIER

This constant is used to identify a Tilt 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 BrickletTilt::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Tilt Bricklet.