JavaScript - API Bindings

The JavaScript bindings allow you to control Bricks and Bricklets from your JavaScript scripts. The ZIP file for the bindings contains:

  • nodejs/tinkerforge.tgz, a Node.js NPM package (installable with npm tool)
  • in nodejs/source/ the source code of tinkerforge.tgz
  • in nodejs/examples/ the Node.js examples for every Brick and Bricklet
  • in browser/source/ the source code of the browser version of the bindings
  • in browser/examples/ the HTML examples for every Brick and Bricklet

Requirements

  • Node.js 0.10 or newer, or any recent browser with WebSocket support (tested with Chrome, Firefox and Internet Explorer)

Installation

If and how the JavaScript bindings should or have to be installed depends on how they should be used.

Node.js

The Node.js version of the bindings can be installed with the Node.js Package Manager npm, but you don't have to.

From NPM Package

There is a NPM package available for using the Bindings with Node.js. It is available from the Node.js Package Repository and can be installed globally with the following command which might has to execute with sudo or as administrator:

npm -g install tinkerforge

Alternatively, the NPM Package is also part of the ZIP file of the bindings. It can be installed globally from there as well with the following command which might has to execute with sudo or as administrator:

npm -g install nodejs/tinkerforge.tgz

Now you're ready to test the examples. The NPM package does not include the examples. Those are available as part of the bindings ZIP file.

Without Installation

You can use the JavaScript bindings for Node.js without having to install them. Just copy the Tinkerforge/ folder and the Tinkerforge.js file from the nodejs/source/ folder in the same folder as your JavaScript script. The section about testing an example has more details about this.

HTML

The browser version of the bindings can be found in the browser/source/ folder. The Tinkerforge.js file contains the complete bindings. Just copy this file into the same directory as your HTML file using the bindings. The section about testing an example has more details about this.

Testing an Example

To test a JavaScript example Brick Daemon and Brick Viewer have to be installed first. Brick Daemon acts as a proxy between the USB interface of the Bricks and the API bindings. Brick Viewer connects to Brick Daemon and helps to figure out basic information about the connected Bricks and Bricklets.

Node.js

As an example let's test the configuration example for the Stepper Brick. For this copy the ExampleConfiguration.js file from the nodejs/examples/Brick/Stepper/ folder into a new folder:

example_project/
 -> ExampleConfiguration.js

In the example HOST and PORT specify at which network address the Stepper Brick can be found. If it is connected locally to USB then localhost and 4223 is correct. The UID value has to be changed to the UID of the connected Stepper Brick, which you can figure out using Brick Viewer:

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change to your UID

If you did install the bindings using the NPM package then you're now ready to test this example:

node ExampleConfiguration.js

If you did not install the bindings then you can also use the source of the bindings directly. Just copy the Tinkerforge/ folder and the Tinkerforge.js file from the nodejs/source/ folder to your example_project/ folder:

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

Then the require statement in ExampleConfiguration.js has to be modified as follows. Instead of:

var Tinkerforge = require('tinkerforge');

use:

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

Now you're ready to test this example:

node ExampleConfiguration.js

HTML

The Browser version of the JavaScript bindings is using WebSockets. WebSockets are supported by Brick Daemon (since version 2.1.0) and the Ethernet Extension (since Master Brick firmware version 2.2.0), but they are disabled by default and need to be configured first:

As an example let's test the configuration example for the Stepper Brick. For this copy the ExampleConfiguration.html file from the browser/examples/Brick/Stepper/ folder and the Tinkerforge.js file from the browser/source/ folder into a new folder:

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

Now you're ready to open this example in a browser.

The example contains input boxes for host and port information. You have to specify at which network address the Stepper Brick can be found. If it is connected locally to USB then localhost and 4280 is correct. The UID value has to be changed to the UID of the connected Stepper Brick, which you can figure out using Brick Viewer. If every<thing is configured correctly you can start the example the clicking the "Start Example" button.

API Reference and Examples

Links to the API reference for the IP Connection, Bricks and Bricklets as well as the examples from the ZIP file of the bindings are listed in the following table. Further project descriptions can be found in the Starter Kits section.

  API Examples
IP Connection API Examples
     
Bricks    
DC API Examples
IMU API Examples
IMU 2.0 API Examples
Master API Examples
RED API Examples
Servo API Examples
Silent Stepper API Examples
Stepper API Examples
     
Bricklets    
Accelerometer API Examples
Ambient Light API Examples
Ambient Light 2.0 API Examples
Analog In API Examples
Analog In 2.0 API Examples
Analog Out API Examples
Analog Out 2.0 API Examples
Barometer API Examples
CAN API Examples
CO2 API Examples
Color API Examples
Current12 API Examples
Current25 API Examples
Distance IR API Examples
Distance US API Examples
Dual Button API Examples
Dual Relay API Examples
Dust Detector API Examples
GPS API Examples
GPS 2.0 API Examples
Hall Effect API Examples
Humidity API Examples
Industrial Analog Out API Examples
Industrial Digital In 4 API Examples
Industrial Digital Out 4 API Examples
Industrial Dual 0-20mA API Examples
Industrial Dual Analog In API Examples
Industrial Quad Relay API Examples
IO-16 API Examples
IO-4 API Examples
Joystick API Examples
Laser Range Finder API Examples
LCD 16x2 API Examples
LCD 20x4 API Examples
LED Strip API Examples
Line API Examples
Linear Poti API Examples
Load Cell API Examples
Moisture API Examples
Motion Detector API Examples
Multi Touch API Examples
NFC/RFID API Examples
OLED 128x64 API Examples
OLED 64x48 API Examples
Piezo Buzzer API Examples
Piezo Speaker API Examples
PTC API Examples
Real-Time Clock API Examples
Remote Switch API Examples
RGB LED API Examples
Rotary Encoder API Examples
Rotary Poti API Examples
RS232 API Examples
Segment Display 4x7 API Examples
Solid State Relay API Examples
Sound Intensity API Examples
Temperature API Examples
Temperature IR API Examples
Thermocouple API Examples
Tilt API Examples
UV Light API Examples
Voltage API Examples
Voltage/Current API Examples