Node.js Language Binding for ev3dev
This is a Node.js module that exposes the features of the ev3dev API in an easy-to-use structure. It is part of the "unified" bindings project for ev3dev, which means it implements our abstract API specification. This specification is implemented in multiple languages so that one can easily carry the same code concepts from one language to another, and all the core ev3dev APIs are supported universally.
Current supported kernel version:
Install the module from
$ npm install ev3dev-lang
Now add a
require statement to your
var ev3dev = require('ev3dev-lang');
Now check out the online documentation to see what you can do. Note that all the classes listed in the docs are available in the
ev3dev object that you imported above.
Getting the Module
Installing the latest release from npm
The easiest way to get the module is to install it through
$ npm install ev3dev-lang
require() it for use in your code.
Downloading the source code and compiling yourself
You can also download the source from GitHub directly, either from the releases page or via git. If you do it this way, you will need to follow the building instructions below to make it usable from Node.
First, you will need to install some tools. Both building and running the module will require Node.js and
npm, so make sure that you have both installed. Then install grunt, the task runner that we use to build the library:
$ npm install -g grunt-cli
Once you have done this, run
grunt --version to make sure that everything was installed correctly (you may have to restart your terminal window first). Next you'll need to get the source code. You can
git clone it to get the most recent changes, or download a release from the releases page. The following commands will need to be executed from the root directory of the source tree so
cd in to that directory before continuing.
Now we will install the last few tools that we need. The list of dependencies for the module is pre-defined in the
package.json file, so all we need to do is to tell
npm to install them for us:
$ npm install
The final step is to run the build job. We can invoke the task runner that we installed earlier to do this:
$ grunt tsc
Getting started with the API
We recommend that you start by running the files in the
examples/ subdirectory of the repo so that you can make sure that your system is set up correctly. Assuming you don't get any errors, you can create your own
js file and
ev3dev-lang module to start writing your own code. For reference, you can take a look at the example scripts or check out the online documentation.
Executing your Node.js scripts
The simplest way is to run your code from the command line with the
node command. This can be done over an SSH session or directly on the brick. To run a
.js file, execute:
$ node path/to/file.js
If you want to be able to execute your scripts from brickman's file browser, you can add a shebang and make it executable. You first must add the following code to the top of your
You can then make it executable from the command line:
$ chmod +x path/to/file.js
You should now be able to execute it directly from brickman.
- Programming a web interface, where you need to serve files
- Responding to commands sent by an external controller (maybe a PC and browser)
- Continuously taking input
- Running a job on a timer
- Running any code that only occasionally "wakes up"
Situations in which you should use other languages:
- Sequential actions that must run in a specific order
- Precise timing and delay
- Coordinating multiple motors, sensors, or other hardware devices