PHP - API Bindings – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
      - Requirements
      - Installation
        - From PEAR Package
        - Without Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# PHP - API Bindings

The PHP bindings allow you to control Bricks and Bricklets from your PHP programs. The ZIP file for the bindings contains:

- `Tinkerforge.tgz`, a PEAR package (installable with pear tool)
- in `source/` the source code of `Tinkerforge.tgz`
- in `examples/` the examples for every Brick and Bricklet

## Requirements

- PHP 5.3 or newer with `bcmath` and `sockets` extension

## Installation

The bindings can be installed, but can also be used without installation.

### From PEAR Package

The bindings are available as a PEAR package. You can install it with the pear tool using the following command. Depending on your PHP installation you might have to execute this with `sudo` or as administrator:

    pear install Tinkerforge.tgz

Now you're ready to test the examples. The PEAR package does not include the examples. Those are available as part of the bindings ZIP file.

### Without Installation

You can use the bindings without having to install them. Just copy the `Tinkerforge/` folder from the `source/` folder in the same folder as your PHP program. The section about testing an example has more details about this.

## 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 = 'XYZ'; // Change to your UID

    ?>

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 Starter Kits section.

| API | Examples
--- | --- | ---
IP Connection | API | Examples
Bricks |  |
DC | API | Examples
IMU | API | Examples
Master | API | Examples
RED | API | Examples
Servo | API | Examples
Stepper | API | Examples
Bricklets |  |
Ambient Light | API | Examples
Analog In | API | Examples
Analog Out | API | Examples
Barometer | API | Examples
Color | API | Examples
Current12 | API | Examples
Current25 | API | Examples
Distance IR | API | Examples
Distance US | API | Examples
Dual Button | API | Examples
Dual Relay | API | Examples
GPS | API | Examples
Hall Effect | API | Examples
Humidity | API | Examples
Industrial Digital In 4 | API | Examples
Industrial Digital Out 4 | API | Examples
Industrial Dual 0-20mA | API | Examples
Industrial Quad Relay | API | Examples
IO-16 | API | Examples
IO-4 | API | Examples
Joystick | API | Examples
LCD 16x2 | API | Examples
LCD 20x4 | API | Examples
LED Strip | API | Examples
Line | API | Examples
Linear Poti | API | Examples
Moisture | API | Examples
Motion Detector | API | Examples
Multi Touch | API | Examples
NFC/RFID | API | Examples
Piezo Buzzer | API | Examples
Piezo Speaker | API | Examples
PTC | API | Examples
Remote Switch | API | Examples
Rotary Encoder | API | Examples
Rotary Poti | API | Examples
Segment Display 4x7 | API | Examples
Solid State Relay | API | Examples
Sound Intensity | API | Examples
Temperature | API | Examples
Temperature IR | API | Examples
Tilt | API | Examples
Voltage | API | Examples
Voltage/Current | API | Examples

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.