rad 0.0.4 → 0.1.0

data/History.txt

@@ -1,3 +1,24 @@
+== 0.1.0 2007-10-28
+* 4ish major updates:
+  * Arduino interop has been updated, and consequently now requires Arduino 0010:
+    * new Makefile imported, with new configuration items (see below)
+    * main() function added to C++ output
+    * make:upload rake task has been updated
+  * C++ generation has been changed to produce a more readable output
+  * configuration file changes:
+    * hardware
+      * fixed typo in serial_port key
+      * added mcu key to specify atmega8/atmega168.  Defaults to atmega168
+      * changed serial_port to /dev/tty.usbserial*, which will pick the first device that matches that blob
+    * software
+      * updated arduino_root for 0010
+* 2 major enhancement:
+  * gem should now correctly install RubyToC
+  * can now enable internal pull-up resistors on input pins by passing the :pullup => true parameter to input_pin
+* 2 minor enhancements:
+  * cleanups in makefile.rb
+  * serial_print_str method added; can now send strings over the serial port
+
 == 0.0.4 2007-07-24
 
 * 1 major enhancement:

data/Rakefile

@@ -79,7 +79,7 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   
   # == Optional
   p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  # p.extra_deps =  [ ['Ruby2C', '>= 1.0.0'] ]
+  p.extra_deps =  [ ['RubyToC', '>= 1.0.0'] ]
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
 end
 

data/bin/rad

@@ -52,14 +52,15 @@ puts "Added #{sketch_name}/config"
 
 File.open("#{sketch_name}/config/hardware.yml", 'w') do |file|
   file << <<-EOS 
-rserial_port: /dev/tty.usbserial-A3000WS0
+serial_port: /dev/tty.usbserial*
+mcu: atmega168
   EOS
 end
 puts "Added #{sketch_name}/config/hardware.yml"
 
 File.open("#{sketch_name}/config/software.yml", 'w') do |file|
   file << <<-EOS 
-arduino_root: /Applications/arduino/arduino-0007
+arduino_root: /Applications/arduino/arduino-0010
   EOS
 end
 puts "Added #{sketch_name}/config/software.yml"

data/lib/rad/arduino_sketch.rb

@@ -6,26 +6,34 @@ class ArduinoSketch
   def initialize
     @declarations = []
     @pin_modes = {:output => [], :input => []}
+    @pullups = []
     @other_setup = [] # specifically, Serial.begin
     @accessors = []
-    @signatures = ["void blink();"]
-    @helper_methods = <<-CODE
-    void blink(int pin, int ms){
-      digitalWrite(pin, 1);
-      delay(ms);
-      digitalWrite(pin, 0);
-      delay(ms);
-    }
-    CODE
+    @signatures = ["void blink();", "int main();"]
+
+    helper_methods = []
+    helper_methods << "void blink(int pin, int ms) {"
+    helper_methods << "\tdigitalWrite( pin, HIGH );"
+    helper_methods << "\tdelay( ms );"
+    helper_methods << "\tdigitalWrite( pin, LOW );"
+    helper_methods << "\tdelay( ms );"
+    helper_methods << "}"
+    @helper_methods = helper_methods.join( "\n" )
   end
   
   def output_pin(num, opts={})
     raise ArgumentError, "can only define pin from Fixnum, got #{num.class}" unless num.is_a?(Fixnum)
     @pin_modes[:output] << num
     if opts[:as]
-      @declarations << "int _#{opts[:as]} = #{num};"
-      @accessors << "int #{opts[:as]}(){\nreturn _#{opts[:as]};\n}"
-      @signatures << "int #{opts[:as]}();"
+      @declarations << "int _#{opts[ :as ]} = #{num};"
+      
+      accessor = []
+      accessor << "int #{opts[ :as ]}() {"
+      accessor << "\treturn _#{opts[ :as ]};"
+      accessor << "}"
+      @accessors << accessor.join( "\n" )
+      
+      @signatures << "int #{opts[ :as ]}();"
     end
   end
   
@@ -38,10 +46,17 @@ class ArduinoSketch
     raise ArgumentError, "can only define pin from Fixnum, got #{num.class}" unless num.is_a?(Fixnum)
     @pin_modes[:input] << num
     if opts[:as]
-      @declarations << "int _#{opts[:as]} = #{num};"
-      @accessors << "int #{opts[:as]}(){\nreturn _#{opts[:as]};\n}"
-      @signatures << "int #{opts[:as]}();"
+      @declarations << "int _#{opts[ :as ]} = #{num};"
+
+      accessor = []
+      accessor << "int #{opts[ :as ]}() {"
+      accessor << "\treturn _#{opts[ :as ]};"
+      accessor << "}"
+      @accessors << accessor.join( "\n" )
+      
+      @signatures << "int #{opts[ :as ]}();"
     end
+    @pullups << num if opts[:as]
   end
   
   def input_pins(nums)
@@ -60,27 +75,61 @@ class ArduinoSketch
   
   
   def compose_setup # also composes headers and signatures
-    result = "#include <WProgram.h>\nvoid loop();\nvoid setup();"
-    @signatures.each do |dec|
-      result << "#{dec}\n"
-    end
+    result = []
+    
+    result << comment_box( "Auto-generated by RAD" )
+    
+    result << "#include <WProgram.h>\n"
+    
+    result << comment_box( 'method signatures' )
+    result << "void loop();"
+    result << "void setup();"
+    @signatures.each {|sig| result << sig}
+
+    result << "\n" + comment_box( "variable and accessors" )
+    @declarations.each {|dec| result << dec}
+    result << "" # blank line    
+    @accessors.each {|ac| result << ac}
+
+    result << "\n" + comment_box( "setup" )
+    result << "void setup() {"
+    result << "\t// pin modes"
     
-    @declarations.each do |dec|
-      result << "#{dec}\n"
-    end
-    @accessors.each do |ac|
-      result << "#{ac}\n"
-    end
-    result << "void setup(){\n"
     @pin_modes.each do |k,v|
       v.each do |value| 
-        result << "pinMode(#{value}, #{k.to_s.upcase});\n"
+        result << "\tpinMode(#{value}, #{k.to_s.upcase});"
       end
     end
-    result << @other_setup.join("\n")
-    result << "}\n#{@helper_methods}"
-    result << "\n#{serial_boilerplate}\n"
 
+    @pullups.each do |pin|
+	  result << "\tdigitalWrite( #{pin}, HIGH ); // enable pull-up resistor for input"
+    end
+    
+    unless @other_setup.empty?
+      result << "\t// other setup"
+      result << @other_setup.join( "\n" )
+    end
+    
+    result << "}\n"
+    
+    result << comment_box( "helper methods" )
+    result << "\n// RAD built-in helpers"
+    result << @helper_methods.lstrip
+    
+    result << "\n// serial helpers"
+    result << serial_boilerplate.lstrip
+    
+    result << "\n" + comment_box( "main() function" )
+    result << "int main() {"
+    result << "\tinit();"
+    result << "\tsetup();"
+    result << "\tfor( ;; ) { loop(); }"
+    result << "\treturn 0;"
+    result << "}"
+
+    result << "\n" + comment_box( "loop!  Autogenerated by RubyToC, sorry it's ugly." )
+
+    return result.join( "\n" )
   end
   
   private
@@ -88,21 +137,36 @@ class ArduinoSketch
   def serial_boilerplate
     # TODO:
     # serial_print and serial_println need signatures for every combination of argument options
-    <<-CODE
-    int serial_available(){
-      return (Serial.available() > 0);
-    }
-    int serial_read(){
-      return Serial.read();
-    }
-    void serial_flush(){
-      return Serial.flush();
-    }
-    CODE
+    out = []
+    out << "int serial_available() {"
+    out << "\treturn (Serial.available() > 0);"
+    out << "}"
+
+    out << "int serial_read() {"
+    out << "\treturn Serial.read();"
+    out << "}"
+
+    out << "void serial_flush() {"
+    out << "\treturn Serial.flush();"
+    out << "}"
+
+    out << "void serial_print_str( char* str ) {"
+    out << "\treturn Serial.print( str );"
+    out << "}"
+
     # void serial_print()
     #     void serial_println()
     #     Serial.print(data)
     #     Serial.println(data)
+    return out.join( "\n" )
   end
   
+  def comment_box( content )
+    out = []
+    out << "/" * 74
+    out << "// " + content
+    out << "/" * 74
+    
+    return out.join( "\n" )
+  end  
 end

data/lib/rad/generators/makefile/makefile.erb

@@ -19,6 +19,21 @@
 #     the function, with a semi-colon at the end.  For example:
 #     int digitalRead(int pin);
 #
+#   - Write a main() function for your program that returns an int, calls
+#     init() and setup() once (in that order), and then calls loop()
+#     repeatedly():
+#
+#	int main()
+#	{
+#		init();
+#		setup();
+#
+#		for (;;)
+#			loop();
+#
+#		return 0;
+#	}
+#
 # Instructions for using the makefile:
 #
 #  1. Copy this file into the folder with your sketch.
@@ -28,7 +43,7 @@
 #
 #  3. Modify the line containg "ARDUINO" to point the directory that
 #     contains the Arduino core (for normal Arduino installations, this
-#     is the lib/targets/arduino sub-directory).
+#     is the hardware/cores/arduino sub-directory).
 #
 #  4. Modify the line containing "PORT" to refer to the filename
 #     representing the USB or serial connection to your Arduino board
@@ -45,12 +60,15 @@
 #
 # $Id$
 
-PORT = <%= params[:serial_port] %>
-TARGET = <%= params[:target] %>
-ARDUINO = <%= params[:arduino_root] %>/lib/targets/arduino
-SRC = $(ARDUINO)/pins_arduino.c $(ARDUINO)/wiring.c $(ARDUINO)/WInterrupts.c
-CXXSRC = $(TARGET).cpp $(ARDUINO)/HardwareSerial.cpp $(ARDUINO)/WRandom.cpp
-MCU = atmega8
+PORT = <%= params['serial_port'] %>
+TARGET = <%= params['target'] %>
+ARDUINO = <%= params['arduino_root'] %>/hardware/cores/arduino
+SRC = $(ARDUINO)/pins_arduino.c $(ARDUINO)/wiring.c \
+$(ARDUINO)/wiring_analog.c $(ARDUINO)/wiring_digital.c \
+$(ARDUINO)/wiring_pulse.c $(ARDUINO)/wiring_serial.c \
+$(ARDUINO)/wiring_shift.c $(ARDUINO)/WInterrupts.c
+CXXSRC = $(ARDUINO)/HardwareSerial.cpp $(ARDUINO)/WRandom.cpp 
+MCU = <%= params['mcu'] %>
 F_CPU = 16000000
 FORMAT = ihex
 UPLOAD_RATE = 19200
@@ -87,14 +105,14 @@ CTUNING = -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
 CFLAGS = $(CDEBUG) $(CDEFS) $(CINCS) -O$(OPT) $(CWARN) $(CSTANDARD) $(CEXTRA)
 CXXFLAGS = $(CDEFS) $(CINCS) -O$(OPT)
 #ASFLAGS = -Wa,-adhlns=$(<:.S=.lst),-gstabs 
-LDFLAGS = 
+LDFLAGS = -lm
 
 
 # Programming support using avrdude. Settings and variables.
 AVRDUDE_PROGRAMMER = stk500
 AVRDUDE_PORT = $(PORT)
 AVRDUDE_WRITE_FLASH = -U flash:w:$(TARGET).hex
-AVRDUDE_FLAGS = -F -p $(MCU) -P $(AVRDUDE_PORT) -C <%= params[:arduino_root] %>/tools/avr/etc/avrdude.conf -c $(AVRDUDE_PROGRAMMER) \
+AVRDUDE_FLAGS = -F -p $(MCU) -P $(AVRDUDE_PORT) -c $(AVRDUDE_PROGRAMMER) \
   -b $(UPLOAD_RATE)
 
 # Program settings
@@ -102,6 +120,7 @@ CC = avr-gcc
 CXX = avr-g++
 OBJCOPY = avr-objcopy
 OBJDUMP = avr-objdump
+AR  = avr-ar
 SIZE = avr-size
 NM = avr-nm
 AVRDUDE = avrdude
@@ -173,11 +192,12 @@ extcoff: $(TARGET).elf
 	$(NM) -n $< > $@
 
 
+core.a: $(OBJ)
+	@for i in $(OBJ); do echo $(AR) rcs core.a $$i; $(AR) rcs core.a $$i; done
 
-# Link: create ELF output file from object files.
-$(TARGET).elf: $(OBJ)
-	$(CC) $(ALL_CFLAGS) $(OBJ) --output $@ $(LDFLAGS)
-
+# Link: create ELF output file from library.
+$(TARGET).elf: core.a
+	$(CC) $(ALL_CFLAGS) -o $@ $(TARGET).cpp -L. core.a $(LDFLAGS)
 
 # Compile: create object files from C++ source files.
 .cpp.o:
@@ -202,7 +222,7 @@ $(TARGET).elf: $(OBJ)
 # Target: clean project.
 clean:
 	$(REMOVE) $(TARGET).hex $(TARGET).eep $(TARGET).cof $(TARGET).elf \
-	$(TARGET).map $(TARGET).sym $(TARGET).lss \
+	$(TARGET).map $(TARGET).sym $(TARGET).lss core.a \
 	$(OBJ) $(LST) $(SRC:.c=.s) $(SRC:.c=.d) $(CXXSRC:.cpp=.s) $(CXXSRC:.cpp=.d)
 
 depend:

data/lib/rad/generators/makefile/makefile.rb

@@ -6,10 +6,9 @@ class Makefile
     # build the sketch Makefile for the given template based on the values in its software and hardware config files
     def compose_for_sketch(sketch_name)
       params = hardware_params.merge software_params
+      params['target'] = sketch_name
       
-      params[:target] = sketch_name
-      
-      e = ERB.new File.open("#{File.dirname(__FILE__)}/makefile.erb").read
+      e = ERB.new File.read("#{File.dirname(__FILE__)}/makefile.erb")
       
       File.open("#{RAD_ROOT}/#{sketch_name}/Makefile", "w") do |f|
         f << e.result(binding)
@@ -18,28 +17,12 @@ class Makefile
     
     def hardware_params
       return @hardware_params if @hardware_params
-      @hardware_params = {}
-      
-      File.open( "#{RAD_ROOT}/config/hardware.yml" ) do |yf|
-        YAML.load_documents( yf ) do |ydoc|
-          @hardware_params[:serial_port] = ydoc["serial_port"]        
-        end
-      end
-      
-      @hardware_params
+      return @hardware_params = YAML.load_file( "#{RAD_ROOT}/config/hardware.yml")
     end
       
     def software_params
       return @software_params if @software_params
-      @software_params = {}
-      
-      File.open( "#{RAD_ROOT}/config/software.yml" ) do |yf|
-        YAML.load_documents( yf ) do |ydoc|
-          @software_params[:arduino_root] = ydoc["arduino_root"]        
-        end
-      end
-      
-      @software_params
+      return @software_params = YAML.load_file( "#{RAD_ROOT}/config/software.yml" )
     end
       
   end

data/lib/rad/tasks/build_and_make.rake

@@ -5,9 +5,9 @@ namespace :make do
   
   desc "compile the sketch and then upload it to your Arduino board"
   task :upload => :compile do
-    puts "Press the Arduino reset button and then hit return."
+    puts "Reset the Arduino (unless yours has auto-reset!) and hit enter."
     STDIN.gets.chomp
-    sh %{#{Makefile.software_params[:arduino_root]}/tools/avr/bin/uisp -v=4 -dpart=atmega8 -dprog=stk500 -dserial=/dev/tty.usbserial-A3000WS0 -dspeed=19200 --upload if=#{RAD_ROOT}/#{@sketch_name}/#{@sketch_name}.hex}
+    sh %{#{Makefile.software_params['arduino_root']}/hardware/tools/avr/bin/avrdude -F -p #{Makefile.hardware_params['mcu']} -P #{Makefile.hardware_params['serial_port']} -c stk500v1 -b 19200 -U flash:w:#{[RAD_ROOT,@sketch_name,@sketch_name].join '/'}.hex}
   end
   
   desc "generate a makefile and use it to compile the .cpp"

data/lib/rad/version.rb

@@ -1,8 +1,8 @@
 module Rad #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY  = 4
+    MINOR = 1
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: rad
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
-date: 2007-07-24 00:00:00 -07:00
+  version: 0.1.0
+date: 2007-10-28 00:00:00 -07:00
 summary: A framework for programming the Arduino physcial computing platform using Ruby. RAD converts Ruby scripts written using a set of Rails-like conventions and helpers into C source code which can be compiled and run on the Arduino microcontroller.
 require_paths: 
 - lib
@@ -72,5 +72,13 @@ extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RubyToC
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: