tallakt-plcutil 0.0.1

data/lib/plcutil/wonderware/intouchfile.rb

@@ -0,0 +1,187 @@
+#!/usr/bin/ruby
+
+require 'yaml'
+
+module PlcUtil
+	# Reads a Siemens Step 7 AWL file and creates single tags with addresses and comment
+	class IntouchFile
+		ApostropheReqiredColumns =
+			%w(
+				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")
+      each_section {|sec| define_data_class @sections[sec][:colnames]}
+
+      @options = options
+
+			if filename
+				File.open filename, 'r' do |f|
+					read_csv f
+				end
+			end
+    end
+
+    def each_section
+			@sections.each_key {|k| yield k}
+		end
+	
+
+		def find_tag(tag, section = nil)
+      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
+      end
+		end
+
+
+    def each_tag(section) 
+      @sections[section][:rows].each {|r| yield r }
+    end
+		
+    def clear
+      each_section do |s|
+        @sections[s][:rows] = []
+      end
+    end
+		
+    def read_csv_file(filename)
+      File.open filename do |f|
+        read_csv f
+      end
+    end
+
+    def write_csv_file(filename)
+      File.open filename, 'w' do |f|
+        write_csv f
+      end
+    end
+
+
+		def read_csv(io)
+			colnames = nil
+			current = nil
+			io.each do |l|
+				case l.chomp!
+					when /^:mode=/
+						# ignore line
+					when /^:/
+						# new section
+						colnames = l.split /;/
+						name = colnames.first
+						unless @sections.key? name
+							@sections[name] = {}
+							@sections[name][:colnames] = colnames
+							@sections[name][:rows] = []
+							@sections[name][:name] = name
+              define_data_class colnames
+						end
+						current = @sections[name]
+					else
+						# new tag
+            cols = l.gsub(/"/, '').split /;/
+						new_data_instance(current[:name][1..-1], cols[0], cols[1, -1])
+				end
+			end
+		end
+		
+		def write_csv(io, mode = :update)
+			throw '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?
+				io.puts section[:colnames].join ';'
+				section[:rows].each do |row|
+          io.puts row.to_csv
+				end
+			end
+		end
+	
+    private
+
+
+    def apostrophe_req?(colname)
+      @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)
+        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
+          # The result should look like: (tag ? '"%s"' : '%s') % tag
+          %Q!\n  (#{cc} ? '"%s"' : '%s') % #{cc}!
+        else
+          %Q!\n  #{cc}.to_s!
+        end
+      end.join(',')
+    end
+
+    def define_data_class(colnames)
+      # 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(', ')
+      values_format = colnames.map {|c| apostrophe_req?(c) ? '"%s"' : '%s'}.join(';')
+
+      PlcUtil.module_eval <<-END
+        class #{klass}
+          attr_accessor #{attrs}
+          attr_reader :tag
+
+          def initialize(tag, values=nil)
+            @tag = tag
+            #{attr_list} = values if values
+          end
+
+          def to_csv
+            #{to_csv_line colnames}
+          end
+
+          def intouch_fields
+            [#{attrs}]
+          end
+        end
+      END
+
+      # define method to create new instances
+      IntouchFile.class_eval <<-END
+        public
+        
+        def new_#{camel_conv klass}(tag, values = nil)
+          result = #{klass}.new tag, values
+          @sections['#{colnames[0]}'][:rows] << result
+          if result.respond_to? :access_name
+            result.access_name = @options[:access_name]
+          end
+          yield result if block_given?
+          result
+        end
+      END
+    end
+
+    def new_data_instance(klass, tag, values)
+      method('new_' + camel_conv(klass)).call(tag, values)
+    end
+
+    def camel_conv(s)
+      res = s.gsub(/[A-Z]{3,}/){|x| x[0..-2].capitalize + x[-1..-1]}
+      res.gsub!(/[A-Z]/, '_\0')
+      res.gsub! /^_/ , ''
+      res.downcase!
+    end
+  end
+end

data/lib/plcutil/wonderware/intouchreader.rb

@@ -0,0 +1,114 @@
+require 'optparse' 
+require 'plcutil/wonderware/intouchfile'
+
+module PlcUtil
+  class IntouchReader
+    def initialize
+      # Standard options
+      @mode = :io
+
+      # Parse command line options
+			option_parser.parse! ARGV
+			if ARGV.size > 1
+				show_help
+				exit
+			end
+      filename, = ARGV
+
+
+
+      # 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 :alarm_groups
+        print_alarm_groups
+      when :access_names
+        print_access_names
+      when :tag
+        print_tag @tag
+      end
+    end
+
+    def print_io
+      ss = %w( :IODisc :IOReal :IndirectAnalog :MemoryReal :IOMsg :IndirectMsg 
+                :MemoryMsg :MemoryDisc :IndirectDisc :IOInt :MemoryInt)
+      ss.each do |section|
+        @intouch_file.each_tag section do |row|
+          puts '%s%-33s%-20s%-20ss%s' % [
+            (row.respond_to?(:alarm_state) && row.alarm_state && row.alarm_state.match(/None/)) ? ' ' : '*', 
+            row.tag, 
+            row.respond_to?(:item_name) ? row.item_name : '',
+            row.access_name, 
+            row.comment
+          ]
+        end
+      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)
+      puts 'Tag: ' + tag
+      @intouch.find_tag(tag).intouch_fields.collect do |field|
+        [field.to_s, row.method(field).call]
+      end.each do |pair|
+        puts '%-20s%s' % pair
+      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("-a", "--alarm-groups", "Show alarm groups") do
+          @mode = :alarm_groups
+				end
+				opts.on_tail("-h", "--help", "Show this message") do
+					puts opts
+					exit
+				end
+			end	
+		end
+		
+		def show_help
+			puts option_parser
+		end  end
+
+  IntouchReader.new
+end
+