rintcore 0.0.3 → 0.0.4

data/lib/rint_core/printer.rb

@@ -2,24 +2,62 @@ require 'rint_core/driver'
 require 'active_support/configurable'
 
 module RintCore
+  # Interface for directly intereacting with the printer.
   class Printer
     include RintCore::Driver
     include ActiveSupport::Configurable
 
-    # Callbacks are typically given a string argument, usually the current line
+    # @!macro config_accessor
+    #   @!attribute [rw] $1
+    #     @return [String] port that the printer is connected to.
+    #   @!attribute [rw] $2
+    #     @return [Fixnum] baud rate that the printer communicates at, value is not checked against {baud_rates}.
+    #   @!attribute [rw] $3
+    #     @return [Hash<Proc>] procs that are called at places in the code that correlate with their key.
+    #     @todo make a list of all the callbacks that are used
+    #   @!attribute [rw] $4
+    #     @return [String] the response or prefix the printer sends when it encounters an error.
+    #   @!attribute [rw] $5
+    #     @return [String] the response or prefix the printer attaches to debugging messages.
+    #   @!attribute [rw] $6
+    #     @return [Array] the response(s) or prefix(es) the printer sends when it has successfully started.
+    #   @!attribute [rw] $7
+    #     @return [Array] the response(s) or prefix(es) the printer sends when it has received or executed a command.
+    #   @!attribute [rw] $8
+    #     @return [Array] the sequences of character the printer sends when it is reporting temperature information.
+    #   @!attribute [rw] $9
+    #     @return [Array] the response(s) or prefix(es) the printer sends when it needs lines resent.
+    #   @!attribute [rw] $10
+    #     @return [String] the character set that the printer uses to communicate.
+    #     @todo make this have an effect on received responses.
+    #   @!attribute [rw] $11
+    #     @return [Float] the amount of time to sleep while waiting for the line to become clear before sending.
+    #   @!attribute [rw] $12
+    #     @return [Fixnum] the number of times to sleep ({#sleep_time}) after sending a command.
+    #   @!attribute [rw] $13
+    #     @return [Fixnum] read timeout value for the serial port.
+    #   @!attribute [rw] $14
+    #     @return [Float] used in various places while waiting for responses from the printer.
+    #   @!attribute [rw] $15
+    #     @return [Float] speed multiplier (print moves only).
+    #   @!attribute [rw] $16
+    #     @return [Float] extrusion multiplier.
+    #   @!attribute [rw] $17
+    #     @return [Float] travel move multiplier.
     config_accessor :port, :baud, :callbacks, :error_response, :debug_response,
                     :online_response, :good_response, :temperature_response,
                     :resend_response, :encoding, :sleep_time, :wait_period,
-                    :read_timeout, :long_sleep
+                    :read_timeout, :long_sleep, :speed_multiplier, :extrusion_multiplier,
+                    :travel_multiplier
 
     self.port = "/dev/ttyACM0"
     self.baud = 115200
     self.callbacks = {}
-    self.error_response = 'Error'
+    self.error_response = 'error'
     self.debug_response = 'DEBUG_'
     self.online_response = ['start','Grbl']
     self.good_response = ['ok']
-    self.temperature_response = 'T:'
+    self.temperature_response = ['T:']
     self.resend_response = ['rs','resend']
     self.encoding = 'us-ascii'
     self.sleep_time = 0.001
@@ -27,15 +65,35 @@ module RintCore
     self.read_timeout = 0
     self.long_sleep = 0.25
 
+    # @!macro attr_reader
+    #   @!attribute [r] $1
+    #     @return [String] the last line read from the printer
+    #   @!attribute [r] $2
+    #   @return [Array] consists of raw strings of GCode or {GCode::Object}s
+    #   @!attribute [r] $3
+    #     @return [Fixnum] 0 if not printer, other wise indicates the position in {#main_queue}
+    #   @!attribute [r] $4
+    #     @return [Fixnum] normally -1, other wise indicates the position to resend data from in {#machine_history}.
+    #   @!attribute [r] $5
+    #     @return [Array] raw us-ascii strings that have been sent to the printer,
+    #       array index reflects the line number, it is emptied upon print completion.
+    #   @!attribute [r] $6
+    #     @return [Array] raw us-ascii strings that have been sent to the printer since it has been connected.
+    #     @todo make a method to clear the history
     attr_reader :last_line_received, :main_queue, :queue_index, :resend_from, :machine_history, :full_history
 
+    # Creates a new {Printer} instance.
+    # @param auto_connect [Boolean] if true, {#connect!} will be called.
+    # @return [Printer] a new instance of RintCore::Printer
     def initialize(auto_connect = false)
       initialize_driver
       connect! if auto_connect
     end
 
+    # Returns the time since a print has started in human readable format, returns "0 seconds" if not printing.
+    # @return [String] human readable time since print started, or "0 seconds" if not printing.
     def time_from_start
-      @start_time ||= Time.now
+      @start_time = Time.now unless printing?
       secs = Time.now - @start_time
       [[60, :seconds], [60, :minutes], [24, :hours], [1000, :days]].map{ |count, name|
         if secs > 0
@@ -46,10 +104,15 @@ module RintCore
     end
 
     class << self
+      # An array of standard serial port baud rates, useful for checking for a valid configuration.
+      # @return [Array] of standard serial port baud rates.
       def baud_rates
         [2400, 9600, 19200, 38400, 57600, 115200, 250000]
       end
 
+      # A function that checks if the given file exists and is a tty, useful for checking for a valid configuration.
+      # @param port [String] a path on the local file system.
+      # @return [Boolean] true if given path is a tty, false otherwise.
       def is_port?(port)
          port.present? && File.exist?(port) && File.new(port).isatty
       end

data/lib/rint_core/version.rb

@@ -1,3 +1,4 @@
 module RintCore
-  VERSION = "0.0.3"
+  # Current release version of the gem.
+  VERSION = "0.0.4"
 end

data/rintcore.gemspec

@@ -7,19 +7,18 @@ Gem::Specification.new do |gem|
   gem.name                       = "rintcore"
   gem.version                    = RintCore::VERSION
   gem.authors                    = ["Kaz Walker"]
-  gem.email                      = ["kaz.walker@doopli.co"]
-  gem.description                = %q{RepRap/GCode utilities written in Ruby.}
-  gem.summary                    = %q{A Ruby implementation of PrintCore.}
+  gem.email                      = ["kaz.walker@slipline.ca"]
+  gem.description                = %q{A RepRap driver and GCode analyzer written in Ruby.}
+  gem.summary                    = %q{A Ruby implementation of Printrun's printcore.py and gcoder.py.}
   gem.homepage                   = "https://github.com/KazW/RintCore"
 
   gem.files                      = `git ls-files`.split($/)
   gem.executables                = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files                 = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths              = ["lib"]
   gem.required_ruby_version      = '>= 1.9.1'
   gem.add_runtime_dependency     'serialport', '1.1.0'
   gem.add_runtime_dependency     'activesupport'
   gem.add_runtime_dependency     'thor'
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'yard'
 end

metadata

@@ -1,71 +1,93 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rintcore
-version: !ruby/object:Gem::Version 
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Kaz Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-26 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: serialport
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 1.1.0
+  type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
   name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id003 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id003
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id003
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id003
   prerelease: false
-  version_requirements: *id006
-description: RepRap/GCode utilities written in Ruby.
-email: 
-- kaz.walker@doopli.co
-executables: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A RepRap driver and GCode analyzer written in Ruby.
+email:
+- kaz.walker@slipline.ca
+executables:
 - rintcore
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CONTRIBUTING.md
 - Gemfile
@@ -90,28 +112,26 @@ files:
 - rintcore.gemspec
 homepage: https://github.com/KazW/RintCore
 licenses: []
-
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
       version: 1.9.1
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id003
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
-summary: A Ruby implementation of PrintCore.
+summary: A Ruby implementation of Printrun's printcore.py and gcoder.py.
 test_files: []
-
+has_rdoc: