kut 0.1.0

data/lib/kut/commands/gost/bom2el_list.rb

@@ -0,0 +1,171 @@
+require 'ostruct'
+require 'kut/net_list/kicad'
+require 'kut/net_list/pcad'
+require 'csv'
+
+module Kut
+  class Bom2EL
+    attr_reader :name
+    attr_reader :help_banner
+    
+    def initialize
+      @name = 'gs-bom2el'
+      @help_banner = 'Generate list of elements from bill of materials'
+      @generators = []
+      
+      @options = OpenStruct.new
+      @options.in_file_name = '-'
+      @options.out_file_name = '-'
+      @options.separator = ';'
+      
+      @option_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: kut #{self.name} [options]"
+               
+        opts.on("-i", "--input INPUT_FILE", "Innput pins file. if - to use stdin.") do |file_name|
+          @options.in_file_name = file_name
+        end
+        
+        opts.on("-o", "--output OUTPUT_FILE", "Output libary file. if - to use stdout.") do |file_name|
+          @options.out_file_name = file_name
+        end   
+        
+      end
+      
+    end
+        
+    def help(args)
+      @option_parser.parse!(args)
+      @option_parser.to_s()
+    end    
+    
+    
+    # 
+    def join_ref(ref_list)
+      return '' unless ref_list
+      
+      ref_list.sort! { |a, b|
+        a =~ /(\D+)(\d*)/
+        a_n = $1
+        a_val = $2 ? $2.to_i : -1
+        b =~ /(\D+)(\d*)/
+        b_n = $1
+        b_val = $2 ? $2.to_i : -1
+        
+        res = a_n <=> b_n
+        res = a_val <=> b_val if res == 0
+        res
+      }
+       
+      ref_list.first =~ /(\D+)(\d+)/
+      prev_pref = $1
+      prev_num = $2.to_i
+      prev_ref = ref_list.first
+      
+      result = ref_list.first
+      ref_list.delete_at(0)
+      counter = 0
+      
+    #  while ! ref_list.empty?
+    #    ref = ref_list.first
+    #    ref_list.delete_at(0)
+    #  end
+      
+      flag = false
+      
+      ref_list.each { |ref|
+        ref =~ /(\D+)(\d+)/
+        pref = $1
+        num = $2.to_i
+        
+        flag = (pref == prev_pref) && (num == (prev_num + 1))
+          
+        if !flag then
+          if counter != 0 then
+            result += counter > 1 ? '..' : ','
+            result += prev_ref + ',' + ref
+          else
+            result += ',' + ref
+          end
+        end
+        
+        #result += '..' + prev_ref + ',' + ref unless flag && counter != 0
+        #result += ',' + ref unless flag
+        
+        counter += 1 if flag
+        counter = 0 unless flag
+        
+        prev_pref = pref
+        prev_num = num    
+        prev_ref = ref
+      }
+      
+      if flag && counter != 0 then
+        result += counter > 1 ? '..' : ','
+        result += prev_ref
+      end 
+      
+      result
+    end  
+    
+    def gs_bom2el(f_in, f_out)
+      
+      sep = @options.separator
+     
+      first_line = true
+      header = nil
+      rows = []
+     
+      f_in.each_line { |line|
+        row = CSV.parse_line(line, sep)
+        header = row if first_line
+        rows << row unless first_line
+        first_line = false if first_line
+      }
+          
+      footprint_index = header.index("footprint")
+      ref_index = header.index("ref")
+      value_index = header.index("value")
+      
+      groups = {}
+      
+      rows.each { |row|
+        gr_id = "#{row[value_index]} #{row[footprint_index]}"
+        group = groups[gr_id]
+        unless group
+          group = [] 
+          groups[gr_id] = group
+        end
+        group << row[ref_index].to_s
+      }
+      
+      result = []
+      
+      groups.each { |key, value|
+        count = value.size()
+        refs = join_ref(value)
+        result << "#{refs}#{sep}#{key}#{sep}#{count}\n" 
+      }      
+      
+      result.sort!
+      f_out << "refs#{sep}type#{sep}count\n"
+      result.each { |v| f_out << v }
+    end
+    
+    def run(args)
+
+      begin @option_parser.parse!(args)
+      rescue OptionParser::InvalidOption => e
+        $stderr << "Unknow option #{e}\n"
+        exit
+      end
+                        
+      f_in = $stdin
+      f_in = File.new(@options.in_file_name) if @options.in_file_name && @options.in_file_name != '-'
+      f_out = $stdout
+      f_out = File.new(@options.out_file_name, 'w') if @options.out_file_name && @options.out_file_name != '-'
+      
+      gs_bom2el(f_in, f_out)
+      
+    end
+  end
+end

data/lib/kut/commands/help-cmd.rb

@@ -0,0 +1,32 @@
+require 'kut/application'
+
+module Kut
+  class HelpCommand
+    attr_reader :name
+    attr_reader :help_banner
+    
+    def initialize
+      @name = 'help'
+      @help_banner = 'Help for information on a specific command.'
+    end
+    
+    def help(args)
+      @help_banner
+    end    
+    
+    def show_cmd_help(cmd_name, args)
+      cmd = Kut.application.command_by_name(cmd_name)
+      puts cmd.help(args) if cmd
+      puts "Help for command #{cmd_name} not found." unless cmd
+      exit
+    end
+    
+    def run(args)
+      Kut.application.show_help() unless args
+      Kut.application.show_help() if args.size() == 0
+      help_args = args.dup()
+      help_args.delete_at(0)
+      show_cmd_help(args[0], help_args)
+    end
+  end
+end

data/lib/kut/commands/lib-gen-cmd.rb

@@ -0,0 +1,88 @@
+require 'ostruct'
+require 'kut/library/generator/simple'
+require 'kut/library/generator/default'
+require 'kut/library/generator/gost-con'
+module Kut
+  class LibraryGeneratorCommand
+    attr_reader :name
+    attr_reader :help_banner
+    attr_accessor :generators
+    
+    def initialize
+      @name = 'gen-lib'
+      @help_banner = 'Generate schema library'
+      @generators = []
+      
+      @options = OpenStruct.new
+      @options.in_file_name = '-'
+      @options.out_file_name = '-'
+      @options.generator_name = 'default'
+      
+      @option_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: kut #{self.name} [options]"
+        opts.on("-G", "--generator GENERATOR_NAME", "Select generator") do |gen_name|
+          @options.generator_name = gen_name
+        end
+        
+        opts.on("-i", "--input INPUT_FILE", "Innput pins file. if - to use stdin.") do |file_name|
+          @options.in_file_name = file_name
+        end
+        
+        opts.on("-o", "--output OUTPUT_LIBRARY_FILE", "Output libary file. if - to use stdout.") do |file_name|
+          @options.out_file_name = file_name
+        end   
+        
+        opts.on("--list", "List of avalaible generators") do
+          $stderr << "Avalaible generators:\n" 
+          generators.each { |gen|
+            $stderr << "#{' ' * 3}#{gen.name}\n" 
+          }
+          exit
+        end
+      end
+      add_default_generators
+    end
+    
+    def add_default_generators
+      generators << Kut::Library::DefaultGenerator.new
+      generators << Kut::Library::SimpleGenerator.new
+      generators << Kut::Library::GOSTConnGenerator.new
+    end
+    
+    def find_generator(name)
+      generators.each { |g| return g if g.name.to_s() == name }
+      nil
+    end
+    
+    def help(args)
+      #args_cp = args.dup()
+      @option_parser.parse!(args)
+      gen = find_generator(@options.generator_name)
+      gen_help = ''
+      gen_help = gen.prepare(args).to_s() if gen
+      @option_parser.to_s() + gen_help
+    end    
+    
+    def run(args)
+      args_cp = args.dup
+      begin @option_parser.parse!(args)
+      rescue OptionParser::InvalidOption => e
+        args = [(args_cp - args)[-1]] + args
+      end
+                  
+      gen = find_generator(@options.generator_name)
+      $stderr << "Generator '#{@options.generator_name}' not found.\n" unless gen
+      exit unless gen
+      
+      f_in = $stdin
+      f_in = File.new(@options.in_file_name) if @options.in_file_name && @options.in_file_name != '-'
+      f_out = $stdout
+      f_out = File.new(@options.out_file_name, 'w') if @options.out_file_name && @options.out_file_name != '-'
+      
+      f_out << "EESchema-LIBRARY Version 2.0 24/1/1997-18:9:6\n"
+      gen.prepare(args)
+      f_out << gen.generate(f_in, f_out)
+      f_out << "#EndLibrary\n" 
+    end
+  end
+end

data/lib/kut/commands/net_list2bom.rb

@@ -0,0 +1,81 @@
+require 'ostruct'
+require 'kut/net_list/kicad'
+require 'kut/net_list/pcad'
+
+module Kut
+  class NetList2Bom
+    attr_reader :name
+    attr_reader :help_banner
+    
+    def initialize
+      @name = 'net2bom'
+      @help_banner = 'Generatr bill of materials from netlist'
+      @generators = []
+      
+      @options = OpenStruct.new
+      @options.in_file_name = '-'
+      @options.out_file_name = '-'
+      @options.net_list_loader = Kut::NetList::KiCadNetList
+      @options.separator = ';'
+      
+      @option_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: kut #{self.name} [options]"
+        
+        opts.on("-f", "--format NET_LIST_FORMAT", "Netlist file format (kicad - default, pcad)") do |format|
+          case format
+          when 'pcad' then @options.net_list_loader = Kut::NetList::PCadNetList
+          when 'kicad' then @options.net_list_loader = Kut::NetList::KiCadNetList
+          else
+            $stderr << "Netlist format #{format} isn't supported.\n"
+            exit
+          end
+        end
+        
+        opts.on("-i", "--input INPUT_FILE", "Innput pins file. if - to use stdin.") do |file_name|
+          @options.in_file_name = file_name
+        end
+        
+        opts.on("-o", "--output OUTPUT_FILE", "Output libary file. if - to use stdout.") do |file_name|
+          @options.out_file_name = file_name
+        end   
+        
+      end
+      
+    end
+        
+    def help(args)
+      @option_parser.parse!(args)
+      @option_parser.to_s()
+    end    
+    
+    def net2bom(f_in, f_out)
+      net_list = @options.net_list_loader.new(f_in)
+      cmp_list = net_list.by_components()
+      
+      sep = @options.separator
+      
+      f_out << "ref#{sep}value#{sep}footprint\n"
+      
+      cmp_list.each{ |cmp|
+        f_out << "#{cmp.reference}#{sep}#{cmp.value}#{sep}#{cmp.footprint}\n"
+      }
+    end
+    
+    def run(args)
+
+      begin @option_parser.parse!(args)
+      rescue OptionParser::InvalidOption => e
+        $stderr << "Unknow option #{e}\n"
+        exit
+      end
+                        
+      f_in = $stdin
+      f_in = File.new(@options.in_file_name) if @options.in_file_name && @options.in_file_name != '-'
+      f_out = $stdout
+      f_out = File.new(@options.out_file_name, 'w') if @options.out_file_name && @options.out_file_name != '-'
+      
+      net2bom(f_in, f_out)
+      
+    end
+  end
+end

data/lib/kut/eeschema/wire.rb

@@ -0,0 +1,3 @@
+class Wire
+  attr_accessor :startx, :starty, :endx, :endy
+end

data/lib/kut/kut_module.rb

@@ -0,0 +1,18 @@
+require 'kut/application'
+
+module Kut
+  #
+  # Kut module singleton methods.
+  #
+  class << self
+    # Current Kut Application
+    def application
+      @application ||= Kut::Application.new
+    end
+   
+    # Set the current Kut application object.
+    def application=(app)
+      @application = app
+    end  
+  end   
+end

data/lib/kut/library/components.rb

@@ -0,0 +1,167 @@
+module Kut
+  module Library
+    
+    class Field
+      attr_accessor :number, :text, :pos, :dimension, :orientation
+      attr_accessor :visibility, :hjustify, :vjustify, :italic, :bold, :name
+      
+      def initialize(params = {}) 
+        #number, text, pos, dimension, orientation, visibility, hjustify, vjustify, italic, bold, name
+        if Hash === params
+          @number = params[:number] ? params[:number] : 0 
+          @text = params[:text] ? params[:text] : 'TEXT'
+          @pos = params[:pos] ? params[:pos] : [0, 0]
+          @dimension = params[:dimension] ? params[:dimension] : 50
+          @orientation = params[:orientation] ? params[:orientation] : 'H'
+          @visibility = params[:visibility] ? params[:visibility] : 'V'
+          @hjustify = params[:hjustify] ? params[:hjustify] : 'C'
+          @vjustify = params[:vjustify] ? params[:vjustify] : 'C'
+          @italic = params[:italic] ? params[:italic] : 'N'
+          @bold = params[:bold] ? params[:bold] : 'N'
+          @name = params[:name] ? params[:name] : nil
+        end
+        #TODO implement raise exception
+      end      
+                
+      def to_s
+        __name = @name ? "\"#{@name}\"" : ''        
+        "F#{@number} \"#{@text}\" #{@pos[0]} #{@pos[1]} #{@dimension} #{@orientation} #{@visibility} #{@hjustify} #{@vjustify}#{@italic}#{@bold} #{__name}\n"      
+      end
+    end    
+    
+    #Implementation of Pin component 
+    class Pin
+      attr_accessor :name, :number, :pos, :length
+      attr_accessor :orientation, :snum, :snom, :unit, :convert, :etype
+      
+      #Parametrs name, number, pos, length, orientation, snum, snom, unit, convert, etype
+      #Example creation: Pin.new(:name => 'PL2303', :orientation => 'U', :pos => [15, 24])
+      def initialize(params = {}) #name, number, posx, posy, length, orientation, snum, snom, unit, convert, etype
+        if Hash === params
+          @name = params[:name] ? params[:name] : '~' 
+          @number = params[:number] ? params[:number] : '0'
+          @pos = params[:pos] ? params[:pos] : [0, 0]
+           @length = params[:length] ? params[:length] : 300
+          @orientation = params[:orientation] ? params[:orientation] : 'R'
+          @snum = params[:snum] ? params[:snum] : 40
+          @snom = params[:snom] ? params[:snom] : 40
+          @unit = params[:unit] ? params[:unit] : 0
+          @convert = params[:convert] ? params[:convert] : 0
+          @etype = params[:etype] ? params[:etype] : 'P'
+        end
+        #TODO implement raise exception
+      end
+            
+      def to_s
+        "X #{@name} #{@number} #{@pos[0]} #{@pos[1]} #{@length} #{@orientation} #{@snum} #{@snom} #{@unit} #{@convert} #{@etype}\n"
+      end
+    end
+    
+    class Text
+      attr_accessor :orientation, :pos, :dimension, :unit, :convert, :text 
+      
+
+      def initialize(params = {}) #:orientation, :pos, :dimension, :unit, :convert, :text
+        if Hash === params
+          @orientation = params[:orientation] ? params[:orientation] : 0
+          @pos = params[:pos] ? params[:pos] : [0, 0]
+          @dimension = params[:dimension] ? params[:dimension] : 40
+          @unit = params[:unit] ? params[:unit] : 0
+          @convert = params[:convert] ? params[:convert] : 0
+          @text = params[:text] ? params[:text] : ''
+        end
+        #TODO implement raise exception
+      end
+            
+      def to_s
+        "T #{@orientation} #{@pos[0]} #{@pos[1]} #{@dimension} 0 #{@unit} #{@convert} #{@text}\n"
+      end
+    end    
+    
+    class Polygon
+      attr_accessor :parts, :convert, :ltrait
+      attr_accessor :points, :cc
+      
+      def initialize(params = {}) #:parts, :convert, :ltrait, :points, :cc
+        if Hash === params
+          @parts = params[:parts] ? params[:parts] : 0
+          @points = params[:points] ? params[:points] : []
+          @convert = params[:convert] ? params[:convert] : 0
+          @ltrait = params[:ltrait] ? params[:ltrait] : 0
+          @cc = params[:cc] ? params[:cc] : 'N'
+        end
+        #TODO implement raise exception
+      end      
+      
+      def to_s
+        result = "P #{@points.length} #{@parts} #{@convert} #{@ltrait}"
+        @points.each { |point|
+          result += " #{point[0]} #{point[1]}"
+        }
+        result += " #{@cc}\n"
+      end
+    end
+        
+    class Rectangle
+      attr_accessor :start, :end, :unit, :convert, :ltrait, :cc
+      
+      def initialize(params = {}) #:start, :end, :unit, :convert, :ltrait, :cc
+        if Hash === params
+          @start = params[:start] ? params[:start] : [0, 0]
+          @end = params[:end] ? params[:end] : [0, 0]
+          @unit = params[:unit] ? params[:unit] : 0
+          @convert = params[:convert] ? params[:convert] : 0
+          @ltrait = params[:ltrait] ? params[:ltrait] : 0
+          @cc = params[:cc] ? params[:cc] : 'N'
+        end
+        #TODO implement raise exception
+      end
+            
+      def to_s
+        "S #{@start[0]} #{@start[1]} #{@end[0]} #{@end[1]} #{@unit} #{@convert} #{@ltrait} #{@cc}\n"
+      end    
+    end 
+       
+    class Component
+      attr_accessor :name, :reference, :text_offset, :draw_pinnumber, :draw_pinname 
+      attr_accessor :unit_count, :units_locked, :option_flag
+      attr_accessor :alias, :fields, :draws
+      
+      def initialize(params = {})
+        if Hash === params
+          @name = params[:name] ? params[:name] : '' 
+          @reference = params[:reference] ? params[:reference] : 'U'
+          @text_offset = params[:text_offset] ? params[:text_offset] : 30
+          @draw_pinnumber = params[:draw_pinnumber] ? params[:draw_pinnumber] : 'Y'
+          @draw_pinname = params[:draw_pinname] ? params[:draw_pinname] : 'Y'
+          @unit_count = params[:unit_count] ? params[:unit_count] : 1
+          @units_locked = params[:units_locked] ? params[:units_locked] : 'F'
+          @option_flag = params[:option_flag] ? params[:option_flag] : 'N'
+          @alias = params[:alias] ? params[:alias] : []
+          @fields = params[:fields] ? params[:fields] : []
+          @draws = params[:draws] ? params[:draws] : []          
+        end
+        #TODO implement raise exception
+      end      
+      
+      def to_s
+        result = "DEF #{@name} #{@reference} 0 #{@text_offset} #{@draw_pinnumber} #{@draw_pinname} #{@unit_count} #{@units_locked} #{@option_flag}\n"
+        result += "ALIAS"
+        @alias.each { |nm| result += " #{nm}" } if @alias
+        result += "\n"
+        
+        @fields.each { |field| result += "#{field.to_s}" } if @fields
+        
+        result += "DRAW\n"
+        
+        @draws.each { |draw| result += "#{draw.to_s}" } if @draws
+        
+        result += "ENDDRAW\n"
+        
+        result += "ENDDEF\n"
+      end
+          
+    end    
+    
+  end  # end module Library
+end # end module Kut