rintcore 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: 25584e4760c4e1b347a2bd718be2d15ea3e6a3a8
-  data.tar.gz: dc98357e1b8995492a12f18622dbfae6b0bab95b
-SHA512: 
-  metadata.gz: 630a045a5a1c463447b5d84c712bf313b9c0a14d080c1386d7b687963b7364ab36c0b023a079c4a8294094e9cdb7a2c7634087615a9ac5f66a4be021a9edc48a
-  data.tar.gz: 679a641143bc7ffe4e3d95e80448bb575c45c16e5b8bbcbbac3729ce27c3bca07186cdf6eb7e7be24f4a98dd52638490f08e3855cc3105a6a3f65e64b4a780f6
+---
+SHA1:
+  metadata.gz: f672b74c95d07cfb62eb006d5209065f57c51bd2
+  data.tar.gz: 64b07a334627117937c29c59d863b0371df74160
+SHA512:
+  metadata.gz: 874f9595f51204151351828eedcb403d679d608a8b04b611283a476a75872fe8711da16c4b25031628278425ce85d96080a69afadf0acff08622da80cb58d269
+  data.tar.gz: 84da65e8d7d6ed60c02c06e4b3dcba01d9ce3cd9479961105d0690769d19d2006c477f471069b9362c9958a8cd6f0dcafcb74d7b2a38ad18b4a7f2c7e540145e

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.ruby-version
+.ruby-version
+profiling.txt

data/README.md

@@ -21,7 +21,8 @@ printer.port = '/dev/ttyUSB0' # Set to /dev/ttyACM0 by default
 printer.baud = 250000 # Set to 115200 by default
 printer.callbacks[:temperature] = Proc.new { |line| puts(line) }
 printer.connect!
-printer.start_print gcode```
+printer.start_print gcode
+```
 
 ### TODO
 Documentation and spec writing.

data/bin/rintcore

@@ -1,4 +1,7 @@
 #!env ruby
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'rubygems'
 require 'rint_core/cli'
 

data/lib/rint_core.rb

@@ -1,5 +1,6 @@
 require "rint_core/version"
 
+# A collection of classes and modules for parsing, analyzing and sending GCode to a RepRap 3D printer.
 module RintCore
-  # Your code goes here...
+
 end

data/lib/rint_core/cli.rb

@@ -5,41 +5,54 @@ require 'thor'
 require 'active_support/core_ext/object/blank'
 
 module RintCore
+  # Provides command line interfaces for interacting with RintCore's classes.
   class Cli < Thor
     map '-a' => :analyze, '-p' => :print
 
     desc 'analyze FILE', 'Get statistics about the given GCode file.'
     method_option :decimals, default: 2, aliases: '-d', type: :numeric, desc: 'The number of decimal places given for measurements.'
+    # Analyze the given file, also sets the @object instance variable to a {RintCore::GCode::Object}.
+    # @param file [String] path to a GCode file on the system.
+    # @return [String] statistics about the given GCode file.
     def analyze(file)
       unless RintCore::GCode::Object.is_file?(file)
         puts "Non-exsitant file: #{file}"
         exit
       end
       @object = RintCore::GCode::Object.new(RintCore::GCode::Object.get_file(file))
+
+      unless @object.present?
+        puts "Non-GCode or empty file: #{file}"
+        exit
+      end
+
       decimals = options[:decimals]
       decimals ||= 2
-      output = <<EOS
-Dimensions:
-\tX: #{@object.x_min.round(decimals)} - #{@object.x_max.round(decimals)} (#{@object.width.round(decimals)}mm)
-\tY: #{@object.y_min.round(decimals)} - #{@object.y_max.round(decimals)} (#{@object.depth.round(decimals)}mm)
-\tZ: #{@object.z_min.round(decimals)} - #{@object.z_max.round(decimals)} (#{@object.height.round(decimals)}mm)
-Total Travel:
-\tX: #{@object.x_travel.round(decimals)}mm
-\tY: #{@object.y_travel.round(decimals)}mm
-\tZ: #{@object.z_travel.round(decimals)}mm
-Filament used: #{@object.filament_used.round(decimals)}mm
-Number of layers: #{@object.layers}
-#{@object.raw_data.length} lines / #{@object.lines.length} commands
-EOS
-      puts output
+
+      puts "Dimensions:\n"\
+            "\tX: #{@object.x_min.round(decimals)} - #{@object.x_max.round(decimals)} (#{@object.width.round(decimals)}mm)\n"\
+            "\tY: #{@object.y_min.round(decimals)} - #{@object.y_max.round(decimals)} (#{@object.depth.round(decimals)}mm)\n"\
+            "\tZ: #{@object.z_min.round(decimals)} - #{@object.z_max.round(decimals)} (#{@object.height.round(decimals)}mm)\n"\
+            "Total Travel:\n"\
+            "\tX: #{@object.x_travel.round(decimals)}mm\n"\
+            "\tY: #{@object.y_travel.round(decimals)}mm\n"\
+            "\tZ: #{@object.z_travel.round(decimals)}mm\n"\
+            "Filament used:\n"
+      @object.filament_used.each_with_index do |filament,extruder|
+        puts "\tExtruder #{extruder+1}: #{filament.round(decimals)}mm"
+      end
+      puts "Number of layers: #{@object.layers}\n"\
+            "#{@object.raw_data.length} lines / #{@object.lines.length} commands"
     end
     
     desc 'print FILE', 'Print the given GCode file.'
     method_option :port, aliases: '-p', type: :string, desc: 'The port that the printer is connected to.'
     method_option :baud, aliases: '-b', type: :numeric, desc: 'The baud rate at which the printer communicates at.'
     method_option :loud, aliases: '-l', default: false, type: :boolean, desc: 'Output additional info (temperature, progress, etc.)'
+    # Analyzes, then prints the given file.
+    # @param file [String] path to a GCode file on the system.
+    # @return [String] value of the disconnect callback in this function.
     def print(file)
-      analyze(file)
       port = options[:port]
       baud = options[:baud]
       baud = baud.to_i unless baud.blank?
@@ -56,6 +69,7 @@ EOS
         baud = baud.to_i unless baud.blank?
         baud = nil unless RintCore::Printer.baud_rates.include?(baud)
       end
+      analyze(file)
       printer = RintCore::Printer.new
       printer.port = port
       printer.baud = baud
@@ -72,7 +86,6 @@ EOS
       until printer.online?
         sleep(printer.long_sleep)
       end
-      start_time = Time.now
       printer.start_print(@object)
       while printer.printing?
         printer.send_now(RintCore::GCode::Codes::GET_EXT_TEMP)

data/lib/rint_core/driver.rb

@@ -5,6 +5,7 @@ require 'rint_core/driver/queueing'
 require 'rint_core/driver/operations'
 
 module RintCore
+  # Conatians the elements of the printer driver.
   module Driver
     include RintCore::Driver::OperatingSystem
     include RintCore::Driver::State
@@ -12,6 +13,7 @@ module RintCore
     include RintCore::Driver::Queueing
     include RintCore::Driver::Operations
     
+    # Calls the initialization functions of the submodules in the correct order
     def initialize_driver
       initialize_state
       initialize_queueing

data/lib/rint_core/driver/operating_system.rb

@@ -1,6 +1,18 @@
 module RintCore
   module Driver
+    # Utilities for performing OS level tasks
     module OperatingSystem
+
+    # Return name of OS as a symbol.
+    # @return [Symbol] name of OS as symbol.
+    def get_os
+      return :linux if /linux/ =~ RUBY_PLATFORM
+      return :mac if /darwin/ =~ RUBY_PLATFORM
+      return :windows if /cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM
+      return :unknown
+    end
+
+private
       def control_ttyhup(port, disable_hup)
         if get_os == :linux
           if disable_hup
@@ -18,13 +30,6 @@ module RintCore
       def disable_hup(port)
         control_ttyhup(port, false)
       end
-
-      def get_os
-        return :linux if /linux/ =~ RUBY_PLATFORM
-        return :mac if /darwin/ =~ RUBY_PLATFORM
-        return :windows if /cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM
-        return :unknown
-      end
     end
   end
 end

data/lib/rint_core/driver/operations.rb

@@ -5,8 +5,11 @@ require 'active_support/core_ext/object/blank'
 
 module RintCore
   module Driver
+    # Provides the raw functionality of the printer.
     module Operations
 
+      # Connects to the printer.
+      # @return [Undefined] returns the value of the connect callback.
       def connect!
         return false if connected?
         if config.port.present? && config.baud.present?
@@ -20,6 +23,8 @@ module RintCore
         end
       end
 
+      # Disconnects to the printer.
+      # @return [Undefined] returns the value of the disconnect callback.
       def disconnect!
         if connected? 
           if @listening_thread
@@ -36,29 +41,45 @@ module RintCore
         config.callbacks[:disconnect].call if config.callbacks[:disconnect].present?
       end
 
+      # Resets the printer.
+      # @return [false] if not connected.
+      # @return [1] if printer was reset.
       def reset!
+        return false unless connected?
         @connection.dtr = 0
         sleep(config.long_sleep)
         @connection.dtr = 1
       end
 
+      # Pauses printing.
+      # @return [Undefined] returns the value of the pause callback.
       def pause!
         return false unless printing?
         @paused = true
-        not_printing!
-        @print_thread.join
+        until @print_thread.alive?
+          sleep(config.sleep_time)
+        end
+        #@print_thread.join
         @print_thread = nil
+        not_printing!
         config.callbacks[:pause].call if config.callbacks[:pause].present?
       end
 
+      # Resumes printing.
+      # @return [Undefined] returns the value of the resume callback.
       def resume!
         return false unless paused?
-        paused!
+        @paused = false
         printing!
         @print_thread = Thread.new{print!()}
         config.callbacks[:resume].call if config.callbacks[:resume].present?
       end
 
+      # Sends the given command to the printer, if printing, will send command after print completion.
+      # @param command [String] the command to send to the printer.
+      # @param wait [Fixnum] number of times to sleep ({RintCore::Printer.sleep_time}).
+      # @param priority [Boolean] defines if command is a priority.
+      # @todo finalize return value.
       def send(command, wait = 0, priority = false)
         if online?
           if printing?
@@ -80,10 +101,18 @@ module RintCore
         end
       end
 
+      # Sends command to the printer immediately by placing it in the priority queue.
+      # @see send
       def send_now(command, wait = 0)
         send(command, wait, true)
       end
 
+      # Starts a print.
+      # @param data [RintCore::GCode::Object] prints the given object.
+      # @param data [Array] executes the each command in the array.
+      # @param start_index [Fixnum] starts printing from the given index (used by {#pause!} and {#resume!}).
+      # @return [false] if printer isn't ready to print or already printing.
+      # @return [true] if print has been started.
       def start_print(data, start_index = 0)
         return false unless can_print?
         data = data.lines if data.class == RintCore::GCode::Object
@@ -104,7 +133,7 @@ private
       def initialize_operations
         @connection = nil
         @listening_thread = nil
-        @printing_thread = nil
+        @print_thread = nil
         @full_history = []
       end
 
@@ -121,6 +150,7 @@ private
         config.callbacks[:start].call if config.callbacks[:start].present?
         while online? && printing? do
           advance_queue
+          return true if paused?
         end
         @print_thread.join
         @print_thread = nil

data/lib/rint_core/driver/parsing.rb

@@ -3,8 +3,10 @@ require 'active_support/core_ext/object/blank'
 
 module RintCore
   module Driver
+    # Handles the parsing of printer responses and formats commands sent to the printer.
     module Parsing
 
+private
       def format_command(command)
         (command.strip + "\n").split(RintCore::GCode::Codes::COMMENT_SYMBOL).first.encode(config.encoding)
       end
@@ -23,9 +25,9 @@ module RintCore
         return :error if line.include?(config.error_response)
         return :debug if line.include?(config.debug_response)
         return :online if line.start_with?(*config.online_response)
-        return :valid if line.start_with?(*config.good_response) && !line.include?(config.temperature_response)
-        return :temperature_response if line.start_with?(*config.good_response) && line.include?(config.temperature_response)
-        return :temperature if line.include?(config.temperature_response)
+        return :valid if line.start_with?(*config.good_response) && !line.include?(*config.temperature_response)
+        return :temperature_response if line.start_with?(*config.good_response) && line.include?(*config.temperature_response)
+        return :temperature if line.include?(*config.temperature_response)
         return :resend if line.start_with?(*config.resend_response)
         return :invalid
       end

data/lib/rint_core/driver/queueing.rb

@@ -3,6 +3,7 @@ require 'active_support/core_ext/object/blank'
 
 module RintCore
   module Driver
+    # Controls the print queue and manages the sending of commands while printing.
     module Queueing
 
 private
@@ -49,17 +50,14 @@ private
       end
 
       def run_priority_queue
-        unless @priority_queue.blank?
-          send!(@priority_queue.shift)
-          # clear_to_send!
-        end
+        send!(@priority_queue.shift) if @priority_queue.present?
       end
 
       def run_main_queue
         if !paused? && @queue_index < @main_queue.length
           current_line = @main_queue[@queue_index]
-          current_line = current_line.to_s unless current_line.class == String
-          unless current_line.blank?
+          current_line = apply_multipliers(current_line) unless current_line.class == String
+          if current_line.present?
             send!(current_line, @line_number, true)
             @line_number += 1
           end
@@ -68,6 +66,13 @@ private
         end
       end
 
+      def apply_multipliers(line)
+        line.speed_multiplier = config.speed_multiplier if config.speed_multiplier.present?
+        line.extrusion_multiplier = config.extrusion_multiplier if config.extrusion_multiplier.present?
+        line.travel_multiplier = config.travel_multiplier if config.travel_multiplier.present?
+        line.to_s
+      end
+
     end
   end
 end

data/lib/rint_core/driver/state.rb

@@ -3,32 +3,35 @@ require 'active_support/core_ext/object/blank'
 
 module RintCore
   module Driver
+    # keeps track of the driver's state
     module State
 
+      # Checks if the printer can start a print.
+      # @return [Boolean] true if printer is ready to print, false otherwise.
       def can_print?
         connected? && online? && !printing?
       end
 
+      # Checks if printer is connected.
+      # @return [Boolean] true if serial port connection is present, false otherwise.
       def connected?
         @connection.present?
       end
 
-      def clear_to_send?
-        @clear && online?
-      end
-
-      def listen_can_continue?
-        !@stop_listening && connected?
-      end
-
+      # Checks if the printer is online.
+      # @return [Boolean] true if online, false otherwise.
       def online?
         connected? && @online
       end
 
+      # Checks if printing is paused.
+      # @return [Boolean] true if pause, false otherwise.
       def paused?
         @paused
       end
 
+      # Checks if the printer is currently printing.
+      # @return [Boolean] true if printing, false otherwise.
       def printing?
         @printing
       end
@@ -43,10 +46,18 @@ private
         @stop_listening = false
       end
 
+      def clear_to_send?
+        @clear && online?
+      end
+
       def clear_to_send!
         @clear = true
       end
 
+      def listen_can_continue?
+        !@stop_listening && connected?
+      end
+
       def not_clear_to_send!
         @clear = false
       end

data/lib/rint_core/g_code.rb

@@ -1,5 +1,6 @@
 require 'rint_core/g_code/codes'
 module RintCore
+  # Contains classes for analyzing and parsing GCode.
   module GCode
 
   end

data/lib/rint_core/g_code/codes.rb

@@ -1,49 +1,105 @@
+#require 'active_support/core_ext/string/inflections'
+
 module RintCore
   module GCode
+    # Contains GCodes.
     module Codes
+      # Do a rapid move.
       RAPID_MOVE      = 'G0'
+      # Do a move at the given or previously given acceleration (F).
       CONTROLLED_MOVE = 'G1'
+      # Pause for (P) a given number of milliseconds.
       DWELL           = 'G4'
+      # Set head offset (for multiple extruders).
       HEAD_OFFSET     = 'G10'
+      # Set units in following commands to be imperial.
       USE_INCHES      = 'G20'
+      # Set units in following commands to be metric (default).
       USE_MILLIMETRES  = 'G21'
+      # Home axes.
       HOME            = 'G28'
+      # Set following commands to use absolute coordinates.
       ABS_POSITIONING = 'G90'
+      # Set following commands to use relative coordinates.
       REL_POSITIONING = 'G91'
+      # Set current position.
       SET_POSITION    = 'G92'
+      # Finish moves, then shutdown (reset required to wake machine).
       STOP            = 'M0'
+      # Finish moves the shutdown (sending commands will wake machine).
       SLEEP           = 'M1'
+      # Enable motors.
       ENABLE_MOTORS   = 'M17'
+      # Disable motors.
       DISABLE_MOTORS  = 'M18'
+      # List contents of SD card.
       LIST_SD         = 'M20'
+      # Initialize SD card (needed if card wasn't present at bootup).
       INIT_SD         = 'M21'
+      # Release SD (safe removal of SD).
       RELEASE_SD      = 'M22'
+      # Select SD file (require to print from SD).
       SELECT_SD_FILE  = 'M23'
+      # Print selected file from SD (requires file to be selected).
       START_SD_PRINT  = 'M24'
+      # Pause printing from SD card.
       PAUSE_SD_PRINT  = 'M25'
+      # Set SD position in bytes.
       SET_SD_POSITION = 'M26'
+      # Report SD printing status.
       SD_PRINT_STATUS = 'M27'
+      # Write following GCodes to given file (requires 8.3 file name).
       START_SD_WRITE  = 'M28'
+      # Signal end of SD write, following commands will be executed as normal.
       STOP_SD_WRITE   = 'M29'
+      # Power on.
       POWER_ON        = 'M80'
+      # Power off.
       POWER_OFF       = 'M81'
+      # Set extrusion units in following commands to absolute coordinates.
       ABS_EXT_MODE    = 'M82'
+      # Set extrusion units in following commands to relative coordinates.
       REL_EXT_MODE    = 'M83'
+      # Trun off powered holding of motors when idle.
       IDLE_HOLD_OFF   = 'M84'
+      # Set Extruder tmeperature and return control to host.
       SET_EXT_TEMP_NW = 'M104'
+      # Report temperatures
       GET_EXT_TEMP    = 'M105'
+      # Trun fans on to given value (S, 0-255).
       FAN_ON          = 'M106'
+      # Turn off fans
       FAN_OFF         = 'M107'
+      # Set extruder temperature and wait for it to reach temperature.
       SET_EXT_TEMP_W  = 'M109'
+      # Reset the line number for the following commands.
       SET_LINE_NUM    = 'M110'
+      # Emergency stop.
       EMRG_STOP       = 'M112'
+      # Report position.
       GET_POSITION    = 'M114'
+      # Report firmware details.
       GET_FW_DETAILS  = 'M115'
+      # Wait for temperature (all extruders and bed) to reach the temerature they were set to.
       WIAT_FOR_TEMP   = 'M116'
-      # ... Left out codes that probably won't be used
+      # Set bed temperature and return control to host.
       SET_BED_TEMP_NW = 'M140'
+      # Set bed temperature and wait for it to reach temperature.
       SET_BED_TEMP_W  = 'M190'
+      # Comment symbol
+      # @todo Move this to a configurable option.
       COMMENT_SYMBOL  = ';'
+
+      # An array of the constant's values.
+      # @return [Array] of GCode commands.
+      # REMOVED: major performance issues
+      # def available_commands
+      #   commands = []
+      #   RintCore::GCode::Codes.constants.each do |constant|
+      #     commands << ('RintCore::GCode::Codes::'+constant.to_s).constantize
+      #   end
+      #   commands
+      # end
     end
   end
 end