JavaScript - API Bindings¶

Node.js¶

There are two ways to install the Node.js version of the bindings: from our APT repository for Debian based Linux distributions or from NPM package. But the bindings can also be used without installing them first.

sudo apt install node-tinkerforge

npm install tinkerforge

npm install nodejs/tinkerforge.tgz

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.

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 = 'XXYYZZ'; // Change XXYYZZ to the UID of your Stepper Brick

If you did install the bindings 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:

• Brick Daemon: WebSockets

• Ethernet Extension: WebSockets

• WIFI Extension 2.0: Ports (WebSocket)

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.