Shell - API Bindings

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

  • tinkerforge, ein Python Skript, das als Shell Befehl agiert
  • tinkerforge-bash-completion.sh, ein Bash Completion Skript
  • in examples/ die Beispiele für alle Bricks und Bricklets

Die Shell Bindings basieren auf den Python Bindings.

Voraussetzungen

  • Python 2.6 oder neuer mit argparse Modul, Python 3 wird auch unterstützt

Installation

Die Shell Bindings können installiert werden, können aber auch ohne Installation verwendet werden.

Zur Installation wird die tinkerforge Datei in einen Ordner kopiert der sich im PATH befindet. Das kann unter Linux und macOS folgender Ordner sein:

/usr/local/bin/

Unter Windows bietet sich der Scripts/ Ordner der Python Installation an:

C:\Python27\Scripts\

Damit die Bindings unter Windows direkt aufgerufen werden können muss noch eine tinkerforge.bat Datei im Scripts/ Ordner mit folgendem Inhalt angelegt werden:

@"C:\Python27\python.exe" "C:\Python27\Scripts\tinkerforge"

Wenn sich die Python Installation nicht im C:\Python27\ Ordner befindet, dann ist natürlich der Inhalt der tinkerforge.bat Datei entsprechend abzuändern.

Bash Completion

Wird Bash als Shell verwendet so kann auch das Bash Completion Skript tinkerforge-bash-completion.sh installiert werden. Dazu die tinkerforge-bash-completion.sh Datei in den /etc/bash_completion.d/ Ordner kopieren und dann die Bash Completions mit folgendem Befehl neu laden:

. /etc/bash_completion

Die Bash Completion für tinkerforge kann Optionen, UIDs, Brick und Bricklet Namen sowie Funktions- und Callback-Namen vervollständigen.

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:

# change to your UID
uid=XYZ

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.

  API Beispiele
IP Connection API Beispiele
     
Bricks    
DC 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 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 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