workshop 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9870f8948edd099f794820edd95ce571d6a63f91
+  data.tar.gz: 53375c9b212cc79172241e5b1ea2a680cb8b2321
+SHA512:
+  metadata.gz: 39fd47e99f2761874540c3d89536a281b82f35da3a4c2eeccfe5491cbe2ef4412d86dca323003df528971d1d524f67aad466c1a461f5669dbd692cf3bf81b0b4
+  data.tar.gz: d3ae1227900daa6f9b6ff8cdeb5c10bf68e106991f47c2053e05397f457feb88a44f8e4b2e6fd2ace746dfa28f9b1205faed86731d75d34e7aa89120c962d728

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
+examples/blink/build

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chase McCarthy
+
+MIT License
+
+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,23 @@
+# Workshop
+
+An Arduino project build system designed to make Arduino development more fun and less... crappy
+
+## Installation
+
+Install the gem:
+
+    $ gem install workshop
+
+## Usage
+
+Use the workshop:
+
+    $ workshop create blink
+
+    $ cd blink/
+
+    $ rake
+
+## Contributing
+
+Pull requests and comments welcome!

data/Rakefile

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

data/bin/workshop

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "workshop/cli"

data/examples/blink/Rakefile

@@ -0,0 +1,15 @@
+require 'workshop'
+
+Workshop::Project.configure do |config|
+  # Configured for an Arduino Fio v3
+  config.project_name = 'blink'
+  config.build.mcu = 'atmega32u4'
+  config.build.core = 'arduino'
+  config.build.variant = 'promicro'
+  config.build.vid = '0x1B4F'
+  config.build.pid = '0x9204'
+  config.build.f_cpu = '8000000L'
+  config.build.includes << '~/Documents/Arduino/hardware/SF32u4_boards/variants/promicro'
+  config.upload.protocol = 'avr109'
+  config.upload.speed = 57600
+end

data/examples/blink/config/com_port.yml

@@ -0,0 +1,2 @@
+---
+port: /dev/tty.usbmodem1411

data/examples/blink/src/blink.cpp

@@ -0,0 +1,30 @@
+#line 1 "Blink.ino"
+/*
+  Blink
+  Turns on an LED on for one second, then off for one second, repeatedly.
+
+  This example code is in the public domain.
+ */
+
+// Pin 13 has an LED connected on most Arduino boards.
+// give it a name:
+#include "Arduino.h"
+void setup();
+void loop();
+#line 10
+int led = 13;
+
+// the setup routine runs once when you press reset:
+void setup() {
+  // initialize the digital pin as an output.
+  pinMode(led, OUTPUT);
+}
+
+// the loop routine runs over and over again forever:
+void loop() {
+  digitalWrite(led, HIGH);   // turn the LED on (HIGH is the voltage level)
+  delay(100);               // wait for a second
+  digitalWrite(led, LOW);    // turn the LED off by making the voltage LOW
+  delay(100);               // wait for a second
+}
+

data/lib/workshop.rb

@@ -0,0 +1,18 @@
+require "rake"
+require "yaml"
+require "active_support/core_ext/string/inflections"
+# Get rid of deprication warning
+I18n.enforce_available_locales = false
+require "workshop/version"
+require "workshop/project"
+require "workshop/builder"
+require "workshop/uploader"
+require "workshop/arduino"
+require "workshop/tools"
+require "workshop/tasks"
+require "workshop/project/configuration"
+require "workshop/project/configuration/build"
+require "workshop/project/configuration/upload"
+
+module Workshop
+end

data/lib/workshop/arduino.rb

@@ -0,0 +1,34 @@
+module Workshop
+  class Arduino
+    attr_accessor :config
+
+    def initialize(config)
+      self.config = config
+    end
+
+    def hardware_path
+      '/Contents/Resources/Java/hardware'
+    end
+
+    def hardware_directory
+      config.arduino_app_directory + hardware_path
+    end
+
+    def core_directory
+      hardware_directory + '/arduino/cores/' + config.build_core
+    end
+
+    def variant_directory
+      # TODO - find proper variant dir (could be in documents)
+      if config.build_variant
+        dir = hardware_directory + '/arduino/variants/' + config.build_variant
+        if File.directory?(dir)
+          dir
+        else
+          nil
+        end
+
+      end
+    end
+  end
+end

data/lib/workshop/builder.rb

@@ -0,0 +1,199 @@
+module Workshop
+  class Builder
+    include FileUtils
+    attr_accessor :project, :tools
+
+    def initialize(project)
+      self.project = project
+      self.tools = Workshop::Tools.new project.arduino_hardware_directory
+    end
+
+    def main_name
+      project.name.parameterize.underscore
+    end
+
+    def main_filename
+      if project.main_filename
+        project.app_directory + '/' + project.main_filename
+      else
+        source_files.first
+      end
+    end
+
+    def create_build_directory
+      Dir.mkdir(project.build_directory) unless Dir.exists?(project.build_directory)
+    end
+
+    def clean
+      FileUtils.rm_rf(project.build_directory)
+    end
+
+    def core_files
+      code_files_in_directory project.arduino_core_directory
+    end
+
+    def variant_files
+      code_files_in_directory(project.arduino_variant_directory)
+    end
+
+    def source_files
+      code_files_in_directory project.source_directory
+    end
+
+    def all_source_files
+      core_files + variant_files + source_files
+    end
+
+    def compile_command_for(filename)
+      [
+        tools.compiler(filename),
+        compiler_flags,
+        include_flags,
+        filename,
+        "-o #{output_file(filename)}"
+      ].join(' ')
+    end
+
+    def archive_command_for(filename)
+      [
+        tools.avr_ar,
+        'rcs',
+        archive_file,
+        filename,
+      ].join(' ')
+    end
+
+    def compile
+      all_source_files.each do |filename|
+        sh compile_command_for(filename)
+      end
+    end
+
+    def o_files_to_archive
+      all_source_files.reject do |filename|
+        filename == main_output_file
+      end.map { |filename| output_file(filename) }
+    end
+
+    def archive
+      o_files_to_archive.each do |filename|
+        sh archive_command_for(filename)
+      end
+    end
+
+    def output_file(filename)
+      project.build_directory + '/' + File.basename(filename) + '.o'
+    end
+
+    def main_output_file
+      project.build_directory + '/' + File.basename(main_filename) + '.o'
+    end
+
+    def archive_file
+      project.build_directory + '/core.a'
+    end
+
+    def elf_file
+      project.build_directory + '/' + main_name + '.elf'
+    end
+
+    def eeprom_file
+      project.build_directory + '/' + main_name + '.eep'
+    end
+
+    def hex_file
+      project.build_directory + '/' + main_name + '.hex'
+    end
+
+    def linker_flags
+      [
+        '-Os',
+        '-Wl,--gc-sections',
+        "-mmcu=#{project.build_mcu}"
+      ].join(' ')
+    end
+
+    def link_command
+      [
+        tools.avr_gcc,
+        linker_flags,
+        "-o #{elf_file}",
+        main_output_file,
+        archive_file,
+        "-L #{project.build_directory}",
+        '-lm'
+      ].join(' ')
+    end
+
+    def link
+      sh link_command
+    end
+
+    def eeprom_command
+      [
+        tools.avr_objcopy,
+        eeprom_flags,
+        elf_file,
+        eeprom_file,
+      ].join(' ')
+    end
+
+    def create_eeprom
+      sh eeprom_command
+    end
+
+    def hex_command
+      [
+        tools.avr_objcopy,
+        hex_flags,
+        elf_file,
+        hex_file,
+      ].join(' ')
+    end
+
+    def create_hex
+      sh hex_command
+    end
+
+    def compiler_flags
+      [
+        '-c',
+        '-g',
+        '-Os',
+        '-Wall',
+        '-fno-exceptions',
+        '-ffunction-sections',
+        '-fdata-sections',
+        ("-mmcu=#{project.build_mcu}" if project.build_mcu),
+        ("-DF_CPU=#{project.build_f_cpu}" if project.build_f_cpu),
+        '-MMD',
+        ("-DUSB_VID=#{project.build_vid}" if project.build_vid),
+        ("-DUSB_PID=#{project.build_pid}" if project.build_pid),
+        ("-DARDUINO=#{project.build_arduino}" if project.build_arduino)
+      ].join(' ')
+    end
+
+    def include_flags
+      include_directories.compact.map { |include| "-I#{File.expand_path(include)}"}.join(' ')
+    end
+
+    def include_directories
+      [project.arduino_core_directory, project.arduino_variant_directory] + project.includes
+    end
+
+    def eeprom_flags
+      '-O ihex -j .eeprom --set-section-flags=.eeprom=alloc,load --no-change-warnings --change-section-lma .eeprom=0'
+    end
+
+    def hex_flags
+      '-O ihex -R .eeprom'
+    end
+
+    def code_files_in_directory(directory)
+      return [] unless directory
+      Dir[directory + '/**/*.c'] +
+      Dir[directory + '/**/*.cpp']
+    end
+
+  end
+end

data/lib/workshop/cli.rb

@@ -0,0 +1,23 @@
+require 'thor'
+require 'erb'
+require 'colorize'
+require 'pathname'
+require 'workshop/project/setup'
+
+module Workshop
+  class Cli < Thor
+
+    desc "create NAME", "create a new project called NAME"
+    long_desc <<-LONGDESC
+      `workshop create foo` will create a new folder in the current directory\
+      named `foo` and initialize an arduino project in that directory.
+    LONGDESC
+    def create(name)
+      dir = File.expand_path('./' + name)
+      Workshop::Project::Setup.new(dir, name).run
+    end
+
+  end
+end
+
+Workshop::Cli.start(ARGV)

data/lib/workshop/project.rb

@@ -0,0 +1,99 @@
+module Workshop
+  class Project
+    attr_accessor :config, :arduino, :builder, :uploader
+
+    def self.configure(&block)
+      new(&block)
+    end
+
+    def initialize(&block)
+      self.config = Workshop::Project::Configuration.new
+      block.call(config)
+      self.arduino = Workshop::Arduino.new(config)
+      self.builder = Workshop::Builder.new(self)
+      self.uploader = Workshop::Uploader.new(self, builder.hex_file)
+      Workshop::Tasks.new(builder, uploader)
+    end
+
+    def name
+      config.project_name
+    end
+
+    def app_directory
+      config.app_directory
+    end
+
+    def main_filename
+      config.main_filename
+    end
+
+    def arduino_hardware_directory
+      arduino.hardware_directory
+    end
+
+    def arduino_variant_directory
+      arduino.variant_directory
+    end
+
+    def arduino_core_directory
+      arduino.core_directory
+    end
+
+    def source_directory
+      config.source_directory
+    end
+
+    def includes
+      config.includes
+    end
+
+    def build_directory
+      config.build_directory
+    end
+
+    def build_mcu
+      config.build_mcu
+    end
+
+    def build_f_cpu
+      config.build_f_cpu
+    end
+
+    def build_vid
+      config.build_vid
+    end
+
+    def build_pid
+      config.build_pid
+    end
+
+    def build_arduino
+      # TODO - where does this come from?
+      '105'
+    end
+
+    def programmer
+      # TODO - read from boards.txt file
+      config.upload_protocol
+    end
+
+    def com_port
+      com_port_config['port']
+    end
+
+    def baud_rate
+      # TODO - read from boards.txt file
+      config.upload_speed
+    end
+
+    private
+
+    def com_port_config
+      YAML::load_file(File.join(app_directory, 'config/com_port.yml'))
+    end
+
+    def config=(config)
+      @config = config
+    end
+  end
+end