MATLAB/Octave - API Bindings

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

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

Die MATLAB/Octave Bindings basieren auf den Java Bindings.

Voraussetzungen

  • MATLAB oder Octave 3.6 mit Java Unterstützung

Installation

Bevor die Bindings mit MATLAB oder Octave benutzt werden können müssen sie installiert werden.

MATLAB

Die Java Unterstützung in MATLAB ist normalerweise standardmäßig aktiv. Dies kann mit folgendem Befehl in MATLAB getestet werden:

version -java

Falls dieser Befehl keine Java Unterstürzung zeigt, dann siehe die MATLAB Dokumentation darüber wie Java für MATLAB eingerichtet werden kann.

Um die Bindings verwenden zu können muss MATLAB die Tinkerforge.jar Datei finden können. Diese kann auf verschiedene Art und Weisen erreicht werden. Die MATLAB Dokumentation beschreibt alle Art und Weisen. Das empfohlene Vorgehen ist die Bindings dem Preferences-Ordner hinzuzufügen.

Starte MATLAB und führe folgenden Befehl aus, um den Pfad zum Preferences-Ordner auszugeben:

prefdir(1)

Preferences-Ordner Beispielpfade:

  • Windows: C:\Users\<user>\AppData\local\MathWorks\MATLAB\R2016a
  • Linux: /home/<user>/.matlab/R2016a
  • macOS: /Users/<user>/.matlab/R2016a

Kopiere die Tinkerforge.jar Datei vom matlab/ Ordner in den Preferences-Ordner. Dann muss die Tinkerforge.jar Datei zu MATLABs Class Path hinzugefügt werden. Dazu eine Datei namens javaclasspath.txt im Preferences-Ordner anlegen bzw. bearbeiten und den absoluten Pfad zur Tinkerforge.jar Datei als neue Zeile hinzufügen. Zum Beispiel:

  • Windows: C:\Users\<User>\AppData\local\MathWorks\MATLAB\R2016a\Tinkerforge.jar
  • Linux: /home/<User>/.matlab/R2016a/Tinkerforge.jar
  • macOS: /Users/<User>/.matlab/R2016a/Tinkerforge.jar

Start MATLAB neu und führe folgenden Befehl aus, er sollte die Tinkerforge.jar Datei mit auflisten:

javaclasspath

Die Java Bindings können jetzt genutzt werden.

Octave

Die Verfügbarkeit der Java Unterstützung in Octave hängt von der Octave Version ab. Bis Version 3.6 einschließlich war die Java Unterstürzung ein einiges Modul. Ab Version 3.8 ist sie standardmäßiger Teil von Octave.

Allerdings funktionieren Callbacks nicht mit der Java Unterstützung in Octave 3.8, siehe dazu den Abschnitt über bekannte Probleme. Wir empfehlen daher derzeit Octave 3.6.

Unter Linux muss die Java Unterstützung für Octave 3.6 separat installiert werden:

sudo apt-get install octave octave-java

Für Windows empfehlen wir die MinGW Variante von Octave. In dieser Variante ist die Java Unterstützung standardmäßig aktiviert. Eine Anleitung wie Octave für Windows installiert werden kann findet sich im Octave Wiki.

Die Verfügbarkeit der Java Unterstützung kann mit folgendem Befehl in Octave getestet werden:

octave_config_info("features").JAVA

Um die Bindings in Octave verfügbar zu machen muss die Tinkerforge.jar Datei aus dem octave/ Ordner zu Octaves Class Path hinzugefügt werden werden. Zum Beispiel durch folgenden Octave Befehl unter Windows:

javaaddpath("C:\\Absoluter\\Pfad\\zum\\Octave\\Tinkerforge.jar");

Und durch folgenden Octave Befehl unter Linux:

javaaddpath("/Absoluter/Pfad/zum/Octave/Tinkerforge.jar");

Damit diese Änderung dauerhaft ist kann der Befehlt unter Linux in folgenden Datei eingetragen werden:

~/.octaverc

Falls diese Datei noch nicht existiert kann sie einfach angelegt werden. Nach Änderungen an dieser Datei muss Octave neugestartet werden.

Test eines Beispiels

Um ein MATLAB/Octave 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.

MATLAB

Als Beispiel werden wir das Stepper Brick Konfigurationsbeispiel ausführen. Dazu die matlab_example_configuration.m Datei aus dem matlab/examples/brick/stepper/ Ordner in MATLAB öffnen.

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:

HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change to your UID

Dann ist auch schon alles bereit, um dieses Beispiel testen zu können.

Octave

Als Beispiel werden wir das Stepper Brick Konfigurationsbeispiel ausführen. Dazu die octave_example_configuration.m Datei aus dem octave/examples/brick/stepper/ Ordner in Octave öffnen.

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:

HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change to your UID

Dann ist auch schon alles bereit, um dieses Beispiel testen zu können.

Function vs Script Dateien

Die Octave Beispiel sind Function Dateien. Um sie direkt von der Kommandozeile ausführen zu können, müssen sie zu Script Dateien erweitert werden. Dazu einfach am Ende des Beispiels die Beispiel Funktion aufrufen:

function octave_example_configuration()
    % ...
end

octave_example_configuration(); % Add this line

Bekannte Probleme

In Bindings Version 2.0.13 oder älter in Octave 3.8 funktioniert die Invoke Funktion nicht und wirft eine java.lang.UnsatisfiedLinkError Exception. Die Invoke Funktion erlaubt es von Java aus Octave Funktionen aufzurufen. Dies wird von den Bindings für Callbacks benutzt. Dies bedeutet, dass in Octave 3.8 keine Callbacks verwendet werden können. Eine Diskussion auf der Octave Mailing Liste hat noch zu keinem Erfolg geführt. Daher empfehlen wir derzeit Octave 3.6, in dieser Version tritt das Problem nicht auf und die Bindings funktionieren in vollem Umfang.

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
IP Connection API Beispiele
     
Bricks    
DC API Beispiele
HAT API Beispiele
HAT Zero API Beispiele
IMU 2.0 API Beispiele
Master API Beispiele
RED API Beispiele
Servo API Beispiele
Silent Stepper API Beispiele
Stepper API Beispiele
     
Bricks (Abgekündigt)    
IMU API Beispiele
     
Bricklets    
Accelerometer API Beispiele
Accelerometer 2.0 API Beispiele
Air Quality API Beispiele
Ambient Light 3.0 API Beispiele
Analog In 3.0 API Beispiele
Analog Out 2.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
Distance IR API Beispiele
Distance IR 2.0 API Beispiele
DMX API Beispiele
Dual Button API Beispiele
Dual Button 2.0 API Beispiele
Dual Relay API Beispiele
Dust Detector API Beispiele
E-Paper 296x128 API Beispiele
GPS 2.0 API Beispiele
Hall Effect API Beispiele
Hall Effect 2.0 API Beispiele
Humidity 2.0 API Beispiele
Industrial Analog Out 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 Analog In 2.0 API Beispiele
Industrial Dual Relay 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
Moisture API Beispiele
Motion Detector API Beispiele
Motion Detector 2.0 API Beispiele
Motorized Linear Poti API Beispiele
Multi Touch API Beispiele
NFC API Beispiele
OLED 128x64 API Beispiele
OLED 128x64 2.0 API Beispiele
OLED 64x48 API Beispiele
One Wire API Beispiele
Outdoor Weather API Beispiele
Particulate Matter API Beispiele
Piezo Speaker API Beispiele
Piezo Speaker 2.0 API Beispiele
PTC 2.0 API Beispiele
Real-Time Clock API Beispiele
Real-Time Clock 2.0 API Beispiele
Remote Switch 2.0 API Beispiele
RGB LED API Beispiele
RGB LED 2.0 API Beispiele
RGB LED Button API Beispiele
Rotary Encoder 2.0 API Beispiele
Rotary Poti 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
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 API Beispiele
UV Light 2.0 API Beispiele
Voltage/Current 2.0 API Beispiele
     
Bricklets (Abgekündigt)    
Ambient Light API Beispiele
Ambient Light 2.0 API Beispiele
Analog In API Beispiele
Analog In 2.0 API Beispiele
Analog Out API Beispiele
CO2 API Beispiele
Current12 API Beispiele
Current25 API Beispiele
Distance US API Beispiele
GPS API Beispiele
Humidity 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
NFC/RFID API Beispiele
Piezo Buzzer API Beispiele
PTC API Beispiele
Remote Switch API Beispiele
RGB LED Matrix API Beispiele
Rotary Encoder API Beispiele
Solid State Relay API Beispiele
Temperature IR API Beispiele
Thermocouple API Beispiele
Voltage API Beispiele
Voltage/Current API Beispiele