JavaScript - API Bindings

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

  • nodejs/tinkerforge.tgz, ein Node.js NPM Package (installierbar mit npm Tool)
  • in nodejs/source/ den Quelltext für tinkerforge.tgz
  • in nodejs/examples/ die Node.js Beispiele für alle Bricks und Bricklets
  • in browser/source/ den Quelltext der Browser Version der Bindings
  • in browser/examples/ die HTML Beispiele für alle Bricks und Bricklets

Voraussetzungen

  • Node.js 0.10 oder neuer oder jeder aktuelle Browser mit WebSocket Unterstützung (getestet mit Chrome, Firefox und Internet Explorer)

Installation

Ob und wie die JavaScript Bindings installiert werden können oder müssen hängt von der Art der Verwendung ab.

Node.js

Die Node.js Version der Bindings können mit dem Node.js Package Manager npm installiert werden, müssen aber nicht.

Vom NPM Package

Für die Verwendung der Bindings mit Node.js steht in NPM Package bereit. Dies ist im Node.js Package Repository verfügbar und kann von dort mit folgendem Befehl global installiert werden. Möglicherweise muss dies mit sudo bzw. als Administrator ausgeführt werden:

npm -g install tinkerforge

Alternativ ist das NPM Package auch in der ZIP Datei der Bindings enthalten und kann mit folgendem Befehl global installiert werden. Möglicherweise muss dies mit sudo bzw. als Administrator ausgeführt werden:

npm -g install nodejs/tinkerforge.tgz

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

Ohne Installation

Die JavaScript Bindings für Node.js müssen nicht unbedingt installiert werden. Stattdessen kann auch einfach der Tinkerforge/ Ordner und die Tinkerforge.js Datei vom nodejs/source/ Ordner in den gleichen Ordner wie dein JavaScript Skript kopiert werden. Der Abschnitt über den Test eines Beispiels vermittelt mehr Details darüber.

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.

Test eines Beispiels

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

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 = 'XYZ'; // Change to your UID

Wenn die Bindings mittels NPM Package 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:

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.

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 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 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
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
Solid State Relay API Beispiele
Temperature IR API Beispiele
Thermocouple API Beispiele
Voltage API Beispiele
Voltage/Current API Beispiele