tallakt-plcutil 0.0.1 → 0.1.0

data/lib/tallakt-plcutil/siemens/step7_to_intouch_runner.rb

@@ -0,0 +1,243 @@
+#!/usr/bin/ruby
+
+require 'optparse'
+require 'tallakt-plcutil/siemens/awlfile'
+require 'tallakt-plcutil/siemens/sdffile'
+require 'tallakt-plcutil/wonderware/intouchfile'
+
+module PlcUtil
+	# Command line tool to read and output an awl file
+	class Step7ToIntouchRunner
+		def initialize(command_line_arguments)
+      # standard command line options
+			@awloptions = {}
+			@intouchoptions = {}
+			@output = nil
+			@symlistfile = nil
+      @no_block = false
+      @access_name = nil
+      @filter_file = nil
+
+      # Parse command line options
+			option_parser.parse! command_line_arguments
+			if command_line_arguments.empty?
+				show_help
+				exit
+			end
+
+      # Read Siemens S7 files
+      # AWL - generated by using 'generate source' and selecting a DB
+      # SDF - export file generated from variable list and selecting 'export'
+      awl_files = command_line_arguments.select {|fn| fn.match(/\.awl$/i) }
+      sdf_files = command_line_arguments - awl_files
+			@sdflist = sdf_files.map{|filename| SdfFile.new filename }
+			@awllist = awl_files.map{|filename| AwlFile.new filename, @awloptions}
+
+      # create a lookup table for used tags in the file to prevent duplicate ids
+      # TODO Move this into Intouchfile class
+      @used_tags = {}
+      
+      @sdflist.each do |sdf|
+        sdf.tags.each do |item|
+          @used_tags[siemens_to_ww_tagname_long item[:name]] = true
+        end
+      end
+
+      @awllist.each do |awl|
+        awl.each_tag :no_block => @no_block do |item|
+          @used_tags[siemens_to_ww_tagname_long item[:name]] = true
+        end
+      end
+
+      # load filter file to enable override of functions filter_comment_format and filter_handle_tag
+      load @filter_file if @filter_file && File.exists?(@filter_file)
+
+      # Write to intouch file
+			if @output
+				File.open @output, 'w' do |f|
+					print_to_file f
+				end
+			else
+				print_to_file $stdout
+			end
+		end
+
+    def format_addr(addr, ww_data_type, options = {})
+      case addr
+      when String
+        # from symbol list file, ww accepts addres directly
+        if options[:is_bool]
+          addr.gsub /\s/, ''
+        else
+          addr.gsub /^([A-Z])[DW]\s*([\d\.]+)/, '\1' + ww_data_type + '\2'
+        end
+      else
+        db = addr.data_block_addr || 'DB???'
+        db + ',' + ww_data_type + addr.byte.to_s + (options[:is_bool] ? ('.' + addr.bit.to_s) : '')
+      end
+    end
+		
+    # This function may be overriden in filter ruby file
+    def filter_comment_format(comment, struct_comment)
+      sc, cc = struct_comment, comment
+      comment = nil unless cc && cc.match(/./)
+      sc = nil unless sc && sc.match(/./)
+      if cc || sc
+        [cc, sc].uniq.compact.join(' / ').gsub(/"/, '')
+      else
+        ''
+      end
+    end
+
+    # This function may be overridden in filter ruby file
+    def filter_handle_tag(item)
+      ww_name = siemens_to_ww_tagname item[:name]
+      cc = filter_comment_format item[:comment], item[:struct_comment]
+      created_io = case item[:type]
+        when :bool
+          @intouchfile.new_io_disc(ww_name) do |io|
+            io.item_name = format_addr(item[:addr], 'X', :is_bool => true)
+            io
+          end
+        when :int
+          @intouchfile.new_io_int(ww_name) do |io|
+            io.item_name = format_addr(item[:addr], 'INT')
+            io
+          end
+        when :word
+          @intouchfile.new_io_int(ww_name) do |io|
+            io.item_name = format_addr(item[:addr], 'WORD')
+            io
+          end
+        when :real
+          @intouchfile.new_io_real(ww_name) do |io|
+            io.item_name = format_addr(item[:addr], 'REAL')
+            io
+          end
+        when :byte
+          @intouchfile.new_io_int(ww_name) do |io|
+            io.item_name = format_addr(item[:addr], 'BYTE')
+            io
+          end
+        when :char
+          @intouchfile.new_io_int(ww_name) do |io|
+            io.item_name = format_addr(item[:addr], 'CHAR')
+            io
+          end
+        when :date, :s5time, :time_of_day, :timer
+          # skip
+        when :dint
+          @intouchfile.new_io_int(ww_name) do |io|
+            io.item_name = format_addr(item[:addr], 'DINT')
+            io
+          end
+        when :dword, :time
+          @intouchfile.new_io_int(ww_name) do |io|
+            io.item_name = format_addr(item[:addr], 'DWORD')
+            io
+          end
+        else
+          raise RuntimeError.new('Unsupported type found: ' + item[:type].to_s)
+      end
+      
+      # Common options
+      if created_io
+        created_io.item_use_tagname = 'No'
+        created_io.comment = cc
+
+        yield created_io if block_given?
+      end
+     end
+
+
+    # This function may be overridden in filter ruby file
+    def filter_handle_sdf_files
+      @sdflist.each do |sdf|
+        sdf.tags.each do |item|
+          filter_handle_tag item
+        end
+      end
+    end
+
+    # This function may be overridden in filter ruby file
+    def filter_handle_awl_files
+      @awllist.each do |awl|
+        awl.each_tag :no_block => @no_block do |item|
+          filter_handle_tag item
+        end
+      end
+    end
+
+
+
+		def print_to_file(f)
+      @intouchfile = IntouchFile.new nil, @intouchoptions
+      filter_handle_sdf_files
+      filter_handle_awl_files
+      @intouchfile.write_csv f
+		end
+
+    def siemens_to_ww_tagname(s)
+      new_unique_tag(siemens_to_ww_tagname_long s)
+    end
+
+    def siemens_to_ww_tagname_long(s)
+      s.gsub(/[\. ]/, '_').gsub(/\[(\d+)\]/) { '_' + $1 }
+    end
+
+    def new_unique_tag_helper(s, n)
+      s[0..(31 - n.to_s.size - 1)] + '%' + n.to_s
+    end
+
+    def new_unique_tag(s)
+      if s.size < 33
+        s
+      else
+        n = nil
+        new_tag = new_unique_tag_helper s, n
+        while @used_tags.key? new_tag
+          n ||= 0
+          n += 1
+          new_tag = new_unique_tag_helper s, n
+        end
+        @used_tags[new_tag] = true
+        new_tag
+      end
+    end
+
+		def option_parser
+			OptionParser.new do |opts|
+				opts.banner = "Usage: s7tointouch [options] <.awl or .sdf files>"
+				opts.on("-s", "--symlist FILE", String, "Specify SYMLIST.DBF file from S7 project ") do |symlistfile|
+					@awloptions[:symlist] = symlistfile
+				end
+				opts.on("-n", "--no-block", String, "Dont use the datablock as part of the tag", "name") do
+					@no_block = true
+				end
+				opts.on("-b", "--block NAME=ADDR", String, "Define address of datablock without", "reading symlist") do |blockdef|
+					name, addr = blockdef.split(/=/)
+					@awloptions[:blocks] ||= {}
+					@awloptions[:blocks][name] = addr
+				end
+				opts.on("-a", "--access ACCESSNAME", String, "Set access name for all tags") do |access_name|
+          @intouchoptions[:access_name] = access_name
+				end
+				opts.on("-f", "--filter FILTER_RUBY_FILE", String, "Specify ruby filter file to override", "filter functions") do |filter_file|
+					@filter_file = filter_file
+				end
+				opts.on("-o", "--output FILE", String, "Output to specified file instead of", "standard output") do |output|
+					@output = output
+				end
+				opts.on_tail("-h", "--help", "Show this message") do
+					puts opts
+					exit
+				end
+			end	
+		end
+		
+		def show_help
+			puts option_parser
+		end
+	end
+end
+

data/lib/tallakt-plcutil/wonderware/intouch_pretty_print_runner.rb

@@ -0,0 +1,254 @@
+require 'rubygems'
+require 'optparse' 
+require 'tallakt-plcutil/wonderware/intouchfile'
+
+module PlcUtil
+  class IntouchPrettyPrintRunner
+    MAX_WW_TAGLENGTH = 32
+
+    def initialize(arguments)
+      # Standard options
+      @mode = :io
+
+      # Parse command line options
+			option_parser.parse! arguments
+			if arguments.size > 1
+				show_help
+				exit
+			end
+      filename, = arguments
+
+
+
+      # Read from intouch file
+      @intouch_file = IntouchFile.new
+			if filename
+				File.open filename do |f|
+					@intouch_file.read_csv f
+				end
+			else
+        @intouch_file.read_csv $stdin
+			end
+
+      # print the tags in intouch
+      case @mode
+      when :io
+        print_io
+      when :duplicates
+        print_duplicates
+      when :missing
+        print_alarms_missing_text
+      when :alarm_groups
+        print_alarm_groups
+      when :access_names
+        print_access_names
+      when :tag
+        print_tag @tag
+      end
+    end
+
+    def addr_signature(tag) 
+      get_tag_field(:access_name, tag) + get_tag_field(:item_name, tag)
+    end
+
+    def tag_is_io?(tag)
+      tag.respond_to?(:item_name) && tag.item_name &&
+        tag.respond_to?(:access_name) && tag.access_name
+    end
+
+    def print_duplicates
+      print_io do |tags| 
+        addresscount = {}
+
+        tags.each do |tag| 
+          addr = addr_signature tag
+
+          addresscount[addr] ||= 0
+          addresscount[addr] += 1 if tag_is_io?(tag)
+        end
+        tmp = tags.select {|tag| addresscount[addr_signature tag] > 1 }
+        tmp.sort {|a, b| addr_signature(a) <=> addr_signature(b) }
+      end
+    end
+
+    def print_alarms_missing_text
+      print_io do |tags| 
+        tags.select {|tag| tag.alarm? && (!tag.alarm_comment || !tag.alarm_comment.match(/\S/)) }
+      end
+    end
+
+    def print_io
+      ss = %w( :IODisc :IOReal :IndirectAnalog :MemoryReal :IOMsg :IndirectMsg 
+                :MemoryMsg :MemoryDisc :IndirectDisc :IOInt :MemoryInt)
+      tags = []
+      ss.each {|section| @intouch_file.each_tag(section) {|tag| tags << tag } }
+
+      if block_given?
+        tags = yield tags
+      end
+
+      columns = []
+      columns << {:max => 1, :min => 1, :nospace => true, :gen => Proc.new { |tag| alarm_icon(tag) } }
+      columns << {:max => MAX_WW_TAGLENGTH, :min => 15, :gen => lambda {|tag| tag.tag } }
+      columns << {:max => 20, :min => 10, :gen => Proc.new {|tag| get_tag_field(:item_name, tag) } }
+      columns << {:max => 20, :min => 10, :gen => Proc.new {|tag| get_tag_field(:access_name, tag) } }
+      columns << {:rest => true, :gen => Proc.new {|tag| comment_for_tag(tag) } }
+
+      # shrink columns
+      columns.each do |c| 
+        if c[:max]
+          c[:adjusted] = max_str_len(tags, c[:max], c[:min]) {|tag| c[:gen].call(tag) }
+        end
+      end
+
+      # use remaining space for :rest tag
+      spaces = columns.map {|c| c[:nospace] ? 0 : 1 }.reduce(:+) - 1
+      wasted = columns.map {|c| c[:adjusted] || 0 }.reduce(:+) - spaces
+      rest = columns.find {|c| c[:rest] }
+      @column_width ||= console_width
+      rest[:adjusted] = @column_width - wasted if rest
+
+      first_columns = columns - [columns.last]
+      tags.each do |tag|
+        cs = first_columns.map do |c| 
+          fix_string(c, tag).ljust(c[:adjusted]) + (c[:nospace] ? '' : ' ') 
+        end
+        cs << fix_string(columns.last, tag)
+        str = cs.join
+        if tag.tag.size > MAX_WW_TAGLENGTH
+          str = red(str)
+        else
+          str = yellow(str) if tag.alarm?
+        end
+        puts str
+      end
+		end
+
+    def max_str_len(tags, abs_max, abs_min) 
+      [abs_max, tags.reduce(abs_min) {|max, tag| max = [max, (yield tag).size].max }].min
+    end
+
+
+
+    def get_tag_field(field, tag)
+      if tag.respond_to? field
+        tag.method(field).call || ''
+      else
+        ''
+      end
+    end
+
+    def fix_string(column, tag)
+      str = column[:gen].call(tag)
+      if str.size > column[:adjusted]
+        str[0..(column[:adjusted] - 4)] + '...'
+      else
+        str
+      end
+    end
+
+
+    def print_alarm_groups
+      print_four_column_tags ':AlarmGroup'
+    end
+
+    def print_access_names
+      print_four_column_tags ':IOAccess'
+    end
+
+    def print_four_column_tags(section)
+      lines = []
+      @intouch_file.each_tag section do |tag|
+        lines << tag.tag
+      end
+      lines.each_slice(4) do |slice|
+        slice[3] ||= nil
+        puts ('%-20s' * 4) % slice
+      end
+    end
+
+    def print_tag(tag)
+      t = @intouch_file.find_tag(tag)
+      if t
+        puts 'Tag: ' + tag
+        t.intouch_fields.each do |field|
+          puts '%-30s%s' % [field.to_s, t.method(field).call]
+        end
+      else
+        puts 'Tag %s was not found' % tag
+      end
+    end
+
+		def option_parser
+			OptionParser.new do |opts|
+				opts.banner = "Usage: intouchreader [options] [DBFILE]"
+				opts.on("-c", "--access-names", "Show access name") do
+          @mode = :access_names
+				end
+				opts.on("-t", "--tag TAGNAME", "Show all fields for the specified tag") do |tag|
+          @mode = :tag
+          @tag = tag
+				end
+				opts.on("-w", "--wide", "Print wider than console width") do
+          @column_width = 9999
+				end
+				opts.on("-a", "--alarm-groups", "Show alarm groups") do
+          @mode = :alarm_groups
+				end
+				opts.on("-m", "--missing", "Show only alarms with missing text") do
+          @mode = :missing
+				end
+				opts.on("-d", "--duplicates", "Show only duplicated tags (shares address)") do
+          @mode = :duplicates
+				end
+				opts.on_tail("-h", "--help", "Show this message") do
+					puts opts
+					exit
+				end
+			end	
+		end
+		
+		def show_help
+			puts option_parser
+		end  
+
+    private
+
+    def console_width
+      80
+    end
+
+    def comment_for_tag(tag)
+      if tag.alarm? 
+        tag.alarm_comment
+      else
+        tag.comment
+      end || ''
+    end
+
+    def alarm_icon(tag)
+      if tag.alarm? 
+        '*'
+      else
+        ' '
+      end
+    end
+
+    def colorize(text, color_code)
+      "#{color_code}#{text}\e[0m"
+    end
+
+    def yellow(text)
+      colorize text, "\e[33m"
+    end
+
+    def red(text)
+      colorize text, "\e[31m"
+    end
+
+    def green(text)
+      colorize text, "\e[32m"
+    end
+
+  end
+end

data/lib/{plcutil → tallakt-plcutil}/wonderware/intouchfile.rb

@@ -7,14 +7,15 @@ module PlcUtil
 	class IntouchFile
 		ApostropheReqiredColumns =
 			%w(
-				SymbolicName Comment OnMsg Group AccessName HiAlarmInhibitor MajDevAlarmInhibitor DSCAlarmInhibitor InitialMessage 
-				HiHiAlarmInhibitor tag Application MinDevAlarmInhibitor Topic AlarmComment EngUnits LoAlarmInhibitor 
+				SymbolicName Comment OnMsg Group AccessName 
+        HiAlarmInhibitor MajDevAlarmInhibitor 
+        DSCAlarmInhibitor InitialMessage 
+				HiHiAlarmInhibitor tag Application MinDevAlarmInhibitor 
+        Topic AlarmComment EngUnits LoAlarmInhibitor 
 				OffMsg LoLoAlarmInhibitor RocAlarmInhibitor ItemName
 			)
 
 		def initialize(filename = nil, options = {})
-			# Lookup table to check wether a certain column must write its values inside apostrophes
-			@lookup_apostrophe_fields = ApostropheReqiredColumns.inject({}) {|h, v| h[v] = true; h}
 
       # load standard sections
 			@sections = YAML.load_file File.join(File.dirname(__FILE__), "standard_sections.yaml")
@@ -38,10 +39,11 @@ module PlcUtil
       if section
         @sections[section][:rows].find {|row| row.tag == tag}
       else
-        tmp = @sections.collect do |sec|
-          sec[:rows].find {|row| row.tag == tag }
-        end.flatten
-        tmp && tmp.first
+        result = []
+        @sections.each do |name, sec|
+          result << sec[:rows].find {|row| row.tag == tag }
+        end
+        result.find {|x| x }
       end
 		end
 
@@ -91,13 +93,13 @@ module PlcUtil
 					else
 						# new tag
             cols = l.gsub(/"/, '').split /;/
-						new_data_instance(current[:name][1..-1], cols[0], cols[1, -1])
+						new_data_instance(current[:name][1..-1], cols[0], cols[1..-1], colnames)
 				end
 			end
 		end
 		
 		def write_csv(io, mode = :update)
-			throw 'Please use mode :ask/:update/:replace' unless [:ask, :replace, :update].include? mode
+			raise 'Please use mode :ask/:update/:replace' unless [:ask, :replace, :update].include? mode
 			io.puts ':mode=' + mode.to_s
 			@sections.each_value do |section|
         next if section[:rows].empty?
@@ -112,12 +114,14 @@ module PlcUtil
 
 
     def apostrophe_req?(colname)
-      @lookup_apostrophe_fields[colname] || colname.match(/^:/)
+			# Lookup table to check wether a certain column must write its values inside apostrophes
+			@@lookup_apostrophe_fields ||= ApostropheReqiredColumns.inject({}) {|h, v| h[v] = true; h}
+      @@lookup_apostrophe_fields[colname] || colname.match(/^:/)
     end
 
     def to_csv_line(colnames)
       '[%s].join ";"' % colnames.map do |c|
-        cc = c.match(/^:/) ? 'tag' : camel_conv(c)
+        cc = c.match(/^:/) ? 'tag' : dasherize(c)
         if apostrophe_req? c
           # When nil, dont display the "" chars, since this will overwrite with an empty string
           # The check is performed at runtime in the generated class
@@ -133,18 +137,21 @@ module PlcUtil
       # define new class for the data type
       klass = colnames[0][1..-1]
       #return if defined? klass
-      attrs = colnames[1..-1].map {|x| ':' + camel_conv(x) }.join(', ')
-      attr_list = colnames[1..-1].map {|x| camel_conv(x)}.join(', ')
+      attrs = colnames[1..-1].map {|x| ':' + dasherize(x) }.join(', ')
+      attr_list = colnames[1..-1].map {|x| dasherize(x)}.join(', ')
       values_format = colnames.map {|c| apostrophe_req?(c) ? '"%s"' : '%s'}.join(';')
 
       PlcUtil.module_eval <<-END
         class #{klass}
           attr_accessor #{attrs}
-          attr_reader :tag
+          attr_accessor :tag
 
-          def initialize(tag, values=nil)
+          def initialize(tag, values={})
             @tag = tag
-            #{attr_list} = values if values
+            values.each do |key, value|
+              mn = key.to_s + '='
+              method(mn).call(value) if respond_to?(mn)
+            end
           end
 
           def to_csv
@@ -154,6 +161,18 @@ module PlcUtil
           def intouch_fields
             [#{attrs}]
           end
+
+          def to_h
+            result = {:tag => tag }
+            intouch_fields.each do |field|
+              result[field] = method(field).call
+            end
+            result
+          end
+
+          def alarm?
+            respond_to?(:alarm_state) && alarm_state && alarm_state.match(/On|Off/)
+          end
         end
       END
 
@@ -161,11 +180,11 @@ module PlcUtil
       IntouchFile.class_eval <<-END
         public
         
-        def new_#{camel_conv klass}(tag, values = nil)
+        def new_#{dasherize klass}(tag, values = {})
           result = #{klass}.new tag, values
           @sections['#{colnames[0]}'][:rows] << result
-          if result.respond_to? :access_name
-            result.access_name = @options[:access_name]
+          if result.respond_to? :access_name 
+            result.access_name = @options[:access_name] if @options[:access_name]
           end
           yield result if block_given?
           result
@@ -173,11 +192,12 @@ module PlcUtil
       END
     end
 
-    def new_data_instance(klass, tag, values)
-      method('new_' + camel_conv(klass)).call(tag, values)
+    def new_data_instance(klass, tag, values, colnames)
+      attributes = colnames[1..-1].map {|cn| dasherize(cn)}
+      method('new_' + dasherize(klass)).call(tag, Hash[attributes.zip(values)])
     end
 
-    def camel_conv(s)
+    def dasherize(s)
       res = s.gsub(/[A-Z]{3,}/){|x| x[0..-2].capitalize + x[-1..-1]}
       res.gsub!(/[A-Z]/, '_\0')
       res.gsub! /^_/ , ''

data/lib/tallakt-plcutil.rb

@@ -0,0 +1 @@
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tallakt-plcutil'
+
+class Test::Unit::TestCase
+end