Shell - API Bindings¶

Voraussetzungen¶

• Python 3.4 oder neuer

Installation¶

Die Shell Bindings können auf zwei Weisen installiert werden: von unserem APT Repository für Debian basierte Linux Distributionen oder durch händisches Kopieren der Dateien an die richtige Stelle. Die Bindings können aber auch ohne Installation genutzt werden.

sudo apt install tinkerforge-shell

/usr/local/bin/

C:\Python\Scripts\

@"C:\Python\python.exe" "C:\Python\Scripts\tinkerforge" %*

. /etc/bash_completion

Test eines Beispiels¶

Um ein Shell 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.

Alle Beispiele sind für typische Unix Shells wie z.B. Bash gemacht. Sie funktionieren auf Linux und macOS so wie sie sind. Es gibt Portierungen von Bash für Windows, die es ermöglichen die Beispiele unverändert auszuführen.

Als Beispiel wird im Folgenden das Konfigurationsbeispiel des Stepper Bricks getestet. Dafür muss zuerst die example-configuration.sh Datei aus dem examples/brick/stepper/ Ordner in einen neuen Ordner kopiert werden:

example_project/
 -> example-configuration.sh

Wenn die Bindings nicht installiert wurden, dann muss die tinkerforge Datei in den example_project/ Ordner kopiert werden:

example_project/
 -> tinkerforge
 -> example-configuration.sh

Damit das Beispiel die nicht installierte tinkerforge Datei finden kann muss jedes Auftreten des tinkerforge Befehls in der example-configuration.sh Datei durch ./tinkerforge ersetzt werden.

Am Anfang des Beispiels steht ein Kommentar der darauf hinweist die Netzwerkadresse mittels --host und --port Option anzugeben, wenn sie von localhost:4223 abweicht. Wenn der Stepper Brick lokal per USB angeschlossen dann ist localhost und 4223 richtig.

# connects to localhost:4223 by default, use --host and --port to change it

Um z.B. zu einen Stepper Brick zu steuern, der an Host foobar und Port 5678 erreichbar ist dann muss das Beispiel so abgewandelt werden: Jedes Auftreten des tinkerforge Befehls muss durch diesen Ausdruck ersetzt werden:

tinkerforge --host foobar --port 5678

Als uid muss die UID des angeschlossen Stepper Bricks angegeben werden, diese kann über den Brick Viewer ermittelt werden:

uid=XXYYZZ # Change XXYYZZ to the UID of your Stepper Brick

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

./example-configuration.sh

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.