PHP - API Bindings¶

Requirements¶

• PHP 5.3 or newer with bcmath and sockets extension

Installation¶

There are two ways to install the PHP bindings: from our APT repository for Debian based Linux distributions or from PEAR package. But the bindings can also be used without installing them first.

sudo apt install php-tinkerforge

pear install Tinkerforge.tgz

Testing an Example¶

To test a PHP example Brick Daemon and Brick Viewer have to be installed first. Brick Daemon acts as a proxy between the USB interface of the Bricks and the API bindings. Brick Viewer connects to Brick Daemon and helps to figure out basic information about the connected Bricks and Bricklets.

As an example let's test the configuration example for the Stepper Brick. For this copy the ExampleConfiguration.php file from the examples/Brick/Stepper/ folder into a new folder:

example_project/
 -> ExampleConfiguration.php

In the example HOST and PORT specify at which network address the Stepper Brick can be found. If it is connected locally to USB then localhost and 4223 is correct. The UID value has to be changed to the UID of the connected Stepper Brick, which you can figure out using Brick Viewer:

<?php

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XXYYZZ'; // Change XXYYZZ to the UID of your Stepper Brick

?>

If you did install the bindings then you're now ready to test this example:

php ExampleConfiguration.php

If you did not install the bindings then you can also use the source of the bindings directly. Just copy the Tinkerforge/ folder from the source/ folder to your example_project/ folder and PHP will automatically find the bindings:

example_project/
 -> Tinkerforge/
 -> ExampleConfiguration.php

Now you're ready to test this example:

php ExampleConfiguration.php

API Reference and Examples¶

Links to the API reference for the IP Connection, Bricks and Bricklets as well as the examples from the ZIP file of the bindings are listed in the following table. Further project descriptions can be found in the Kits section.