A framework for working with Arduinos in node.js
npm install duino
var arduino = require('duino'),
board = new arduino.Board();
var led = new arduino.Led({
board: board,
pin: 13
});
led.blink();
The way this works is simple (in theory, not in practice). The Arduino listens for low-level signals over a serial port, while we abstract all of the logic on the Node side.
- Plug in your Arduino
- Upload the C code at
./src/du.ino
to it - Write a simple duino script
- ?????
- Profit!
##board
Right now, the board library will attempt to autodiscover the Arduino. I'm going to make it configurable, don't worry.
var board = new arduino.Board({
debug: true
});
Debug mode is off by default. Turning it on will enable verbose logging in your terminal, and tell the Arduino board to echo everthing back to you. You will get something like this:
The board object is an EventEmitter. You can listen for the following events:
data
raw output from the serial portmessage
on newline, emits all data since the last newlineconnected
when the serial port has connectedready
when all internal post-connection logic has finished and the board is ready to use
board.on('ready', function(){
// do stuff
});
board.on('message', function(m){
console.log(m);
}
###board.serial
Low-level access to the serial connection to the board
###board.write(msg)
Write a message to the board, wrapped in predefined delimiters (! and .)
###board.pinMode(pin, mode)
Set the mode for a pin. mode
is either 'in'
or 'out'
###board.digitalWrite(pin, val)
Write one of the following to a pin:
####board.HIGH and board.LOW
Constants for use in low-level digital writes
##led
var led = new arduino.Led({
board: board,
pin: 13
});
Pin will default to 13.
###led.on()
Turn the LED on
###led.off()
Turn the LED off
###led.blink(interval)
Blink the LED at interval
ms. Defaults to 1000
##piezo
var led = new arduino.Piezo({
board: board,
pin: 13
});
Pin will default to 13.
###piezo.note(note, duration)
Play a pre-calculated note for a given duration (in milliseconds).
note
must be a string, one of d
, e
, f
, g
, a
, b
, or c
(must be lowercase)
###piezo.tone(tone, duration)
Write a square wave to the piezo element.
tone
and duration
must be integers. See code comments for math on tone
generation.
##button
##servo
##motor
##potentiometer
Each message sent to the Arduino board by the board class has 8 bytes.
A full message looks like this:
!011301.
!
Start
01
Command (digitalWrite)
13
Pin number
01
Value (high)
.
Stop
I was drunk. It works.
##command
What is implemented right now:
00
pinMode01
digitalWrite
##pin
I haven't tested analog pins yet. Soon. Digital pins 0-13 tested.
##value
00
low01
high
(The MIT License)
Copyright (c) 2011 Cam Pedersen cam@onswipe.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.