arduino-firmata

Arduino Firmata implementation for Node.js

arduino-firmata

Arduino Firmata protocol (http://firmata.org) implementation on Node.js.

Firmata is a protocol to controll Arduino from software on PC.
You can embed Arduino code into Node.js application.
Support sharing an Arduino between multiple processes.
https://github.com/shokai/node-arduino-firmata
https://npmjs.org/package/arduino-firmata

Install

% npm install arduino-firmata

Requirements

Arduino (http://arduino.cc)
- testing with
  - Arduino Diecimila
  - Arduino Duemillanove
  - Arduino UNO
  - Arduino Leonardo
  - Arduino Micro
  - Seeduino v2
Arduino Standard Firmata v2.2
- Arduino IDE -> [File] -> [Examples] -> [Firmata] -> [StandardFirmata]

Usage

Samples

https://github.com/shokai/node-arduino-firmata/tree/master/samples

Setup

Connect

var ArduinoFirmata = require('arduino-firmata');
var arduino = new ArduinoFirmata();
 
arduino.connect(); // use default arduino 
arduino.connect('/dev/tty.usb-device-name');
 
arduino.on('connect', function(){
 
  console.log("board version"+arduino.boardVersion);
  // your-code-here 
 
});

Reset

arduino.reset(callback);

arduino.close(callback);

I/O

Digital Write

arduino.digitalWrite(13, true, callback);
arduino.digitalWrite(13, false, callback);

Digital Read

arduino.pinMode(7, ArduinoFirmata.INPUT);
console.log( arduino.digitalRead(7) ); // => true/false

Digital Read (event)

arduino.pinMode(7, ArduinoFirmata.INPUT);
 
arduino.on('digitalChange', function(e){
  console.log("pin" + e.pin + " : " + e.old_value + " -> " + e.value);
});

Analog Write (PWM)

setInterval(function(){
  var an = Math.random()*255; // 0 ~ 255
  arduino.analogWrite(9, an, callback);
}, 100);

Analog Read

console.log( arduino.analogRead(0) ); // => 0 ~ 1023

Analog Read (event)

arduino.on('analogChange', function(e){
  console.log("pin" + e.pin + " : " + e.old_value + " -> " + e.value);
});

Servo Motor

setInterval(function(){
  var angle = Math.random()*180; // 0 ~ 180 
  arduino.servoWrite(11, angle, callback);
}, 1000);

Sysex

Send

arduino.sysex(0x01, [13, 5, 2], callback);  // command, data_array, callback

arduino.on('sysex', function(e){
  console.log("command : " + e.command);
  console.log(e.data);
});

Develop

% npm install
% npm run build
# or
% npm run watch

Test

Install SysexLedBlinkFirmata into Arduino

https://github.com/shokai/node-arduino-firmata/blob/master/samples/sysex/StandardFirmataWithLedBlink/StandardFirmataWithLedBlink.ino

Run Test

% npm test

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Develop front-end JavaScript?

Help us make npm better.

Tell us how you develop, build, and ship front-end JavaScript, and we’ll help make it easier. Take the survey »

how? learn more

shokai published 2016-02-18T11:54:57.479Z
0.3.4 is the latest of 13 releases
github.com/shokai/node-arduino-firmata
MIT ®

Collaborators

Stats

4 downloads in the last day
65 downloads in the last week
321 downloads in the last month
Have an issue? File it. on GitHub
on GitHub

Stats

Try it out

Keywords

Dependencies (3)