mkduino 0.0.1

data/README.md

@@ -0,0 +1,79 @@
+mkduino
+=======
+
+Ruby script for generating a GNU Automake style makefile system for your arduino projects
+
+You'll probably need to use Fedora 19 to have this work out of the box.   Pull requests or
+github issues for other distributions / systems will thoughtfully considered.
+
+If there's enough interest, I'll add some command line switches and more dynamic configuration
+of he environment.  It would probably be simple to find the arduino environment rather than
+hardcoding it.  Also, doing a `git init` and adding certain files to the repo would be really
+handy for someone that uses this regularly.   Again - add github issues or send pull requests...
+
+## Installation
+
+`gem install mkduino`
+
+## Usage
+========
+Go to the directory where your source code is(or should be):
+
+```
+mkduino
+./autogen.sh
+./configure --host=avr
+make
+make upload
+```
+
+## Files Generated
+==================
+
+### src/main.cpp
+This cpp file is generated if there are no `.cpp`, `.hpp`, `.c` or `.h` files found when mkduino is run.
+It's a simple file like the one generated from the IDE.
+
+### Makefile.am
+This is where most of the configuration for automake ends up.   This Automake file is
+initially configured for an Arduino Pro Mini, but there are some variables that can
+be changed in this file to customize it.   Any changes made to this file will be
+automatically picked up by make on your next make invocation.
+
+* `ARDUINO_VERSION=-DARDUINO=105`
+  Define of what version of the Arduino libaries you're using.
+* `ARDUINO_INSTALL=/usr/share/arduino/hardware/arduino`
+  Where the Arduino library stuff is installed.   This is the default on a Fedora system
+* `MCU=atmega328p`
+   Change this if you have a different supported ATMEL chip.
+   For instance set it to `MCU=atmega1280` for an ATMEL atmega1280 chip
+* `ARDUINO_VARIANTS=$(ARDUINO_INSTALL)/variants/standard`
+   You many need to change `standard` to something else for mega 1280 and 2560 chips
+* `AVRDUDE_PORT=/dev/ttyUSB0`
+  The port that `make upload` will try to send the code to.
+* `AVRDUDE_PROGRAMMER = arduino*`
+  The `avrdude` programmer type.
+  Check the [`avrdude` documentation](http://www.nongnu.org/avrdude/user-manual)
+
+### configure.ac
+There's not much to see here.  This file is customized with the project name and that's about it.
+
+### autogen.sh
+Execute this file after running `mkduino`.  This file isn't customized for each project - it's the same every time.
+
+### README, NEWS, AUTHORS, ChangeLog, config/config.h and m4/
+Standard files and directories for GNU Automake.   Just created, nothing is in them.
+
+## Why?
+======
+Every time I run the Arduino IDE I struggle to have my hands unlearn the `emacs` keybindings
+so I can do some little thing.  I got really tired of it and made myself a makefile.
+
+After bragging about my makefile prowess to my friends, they all wanted to ditch the Arduino IDE.
+I was embarrassed of my initial makefile, so I decided to make an environment builder for Arduino.
+My initial try at this projects included downloading all of the tools (yes, even gcc), building
+it all very similarly to `rvm`.   That proved to be a project much too big for the typical Arduino
+hacker to undertake, so I quickly regrouped and hacked out this ruby script to make an automake
+environment.
+
+Hopefully this enables you to use your environment of choice for Arduino hacking.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/mkduino

@@ -0,0 +1,63 @@
+#! /usr/bin/env ruby
+#
+# mkduino.rb
+#   Ruby script for generating a GNU Automake (ish)
+#   environment for Arduino development
+#
+# (C) Copyright 2013,2014
+# David H. Wilkins  <dwilkins@conecuh.com>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of
+# the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+# MA 02111-1307 USA
+#
+
+require "mkduino"
+
+ma = Mkduino::MakefileAm.new
+ma.find_arduino_libraries '/usr/share/arduino/libraries'
+ma.find_arduino_libraries '/usr/share/arduino/hardware/arduino/cores'
+ma.find_source_files
+ca = Mkduino::ConfigureAc.new ma
+as = Mkduino::AutogenSh.new
+puts ma.to_yaml
+
+##
+# Output the Makefile.am file withe the needed variable replacements
+##
+ma.write_makefile_am
+##
+# Output the configure.ac - requires a few things from Makefile.am
+##
+ca.write_configure_ac
+##
+# Finally write the autogen.sh - no replacements there
+##
+as.write_autogen_sh
+
+#
+# A few shell commands required to make it all tidy
+#
+`chmod +x autogen.sh`
+`mkdir m4` unless Dir.exist?('m4')
+`mkdir config` unless Dir.exist?('config')
+`touch config/config.h`
+`touch NEWS`
+`touch README`
+`touch AUTHORS`
+`touch ChangeLog`
+
+puts "*******************************"
+puts "** now run ./autogen.sh      **"
+puts "*******************************"

data/lib/mkduino.rb

@@ -0,0 +1,407 @@
+require "mkduino/version"
+require 'yaml'
+require 'find'
+require 'pathname'
+require 'fileutils'
+
+include FileUtils
+
+module Mkduino
+  #
+  # Represents the files needed for a particular arduino library
+  #
+  class ArduinoLibrary
+    def initialize name
+      @library_sources = []
+      @name = name
+      @library_includes = []
+    end
+
+    def name
+      return @name.downcase
+    end
+
+    def add_source_file(file)
+      pn = Pathname.new(file)
+      puts "!! ******** File #{file} not found ******** " unless pn.exist?
+      @library_sources << file
+    end
+    def add_include_path file
+      pn = Pathname.new(file)
+      puts "!! ******** File #{file} not found ******** " unless pn.exist?
+      include_dir = pn.file? ? pn.dirname : file
+      puts "Add include for #{file} = #{include_dir}"
+
+      @library_includes << include_dir.to_s unless @library_includes.include? include_dir.to_s
+    end
+
+    def linker_name
+      self.name
+    end
+
+    def library_name
+      "lib#{self.name}.a"
+    end
+
+    def makefile_am_output
+      output = <<LIBRARY_OUTPUT
+lib#{self.name}_a_CFLAGS=-Wall -I$(ARDUINO_VARIANTS) $(ARDUINO_COMMON_INCLUDES) $(lib#{self.name}_a_INCLUDES) -Wl,--gc-sections -ffunction-sections -fdata-sections -mmcu=$(MCU) $(F_CPU) $(ARDUINO_VERSION) -D__AVR_LIBC_DEPRECATED_ENABLE__
+lib#{self.name}_a_CXXFLAGS=-Wall -I$(ARDUINO_VARIANTS) $(ARDUINO_COMMON_INCLUDES) $(lib#{self.name}_a_INCLUDES) -Wl,--gc-sections -ffunction-sections -fdata-sections -mmcu=$(MCU) $(F_CPU) $(ARDUINO_VERSION) -D__AVR_LIBC_DEPRECATED_ENABLE__
+lib#{self.name}_a_SOURCES = #{@library_sources.join("\\\n                    ")}
+lib#{self.name}_a_INCLUDES = -I#{@library_includes.join("\\\n                    -I")}
+LIBRARY_OUTPUT
+      output
+    end
+  end
+
+  #
+  # Class that keeps up with the stuff needed for the Makefile.am file
+  # this is most of the stuff needed to generate the automake stuff
+  #
+
+  class MakefileAm
+    attr_accessor :source_files, :header_files, :arduino_sources
+    attr_accessor :project_name, :project_author, :project_dir
+    attr_accessor :project_includes
+    # future stuff
+    attr_accessor :git_project
+    attr_accessor :board, :common_includes
+
+    def initialize
+      @project_dir =  Dir.pwd
+      @project_name = File.basename @project_dir
+      @project_name.tr!('.','_')
+      @source_files = []
+      @header_files = []
+      @project_includes = []
+      @arduino_sources = []
+      @arduino_includes = []
+      @arduino_libraries = []
+      @project_author = {}
+      @git_project = nil
+      @common_libraries = ['arduino', 'spi','wire']
+      @libraries_to_skip = {
+        'standard' => ['Esplora','GSM','Robot_Control','Robot_Motor','TFT','robot']
+      }
+      @board='standard'
+      @project_author[:username] = ENV['USERNAME']
+      git_exists = `which git`.chomp
+      if git_exists &&  git_exists.length > 0
+        @project_author[:name] = `git config --get user.name`.chomp
+        @project_author[:email] = `git config --get user.email`.chomp
+        @git_project = `git remote show -n origin 2> /dev/null | grep 'Fetch URL:' | cut -f 5 -d ' '`.chomp
+      else
+        @project_author[:name] = @project_author[:username]
+        @project_author[:email]= @project_author[:username]
+        @git_project = "no_git_project"
+      end
+    end
+
+    #
+    # Add a source file that we found in this directory
+    #
+    def add_source_file(file)
+      @source_files << "../" + Pathname.new(file).relative_path_from(Pathname.new(@project_dir)).to_s
+    end
+    def add_header_file(file)
+      @header_files << "../" + Pathname.new(file).relative_path_from(Pathname.new(@project_dir)).to_s
+    end
+
+    def add_include_path file
+      pn = Pathname.new(file)
+      puts "!! ******** File #{file} not found ******** " unless pn.exist?
+      include_dir = pn.file? ? pn.dirname : file
+      puts "Add include for #{file} = #{include_dir}"
+
+      @project_includes << include_dir.to_s unless @project_includes.include? include_dir.to_s
+    end
+
+
+    #
+    # As libraries are found, add them to our collection
+    # if they're not already there
+    #
+    def add_arduino_library library
+      @arduino_libraries << library  if !arduino_library library
+    end
+
+    #
+    # fetch a library from our collection - nil if not there
+    #
+
+    def arduino_library library
+      @arduino_libraries.each do |l|
+        return l if l.name == library
+      end
+      nil
+    end
+
+    #
+    # output the Makefile.am macro needed for some include
+    # files from libraries that are apparently always needed
+    #
+    def common_includes
+      @arduino_libraries.collect do |l|
+        @common_libraries.include?(l.name) ? "$(lib#{l.name}_a_INCLUDES)" : nil
+      end.compact.join(' ')
+    end
+
+
+    def source_file_pattern
+      /\.([c])(pp|)$/
+    end
+
+    def header_file_pattern
+      /\.([h])(pp|)$/
+    end
+
+    #
+    # output a list of all the libraries that are needed here
+    # for Makefile.am.   The project will depend on these
+    #
+    def arduino_library_names
+      @arduino_libraries.collect do |l|
+        l.library_name
+      end
+    end
+
+    #
+    # return the linker entries for all of the libraries that we
+    # know about
+    #
+    def arduino_linker_entries
+      @arduino_libraries.collect do |l|
+        "-l#{l.linker_name}"
+      end
+    end
+
+    #
+    # after finding all of the Arduino libraries, go through each
+    # one of them asking them to output themselves.
+    #
+
+    def output_arduino_libraries
+      output = @arduino_libraries.collect do |l|
+        l.makefile_am_output
+      end.join("\n")
+      #
+      # After all of the library compile lines are output, output
+      # a comprehensive list of all of the include directories associated
+      # with the libraries.   Used for the source project
+      #
+      output += "\nLIBRARY_INCLUDES="
+      output += @arduino_libraries.collect do |l|
+        "$(lib#{l.name}_a_INCLUDES)"
+      end.join(' ')
+    end
+
+    def find_arduino_libraries libraries_dir
+      lib = nil
+      Find.find(libraries_dir) do |path|
+        if FileTest.directory?(path)
+          if File.basename(path)[0] == ?. || File.basename(path) == 'examples' ||
+              (@libraries_to_skip[@board] && @libraries_to_skip[@board].include?(File.basename(path)) )
+            Find.prune       # Don't look any further into this directory.
+          else
+            if File.dirname(path) == libraries_dir
+              lib_name = path.split('/')[-1]
+              lib = arduino_library(lib_name) || ArduinoLibrary.new(lib_name)
+              add_arduino_library lib
+            end
+            next
+          end
+        elsif path =~ source_file_pattern
+          lib.add_source_file path
+        elsif path =~ header_file_pattern
+          lib.add_include_path path
+        end
+      end
+    end
+
+    def find_source_files
+      #
+      # Root around for some source file
+      # and add them to the Makefile.am
+      #
+      Find.find(Dir.pwd) do |path|
+        if FileTest.directory?(path)
+          if File.basename(path)[0] == ?.
+            Find.prune       # Don't look any further into this directory.
+          else
+            next
+          end
+        elsif path =~ source_file_pattern
+          add_source_file path
+        elsif path =~ header_file_pattern
+          add_header_file path
+          add_include_path path
+
+        end
+      end
+
+      #
+      # If no source files were found, make
+      # the src/ directory and put in a
+      # sample main.cpp file
+      #
+      if source_files.length < 1
+        `mkdir src`  unless Dir.exist?('src')
+        File.open('src/main.cpp',"w") do |f|
+          f.puts <<-MAIN_CPP
+#include <Arduino.h>
+
+extern "C" void __cxa_pure_virtual(void) {
+    while(1);
+}
+
+void setup() {
+  Serial.begin(115200);
+  Serial.println("Startup...");
+}
+
+void loop() {
+}
+
+
+
+int main(void)
+{
+  init();
+  setup();
+  for (;;){
+    loop();
+  }
+  return 0;
+}
+MAIN_CPP
+        end
+        add_source_file project_dir + '/src/main.cpp'
+      end
+    end
+
+
+
+
+    def write_makefile_am
+      File.open('Makefile.am',"w") do |f|
+        f.puts <<-MAKEFILE_AM
+## Process this file with automake to produce Makefile.in
+bin_PROGRAMS=#{self.project_name}
+# MCU=atmega1280
+MCU=atmega328p
+F_CPU=-DF_CPU=16000000
+ARDUINO_VERSION=-DARDUINO=105
+ARDUINO_INSTALL=/usr/share/arduino/hardware/arduino
+ARDUINO_CORES=$(ARDUINO_INSTALL)/cores/arduino
+ARDUINO_VARIANTS=$(ARDUINO_INSTALL)/variants/#{self.board}
+ARDUINO_COMMON_INCLUDES=#{self.common_includes}
+ARDUINO_INCLUDE_PATH=-I$(ARDUINO_VARIANTS) $(LIBRARY_INCLUDES)
+nodist_#{self.project_name}_SOURCES=#{self.source_files.join(' ')}
+
+#{self.project_name}_CFLAGS=-Wall $(#{self.project_name}_INCLUDES) $(ARDUINO_INCLUDE_PATH) -Wl,--gc-sections -ffunction-sections -fdata-sections -gstabs -mmcu=$(MCU) $(F_CPU) $(ARDUINO_VERSION) -D__AVR_LIBC_DEPRECATED_ENABLE__
+#{self.project_name}_CXXFLAGS=-Wall $(#{self.project_name}_INCLUDES) $(ARDUINO_INCLUDE_PATH) -Wl,--gc-sections -ffunction-sections -fdata-sections -gstabs -mmcu=$(MCU) $(F_CPU) $(ARDUINO_VERSION) -D__AVR_LIBC_DEPRECATED_ENABLE__
+#{self.project_name}_LDFLAGS=-L.
+#{self.project_name}_LDADD=#{self.arduino_linker_entries.join(' ')} -lm
+#{self.project_name}_INCLUDES=-I#{self.project_includes.join("\\\n                    -I")}
+
+lib_LIBRARIES=#{self.arduino_library_names.join(' ')}
+#{self.output_arduino_libraries}
+
+
+AM_LDFLAGS=
+AM_CXXFLAGS=-g0 -Os
+AM_CFLAGS=-g0 -Os
+VPATH=/usr/share/arduino/hardware/arduino/cores/arduino
+
+# AVRDUDE_PORT=/dev/ttyACM0
+AVRDUDE_PORT=/dev/ttyUSB0
+AVRDUDE_PROGRAMMER = arduino
+# UPLOAD_RATE = 115200
+UPLOAD_RATE = 57600
+FORMAT=ihex
+
+AVRDUDE_WRITE_FLASH = -U flash:w:$(bin_PROGRAMS).hex
+AVRDUDE_FLAGS = -q -D -C/etc/avrdude/avrdude.conf -p$(MCU) -P$(AVRDUDE_PORT) -c$(AVRDUDE_PROGRAMMER) -b$(UPLOAD_RATE)
+
+
+.PHONY: upload
+upload: all-am
+	$(OBJCOPY) -S -O $(FORMAT) $(bin_PROGRAMS) $(bin_PROGRAMS).hex
+	$(AVRDUDE) $(AVRDUDE_FLAGS) $(AVRDUDE_WRITE_FLASH)
+MAKEFILE_AM
+
+      end
+    end
+
+  end
+
+
+  class ConfigureAc
+    attr_accessor :makefile_am
+    def initialize makefile_am
+      @makefile_am = makefile_am
+    end
+    def write_configure_ac
+      ##
+      # Output the configure.ac file
+      ##
+      File.open('configure.ac',"w") do |f|
+        f.puts <<-CONFIGURE_AC
+dnl Process this file with autoconf to produce a configure script.")
+AC_INIT([#{makefile_am.project_name}], [1.0])
+dnl AC_CONFIG_SRCDIR( [ Makefile.am ] )
+AM_INIT_AUTOMAKE
+AM_CONFIG_HEADER(config.h)
+dnl AM_CONFIG_HEADER(config.h)
+dnl Checks for programs.
+AC_PROG_CC( avr-gcc )
+AC_PROG_CXX( avr-g++ )
+AC_PROG_RANLIB( avr-ranlib )
+AC_PATH_PROG(OBJCOPY, avr-objcopy)
+AC_PATH_PROG(AVRDUDE, avrdude)
+
+AC_ISC_POSIX
+
+dnl Checks for libraries.
+
+dnl Checks for header files.
+AC_HAVE_HEADERS( Arduino.h )
+
+dnl Checks for library functions.
+
+dnl Check for st_blksize in struct stat
+
+
+dnl internationalization macros
+AC_OUTPUT([Makefile])
+
+CONFIGURE_AC
+
+      end
+    end
+  end
+
+  class AutogenSh
+    def write_autogen_sh
+      File.open('autogen.sh',"w") do |f|
+      f.puts <<-AUTOGEN_SH
+#!/bin/sh
+if [ -e 'Makefile.am' ] ; then
+    echo "Makefile.am Exists - reconfiguring..."
+    autoreconf --force --install -I config -I m4
+    echo
+    echo
+    echo "************************************"
+    echo "** Now run mkdir build ; cd build ; ../configure --host=avr **"
+    echo "************************************"
+    exit
+fi
+echo "Lets get your project started!"
+
+echo '## Process this file with automake to produce Makefile.in' >> Makefile.am
+echo No Makefile.am
+AUTOGEN_SH
+      end
+    end
+  end
+end