Python - API Bindings

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

  • in source/ den Quelltext der Bindings (inklusive setup.py Installations Skript)
  • in examples/ die Beispiele für alle Bricks und Bricklets

Voraussetzungen

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

Installation

Die Python Bindings können auf zwei Weisen installiert werden: von PyPI oder vom Quelltext. Die Bindings können aber auch ohne Installation genutzt werden.

Von PyPI

Die Bindings stehen auch im Python Package Index PyPI bereit. Von dort können sie mit dem Python Package Installer pip und folgendem Befehl installiert werden (dazu wird die ZIP Datei der Bindings nicht benötigt). Abhängig von der Art der Python Installation muss dies möglicherweise mit sudo bzw. als Administrator ausgeführt werden:

pip install tinkerforge

Dann ist auch schon alles bereit, um Beispiele testen zu können. Das PyPI Package beinhaltet keine Beispiele. Diese sind als Teil der ZIP Datei der Bindings verfügbar.

Vom Quelltext

Der source/ Ordner beinhaltet ein setup.py Installations Skript, welches die setuptools für Python benötigt. Um die Bindings zu installieren muss nur dieses Skript im source/ Ordner ausgeführt werden. Abhängig von der Art der Python Installation muss dies möglicherweise mit sudo bzw. als Administrator ausgeführt werden:

python setup.py install

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

Ohne Installation

Die Python Bindings müssen nicht unbedingt installiert werden. Stattdessen kann auch einfach der tinkerforge/ Ordner vom source/ Ordner in den gleichen Ordner wie dein Python Skript kopiert werden und Python wird die Bindings automatisch finden. Der Abschnitt über den Test eines Beispiels vermittelt mehr Details darüber.

Test eines Beispiels

Um ein Python 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 getestet. Dafür muss zuerst die example_configuration.py Datei aus dem examples/brick/stepper/ Ordner in einen neuen Ordner kopiert werden:

example_project/
 -> example_configuration.py

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

Wenn die Bindings vom Quelltext oder von PyPI installiert wurden, dann kann das Beispiel jetzt direkt ausgeführt werden:

python example_configuration.py

Wenn die Bindings nicht installiert wurden, dann kann der Quelltext der Bindings auch direkt verwendet werden. Dafür muss der tinkerforge/ Ordner vom source/ Ordner in den example_project/ Ordner kopiert werden und Python wird die Bindings automatisch finden:

example_project/
 -> tinkerforge/
 -> example_configuration.py

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

python example_configuration.py

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 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
Air Quality API Beispiele
Ambient Light 2.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 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
GPS 2.0 API Beispiele
Hall Effect 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
Laser Range Finder API Beispiele
LCD 128x64 API Beispiele
LCD 20x4 API Beispiele
LED Strip 2.0 API Beispiele
Line API Beispiele
Linear Poti 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
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 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
Solid State Relay 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
Analog In API Beispiele
Analog In 2.0 API Beispiele
Analog Out 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
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
Temperature IR API Beispiele
Thermocouple API Beispiele
Voltage API Beispiele
Voltage/Current API Beispiele