Merge branch 'master' into HEAD

Conflicts:
	examples/rc.js
	index.js
	lib/board.js
	lib/rc.js
	package.json
	src/du.ino

Author: tjanson

README.md

@@ -36,7 +36,16 @@ The way this works is simple (in theory, not in practice). The Arduino listens f
 
 ##board
 
-Right now, the board library will attempt to autodiscover the Arduino. I'm going to make it configurable, don't worry.
+````javascript
+var board = new arduino.Board({
+  device: "ACM"
+});
+````
+The board library will attempt to autodiscover the Arduino.
+The `device` option can be used to set a regex filter that will help the library when scanning for matching devices.
+**Note**: the value of this parameter will be used as argument of the grep command
+
+If this parameter is not provided the board library will attempt to autodiscover the Arduino by quering every device containing 'usb' in its name.
 
 ````javascript
 var board = new arduino.Board({
@@ -119,6 +128,67 @@ Fade the to full brightness then back to minimal brightness in `interval` ms. De
 
 Current brightness of the LED
 
+##lcd
+
+This is a port of the [LiquidCrystal library](http://arduino.cc/en/Reference/LiquidCrystal) into JavaScript. Note that communicating with the LCD requires use of the synchronous `board.delay()` busy loop which will block other node.js events from being processed for several milliseconds at a time. (This could be converted to pause a board-level buffered message queue instead.)
+
+````javascript
+var lcd = new d.LCD({
+  board: board,
+  pins: {rs:12, rw:11, e:10, data:[5, 4, 3, 2]}
+});
+lcd.begin(16, 2);
+lcd.print("Hello Internet.");
+````
+
+In `options`, the "pins" field can either be an array matching a call to any of the [LiquidCrystal constructors](http://arduino.cc/en/Reference/LiquidCrystalConstructor) or an object with "rs", "rw" (optional), "e" and a 4- or 8-long array of "data" pins. Pins will default to `[12, 11, 5, 4, 3, 2]` if not provided.
+
+###lcd.begin(), lcd.clear(), lcd.home(), lcd.setCursor(), lcd.scrollDisplayLeft(), lcd.scrollDisplayRight()
+
+These should behave the same as their counterparts in the [LiquidCrystal library](http://arduino.cc/en/Reference/LiquidCrystal).
+
+###lcd.display(on), lcd.cursor(on), lcd.blink(on), lcd.autoscroll(on)
+
+These are similar to the methods in the [LiquidCrystal library](http://arduino.cc/en/Reference/LiquidCrystal), however they can take an optional boolean parameter. If true or not provided, the setting is enabled. If false, the setting is disabled. For compatibility `.noDisplay()`, `.noCursor()`, `.noBlink()` and `.noAutoscroll()` methods are provided as well.
+
+###lcd.write(val), lcd.print(val)
+
+These take a buffer, string or integer and send it to the display. The `.write` and `print` methods are equivalent, aliases to the same function.
+
+###lcd.createChar(location, charmap)
+
+Configures a custom character for code `location` (numbers 0–7). `charmap` can be a 40-byte buffer as in [the C++ method](http://arduino.cc/en/Reference/LiquidCrystalCreateChar), or an array of 5-bit binary strings, or a 40-character string with pixels denoted by any non-space (`' '`) character. These bits determine the 5x8 pixel pattern of the custom character.
+
+````javascript
+var square = new Buffer("1f1f1f1f1f1f1f1f", 'hex');
+
+var smiley = [
+  '00000',
+  '10001',
+  '00000',
+  '00000',
+  '10001',
+  '01110',
+  '00000'
+];
+
+var random =
+  ".  .." +
+  " . . " +
+  ". . ." +
+  " . . " +
+  " ..  " +
+  ".  . " +
+  " .  ." +
+  ".. .." ;
+
+lcd.createChar(0, square);
+lcd.createChar(1, smiley);
+lcd.createChar(2, random);
+lcd.setCursor(5,2);
+lcd.print(new Buffer("\0\1\2\1\0"));    // NOTE: when `.print`ing a string, 'ascii' turns \0 into a space
+````
+
 ##piezo
 
 ````javascript
@@ -164,6 +234,20 @@ setInterval(function(){
 }, 1000);
 ````
 
+##ping
+
+See: <http://arduino.cc/en/Tutorial/Ping>
+
+````javascript
+var range = new arduino.Ping({
+  board: board
+});
+
+range.on('read', function () {
+  console.log("Distance to target (cm)", range.centimeters);
+});
+````
+
 ##servo
 
 ````javascript
@@ -213,6 +297,8 @@ What is implemented right now:
 *  `02` digitalRead
 *  `03` analogWrite
 *  `04` analogRead
+*  `97` ping
+*  `98` servo
 *  `99` debug
 
 ##pin

examples/adjustable-port.js

@@ -0,0 +1,15 @@
+var arduino = require('../');
+
+var board = new arduino.Board({
+  debug: true,
+  device: "ACM"
+});
+
+var led = new arduino.Led({
+  board: board,
+  pin: "13"
+});
+
+board.on('ready', function(){
+  led.blink();
+});

examples/rc.js

@@ -12,6 +12,7 @@ var rc = new arduino.RC({
 
 board.on('ready', function(){
   setTimeout(function() {
+    // alternative: rc.decimal("123456")
   	rc.triState("0FFF0FFFFF0F");
   }, 1000);
   setTimeout(function() {

index.js

@@ -8,6 +8,7 @@ module.exports = {
   Sensor: require('./lib/sensor'),
   Ping:   require('./lib/ping'),
   PIR:    require('./lib/pir'),
+  LCD:    require('./lib/lcd'),
   RC:     require('./lib/rc'),
   IR:     require('./lib/ir')
 };

lib/board.js

@@ -2,7 +2,7 @@
 var events = require('events'),
     child  = require('child_process'),
     util   = require('util'),
-    colors = require('colors'),
+    chalk  = require('chalk'),
     serial = require('serialport');
 
 /*
@@ -12,6 +12,7 @@ var events = require('events'),
 var Board = function (options) {
   this.log('info', 'initializing');
   this.debug = options && options.debug || false;
+  this.device = options && options.device || 'usb|ttyACM*|ttyS0';
   this.baudrate = options && options.baudrate || 115200;
   this.writeBuffer = [];
 
@@ -28,7 +29,7 @@ var Board = function (options) {
 
       self.log('info', 'binding serial events');
       self.serial.on('data', function(data){
-        self.log('receive', data.toString().red);
+        self.log('receive', chalk.red(data.toString()));
         self.emit('data', data);
       });
 
@@ -72,7 +73,7 @@ util.inherits(Board, events.EventEmitter);
 Board.prototype.detect = function (callback) {
   this.log('info', 'attempting to find Arduino board');
   var self = this;
-  child.exec('ls /dev | grep ACM', function(err, stdout, stderr){
+  child.exec('ls /dev | grep -E "'+ self.device +'"', function(err, stdout, stderr){
     var usb = stdout.slice(0, -1).split('\n'),
         found = false,
         err = null,
@@ -131,7 +132,7 @@ Board.prototype.write = function (m) {
     this.log('write', m);
     this.serial.write('!' + m + '.');
   } else {
-    this.log('info', 'serial not ready, buffering message: ' + m.red);
+    this.log('info', 'serial not ready, buffering message: ' + chalk.red(m));
     this.writeBuffer.push(m);
   }
 }
@@ -180,7 +181,7 @@ Board.prototype.pinMode = function (pin, val) {
 Board.prototype.digitalWrite = function (pin, val) {
   pin = this.normalizePin(pin);
   val = this.normalizeVal(val);
-  this.log('info', 'digitalWrite to pin ' + pin + ': ' + val.green);
+  this.log('info', 'digitalWrite to pin ' + pin + ': ' + chalk.green(val));
   this.write('01' + pin + val);
 }
 
@@ -196,7 +197,7 @@ Board.prototype.digitalRead = function (pin) {
 Board.prototype.analogWrite = function (pin, val) {
 	pin = this.normalizePin(pin);
 	val = this.normalizeVal(val);
-	this.log('info', 'analogWrite to pin ' + pin + ': ' + val.green);
+	this.log('info', 'analogWrite to pin ' + pin + ': ' + chalk.green(val));
 	this.write('03' + pin + val);
 }
 Board.prototype.analogRead = function (pin) {
@@ -219,7 +220,7 @@ Board.prototype.delay = function (ms) {
 Board.prototype.log = function (/*level, message*/) {
   var args = [].slice.call(arguments);
   if (this.debug) {
-    console.log(String(+new Date()).grey + ' duino '.blue + args.shift().magenta + ' ' + args.join(', '));
+    console.log(chalk.gray(Date.now()) + chalk.blue(' duino ') + chalk.magenta(args.shift()) + ' ' + args.join(', '));
   }
 }