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 8 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.

Vom APT Repository

Die Bindings stehen in unserem APT Repository für Debian basierte Linux Distributionen bereit (dazu wird die ZIP Datei der Bindings nicht benötigt). Zuerst das APT Repository einrichten dann die Bindings installieren:

sudo apt install libtinkerforge-java

Die Bindings JAR Datei ist hier installiert:

/usr/share/java/tinkerforge.jar

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

Vom Maven Central Repository

Die Bindings steht auch im Maven Central 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 = "XXYYZZ"; // Change XXYYZZ to the UID of your Stepper Brick

Im example_project/ Ordner kann jetzt der Java Compiler mit den folgenden Parametern auf Windows aufgerufen werden (für Linux und macOS 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 macOS 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 Kits.

  API Beispiele
Sonstiges    
IP Connection API Beispiele
     
Bricks    
ESP32 API  
ESP32 Ethernet API  
HAT API Beispiele
HAT Zero API Beispiele
IMU 2.0 API Beispiele
Master API Beispiele
RED API Beispiele
Silent Stepper API Beispiele
     
Bricks (Abgekündigt)    
DC API Beispiele
IMU API Beispiele
Servo API Beispiele
Stepper API Beispiele
     
Bricklets    
Accelerometer 2.0 API Beispiele
Air Quality API Beispiele
Ambient Light 3.0 API Beispiele
Analog In 3.0 API Beispiele
Analog Out 3.0 API Beispiele
Barometer API Beispiele
Barometer 2.0 API Beispiele
CAN API Beispiele
CAN 2.0 API Beispiele
CO2 2.0 API Beispiele
Color API Beispiele
Color 2.0 API Beispiele
Compass API Beispiele
DC 2.0 API Beispiele
Distance IR API Beispiele
Distance IR 2.0 API Beispiele
Distance US 2.0 API Beispiele
DMX API Beispiele
Dual Button 2.0 API Beispiele
Dust Detector API Beispiele
E-Paper 296x128 API Beispiele
Energy Monitor API Beispiele
GPS 2.0 API Beispiele
GPS 3.0 API Beispiele
Hall Effect API Beispiele
Hall Effect 2.0 API Beispiele
Humidity 2.0 API Beispiele
IMU 3.0 API Beispiele
Industrial Analog Out 2.0 API Beispiele
Industrial Counter API Beispiele
Industrial Digital In 4 2.0 API Beispiele
Industrial Digital Out 4 API Beispiele
Industrial Digital Out 4 2.0 API Beispiele
Industrial Dual 0-20mA API Beispiele
Industrial Dual 0-20mA 2.0 API Beispiele
Industrial Dual AC In API  
Industrial Dual AC Relay API Beispiele
Industrial Dual Analog In 2.0 API Beispiele
Industrial Dual Relay API Beispiele
Industrial PTC API Beispiele
Industrial Quad Relay 2.0 API Beispiele
IO-16 API Beispiele
IO-16 2.0 API Beispiele
IO-4 2.0 API Beispiele
Isolator API Beispiele
Joystick API Beispiele
Joystick 2.0 API Beispiele
Laser Range Finder 2.0 API Beispiele
LCD 128x64 API Beispiele
LCD 20x4 API Beispiele
LED Strip 2.0 API Beispiele
Line API Beispiele
Linear Poti API Beispiele
Linear Poti 2.0 API Beispiele
Load Cell 2.0 API Beispiele
Motion Detector 2.0 API Beispiele
Motorized Linear Poti API Beispiele
Multi Touch API Beispiele
Multi Touch 2.0 API Beispiele
NFC API Beispiele
OLED 128x64 2.0 API Beispiele
OLED 64x48 API Beispiele
One Wire API Beispiele
Outdoor Weather API Beispiele
Particulate Matter API Beispiele
Performance DC API Beispiele
Piezo Speaker API Beispiele
Piezo Speaker 2.0 API Beispiele
Real-Time Clock API Beispiele
Real-Time Clock 2.0 API Beispiele
Remote Switch 2.0 API Beispiele
RGB LED 2.0 API Beispiele
RGB LED Button API Beispiele
Rotary Encoder 2.0 API Beispiele
Rotary Poti API Beispiele
Rotary Poti 2.0 API Beispiele
RS232 API Beispiele
RS232 2.0 API Beispiele
RS485 API Beispiele
Segment Display 4x7 API Beispiele
Segment Display 4x7 2.0 API Beispiele
Servo 2.0 API Beispiele
Silent Stepper 2.0 API Beispiele
Solid State Relay 2.0 API Beispiele
Sound Intensity API Beispiele
Sound Pressure Level API Beispiele
Temperature API Beispiele
Temperature 2.0 API Beispiele
Temperature IR 2.0 API Beispiele
Thermal Imaging API Beispiele
Thermocouple 2.0 API Beispiele
Tilt API Beispiele
UV Light 2.0 API Beispiele
Voltage/Current 2.0 API Beispiele
XMC1400 Breakout API Beispiele
     
Bricklets (Abgekündigt)    
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
CO2 API Beispiele
Current12 API Beispiele
Current25 API Beispiele
Distance US API Beispiele
Dual Button API Beispiele
Dual Relay API Beispiele
GPS API Beispiele
Humidity API Beispiele
Industrial Analog Out API Beispiele
Industrial Digital In 4 API Beispiele
Industrial Dual Analog In API Beispiele
Industrial Quad Relay API Beispiele
IO-4 API Beispiele
Laser Range Finder API Beispiele
LCD 16x2 API Beispiele
LED Strip API Beispiele
Load Cell API Beispiele
Moisture API Beispiele
Motion Detector API Beispiele
NFC/RFID API Beispiele
OLED 128x64 API Beispiele
Piezo Buzzer API Beispiele
PTC API Beispiele
PTC 2.0 API Beispiele
Remote Switch API Beispiele
RGB LED API Beispiele
RGB LED Matrix API  
Rotary Encoder API Beispiele
Solid State Relay API Beispiele
Temperature IR API Beispiele
Thermocouple API Beispiele
UV Light API Beispiele
Voltage API Beispiele
Voltage/Current API Beispiele