rintcore 0.0.3 → 0.0.4

data/lib/rint_core/g_code/line.rb

@@ -1,81 +1,176 @@
 require 'rint_core/g_code/codes'
-require 'active_support/core_ext/object/blank'
 
 module RintCore
   module GCode
+    # Represents a single line in a GCode file, parse expression tester: {http://rubular.com/}
     class Line
       include RintCore::GCode::Codes
 
-      attr_accessor :imperial, :relative, :f
-      attr_reader :raw
-      attr_writer :x, :y, :z, :e
-
+      # @!macro attr_accessor
+      #   @!attribute [rw] $1
+      #     @param speed_multiplier [Float] number speed (F) will be multiplied by.
+      #     @return [nil] if the speed multiplier is not set.
+      #     @return [Float] the speed multiplier (print moves only).
+      #   @!attribute [rw] $2
+      #     @param extrusion_multiplier [Float] number extrusions (E) will be multiplied by.
+      #     @return [nil] if the extrusion multiplier is not set.
+      #     @return [Float] the extrusion multiplier.
+      #   @!attribute [rw] $3
+      #     @param travel_multiplier [Float] number travel move speeds (F) will be multiplied by.
+      #     @return [nil] if the travel multiplier is not set.
+      #     @return [Float] the travel multiplier.
+      #   @!attribute [rw] $4
+      #     @param tool_number [Fixnum] the tool used in the command.
+      #     @return [Fixnum] the tool used in the command.
+      #   @!attribute [rw] $5
+      #     @param f [Float] speed of the command (in mm/minute).
+      #     @return [Float] the speed of the command (in mm/minute).
+      attr_accessor :speed_multiplier, :extrusion_multiplier,
+                    :travel_multiplier, :tool_number, :f
+
+      # @!macro attr_reader
+      #   @!attribute [r] $1
+      #     @return [String] the line, upcased and stripped of whitespace.
+      #   @!attribute [r] $2
+      #     @return [nil] if the line wasn't valid GCode.
+      #     @return [MatchData] the raw matches from the regular evaluation expression.
+      #   @!attribute [r] $3
+      #     @return [String] ready to send version of the original line (no multipliers, call {#to_s} to apply multipliers).
+      #   @!attribute [r] $4
+      #     @return [String] command portion of the line.
+      #   @!attribute [r] $5
+      #     @return [String] command letter of the line (G,M,T).
+      #   @!attribute [r] $6
+      #     @return [Fixnum] command number of the line (ex. 28 for "G28").
+      #   @!attribute [r] $7
+      #     @return [nil] if there's no S data for the command.
+      #     @return [Fixnum] S data for the command.
+      #   @!attribute [r] $8
+      #     @return [nil] if there's no P data for the command.
+      #     @return [Fixnum] P data for the command.
+      #   @!attribute [r] $9
+      #     @return [nil] if there's no X coordinate of the command.
+      #     @return [Float] X coordinate of the command.
+      #   @!attribute [r] $10
+      #     @return [nil] if there's no Y coordinate of the command.
+      #     @return [Float] Y coordinate of the command.
+      #   @!attribute [r] $11
+      #     @return [nil] if there's no Z coordinate of the command.
+      #     @return [Float] Z coordinate of the command.
+      #   @!attribute [r] $12
+      #     @return [nil] if there's no E parameter of the command.
+      #     @return [Float] E parameter of the command.
+      attr_reader :raw, :matches, :line, :command, :command_letter, :command_number,
+                  :s_data, :p_data, :x, :y, :z, :e
+
+      # Creates a {Line}
+      # @param line [String] a line of GCode.
+      # @return [false] if line is empty or doesn't match the evaluation expression.
+      # @return [Line]
       def initialize(line)
-        @coordinates = ['X','Y','Z','E','F']
-        @number_pattern = /[-]?\d+[.]?\d*/
-        @raw = line.upcase.strip
-        @raw = @raw.split(COMMENT_SYMBOL).first.strip if line.include?(COMMENT_SYMBOL)
-
-        parse_coordinates
+        return false if line.nil? || line.empty?
+        @raw = line
+        @gcode_pattern = /^(?<line>(?<command>((?<command_letter>[G|M|T])(?<command_number>\d{1,3}))) ?(?<regular_data>([S](?<s_data>\d*))? ?([P](?<p_data>\d*))? ?([X](?<x_data>[-]?\d+\.?\d*))? ?([Y](?<y_data>[-]?\d+\.?\d*))? ?([Z](?<z_data>[-]?\d+\.?\d*))? ?([F](?<f_data>\d+\.?\d*))? ?([E](?<e_data>[-]?\d+\.?\d*))?)? (?<string_data>[^;]*)?)? ?;?(?<comment>.*)$/
+        @matches = @raw.match(@gcode_pattern)
+        return false if @matches.nil?
+        assign_values unless @matches.nil?
       end
 
-      def to_mm(number)
-        number *= 25.4 if number.present? && @imperial
-        number
+      # Checks if the given line is more than just a comment.
+      # @return [Boolean] true if empty/invalid
+      def empty?
+        @command.nil?
       end
 
-      def x
-        to_mm @x
+      # Checks if the command in the line causes movement.
+      # @return [Boolean] true if command moves printer, false otherwise.
+      def is_move?
+        @command == RAPID_MOVE || @command == CONTROLLED_MOVE
       end
 
-      def y
-        to_mm @y
+      # Checks whether the line is a travel move or not.
+      # @return [Boolean] true if line is a travel move, false otherwise.
+      def travel_move?
+        is_move? && @e.nil?
       end
 
-      def z
-        to_mm @z
+      # Checks whether the line is as extrusion move or not.
+      # @return [Boolean] true if line is an extrusion move, false otherwise.
+      def extrusion_move?
+        is_move? && !@e.nil? && @e > 0
       end
 
-      def e
-        to_mm @e
+      # Checks wether the line is a full home or not.
+      # @return [Boolean] true if line is full home, false otherwise.
+      def full_home?
+        @command == HOME && !@x.nil? && !@y.nil? && !@z.nil?
       end
 
-      def command
-        if @raw.present?
-          @raw.split(' ').first
-        else
-          ''
-        end
-      end
+      # Returns the line, modified if multipliers are set.
+      # @return [String] the line.
+      def to_s
+        return @line if @extrusion_multiplier.nil? && @speed_multiplier.nil?
+
+        new_f = multiplied_speed unless is_move?
+        new_e = multiplied_extrusion unless @e.nil?
+
+        x_string = !@x.nil? ? " X#{@x}" : ''
+        y_string = !@y.nil? ? " Y#{@y}" : ''
+        z_string = !@z.nil? ? " Z#{@z}" : ''
+        e_string = !@e.nil? ? " E#{new_e}" : ''
+        f_string = is_move? ? " F#{new_f}" : ''
+        string = !@string_data.nil? ? " #{@string_data}" : ''
 
-      def get_float(axis)
-        @raw.split(axis).last.scan(@number_pattern).first.to_f
+        "#{@command}#{x_string}#{y_string}#{z_string}#{f_string}#{e_string}#{string}"
       end
 
-      def parse_coordinates
-        @coordinates.each do |axis|
-          send(axis.downcase+'=', get_float(axis)) if @raw.include?(axis)
-        end
+private
+
+      def assign_values
+        command_assignments
+        coordinate_assignments
+        @s = @matches[:s_data].to_i unless @matches[:s_data].nil?
+        @p = @matches[:p_data].to_i unless @matches[:p_data].nil?
+        @string_data = @matches[:string_data]
+        @comment = @matches[:comment].strip unless @matches[:comment].nil?
       end
 
-      def is_move?
-        @raw.start_with?(RAPID_MOVE) || @raw.start_with?(CONTROLLED_MOVE)
+      def command_assignments
+        @command = @matches[:command]
+        @line = @matches[:line] unless @matches[:line].nil?
+        @command_letter = @matches[:command_letter]
+        @command_number = @matches[:command_number].to_i unless @matches[:command_number].nil?
+        @tool_number = @command_number if !@matches[:command_letter].nil? && @matches[:command_letter] == 'T'
       end
 
-      def travel_move?
-        is_move? && !@e.present?
+      def coordinate_assignments
+        @x = @matches[:x_data].to_f unless @matches[:x_data].nil?
+        @y = @matches[:y_data].to_f unless @matches[:y_data].nil?
+        @z = @matches[:z_data].to_f unless @matches[:z_data].nil?
+        @f = @matches[:f_data].to_f unless @matches[:f_data].nil?
+        @e = @matches[:e_data].to_f unless @matches[:e_data].nil?
       end
 
-      def extrusion_move?
-        is_move? && @e.present? && @e > 0
+      def multiplied_extrusion
+        if valid_multiplier?(@extrusion_multiplier)
+          return @e * @extrusion_multiplier
+        else
+          @e
+        end
       end
 
-      def full_home?
-        command == HOME && @x.blank? && @y.blank? && @z.blank?
+      def multiplied_speed
+        if travel_move? && valid_multiplier?(@travel_multiplier)
+          return @f * @travel_multiplier
+        elsif extrusion_move? && valid_multiplier?(@speed_multiplier)
+          return @f * @speed_multiplier
+        else
+         return @f
+        end
       end
 
-      def to_s
-        @raw
+      def valid_multiplier?(multiplier)
+        !multiplier.nil? && (multiplier.class == Fixnum || multiplier.class == Float) && multiplier > 0
       end
 
     end

data/lib/rint_core/g_code/object.rb

@@ -1,45 +1,121 @@
 require 'rint_core/g_code/codes'
 require 'rint_core/g_code/line'
-require 'active_support/core_ext/object/blank'
 
 module RintCore
   module GCode
+    # A class that represents a processed GCode file.
     class Object
       include RintCore::GCode::Codes
 
-      attr_accessor :raw_data, :layers
+      # An array of the raw Gcode with each line as an element.
+      # @return [Array] of raw GCode without the comments stripped out.
+      attr_accessor :raw_data
+      # @!macro attr_reader
+      #   @!attribute [r] $1
+      #     @return [Array<Line>] an array of {Line}s.
+      #   @!attribute [r] $2
+      #     @return [Float] the smallest X coordinate of an extrusion line.
+      #   @!attribute [r] $3
+      #     @return [Float] the biggest X coordinate of an extrusion line.
+      #   @!attribute [r] $4
+      #     @return [Float] the smallest Y coordinate of an extrusion line.
+      #   @!attribute [r] $5
+      #     @return [Float] the biggest Y coordinate of an extrusion line.
+      #   @!attribute [r] $6
+      #     @return [Float] the smallest Z coordinate.
+      #   @!attribute [r] $7
+      #     @return [Float] the biggest Z coordinate.
+      #   @!attribute [r] $8
+      #     @return [Array<Float>] the amount in mm of fliament extruded with the index representing the extruder.
+      #   @!attribute [r] $9
+      #     @return [Float] the distance in total that the X axis will travel in mm.
+      #   @!attribute [r] $10
+      #     @return [Float] the distance in total that the Y axis will travel in mm.
+      #   @!attribute [r] $11
+      #     @return [Float] the distance in total that the Z axis will travel in mm.
+      #   @!attribute [r] $12
+      #     @return [Float] the distance in total that the E axis will travel in mm.
+      #     @todo implement this
+      #   @!attribute [r] $13
+      #     @return [Float] the width of the print.
+      #   @!attribute [r] $14
+      #     @return [Float] the depth of the print.
+      #   @!attribute [r] $15
+      #     @return [Float] the height of the print.
+      #   @!attribute [r] $16
+      #   @return [Fixnum] the number of layers in the print.
       attr_reader :lines, :x_min, :x_max, :y_min, :y_max, :z_min, :z_max,
                   :filament_used, :x_travel, :y_travel, :z_travel, :e_travel,
-                  :width, :depth, :height
+                  :width, :depth, :height, :layers
 
-      def initialize(data = nil)
+      # Creates a GCode {Object}.
+      # @param data [String] path to a GCode file on the system.
+      # @param data [Array] with each element being a line of GCode.
+      # @param default_speed [Float] the default speed (in mm/minute) for moves that don't have one declared.
+      # @param auto_process [Boolean] enable/disable auto processing.
+      # @return [Object] if data is valid, returns a GCode {Object}.
+      # @return [false] if data is not an array, path, didn't contain GCode or default_speed wasn't a number grater than 0.
+      def initialize(data = nil, default_speed = 2400, auto_process = true)
+        return false if default_speed.nil? && (default_speed.class == Fixnum || default_speed.class == Float) && default_speed <= 0
         if data.class == String && self.class.is_file?(data)
           data = self.class.get_file(data)
         end
-        return false if data.blank? || data.class != Array
-        @raw_data = data
-        @imperial = false
-        @relative = false
-        @lines = []
+        return false if data.nil? || data.class != Array
+        set_variables(data, default_speed)
         data.each do |line|
           line = RintCore::GCode::Line.new(line)
-          @lines << line if line.raw.present?
+          @lines << set_line_properties(line) if line && !line.command.nil?
         end
-        process
+        process if auto_process
+        return false if empty?
       end
 
+      # Checks if the given string is a file and if it exists.
+      # @param file [String] path to a file on the system.
+      # @return [Boolean] true if is a file that exists on the system, false otherwise.
       def self.is_file?(file)
-        file.present? && File.exist?(file) && File.file?(file)
+        !file.nil? && !file.empty? && File.exist?(file) && File.file?(file)
       end
 
+      # Returns an array of the lines of the file if it exists.
+      # @param file [String] path to a file on the system.
+      # @return [Array] containting the lines of the given file as elements.
+      # @return [false] if given string isn't a file or doesn't exist.
       def self.get_file(file)
+        return false unless self.is_file?(file)
         IO.readlines(file)
       end
 
+      # Checks if there are any {Line}s in {#lines}.
+      # @return [Boolean] true if no lines, false otherwise.
+      def blank?
+        empty?
+      end
+
+      # Checks if there are any {Line}s in {#lines}.
+      # @return [Boolean] true if no lines, false otherwise.
+      def empty?
+        @lines.empty?
+      end
+
+      # Opposite of {#empty?}.
+      # @see #empty?
+      def present?
+        !empty?
+      end
+
+      # Checks if the GCode object contains multiple materials.
+      # @return [nil] if processing hasn't been done.
+      # @return [Boolean] true if multiple extruders used, false otherwise.
+      def multi_material?
+        return nil unless @width
+        @filament_used.length > 1
+      end
+
 private
 
       def process
-        set_variables
+        set_processing_variables
 
         @lines.each do |line|
           case line.command
@@ -63,94 +139,105 @@ private
           end
         end
 
+        set_dimensions
+      end
+
+      def set_dimensions
         @width = @x_max - @x_min
         @depth = @y_max - @y_min
         @height = @z_max - @z_min
       end
 
       def count_layers(line)
-        if line.z.present? && line.z > @current_z
+        if !line.z.nil? && line.z > @current_z
           @layers += 1
         end
       end
 
       def movement_line(line)
-        line.imperial = @imperial
-        line.relative = @relative
         measure_travel(line)
         set_current_position(line)
         set_limits(line)
       end
 
       def measure_travel(line)
-        if line.relative
-          @x_travel += line.x.abs if line.x.present?
-          @y_travel += line.y.abs if line.y.present?
-          @z_travel += line.z.abs if line.z.present?
+        if @relative
+          @x_travel += to_mm(line.x).abs unless line.x.nil?
+          @y_travel += to_mm(line.y).abs unless line.y.nil?
+          @z_travel += to_mm(line.z).abs unless line.z.nil?
         else
-          @x_travel += (@current_x - line.x).abs if line.x.present?
-          @y_travel += (@current_y - line.y).abs if line.y.present?
-          @z_travel += (@current_z - line.z).abs if line.z.present?
+          @x_travel += (@current_x - to_mm(line.x)).abs unless line.x.nil?
+          @y_travel += (@current_y - to_mm(line.y)).abs unless line.y.nil?
+          @z_travel += (@current_z - to_mm(line.z)).abs unless line.z.nil?
         end
       end
 
       def home_axes(line)
-        if line.x.present? || line.full_home?
+        if !line.x.nil? || line.full_home?
           @x_travel += @current_x
           @current_x = 0
         end
-        if line.y.present? || line.full_home?
+        if !line.y.nil? || line.full_home?
           @y_travel += @current_y
           @current_y = 0
         end
-        if line.z.present? || line.full_home?
+        if !line.z.nil? || line.full_home?
           @z_travel += @current_z
           @current_z = 0
         end
       end
 
       def set_positions(line)
-        @current_x = line.x if line.x.present?
-        @current_y = line.y if line.y.present?
-        @current_z = line.z if line.z.present?
-        if line.e.present?
-          @filament_used += @current_e
-          @current_e = line.e
+        @current_x = to_mm(line.x) unless line.x.nil?
+        @current_y = to_mm(line.y) unless line.y.nil?
+        @current_z = to_mm(line.z) unless line.z.nil?
+        unless line.e.nil?
+          @filament_used[line.tool_number] = 0 if @filament_used[line.tool_number].nil?
+          @filament_used[line.tool_number] += @current_e
+          @current_e = to_mm(line.e)
         end
       end
 
       def set_current_position(line)
-        if line.relative
-          @current_x += line.x if line.x.present?
-          @current_y += line.y if line.y.present?
-          @current_z += line.z if line.z.present?
-          @current_e += line.e if line.e.present?
+        if @relative
+          @current_x += to_mm(line.x) unless line.x.nil?
+          @current_y += to_mm(line.y) unless line.y.nil?
+          @current_z += to_mm(line.z) unless line.z.nil?
+          @current_e += to_mm(line.e) unless line.e.nil?
         else
-          @current_x = line.x if line.x.present?
-          @current_y = line.y if line.y.present?
-          @current_z = line.z if line.z.present?
-          @current_e = line.e if line.e.present?
+          @current_x = to_mm(line.x) unless line.x.nil?
+          @current_y = to_mm(line.y) unless to_mm(line.y).nil?
+          @current_z = to_mm(line.z) unless line.z.nil?
+          @current_e = to_mm(line.e) unless line.e.nil?
         end
       end
 
       def set_limits(line)
         if line.extrusion_move?
-          if line.x.present? && !line.x.zero?
+          unless line.x.nil?
             @x_min = @current_x if @current_x < @x_min
             @x_max = @current_x if @current_x > @x_max
           end
-          if line.y.present? && !line.y.zero?
+          unless line.y.nil?
             @y_min = @current_y if @current_y < @y_min
             @y_max = @current_y if @current_y > @y_max
           end
         end
-        if line.z.present?
+        unless line.z.nil?
           @z_min = @current_z if @current_z < @z_min
           @z_max = @current_z if @current_z > @z_max
         end
       end
 
-      def set_variables
+      def set_line_properties(line)
+        @tool_number = line.tool_number unless line.tool_number.nil?
+        line.tool_number = @tool_number if line.tool_number.nil?
+        @speed = line.f unless line.f.nil?
+        line.f = @speed if line.f.nil?
+        line
+      end
+
+      def set_processing_variables
         @x_travel = 0
         @y_travel = 0
         @z_travel = 0
@@ -164,10 +251,24 @@ private
         @x_max = -999999999
         @y_max = -999999999
         @z_max = -999999999
-        @filament_used = 0
+        @filament_used = []
         @layers = 0
       end
 
+      def set_variables(data, default_speed)
+        @raw_data = data
+        @imperial = false
+        @relative = false
+        @tool_number = 0
+        @speed = default_speed.to_f
+        @lines = []
+      end
+
+      def to_mm(number)
+        return number unless @imperial
+        number *= 25.4 if !number.nil?
+      end
+
     end
   end
 end