Java - API Bindings

Bemerkung

Es gibt einen extra Abschnitt für Java und Android.

Die Java Bindings ermöglichen es Bricks und Bricklets aus selbst erstellen Java Programmen heraus zu steuern. Die ZIP Datei für die Bindings beinhaltet:

  • Tinkerforge.jar, eine vorkompilierte Java Bibliothek
  • in source/ den Quelltext für Tinkerforge.jar
  • in examples/ die Beispiele für alle Bricks und Bricklets

Die Java Bibliothek hat keine weiteren Abhängigkeiten.

Voraussetzungen

  • Java JDK 1.6 oder neuer

Installation

Ob und wie die Java Bindings installiert werden müssen hängt stark davon ab wie sie benutzt werden sollen. Wenn der Java Compiler direkt von der Kommandozeile aufgerufen wird genügt es die Tinkerforge.jar Datei im gleichen Verzeichnis wie den Java Quelltext des Programms abzulegen und sie im Class Path mit anzugeben.

Wie die Bindings in einer bestimmten IDE zu verwenden sind hängt von der IDE ab und wird in der Dokumentation der jeweiligen IDE erklärt.

Maven

Die Bindings steht auch im Central Maven Repository zur Verfügung. Dadurch können sie direkt in Maven Projekte eingebunden werden. Dazu einfach tinkerforge als Abhängigkeit in die Maven Projektdatei (pom.xml) aufnehmen. Der Platzhalter X.Y.Z steht dabei für die zu verwendende Version der Bindings, z.B. 2.1.1:

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

Das Maven Package beinhaltet keine Beispiele. Diese sind als Teil der ZIP Datei der Bindings verfügbar.

Test eines Beispiels

Um ein Java Beispiel testen zu können müssen zuerst Brick Daemon und Brick Viewer installiert werden. Brick Daemon arbeitet als Proxy zwischen der USB Schnittstelle der Bricks und den API Bindings. Brick Viewer kann sich mit Brick Daemon verbinden und gibt Informationen über die angeschlossenen Bricks und Bricklets aus.

Als Beispiel wird im Folgenden das Konfigurationsbeispiel des Stepper Bricks kompiliert. Dafür müssen zuerst die Tinkerforge.jar Datei und die ExampleConfiguration.java Datei aus dem examples/Brick/Stepper/ in einen neuen Ordern kopiert werden:

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

Am Anfang des Beispiels ist mit HOST und PORT angegeben unter welcher Netzwerkadresse der Stepper Brick zu erreichen ist. Ist er lokal per USB angeschlossen dann ist localhost und 4223 richtig. Als UID muss die UID des angeschlossen Stepper Bricks angegeben werden, diese kann über den Brick Viewer ermittelt werden:

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

Im example_project/ Ordner kann jetzt der Java Compiler mit den folgenden Parametern auf Windows aufgerufen werden (für Linux und Mac OS X das ; im Class Path durch : ersetzen):

javac -cp Tinkerforge.jar;. ExampleConfiguration.java

Und ausgeführt wird es mit dem folgenden Befehl (für Linux und Mac OS X wieder das ; im Class Path durch : ersetzen):

java -cp Tinkerforge.jar;. ExampleConfiguration

Alternativ können die Beispiele auch in einer Java IDE deiner Wahl verwendet werden, wie z.B. Eclipse oder NetBeans.

API Referenz und Beispiele

Links zur API Referenz der IP Connection, Bricks und Bricklets sowie die Beispiele aus der ZIP Datei der Bindings sind in der folgenden Tabelle aufgelistet. Anleitungen für weiterführende Projekte finden sich im Abschnitt über Starterkits.

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