Class: PlcUtil::Step7ToIntouchRunner

Inherits:
Object
  • Object
show all
Defined in:
lib/plcutil/siemens/step7_to_intouch_runner.rb

Overview

Command line tool to read and output an awl file

Instance Method Summary collapse

Constructor Details

#initialize(command_line_arguments) ⇒ Step7ToIntouchRunner

Returns a new instance of Step7ToIntouchRunner.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 11

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

Instance Method Details

#filter_comment_format(comment, struct_comment) ⇒ Object

This function may be overriden in filter ruby file



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 81

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

#filter_handle_awl_files ⇒ Object

This function may be overridden in filter ruby file



163
164
165
166
167
168
169
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 163

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

#filter_handle_sdf_files ⇒ Object

This function may be overridden in filter ruby file



154
155
156
157
158
159
160
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 154

def filter_handle_sdf_files
  @sdflist.each do |sdf|
    sdf.tags.each do |item|
      filter_handle_tag item
    end
  end
end

#filter_handle_tag(item) ⇒ Object

This function may be overridden in filter ruby file



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 93

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

#format_addr(addr, ww_data_type, options = {}) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 65

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

#new_unique_tag(s) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 192

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

#new_unique_tag_helper(s, n) ⇒ Object 



188
189
190
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 188

def new_unique_tag_helper(s, n)
  s[0..(31 - n.to_s.size - 1)] + '%' + n.to_s
end

#option_parser ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 208

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

#print_to_file(f) ⇒ Object 



173
174
175
176
177
178
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 173

def print_to_file(f)
    @intouchfile = IntouchFile.new nil, @intouchoptions
    filter_handle_sdf_files
    filter_handle_awl_files
    @intouchfile.write_csv f
end

#show_help ⇒ Object 



238
239
240
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 238

def show_help
	puts option_parser
end

#siemens_to_ww_tagname(s) ⇒ Object 



180
181
182
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 180

def siemens_to_ww_tagname(s)
  new_unique_tag(siemens_to_ww_tagname_long s)
end

#siemens_to_ww_tagname_long(s) ⇒ Object 



184
185
186
 
# File 'lib/plcutil/siemens/step7_to_intouch_runner.rb', line 184

def siemens_to_ww_tagname_long(s)
  s.gsub(/[\. ]/, '_').gsub(/\[(\d+)\]/) { '_' + $1 }
end