Java - API Bindings

Note

There is an extra section for Java and Android.

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

  • Tinkerforge.jar, a precompiled Java library
  • in source/ the source code of Tinkerforge.jar
  • in examples/ examples for every Brick and Bricklet

The Java library has no external dependencies.

Requirements

  • Java JDK 1.5 or newer

Installation

If and how the Java bindings have to be installed depends heavily on how you are going to use them. If you are just calling the Java compiler from the command line then you can just put the Tinkerforge.jar file into the same folder as the Java code of your program and include it in the class path.

How the bindings can be used in a certain IDE depends on the specific IDE and will be explained in the documentation of the IDE.

Maven

The bindings are also available from the Central Maven Repository. This allows to use them directly in Maven project. Just add tinkerforge as a dependency to your Maven project file (pom.xml). The placeholder X.Y.Z represents the specific version of the bindings to be used, e.g. 2.1.1:

<project ...>
  ...
  <dependencies>
    ...
    <dependency>
      <groupId>com.tinkerforge</groupId>
      <artifactId>tinkerforge</artifactId>
      <version>X.Y.Z</version>
    </dependency>
    ...
  </dependencies>
  ...
</project>

The Maven package does not include the examples. Those are available as part of the bindings ZIP file.

Testing an Example

To test a Java 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 compile the configuration example for the Stepper Brick. Copy the Tinkerforge.jar file and the ExampleConfiguration.java file from examples/Brick/Stepper/ into a new folder:

example_project/
 -> Tinkerforge.jar
 -> ExampleConfiguration.java

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:

private static final String HOST = "localhost";
private static final int PORT = 4223;
private static final String UID = "XYZ"; // Change to your UID

Now we can execute the Java compiler in the example_project/ folder like this on Windows (replace ; in class path with : on Linux and Mac OS X):

javac -cp Tinkerforge.jar;. ExampleConfiguration.java

and run it with the following parameters on Windows (replace ; in class path with : on Linux and Mac OS X again):

java -cp Tinkerforge.jar;. ExampleConfiguration

Alternatively you can use the Java library and example in an Java IDE of your choice such as Eclipse or NetBeans.

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
IMU 2.0 API Examples
Master API Examples
RED API Examples
Servo API Examples
Stepper API Examples
     
Bricklets    
Accelerometer API Examples
Ambient Light API Examples
Ambient Light 2.0 API Examples
Analog In API Examples
Analog In 2.0 API Examples
Analog Out API Examples
Analog Out 2.0 API Examples
Barometer API Examples
CAN API Examples
CO2 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
Dust Detector API Examples
GPS API Examples
Hall Effect API Examples
Humidity API Examples
Industrial Analog Out API Examples
Industrial Digital In 4 API Examples
Industrial Digital Out 4 API Examples
Industrial Dual 0-20mA API Examples
Industrial Dual Analog In API Examples
Industrial Quad Relay API Examples
IO-16 API Examples
IO-4 API Examples
Joystick API Examples
Laser Range Finder API Examples
LCD 16x2 API Examples
LCD 20x4 API Examples
LED Strip API Examples
Line API Examples
Linear Poti API Examples
Load Cell API Examples
Moisture API Examples
Motion Detector API Examples
Multi Touch API Examples
NFC/RFID API Examples
OLED 128x64 API Examples
OLED 64x48 API Examples
Piezo Buzzer API Examples
Piezo Speaker API Examples
PTC API Examples
Real-Time Clock API Examples
Remote Switch API Examples
RGB LED API Examples
Rotary Encoder API Examples
Rotary Poti API Examples
RS232 API Examples
Segment Display 4x7 API Examples
Solid State Relay API Examples
Sound Intensity API Examples
Temperature API Examples
Temperature IR API Examples
Thermocouple API Examples
Tilt API Examples
UV Light API Examples
Voltage API Examples
Voltage/Current API Examples