arduino 0.2 → 0.3

data/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: .
+  specs:
+    arduino (0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    serialport (1.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  arduino!
+  serialport

data/MIT-license.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2009-2010 Akash Manohar J <akash@akash.im>
+
+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.

data/README.md

@@ -0,0 +1,67 @@
+# Arduino ruby gem
+
+Arduino is a prototyping API for Arduino in Ruby. Helps prototype Arduino programs quickly from the computer, without the need to burn to the board frequently.
+
+#### Setup:
+1. Install the gem: `gem install arduino`
+2. Load arduino.pde onto your Arduino dev board (just once and for all).
+3. Import the arduino gem: `require "arduino"`
+
+## Methods
+
+#### Initializing:
+
+	#Arduino.new(port, baudrate)
+	board = Arduino.new("/dev/ttyUSB1")
+
+Port is something like "/dev/ttyUSB0" on linux and COM*x* (COM1/COM2) on windows. Baudrate is optional. It is 115200 by default.
+
+#### Setting output pins
+
+The output pins must be set explicitly. 
+
+	#Arduino.output(list_of_output_pins)
+	board.output(10,11,13)
+
+
+**Digital I/O**
+
+1. `Arduino.setHigh(pin)`
+2. `Arduino.setLow(pin)`
+3. `Arduino.getState(pin)` - returns `true` if pin state is high, else it returns `false`
+
+**Analog I/O**
+
+1. `Arduino.analogRead(pin)` - returns the analog value
+2. `Arduino.analogRead(pin, value)` - sets the analog value
+
+**Misc**
+
+1.) `Arduino.turnOff` - sets all the pins to low state
+
+2.) `Arduino.close` - closes serial connection. Using this makes sure that you won't have to disconnect & reconnect the Arduino again to recover the serial port.
+
+## Usage example
+
+			# This is the blink program.
+
+      require "arduino"
+
+			#specify the port Baudrate is optional and set to 115200 by default
+			myBoard = Arduino.new("/dev/ttyUSB1")
+
+			#declare output pins
+			myBoard.output(13)
+
+			#perform operations
+			10.times do
+				myBoard.setHigh(13)
+				sleep(1)
+				myBoard.setLow(13)
+				sleep(1)
+			end
+
+# Developed for the love of programming by
+> &copy; 2010 Akash Manohar <akash@akash.im>
+> under the MIT License
+

data/arduino.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["akash@akash.im"]
   s.homepage    = ""
   s.summary     = %q{Arduino Prototyping API for Ruby}
-  s.description = %q{A library to talk to Arduino in Ruby without having to burn programs repeatedly to the board.}
+  s.description = %q{A ruby library to talk to Arduino without having to burn programs repeatedly to the board}
 
   s.rubyforge_project = "arduino"
 

data/arduino.pde

@@ -0,0 +1,131 @@
+// variable to store the data from the serial port
+int cmd = 0;
+
+// command arguments
+int cmd_arg[2];
+
+
+void setup() {
+  // connect to the serial port
+  Serial.begin(115200);
+  // confirm ready state
+
+  while(Serial.available()<1)
+  {
+    // get number of output pins and convert to int
+    cmd = int(readData()) - 48;
+    for(int i=0; i<cmd; i++)
+    {
+      cmd_arg[0] = int(readData()) - 48;
+      pinMode(cmd_arg[0], OUTPUT);
+    }
+    break;
+  }
+}
+
+void loop()
+{
+
+  askCmd();
+
+  if(Serial.available()>0)
+  {
+    cmd = int(Serial.read()) - 48;
+
+    if(cmd==0) //set digital low
+    {
+      cmd_arg[0] = int(readData()) - 48;
+      digitalWrite(cmd_arg[0],LOW);
+    }
+
+    if(cmd==1) //set digital high
+    {
+      cmd_arg[0] = int(readData()) - 48;
+      digitalWrite(cmd_arg[0],HIGH);
+    }
+
+    if(cmd==2) //get digital value
+    {
+      cmd_arg[0] = int(readData()) - 48;
+      cmd_arg[0] = digitalRead(cmd_arg[0]);
+      Serial.println(cmd_arg[0]);
+    }
+
+    if(cmd==3) // set analog value
+    {
+      Serial.println("I'm in the right place");
+      cmd_arg[0] = int(readData()) - 48;
+      cmd_arg[1] = readHexValue();
+      analogWrite(cmd_arg[0],cmd_arg[1]);
+    }
+
+    if(cmd==4) //read analog value
+    {
+      cmd_arg[0] = int(readData()) - 48;
+      cmd_arg[0] = analogRead(cmd_arg[0]);
+      Serial.println(cmd_arg[0]);
+    }
+  }
+}
+
+char readData()
+{
+  askData();
+
+  while(1)
+  {
+    if(Serial.available()>0)
+    {
+      return Serial.read();
+    }
+  }
+}
+
+
+//read hex value from serial and convert to integer
+int readHexValue()
+{
+  int strval[2];
+  int converted_str;
+
+  while(1)
+  {
+    if(Serial.available()>0)
+    {
+      strval[0] = convert_hex_to_int(Serial.read());
+      break;
+    }
+  }
+
+  askData();
+
+  while(1)
+  {
+    if(Serial.available()>0)
+    {
+      strval[1] = convert_hex_to_int(Serial.read());
+      break;
+    }
+  }
+
+  converted_str = (strval[0]*16) + strval[1];
+  return converted_str;
+}
+
+int convert_hex_to_int(char c)
+{
+  return (c <= '9') ? c-'0' : c-'a'+10;
+}
+
+void askData()
+{
+  Serial.println("?");
+}
+
+void askCmd()
+{
+  askData();
+  while(Serial.available()<=0)
+  {}
+}
+

data/example_blink.rb

@@ -0,0 +1,15 @@
+require "arduino"
+
+#specify the port as an argument
+myBoard = Arduino.new('/dev/ttyUSB2')
+
+#declare output pins
+myBoard.output(13)
+
+#perform operations
+10.times do
+  myBoard.setHigh(13)
+  sleep(1)
+  myBoard.setLow(13)
+  sleep(1)
+end

data/lib/arduino.rb

@@ -1,18 +1,35 @@
+# The program takes an initial word or phrase from
+# the command line (or in the absence of a
+# parameter from the first line of standard
+# input).  In then reads successive words or
+# phrases from standard input and reports whether
+# they are angrams of the first word.
+#
+# Author::    Dave Thomas  (mailto:dave@x.y)
+# Copyright:: Copyright (c) 2002 The Pragmatic Programmers, LLC
+# License::   Distributes under the same terms as Ruby
+
 require "serialport"
 
+# The main Arduino class.
+# Allows managing connection to board and getting & setting pin states.
+
 class Arduino
 
+	# initialize port and baudrate
 	def initialize(port, baudrate=115200)
 	  @serial = SerialPort.new port, baudrate
 	  @serial.sync
-	  @port = port	#Cannot get connected port via SerialPort class
+	  @port = port
 	  @outputPins = []
 	end
 
+	# Print information about connected board
 	def to_s
 	  "Arduino is on port #{@port} at #{@serial.baud} baudrate"
 	end
-
+	
+	# Set output pins. This is a must.
 	def output(*pinList)
 	  sendData(pinList.length)
 	
@@ -26,22 +43,26 @@ class Arduino
 	  end
 	end
 
+	# Get state of a digital pin. Returns true if high and false if low.
 	def getState(pin)
 	  sendData('2')
 	  sendPin(pin)
 	  return formatPinState(getData())
 	end
 
+	# Set a pin state to low
 	def setLow(pin)
 	  sendData('0')
 	  sendPin(pin)
 	end
-
+	
+	# Set a pin state to high
 	def setHigh(pin)
 	  sendData('1')
 	  sendPin(pin)
 	end
-
+	
+	# Write to an analog pin
 	def analogWrite(pin, value)
 		sendData('3')
 	  fullHexValue = value.to_s(base=16)
@@ -54,18 +75,21 @@ class Arduino
 	  sendData(hexValue[1])
 	end
 
+	# Read from an analog pin
 	def analogRead(pin)
 	  sendData('4')
 	  sendPin(pin)
 	  getData()
 	end
 
+	# set all pins to low
 	def turnOff
 	  @outputPins.each do |pin|
 	    setLow(pin)
 	  end
 	end
 
+	# close serial connection to connected board
 	def close
 		@serial.close
 	end
@@ -91,9 +115,8 @@ class Arduino
 	end
 
 	def formatPinState(pinValue)
-	  return 1 if pinValue=="1"
-	  return 0 #if pinValue=="0"
-	  #raise Exception, "Data/Connection error"
+	  return true if pinValue=="1"
+	  return false #if pinValue=="0"
 	end
 
 end

data/lib/arduino/version.rb

@@ -1,3 +1,3 @@
 module Arduino
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  version: "0.2"
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - Akash Manohar
@@ -17,7 +17,7 @@ date: 2011-01-01 00:00:00 +05:30
 default_executable: 
 dependencies: []
 
-description: A library to talk to Arduino in Ruby without having to burn programs repeatedly to the board.
+description: A ruby library to talk to Arduino without having to burn programs repeatedly to the board
 email: 
 - akash@akash.im
 executables: []
@@ -29,8 +29,13 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- Gemfile.lock
+- MIT-license.txt
+- README.md
 - Rakefile
 - arduino.gemspec
+- arduino.pde
+- example_blink.rb
 - lib/arduino.rb
 - lib/arduino/version.rb
 has_rdoc: true