ecto · khirakawa · Mar 9, 2013 · Apr 17, 2013 · Apr 17, 2013 · Apr 17, 2013
diff --git a/README.md b/README.md
@@ -1,239 +1,48 @@
-# duino
+# [rf]duino
 
-A framework for working with Arduinos in node.js
+This fork of [ecto's duino library](https://github.com/ecto/duino) replaces the servo library with a RF receiver and transmitter.
 
-![arduino](http://i.imgur.com/eFq84.jpg)
-
-# install
+## install
 
     npm install duino
 
-# usage
+Make sure to upload src/du/du.ino to your arduino
+
+## receiver usage
 
 ````javascript
 var arduino = require('duino'),
     board = new arduino.Board();
 
-var led = new arduino.Led({
-  board: board,
-  pin: 13
-});
-
-led.blink();
-````
-
-# what ಠ_ಠ
-
-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.
-
-1.  Plug in your Arduino
-2.  Upload the C code at `./src/du.ino` to it
-3.  Write a simple **duino** script
-4.  ?????
-5.  Profit!
-
-# libraries
-
-##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({
-  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:
-
-![debug](http://i.imgur.com/gBYZA.png)
-
-The **board** object is an EventEmitter. You can listen for the following events:
-
-* `data` messages from the serial port, delimited by newlines
-* `connected` when the serial port has connected
-* `ready` when all internal post-connection logic has finished and the board is ready to use
-
-````javascript
 board.on('ready', function(){
-  // do stuff
-});
-
-board.on('data', 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
-
-###board.analogWrite(pin,val)
-
-Write a value between 0-255 to a pin
-
-##led
-
-````javascript
-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
 
-###led.fade(interval)
+  var rfReceiver = new arduino.RFReceiver({
+    board: board,
+    pin: '02'
+  });
 
-Fade the to full brightness then back to minimal brightness in `interval` ms. Defaults to 2000
-
-###led.bright
-
-Current brightness of the LED
-
-##piezo
-
-````javascript
-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
-
-````javascript
-var button = new arduino.Button({
-  board: board,
-  pin: 13
+  rfReceiver.on('read', function(err, data){
+    console.log("data", data);
+  });
 });
 ````
-Pin will default to 13.
 
-Buttons are simply EventEmitters. They will emit the events `up` and `down`. You may also access their `down` property.
+## transmitter usage
 
 ````javascript
-button.on('down', function(){
-  // delete the database!
-  console.log('BOOM');
-});
+var arduino = require('duino'),
+    board = new arduino.Board();
 
-setInterval(function(){
-  console.log(button.down);
-}, 1000);
-````
+board.on('ready', function(){
 
-##servo
+  var rfTransmitter = new arduino.RFTransmitter({
+    board: board,
+    pin: '03'
+  });
 
-````javascript
-var servo = new arduino.Servo({
-  board: board
+  rfTransmitter.send("hey there delilah");
 });
-
-servo.write(0);
-servo.write(180);
 ````
-Pin will default to 9. (Arduino PWM default)
-
-###servo.sweep()
-
-Increment position from 0 to 180.
-
-###servo.write(pos)
-
-Instruct the servo to immediately go to a position from 0 to 180.
-
-##motor
-
-##potentiometer
-
-# protocol
-
-Each message sent to the Arduino board by the **board** class has 8 bytes.
-
-A full message looks like this:
-
-    !0113001.
-
-`!` Start
-`01` Command (digitalWrite)
-`13` Pin number
-`001` Value (high)
-`.` Stop
-
-I was drunk. It works.
-
-##command
-
-What is implemented right now:
-
-*  `00` pinMode
-*  `01` digitalWrite
-*  `02` digitalRead
-*  `03` analogWrite
-*  `04` analogRead
-*  `99` debug
-
-##pin
-
-Pins can be sent as an integer or a string(`1`, `2`, `"3"`, `"A0"`)
-
-##value
-
-*  `board.LOW`(`0`)
-*  `board.HIGH`(`255`)
-*  integer/string from `0`-`255` for PWM pins
-
-# license
-
-(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.
 
+Note that the transmitter can only send up to 26 characters at a time.
+Messages may be dropped if messages are sent at high rates.
diff --git a/examples/servo.js b/examples/servo.js
diff --git a/index.js b/index.js
@@ -4,8 +4,9 @@ module.exports = {
   Led:    require('./lib/led'),
   Piezo:  require('./lib/piezo'),
   Button: require('./lib/button'),
-  Servo:  require('./lib/servo'),
   Sensor: require('./lib/sensor'),
   Ping:   require('./lib/ping'),
-  PIR:    require('./lib/pir')
+  PIR:    require('./lib/pir'),
+  RFReceiver: require('./lib/rfReceiver'),
+  RFTransmitter: require('./lib/rfTransmitter')
 };
diff --git a/lib/board.js b/lib/board.js
@@ -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';
   this.baudrate = options && options.baudrate || 115200;
   this.writeBuffer = [];
 
@@ -53,7 +54,7 @@ var Board = function (options) {
           self.processWriteBuffer();
         }
 
-        self.emit('ready');      
+        self.emit('ready');
       }, 500);
     }
   });
@@ -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 usb', function(err, stdout, stderr){
+  child.exec('ls /dev | grep "' + self.device + '"', function(err, stdout, stderr){
     var usb = stdout.slice(0, -1).split('\n'),
         found = false,
         err = null,
@@ -205,6 +206,24 @@ Board.prototype.analogRead = function (pin) {
 	this.write('04' + pin + this.normalizeVal(0));
 }
 
+/*
+ * Tell the board to read from RF receiver
+ */
+Board.prototype.rfRead = function (pin) {
+  pin = this.normalizePin(pin);
+  this.log('info', 'rfRead from pin ' + pin);
+  this.write('05' + pin + this.normalizeVal(0));
+}
+
+/*
+ * Tell the board to send RF message
+ */
+Board.prototype.rfTransmit = function (pin, msg) {
+  pin = this.normalizePin(pin);
+  this.log('info', 'rfTransmit from pin ' + pin, 'with message: ' + msg);
+  this.write('06' + pin + msg);
+}
+
 /*
  * Utility function to pause for a given time
  */