The Node.js version of the bindings can be installed with the Node.js Package Manager npm, but you don't have to.
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.
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.
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:
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');
var Tinkerforge = require('./Tinkerforge.js');
Now you're ready to test this example:
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.
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.
|Ambient Light 2.0||API||Examples|
|Analog In 2.0||API||Examples|
|Analog Out 2.0||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|
|Laser Range Finder||API||Examples|
|Motorized Linear Poti||API||Examples|
|RGB LED Button||API||Examples|
|RGB LED Matrix||API||Examples|
|Segment Display 4x7||API||Examples|
|Solid State Relay||API||Examples|