rake-arduino 0.0.1.alpha

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+build/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in rake-arduino.gemspec
+gemspec

data/README.md

@@ -0,0 +1,78 @@
+rake-arduino
+============
+_A Flexible build tool for Arduino development_
+
+## Usage
+_`rake-arduino` is very pre-alpha at the moment. Be prepared to find and fix a
+lot of bugs while using it._
+
+After installing the gem (see below), simply add a Rakefile that looks like
+this to the root of your project:
+
+    require 'rubygems'
+    require 'rake/arduino'
+
+    Rake::Arduino::Sketch.new do |s|
+      s.sources << "MySketch.cpp"
+      s.libraries << "Servo"
+
+      s.board = Rake::Arduino::Board["Arduino Uno"]
+    end
+
+See the `examples` directory for more advanced usage.
+
+Then, to build your project run:
+
+    rake
+
+To upload it to your arduino:
+
+    rake upload
+
+If your arduino installation is somewhere non-standard, you'll need to
+configure that at the top of your Rakefile:
+
+    Rake::Arduino.configure do |c|
+      c.home = "/home/me/apps/arduino-0022"
+    end
+
+## Installation
+You'll need ruby and rubygems installed (use your system's package manager, or
+RVM).
+
+As a gem:
+
+    gem install rake-arduino
+
+From source:
+
+    gem install bundler rake
+
+    git clone https://github.com/wjbuys/rake-arduino
+    cd rake-arduino
+    rake install
+
+## Background
+Arduino is great. The arduino IDE: not so great. Once your project moves beyond
+a nontrivial size, it's a massive pain to use. Sorry Arduino team, but it's
+just painful and ugly (and stupid, if you're used to Vim/Emacs).
+
+At this point all the gurus say: "Just use a `Makefile`!". Unfortunately, this
+becomes a very roll-your-own mission (there's no centrally maintained version).
+
+Also, the `Makefile` syntax makes my eyes bleed. Inevitably multiple copies of
+the same `Makefile` with minor tweaks will end up around all my projects, because
+I'm lazy.
+
+*Luckily, there's a solution: _Rake_.* Rake is Ruby, so
+
+1. the syntax is gorgeous,
+1. you get a real programming language to do additional pre-processing,
+1. and you can wrap common logic up neatly into a central library.
+
+## TODO
+
+1. Support `.pde` sketch pre-processing
+1. Add some specs (I just ripped this out of a project I was working on, so no
+   tests :( )
+1. Support config from ~/.rake-arduino

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/examples/basic/Blink.cpp

@@ -0,0 +1,14 @@
+#include <WProgram.h>
+
+int led = 11;
+
+void setup() {
+  pinMode(led, OUTPUT);
+};
+
+void loop() {
+  digitalWrite(led, HIGH);
+  delay(1000);
+  digitalWrite(led, LOW);
+  delay(1000);
+};

data/examples/basic/Rakefile

@@ -0,0 +1,25 @@
+$:.unshift "../../lib"
+require 'rake/arduino'
+
+# The basic configuration of a project is done via the
+# Rake::Arduino::Sketch task:
+
+Rake::Arduino::Sketch.new do |s|
+  # Add your main source files to the s.sources array:
+  s.sources << "Blink.cpp"
+
+  # If you need any Arduino libraries, add them to s.libraries:
+  s.libraries << "Servo"
+
+  # Specify the board you'd like to use. Boards are defined
+  # in lib/rake/arduino/boards.rb, and referenced by name:
+  s.board = Rake::Arduino.board("Arduino Uno") do |b|
+
+    # In the board block, you can customize board parameters
+    # for your specific needs.
+    b.cpu_speed = 8000000
+
+    # See the Board class docs for a full list of settings that
+    # can be configured.
+  end
+end

data/examples/multi_target/Blink.cpp

@@ -0,0 +1,14 @@
+#include <WProgram.h>
+
+int led = 11;
+
+void setup() {
+  pinMode(led, OUTPUT);
+};
+
+void loop() {
+  digitalWrite(led, HIGH);
+  delay(1000);
+  digitalWrite(led, LOW);
+  delay(1000);
+};

data/examples/multi_target/Rakefile

@@ -0,0 +1,33 @@
+$:.unshift "../../lib"
+require 'rake/arduino'
+
+# rake-arduino supports defining multiple targets in a single rakefile.
+# This allows you to build variations on the same project quite easily.
+# Say, for example, you'd like to compile hex files for both the classic
+# arduino, and for the Teensy:
+
+Rake::Arduino::Sketch.new :arduino do |s|
+  s.sources << "Blink.cpp"
+  s.board = Rake::Arduino.board("Arduino Uno")
+end
+
+Rake::Arduino::Sketch.new :teensy do |s|
+  s.sources << "Blink.cpp"
+  s.board = Rake::Arduino.board("Teensy 2.0")
+end
+
+# Now you can build each target with `rake <target>`
+# If you want to build them all at once, add a default task that references
+# both targets:
+
+task :default => [:arduino, :teensy]
+
+# You can even have both platforms built in parallel:
+
+multitask :all => [:arduino, :teensy]
+
+# Now `rake` will build .hex files for both platforms in one go.
+# 
+# Note: Your targets don't have to relate to each other at all. If you'd
+# like to build completely separate projects from the same Rakefile, you
+# can do that too.

data/lib/rake/arduino.rb

@@ -0,0 +1,10 @@
+module Rake
+  module Arduino
+    require "rake/arduino/version"
+    require "rake/arduino/config"
+    require "rake/arduino/toolchain"
+    require "rake/arduino/board"
+    require "rake/arduino/boards"
+    require "rake/arduino/sketch"
+  end
+end

data/lib/rake/arduino/board.rb

@@ -0,0 +1,37 @@
+module Rake
+  module Arduino
+    class Board
+      attr_accessor :name
+      attr_accessor :cores, :defines
+      attr_accessor :mcu, :cpu_speed
+      attr_accessor :max_size
+
+      @boards = {}
+      def self.[](name)
+        @boards[name]
+      end
+
+      def self.register(board)
+        @boards[board.name] = board
+      end
+
+      def register
+        self.class.register(self)
+      end
+
+      def initialize(name)
+        self.name = name
+        self.defines = []
+        self.cores = []
+
+        yield self if block_given?
+      end
+    end
+
+    def self.board(name)
+      board = Board[name]
+      yield board if block_given?
+      board
+    end
+  end
+end

data/lib/rake/arduino/boards.rb

@@ -0,0 +1,16 @@
+module Rake::Arduino
+  Board.new("Arduino Uno") do |b|
+    b.cores = ["arduino"]
+    b.cpu_speed = 16000000
+    b.mcu = "atmega328p"
+    b.max_size = 30720
+  end.register
+
+  Board.new("Teensy 2.0") do |b|
+    b.cores = ["teensy", "usb_serial"]
+    b.defines = ["USB_SERIAL"]
+    b.cpu_speed = 16000000
+    b.mcu = "atmega32u4"
+    b.max_size = 32256
+  end.register
+end

data/lib/rake/arduino/config.rb

@@ -0,0 +1,34 @@
+module Rake
+  module Arduino
+    class Config
+      attr_accessor :home, :hardware_path, :library_path
+      attr_accessor :cores
+
+      def initialize
+        yield self if block_given?
+
+        self.home ||= ENV["HOME"] + "/apps/arduino"
+
+        self.hardware_path ||= home + "/hardware"
+        self.library_path ||= home + "/libraries"
+
+        self.cores ||= Dir.glob(hardware_path + "/**/cores/*")
+      end
+
+      def self.read_defaults
+        load ENV["HOME"] + "/.rake-arduino"
+      rescue LoadError
+      end
+    end
+
+    class << self
+      def config
+        @config ||= Config.new
+      end
+
+      def configure(&block)
+        @config = Config.new(&block)
+      end
+    end
+  end
+end

data/lib/rake/arduino/core_ext/array.rb

@@ -0,0 +1,9 @@
+require 'pathname'
+
+class Array
+  def to_paths
+    self.map do |path|
+      Pathname(path) unless path.is_a? Pathname
+    end
+  end
+end

data/lib/rake/arduino/core_ext/pathname.rb

@@ -0,0 +1,5 @@
+require 'pathname'
+
+class Pathname
+  def to_str; to_s; end
+end

data/lib/rake/arduino/sketch.rb

@@ -0,0 +1,156 @@
+require 'rake/arduino/core_ext/pathname'
+require 'rake/arduino/core_ext/array'
+
+module Rake
+  module Arduino
+    class Sketch
+      include Rake::DSL
+
+      attr_accessor :sources
+      attr_accessor :name
+      attr_accessor :target
+      attr_accessor :board
+      attr_accessor :libraries
+      attr_accessor :hex, :elf
+      attr_accessor :programmer, :upload_rate
+      attr_accessor :usb_type
+      attr_accessor :build_root, :root
+      attr_accessor :toolchain
+
+      def initialize(target = :default)
+        Config.read_defaults
+
+        self.target = target.to_sym
+        self.build_root = "build/#{target}"
+
+        self.root = Pathname.pwd
+
+        self.sources = []
+        self.libraries = []
+
+        yield self
+
+        raise "You have to specify a board for the sketch" unless board
+
+        self.sources = sources.to_paths
+        self.build_root = Pathname(build_root)
+
+        self.name ||= root.basename.to_s
+
+        self.elf ||= build("#{name}.elf")
+        self.hex ||= build("#{name}.hex")
+
+        self.programmer ||= "avr109"
+        self.upload_rate ||= 19200
+
+        self.toolchain = Toolchain.new(self)
+
+        create_tasks
+      end
+
+
+      def config
+        Rake::Arduino.config
+      end
+
+      def core_paths
+        @core_paths ||= config.cores.to_paths.select do |core|
+          board.cores.include? core.basename.to_s
+        end
+      end
+
+      def library_paths
+        libraries.map do |lib|
+          Pathname(config.library_path) + lib
+        end
+      end
+
+      def build(path)
+        path = Pathname(path)
+        path = path.relative_path_from(root) if path.absolute?
+
+        # Use fully-qualified paths for source outside the project root
+        path = path.expand_path.sub(/^\//, "") if path.to_s.start_with? ".."
+
+        build_path = Pathname(build_root) + path
+      end
+
+      def compile(*source_files)
+        source_files = [source_files].flatten
+        object_files = source_files.map do |source|
+          build(source.sub_ext(".o"))
+        end
+
+        object_files.zip(source_files).each do |object_file, source_file|
+          file object_file => source_file do
+            object_file.parent.mkpath
+            toolchain.compile source_file, :into => object_file
+          end
+        end
+
+        object_files
+      end
+
+      def create_tasks
+        compiled_libraries = [
+          *board.cores,
+          *libraries
+        ].map{|l| build("#{l}.a")}
+
+        task target => [*compiled_libraries, hex]
+
+        main_objects = compile sources
+
+        (core_paths + library_paths).each do |path|
+          library_out = build(path.basename.sub_ext(".a"))
+
+          object_files = compile Pathname.glob(path +"**/*.{c,cpp}")
+
+          file library_out => object_files do
+            object_files.each do |object_file|
+              library_out.parent.mkpath
+              toolchain.archive object_file, :into => library_out
+            end
+          end
+        end
+
+        file elf => main_objects + compiled_libraries do
+          toolchain.link main_objects, :with => compiled_libraries, :into => elf
+        end
+
+        file hex => elf do
+          size = toolchain.convert_binary(elf, :hex => hex)
+
+          if size > board.max_size
+            puts "The sketch size (#{size} bytes) has overriden the maximum size (#{board.max_size} bytes)."
+            rm hex
+            exit -1
+          else
+            puts "Sketch size: #{size} bytes (of a #{board.max_size} bytes maximum)."
+          end
+        end
+
+        task :upload => [:all, :upload_pre] do
+          sh "#{avrdude} -V -F -p #{board.mcu} -c #{programmer} -P #{port} -b #{upload_rate} -D -Uflash:w:#{hex}:i"
+        end
+
+        task :clean do
+          rm_rf Dir["build"]
+          rm_f Dir["**/*.{o,a,hex,elf}"]
+        end
+      end
+
+      def includes
+        ["/usr/lib/avr/include/avr", *core_paths, *library_paths]
+      end
+
+      def defines
+        ["F_CPU=#{board.cpu_speed}L", "ARDUINO=18", *board.defines]
+      end
+
+      def avrdude
+        "avrdude"
+      end
+    end
+  end
+end

data/lib/rake/arduino/toolchain.rb

@@ -0,0 +1,65 @@
+module Rake
+  module Arduino
+    class Toolchain
+      include FileUtils
+
+      attr_accessor :sketch
+
+      def initialize(sketch)
+        self.sketch = sketch
+      end
+
+      def mcu
+        sketch.board.mcu
+      end
+
+      def cpp_flags
+        [
+          "-Wall",
+          "-std=gnu++0x",
+          "-g",
+          "-Os",
+          "-w",
+          "-fno-exceptions",
+          "-ffunction-sections",
+          "-fdata-sections",
+          "-mmcu=#{mcu}",
+          *sketch.defines.map{|d| "-D#{d}"},
+          *sketch.includes.map{|i| "-I'#{i}'"}
+        ]
+      end
+
+      def ld_flags
+        ["-Os", "-Wl,--gc-sections", "-mmcu=#{mcu}"]
+      end
+
+      def ar_flags
+        ['rcs']
+      end
+
+      def compile(source_file, options = {})
+        object_file = options[:into]
+        sh "avr-gcc #{cpp_flags.join(" ")} -c #{source_file} -o #{object_file}"
+      end
+
+      def link(main_objects, options)
+        compiled_libraries = options[:with]
+        binary = options[:into]
+        sh "avr-gcc #{ld_flags.join(" ")} #{main_objects.join(" ")} #{compiled_libraries.join(" ")} -lm -o #{binary}"
+      end
+
+      def archive(object_file, options = {})
+        archive = options[:into]
+        sh "avr-ar #{ar_flags.join(" ")} #{archive} #{object_file}"
+      end
+
+      def convert_binary(binary, options)
+        hex = options[:hex]
+        sh "avr-objcopy -O ihex -R .eeprom #{binary} #{hex}"
+
+        `avr-size -A --mcu=#{mcu} #{hex}` =~ /Total(\s*)(\d*)/
+        $2.to_i
+      end
+    end
+  end
+end

data/lib/rake/arduino/version.rb

@@ -0,0 +1,5 @@
+module Rake
+  module Arduino
+    VERSION = "0.0.1.alpha"
+  end
+end

data/rake-arduino.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rake/arduino/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jacob Buys"]
+  gem.email         = ["wjbuys@gmail.com"]
+  gem.summary       = %q{Flexible build system for Arduino projects.}
+  gem.description   = %q{rake-arduino allows you to easily build Arduino sketches using Rake.}
+  gem.homepage      = "https://github.com/wjbuys/rake-arduino"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.name          = "rake-arduino"
+  gem.require_paths = ["lib"]
+  gem.version       = Rake::Arduino::VERSION
+
+  gem.add_dependency "rake"
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: rake-arduino
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Jacob Buys
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &12055520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12055520
+description: rake-arduino allows you to easily build Arduino sketches using Rake.
+email:
+- wjbuys@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- examples/basic/Blink.cpp
+- examples/basic/Rakefile
+- examples/multi_target/Blink.cpp
+- examples/multi_target/Rakefile
+- lib/rake/arduino.rb
+- lib/rake/arduino/board.rb
+- lib/rake/arduino/boards.rb
+- lib/rake/arduino/config.rb
+- lib/rake/arduino/core_ext/array.rb
+- lib/rake/arduino/core_ext/pathname.rb
+- lib/rake/arduino/sketch.rb
+- lib/rake/arduino/toolchain.rb
+- lib/rake/arduino/version.rb
+- rake-arduino.gemspec
+homepage: https://github.com/wjbuys/rake-arduino
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1016166330329218044
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Flexible build system for Arduino projects.
+test_files: []