JavaScript - API Bindings¶

Node.js¶

Die Node.js Version der Bindings können auf zwei Weisen installiert werden: von unserem APT Repository für Debian basierte Linux Distributionen oder vom NPM Package. Die Bindings können aber auch ohne Installation genutzt werden.

sudo apt install node-tinkerforge

npm install tinkerforge

npm -g install nodejs/tinkerforge.tgz

HTML¶

Für die Verwendung der Bindings im Browser steht im browser/source/ Ordner eine Tinkerforge.js Datei bereit, die die kompletten Bindings beinhaltet. Diese wird einfach in das gleiche Verzeichnis wie deine HTML Datei kopiert. Der Abschnitt über den Test eines Beispiels vermittelt mehr Details darüber.

Node.js¶

Als Beispiel wird im Folgenden das Konfigurationsbeispiel des Stepper Bricks getestet. Dafür muss zuerst die ExampleConfiguration.js Datei aus dem nodejs/examples/Brick/Stepper/ Ordner in einen neuen Ordner kopiert werden:

example_project/
 -> ExampleConfiguration.js

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:

var HOST = 'localhost';
var PORT = 4223;
var 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:

node ExampleConfiguration.js

Wenn die Bindings nicht installiert wurden, dann kann der Quelltext der Bindings auch direkt verwendet werden. Dafür muss der Tinkerforge/ Ordner und die Tinkerforge.js Datei vom nodejs/source/ Ordner in den example_project/ Ordner kopiert werden:

example_project/
 -> Tinkerforge/
 -> Tinkerforge.js
 -> ExampleConfiguration.js

Dann muss noch der require Aufruf in ExampleConfiguration.js angepasst werden. Statt:

var Tinkerforge = require('tinkerforge');

muss dort nun dies stehen:

var Tinkerforge = require('./Tinkerforge.js');

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

node ExampleConfiguration.js

HTML¶

Die Browser Version der JavaScript Bindings verwendet WebSockets. WebSockets werden von Brick Daemon (seit Version 2.1.0) und der Ethernet Extension (seit Master Brick Firmware Version 2.2.0) unterstützt. Sie sind allerdings standardmäßig nicht aktiviert und müssen erst konfiguriert werden:

• Brick Daemon: WebSockets
• Ethernet Extension: WebSockets
• WIFI Extension 2.0: Ports (WebSocket)

Als Beispiel wird im Folgenden das Konfigurationsbeispiel des Stepper Bricks getestet. Dafür muss zuerst die ExampleConfiguration.html Datei aus dem browser/examples/Brick/Stepper/ Ordner und die Tinkerforge.js Datei aus dem browser/source/ Ordner in einen neuen Ordner kopiert werden:

example_project/
 -> Tinkerforge.js
 -> ExampleConfiguration.html

Dann ist auch schon alles bereit, um dieses Beispiel im Browser zu öffnen.

Am Anfang des Beispiels gibt es Eingabefelder für Host und Port. Hier muss angegeben werden unter welcher Netzwerkadresse der Stepper Brick zu erreichen ist. Ist er lokal per USB angeschlossen dann ist localhost und 4280 richtig. Als UID muss die UID des angeschlossen Stepper Bricks angegeben werden, diese kann über den Brick Viewer ermittelt werden. Ist alles richtig eingegeben kann über den "Start Example" Knopf das Beispiel gestartet werden.