tallakt-plcutil 0.0.1 → 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+*swp

data/History.txt

@@ -1,3 +1,12 @@
+== 0.0.4 2009-06-12
+
+* 1 minor enhancement
+	* Ncurses based resizing to full screen intouchpp
+
+== 0.0.3 2009-06-12
+
+* Lots of work and progress - intouchpp should just work by now, also s7tointouch
+
 == 0.0.1 2009-01-28
 
 * 1 major enhancement:

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Tallak Tveide
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -4,18 +4,33 @@ Manifest.txt
 README.rdoc
 Rakefile
 TODO
+bin
 bin/awlpp
+bin/intouchpp
 bin/s7tointouch
+lib
+lib/plcutil
+lib/plcutil/siemens
 lib/plcutil/siemens/awlfile.rb
-lib/plcutil/siemens/awlprettyprintrunner.rb
-lib/plcutil/siemens/step7tointouchrunner.rb
+lib/plcutil/siemens/awl_pretty_print_runner.rb
+lib/plcutil/siemens/sdffile.rb
+lib/plcutil/siemens/step7_to_intouch_runner.rb
+lib/plcutil/wonderware
 lib/plcutil/wonderware/intouchfile.rb
-lib/plcutil/wonderware/intouchreader.rb
+lib/plcutil/wonderware/intouch_pretty_print_runner.rb
 lib/plcutil/wonderware/standard_sections.yaml
 lib/plcutil.rb
+plcutil.gemspec
+script
 script/console
 script/console.cmd
 script/destroy
 script/destroy.cmd
 script/generate
 script/generate.cmd
+test
+test/input_files
+test/input_files/step7_v5.4
+test/input_files/step7_v5.4/00000001.AWL
+test/input_files/step7_v5.4/S7_pro2.zip
+test/input_files/step7_v5.4/SYMLIST.DBF

data/README.rdoc

@@ -32,7 +32,8 @@ The commands support the --help parameter for a full list of parameters
 
 == INSTALL:
 
-  gem install plcutil
+  sudo gem sources -a http://gems.github.com
+  sudo gem install tallakt-plcutil
 
 
 == LICENSE:
@@ -59,3 +60,4 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Rakefile

@@ -1,27 +1,52 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/plcutil'
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('plcutil', Plcutil::VERSION) do |p|
-  p.developer('Tallak Tveide', 'tallak@tveide.net')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.rubyforge_name       = p.name # TODO this is default value
-  # p.extra_deps         = [
-  #   ['activesupport','>= 2.0.2'],
-  # ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
-end
-
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# task :default => [:spec, :features]
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tallakt-plcutil"
+    gem.summary = %Q{Ruby PLC file library}
+    gem.description = %Q{Ruby library for using Siemens and Intouch files} 
+    gem.email = "tallak@tveide.net"
+    gem.homepage = "http://github.com/tallakt/tallakt-plcutil"
+    gem.authors = ["Tallak Tveide"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tallakt-plcutil #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/awlpp

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 require 'rubygems'
-require 'plcutil/siemens/awlprettyprintrunner'
-require 'plcutil/siemens/step7tointouchrunner'
+require 'plcutil/siemens/awl_pretty_print_runner'
 
 # try: awlpp --help
 PlcUtil::AwlPrettyPrintRunner.new ARGV

data/bin/intouchpp

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'plcutil/wonderware/intouch_pretty_print_runner'
+
+# try: intouchpp --help
+PlcUtil::IntouchPrettyPrintRunner.new ARGV
+

data/bin/s7tointouch

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 require 'rubygems'
-require 'plcutil/siemens/step7tointouchrunner'
+require 'plcutil/siemens/step7_to_intouch_runner'
 
 # try: s7tointouch --help
 PlcUtil::Step7ToIntouchRunner.new ARGV

data/lib/{plcutil/siemens/awlprettyprintrunner.rb → tallakt-plcutil/siemens/awl_pretty_print_runner.rb}

@@ -1,7 +1,7 @@
 #!/usr/bin/ruby
 
 require 'optparse'
-require 'plcutil/siemens/awlfile'
+require 'tallakt-plcutil/siemens/awlfile'
 
 module PlcUtil
 	# Command line tool to read and output an awl file
@@ -12,6 +12,8 @@ module PlcUtil
 			@commentformat = '# %s / %s'
 			@output = nil
 			@symlistfile = nil
+      @no_block = false
+
 			option_parser.parse! args
 			if args.size != 1
 				show_help
@@ -28,12 +30,19 @@ module PlcUtil
 			end
 		end
 		
+    def fix_name(name)
+      if @no_block
+        name.sub /^[^\.]*\./, ''
+      else
+        name
+      end
+    end
 
 		def print_to_file(f)
-			@awl.each_tag do |name, addr, comment, struct_comment, type|
+			@awl.each_tag do |name, data_block_name, addr, comment, struct_comment, type|
 				f.puts @format % [
           addr, 
-          name, 
+          fix_name(name), 
           type.to_s, 
           [comment, struct_comment].compact! ? '' : (@commentformat % [comment, struct_comment])
         ]
@@ -47,7 +56,10 @@ module PlcUtil
 					format = '%s;%s;%s;%s' 
 					@commentformat = '%s'
 				end
-				opts.on("-s", "--symlist FILE", String, "Specify SYMLIST.DBF file from S7 project ") do |symlistfile|
+				opts.on("-n", "--no-block", String, "Dont use the datablock as part of the tag", "name") do
+					@no_block = true
+				end
+        opts.on("-s", "--symlist FILE", String, "Specify SYMLIST.DBF file from S7 project ") do |symlistfile|
 					@awloptions[:symlist] = symlistfile
 				end
 				opts.on("-b", "--block NAME=ADDR", String, "Define address of datablock without", "reading symlist") do |blockdef|

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

@@ -0,0 +1,296 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+
+module PlcUtil
+
+	# Reads a Siemens Step 7 AWL file and creates single tags with addresses and comment
+	class AwlFile
+    attr_reader :symlist
+
+		def initialize(filename, options = {})
+			@types = {}
+			init_basic_types
+			@datablocks = []
+			@symlist = {}
+			
+			if options[:symlist]
+        require 'dbf' or raise 'Please install gem dbf to read symlist file'
+
+				raise 'Specified symlist file not found' unless File.exists? options[:symlist]
+				table = DBF::Table.new(options[:symlist])
+				table.records.each do |rec|
+					@symlist[rec.attributes['_skz']] = rec.attributes['_opiec'] # or _ophist or _datatyp
+				end
+			end
+
+			@symlist.merge!(options[:blocks] || {}) # User may override blocks
+			
+			File.open filename do |f|
+				parse f
+			end
+		end
+		
+		def each_tag(options = {})
+			@datablocks.each do |var|
+        name = var.name
+        if options[:no_block]
+          name = nil
+        end
+				var.type.explode(Address.new(0, data_block_address(var.name)), name, options).each do |item|
+          ii = item.clone
+          ii[:type] = item[:type].downcase.to_sym
+					yield ii
+				end
+			end
+		end
+		
+		private
+		
+		def data_block_address(name)
+			if @symlist.key? name
+				@symlist[name].gsub /\s+/, ''
+			else
+				nil
+			end
+		end
+		
+		def init_basic_types
+      types = {
+        'BOOL' => 1,
+        'BYTE' => 8,
+        'CHAR' => 8,
+        'DATE' => 2 * 8, 
+        'DINT' => 4 * 8,
+        'DWORD' => 4 * 8,
+        'INT' => 2 * 8,
+        'REAL' => 4 * 8,
+        'S5TIME' => 2 * 8,
+        'TIME' => 4 * 8,
+        'TIME_OF_DAY' => 4 * 8,
+        'WORD' => 2 * 8,
+        'DATE_AND_TIME' => 4 * 8, # ??? only used in VAR_TEMP
+        'TIMER' => 1, # Only in FC calls
+        'CONT_C' => 125 * 8, 
+      }
+      types.each {|name, size| add_type BasicType.new(name, size) }
+		end
+		
+		def add_type(type)
+				@types[type.name] = type
+		end
+
+		def lookup_type(type)
+			raise "Could not find type '#{type}'" unless @types.key? type
+			@types[type]
+		end
+		
+		def parse(file)
+			stack = []
+			in_array_decl = false
+      in_datablock_decl = false
+			tagname = start = stop = type = comment = nil
+      db_to_fb = {}
+			file.each_line do |l|
+        l.chomp!
+				if in_array_decl
+					if l.match '^\s+\"?([A-Za-z0-9_]+)"?\s?;'
+						type = $1
+						stack.last.add Variable.new(tagname, ArrayType.new(@types[type], start..stop), comment)
+					end
+					in_array_decl = false
+				else
+					in_array_decl = false
+					case l
+            # TODO should also cater for 'DB  90' type addresses
+          when /^TYPE "(.+?)"/ 
+            stack = [StructType.new $1, :datatype]
+            add_type stack.last
+          when /^FUNCTION_BLOCK "(.+?)"/
+            stack = [StructType.new $1, :functionblock]
+            add_type stack.last
+          when /^DATA_BLOCK ("(.+?)"|DB\s+(\d+))/
+            in_datablock_decl = true
+            name = $2 || ('DB' + $3)
+            stack = [StructType.new name, :datablock]
+            @datablocks << Variable.new(name, stack.last)
+          when /^VAR_TEMP/
+            s = StructType.new 'VAR_TEMP', :anonymous
+            stack = [s]
+          when /^\s*(\S+) : STRUCT /
+            in_datablock_decl = false
+            s = StructType.new 'STRUCT', :anonymous
+            stack.last.add Variable.new $1, s
+            stack << stack.last.children.last.type
+          when /^BEGIN$/
+            in_datablock_decl = false
+          when /^\s+BEGIN/
+            stack.pop
+          # New variable in struct or data block
+          when /^\s+([A-Za-z0-9_ ]+) : "?([A-Za-z0-9_ ]+?)"?\s*(:=\s*[^;]+)?;(\s*\/\/(.*))?/
+            if stack.any?
+              tagname, type_name, comment = $1, $2, ($5 || '')
+              stack.last.add Variable.new(tagname, lookup_type(type_name), comment)
+            end
+          when /^\s+([A-Za-z0-9_]+) : ARRAY\s*\[(\d+)\D+(\d+) \] OF "?([A-Za-z0-9_]+)"?\s?;(\s*\/\/(.*))?/
+            tagname, start, stop, type, comment = $1, $2, $3, $4, $6
+            stack.last.add Variable.new(tagname, ArrayType.new(lookup_type(type), start..stop), comment)
+          when /^\s+([A-Za-z0-9_]+) : ARRAY\s*\[(\d+)\D+(\d+) \] OF(\s?\/\/(.*))?$/
+            tagname, start, stop, comment = $1, $2, $3, $4
+            in_array_decl = true
+          when /^"(.*?)"$/
+            # datablock definition is stored in FB definition
+            # remember which FB to use but assign the FB
+            # only after all blocks have been loaded
+            db_to_fb[stack.first.name] = $1 if in_datablock_decl
+					end
+				end
+			end
+
+      # Update FB to DB use
+      @datablocks.each do |db|
+        if db_to_fb.key? db.name
+          fb = lookup_type db_to_fb[db.name]
+          fb.children.each {|child| db.type.add child } if fb.respond_to? :children
+        end
+      end
+		end
+		
+		def defined_type(type)
+			@types.key?(type.name)
+		end
+		
+		
+		class BasicType
+			attr_accessor :bit_size, :name
+			
+			def initialize(name, bit_size)
+				@bit_size, @name = bit_size, name
+			end
+			
+			def explode(start_addr, name, comment, struct_comment, options = {})
+        actual_start = start_addr.next_start bit_size
+        [{:addr => actual_start, :name => name, 
+          :struct_comment => struct_comment, :comment => comment, :type => @name}]
+			end
+			
+			def end_address(start_address)
+				start_address.next_start(bit_size).skip! bit_size
+			end
+		end
+
+
+		
+		class StructType
+			attr_accessor :name, :children, :type
+			
+			def initialize(name = 'STRUCT', type = :anonymous)
+				@name = name
+				@children = []
+        @type = type
+			end
+			
+			def add(child)
+				raise 'Added nil child' unless child
+				raise 'Added nil child type' unless child.type
+				@children << child
+			end
+				
+			def end_address(start_address) 
+				addr = start_address.next_start
+				@children.each do |child|
+					addr = child.type.end_address addr
+				end
+        addr.next_start!
+			end
+			
+			def explode(start_addr, name, comment = nil, struct_comment = nil, options = {})
+				addr = start_addr.next_start
+				exploded = []
+				@children.each do |child|
+
+					exploded += child.type.explode(addr, [name, child.name].compact.join('.'), child.comment, 
+                                         type == :datablock ? child.comment : struct_comment, options)
+					addr = child.type.end_address addr
+				end
+				exploded
+			end
+		end
+		
+		class ArrayType
+			attr_accessor :range, :type
+			
+			def initialize(type, range)
+				raise 'Added nil array type' unless type
+				raise 'Added nil array range' unless range
+				@range, @type = range, type
+			end
+			
+			def name
+				'ARRAY'
+			end
+
+			def end_address(start_address) 
+				addr = start_address.next_start
+				range.each do
+					addr = type.end_address addr
+				end
+				addr
+			end
+
+			def explode(start_addr, name, comment, struct_comment, options = {})
+				exploded = []
+				addr = start_addr.next_start
+				range.to_a.each_with_index do |v, i|
+					exploded += type.explode(addr, name + '[' + v.to_s + ']', comment, struct_comment, options = {})
+					addr = type.end_address(addr)
+				end
+				exploded
+			end
+		end
+		
+		class Variable
+			attr_accessor :name, :type, :comment
+
+			def initialize(name, type, comment = nil)
+				@name, @type, @comment= name, type, comment
+			end
+		end
+		
+		class Address
+			attr_accessor :bit_addr, :data_block_addr
+			
+			def initialize(bit_addr, data_block_addr = nil)
+				@bit_addr, @data_block_addr = bit_addr, data_block_addr
+			end
+			
+			def to_s
+				(data_block_addr || 'DB???') + ',' + byte.to_s + '.' + bit.to_s
+			end
+
+      def bit
+        @bit_addr % 8
+      end
+
+      def byte
+        @bit_addr / 8
+      end
+
+      def next_start!(bit_size = 2 * 8)
+        bs = [bit_size, 2 * 8].min  # bools use bits, chars/bytes one byte others two byte rounding of start address
+        rest = @bit_addr % bs
+        @bit_addr += (bs - rest) if rest > 0
+        self
+      end
+
+      def next_start(bit_size = 2 * 8)
+        self.clone.next_start! bit_size
+      end
+
+      def skip!(bit_count)
+        @bit_addr += bit_count
+        self
+      end
+		end
+	end
+end

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

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require 'ostruct'
+
+module PlcUtil
+	class SdfFile
+    attr_reader :tags
+
+		def initialize(filename = nil)
+      @tags = []
+      case filename
+      when '--'
+        parse $stdin
+      when nil
+        # dont read file
+      else
+        File.open filename do |f|
+          parse f
+        end
+      end
+		end
+
+
+    private
+
+    def parse(f)
+      f.each_line do |l|
+        item = {}
+        values = l.strip.split(/,/).map do |x| 
+          x.gsub(/^"|"$/, '').strip 
+        end
+        item = Hash[[:name, :addr, :type, :comment].zip values]
+        item[:addr].gsub! /\s+/, ' '
+        if not item[:type].match(/\s/) # skip OB XX, FC XX, FB XX and so on
+          begin
+            item[:type] = item[:type].downcase.to_sym
+            @tags << item
+          rescue
+            # no worries
+          end
+        end
+      end
+    end
+  end  
+end
+