- Einstieg
- Hardware
- Software
- Brick Daemon (brickd)
- Brick Viewer (brickv)
- Brick Logger
- API Bindings
- ESP32 Firmware
- APT Repository
- Device Identifier
- Quelltexte und Bug Tracking
- Programmierschnittstelle
- Kits
- Embedded Boards
- Spezifikationen
Ruby - API Bindings¶
Die Ruby Bindings ermöglichen es Bricks und Bricklets aus selbst erstellen Ruby Programmen heraus zu steuern. Die ZIP Datei für die Bindings beinhaltet:
tinkerforge.gem, ein Ruby GEM (installierbar mit gem Tool)- in
source/den Quelltext fürtinkerforge.gem - in
examples/die Beispiele für alle Bricks und Bricklets
Voraussetzungen¶
- Ruby 1.9 oder neuer
Installation¶
Die Ruby Bindings können auf zwei Weisen installiert werden: von unserem APT Repository für Debian basierte Linux Distributionen oder vom GEM. Die Bindings können aber auch ohne Installation genutzt werden.
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 ruby-tinkerforge
Dann ist auch schon alles bereit, um Beispiele testen zu können. Das Debian Package beinhaltet keine Beispiele. Diese sind als Teil der ZIP Datei der Bindings verfügbar.
Vom GEM¶
Die Bindings stehen als GEM auf rubygems.org bereit. Von dort können sie mit
dem gem Tool und folgendem Befehl
installiert werden (dazu wird die ZIP Datei der Bindings nicht benötigt).
Abhängig von der Art der Ruby Installation muss dies möglicherweise mit
sudo bzw. als Administrator ausgeführt werden:
gem install tinkerforge
Alternativ ist der GEM auch in der ZIP Datei der Bindings enthalten und kann
mit folgendem Befehl installiert werden. Möglicherweise muss dies mit sudo
bzw. als Administrator ausgeführt werden:
gem install tinkerforge.gem
Dann ist auch schon alles bereit, um Beispiele testen zu können. Der GEM beinhaltet keine Beispiele. Diese sind als Teil der ZIP Datei der Bindings verfügbar.
Ohne Installation¶
Die Bindings müssen nicht unbedingt installiert werden. Stattdessen kann auch
einfach der tinkerforge/ Ordner vom source/ Ordner in den gleichen
Ordner wie dein Ruby Programm kopiert werden. Der Abschnitt über den Test eines
Beispiels vermittelt mehr Details darüber.
Test eines Beispiels¶
Um ein Ruby 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.rb Datei aus dem
examples/brick/stepper/ Ordner in einen neuen Ordner kopiert werden:
example_project/
-> example_configuration.rb
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 = 'XXYYZZ' # Change XXYYZZ to the UID of your Stepper Brick
Wenn die Bindings installiert wurden, dann kann das Beispiele jetzt direkt ausgeführt werden:
ruby example_configuration.rb
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:
example_project/
-> tinkerforge/
-> example_configuration.rb
Dann ist auch schon alles bereit, um dieses Beispiel testen zu können.
Damit Ruby den tinkerforge/ Ordner findet muss es per -I. Option
angewiesen werden im aktuelle Ordner danach zu suchen:
ruby -I. example_configuration.rb
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.