escalator 0.2.1 → 0.2.2

data/lib/escalator/protocol/keyence/kv_protocol.rb

@@ -0,0 +1,161 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2016 ITO SOFT DESIGN Inc.
+#
+# 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.
+
+module Escalator
+module Protocol
+module Keyence
+
+  class KvProtocol < Protocol
+
+    def initialize options={}
+      super
+      @host = options[:host] || "192.168.0.10"
+      @port = options[:port] || 8501
+    end
+
+    def open
+      open!
+    rescue
+      nil
+    end
+
+    def open!
+      @socket ||= TCPSocket.open(@host, @port)
+    end
+
+    def close
+      @socket.close if @socket
+      @socket = nil
+    end
+
+    def get_bit_from_device device
+      device = device_by_name device
+      get_bits_from_device(1, device).first
+    end
+
+    def get_bits_from_device count, device
+      values = get_words_from_device count, device
+      values.map{|v| v == 0 ? false : true}
+      values.each do |v|
+        device.bool = v
+        device = device_by_name (device+1).name
+      end
+      values
+    end
+
+    def set_bits_to_device bits, device
+      device = device_by_name device
+      bits = [bits] unless bits.is_a? Array
+      @logger.debug("#{device.name}[#{bits.size}] <= #{bits}")
+      bits.each do |v|
+        cmd = "ST"
+        case v
+        when false, 0
+          cmd = "RS"
+        end
+        packet = "#{cmd} #{device.name}\r"
+        @logger.debug("> #{dump_packet packet}")
+        open
+        @socket.puts(packet)
+        res = receive
+        raise res unless /OK/i =~ res
+        device = device_by_name (device+1).name
+      end
+    end
+    alias :set_bit_to_device :set_bits_to_device
+
+
+    def get_word_from_device device
+      device = device_by_name device
+      get_words_from_device(1, device).first
+    end
+
+    def get_words_from_device(count, device)
+      device = device_by_name device
+      packet = "RDS #{device.name} #{count}\r"
+      @logger.debug("> #{dump_packet packet}")
+      open
+      @socket.puts(packet)
+      res = receive
+      values = res.split(/\s+/).map{|v| v.to_i}
+      @logger.debug("#{device.name}[#{count}] => #{values}")
+      values
+    end
+
+    def set_words_to_device words, device
+      device = local_device device
+      words = [words] unless words.is_a? Array
+      packet = "WRS #{device.name} #{words.size} #{words.map{|w| w.to_s}.join(" ")}\r"
+      @logger.debug("> #{dump_packet packet}")
+      open
+      @socket.puts(packet)
+      res = receive
+      @logger.debug("#{device.name}[#{words.size}] <= #{words}")
+      raise res unless /OK/i =~ res
+    end
+    alias :set_word_to_device :set_words_to_device
+
+
+    def device_by_name name
+      case name
+      when String
+        device_class.new name
+      else
+        # it may be already Device
+        name
+      end
+    end
+
+
+    def receive
+      res = ""
+      begin
+        Timeout.timeout(0.1) do
+          res = @socket.gets
+        end
+      rescue Timeout::Error
+      end
+      @logger.debug("< #{dump_packet res}")
+      res.chomp
+    end
+
+    def dump_packet packet
+      packet.dup.chomp
+    end
+
+    private
+
+      def local_device device
+        # TODO:
+        device
+      end
+
+      def device_class
+        KvDevice
+      end
+
+  end
+
+end
+end
+end

data/lib/escalator/protocol/mitsubishi/mc_protocol.rb

@@ -29,11 +29,18 @@ module Mitsubishi
 
     def initialize options={}
       super
-      @host = options[:host] || "192.168.0.1"
+      @host = options[:host] || "192.168.0.10"
       @port = options[:port] || 5010
+      prepare_device_map
     end
 
     def open
+      open!
+    rescue
+      nil
+    end
+
+    def open!
       @socket ||= TCPSocket.open(@host, @port)
     end
 
@@ -117,6 +124,8 @@ module Mitsubishi
       case name
       when String
         QDevice.new name
+      when EscDevice
+        local_device_of name
       else
         # it may be already QDevice
         name
@@ -128,17 +137,18 @@ module Mitsubishi
       res = []
       len = 0
       begin
-        Timeout.timeout(0.1) do
-          while  true
+        Timeout.timeout(1.0) do
+          loop do
             c = @socket.read(1)
             next if c.nil? || c == ""
 
             res << c.bytes.first
-            len = res[7] + res[8] << 8 if res.length >= 9
+            len = res[7,2].pack("c*").unpack("v*").first if res.length >= 9
             break if (len + 9 == res.length)
           end
         end
       rescue Timeout::Error
+        puts "*** ERROR: TIME OUT ***"
       end
       @logger.debug("< #{dump_packet res}")
       res
@@ -221,6 +231,36 @@ module Mitsubishi
       "[" + a.join(", ") + "]"
     end
 
+    def prepare_device_map
+      @conv_dev_dict ||= begin
+        h = {}
+        [
+          ["X", "X0", 1024],
+          ["Y", "Y0", 1024],
+          ["M", "M0", 1024],
+          ["C", "C0", 256],
+          ["T", "T0", 256],
+          ["L", "L0", 1024],
+          ["SC", "M1024", 1024],
+          ["D", "D0", 1024],
+          ["H", "D1024", 1024],
+          ["SD", "D2048", 1024],
+          ["PRG", "D3072", 1024]    # ..D4095
+        ].each do |s,d,c|
+          h[s] = [QDevice.new(d), c]
+        end
+        h
+      end
+    end
+
+    def local_device_of device
+      return device if device.is_a? QDevice
+      d, c = @conv_dev_dict[device.suffix]
+      return nil unless device.number < c
+      ld = QDevice.new(d.suffix, d.number + device.number)
+      device_by_name ld.name
+    end
+
   end
 
 end

data/lib/escalator/protocol/mitsubishi/mitsubishi.rb

@@ -23,14 +23,8 @@
 
 $:.unshift File.dirname(__FILE__)
 
-module Escalator
-module Protocol
-
 require 'socket'
 require 'logger'
 require 'timeout'
 require 'qdevice'
 require 'mc_protocol'
-
-end
-end

data/lib/escalator/protocol/mitsubishi/qdevice.rb

@@ -100,11 +100,11 @@ module Mitsubishi
     end
 
     def + value
-      QDevice.new self.suffix, self.number + value
+      self.class.new self.suffix, self.number + value
     end
 
     def - value
-      QDevice.new self.suffix, [self.number - value, 0].max
+      self.class.new self.suffix, [self.number - value, 0].max
     end
 
   end

data/lib/escalator/protocol/protocol.rb

@@ -21,7 +21,13 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-$:.unshift File.dirname(__FILE__)
+dir = File.expand_path(File.dirname(__FILE__))
+$:.unshift dir unless $:.include? dir
+
+module Escalator
+module Protocol
+end
+end
 
 module Escalator
 module Protocol
@@ -32,7 +38,7 @@ module Protocol
 
     def initialize options={}
       @logger = Logger.new(STDOUT)
-      @logger.level = options[:log_level] || Logger::INFO
+      self.log_level = options[:log_level] || :info
     end
 
     def log_level= level
@@ -70,9 +76,30 @@ module Protocol
 
     def device_by_name name; nil; end
 
+    def get_from_devices device, count = 1
+      d = device_by_name device
+      if d.bit_device?
+        get_bits_from_device count, d
+      else
+        get_words_from_device count, d
+      end
+    end
+
+    def set_to_devices device, values
+      d = device_by_name device
+      if d.bit_device?
+        set_bits_to_device values, d
+      else
+        set_words_to_device values, d
+      end
+    end
+
   end
 
 end
 end
 
+require 'keyence/keyence'
+# Use load instead require, because there are two emulator files.
+load File.join(dir, 'emulator/emulator.rb')
 require 'mitsubishi/mitsubishi'

data/lib/escalator/tasks/build.rb

@@ -21,15 +21,12 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-Escalator_root = File.expand_path(File.join(File.dirname(__FILE__), "../../../"))
+dir = File.expand_path(File.join(File.dirname(__FILE__), "../../../lib"))
+$:.unshift dir unless $:.include? dir
 
-require "escalator/config"
-require 'escalator/asm'
-require 'escalator/intel_hex'
 require 'rake/loaders/makefile'
 require 'fileutils'
-
-#directory "build"
+require "escalator"
 
 directory "build"
 
@@ -69,23 +66,6 @@ rule %r{^build/.+\.hex} => ['%{^build,asm}X.esc'] do |t|
   File.write(t.name, hex.dump)
 end
 
-desc "GX Works Memory Image"
-rule %r{^build/.+\.gxwm} => ['%{^build,asm}X.esc'] do |t|
-  Rake::Task["build"].invoke
-  begin
-    $stderr = File.open('hb.log', 'w')
-    $stdout = $stderr
-  ensure
-    $stdout = STDOUT
-    $stderr = STDERR
-  end
-  stream = StringIO.new
-  puts "gxwm #{t.source}"
-  asm = Escalator::Asm.new File.read(t.source)
-  hex = Escalator::IntelHex.new asm.codes
-  File.write(t.name, hex.gxworks_memory_image)
-end
-
 desc "Clean all generated files."
 task :clean do
   FileUtils.rm_r "build"
@@ -93,15 +73,29 @@ end
 
 @config = Escalator::EscalatorConfig.default
 
+desc "Install program to PLCs."
 task :upload => @config.output do
-  u = @config.uploader
+  t = @config.target ENV['target']
+  t.run
+  u = t.uploader
   u.source = @config.output
+  puts "uploading #{u.source} ..."
   u.upload
-  puts "upload #{u.source}"
+  puts "done uploading"
 end
 
-desc "Install program to PLCs."
-task :plc => :upload do
+desc "Launch emulator."
+task :emulator do
+  t = @config.target :emulator
+  t.run
+  puts "launch emulator"
+  Escalator::Console.instance.run
+end
+
+task :console => :upload do
+  c = Escalator::Console.instance
+  c.target = @config.target ENV['target']
+  c.run
 end
 
-task :default => %w(build/main.lst build/main.hex build/main.gxwm)
+task :default => :console

data/lib/escalator/uploader.rb

@@ -21,27 +21,22 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+require "escalator/plc_define"
+require "escalator/plc_device"
+
 module Escalator
 
   class Uploader
+    include ::Escalator::PlcDefine
 
     attr_accessor :protocol
-    attr_accessor :program_area, :interaction_area
     attr_accessor :source
     attr_accessor :data
 
     def initialize options={}
       @protocol = options[:protocol] if options[:protocol]
-      @program_area = options[:program_area] if options[:program_area]
-      @interaction_area = options[:interaction_area] if options[:interaction_area]
     end
 
-    STOP_PLC_FLAG         = 2     # bit 1
-    CLEAR_PROGRAM_FLAG    = 4     # bit 2  require bit 1 on
-
-    CYCLE_RUN_FLAG        = 2
-
-
     def upload
       # stop plc
       stop_plc
@@ -59,52 +54,44 @@ module Escalator
 
     def word_data
       data.each_slice(2).map do |pair|
+        pair << 0 if pair.size == 1
         pair.pack("c*").unpack("n*")
       end.flatten
     end
 
     private
 
-      def to_plc_status
-        @to_plc_status ||= interaction_area
-      end
-
-      def from_plc_status
-        @from_plc_status ||= interaction_area.next_device
-      end
-
-
       def stop_plc
-        @protocol.set_word_to_device STOP_PLC_FLAG, to_plc_status
+        @protocol.set_word_to_device ESC_STATUS_TO_PLC_STOP_PLC_FLAG, EscDevice.status_to_plc_device
         Timeout.timeout(5) do
-          v = @protocol.get_word_from_device from_plc_status
-          break if (v & STOP_PLC_FLAG) != 0
+          v = @protocol.get_word_from_device EscDevice.status_from_plc_device
+          break if (v & ESC_STATUS_TO_PLC_STOP_PLC_FLAG) != 0
           sleep 0.1
         end
       end
 
       def clear_program
-        @protocol.set_word_to_device STOP_PLC_FLAG | CLEAR_PROGRAM_FLAG, to_plc_status
+        @protocol.set_word_to_device ESC_STATUS_TO_PLC_STOP_PLC_FLAG | ESC_STATUS_TO_PLC_CLEAR_PROGRAM, EscDevice.status_to_plc_device
         Timeout.timeout(5) do
-          v = @protocol.get_word_from_device from_plc_status
-          break if (v & CLEAR_PROGRAM_FLAG) != 0
+          v = @protocol.get_word_from_device EscDevice.status_from_plc_device
+          break if (v & ESC_STATUS_TO_PLC_CLEAR_PROGRAM) != 0
           sleep 0.1
         end
-        @protocol.set_word_to_device STOP_PLC_FLAG, to_plc_status
+        @protocol.set_word_to_device ESC_STATUS_TO_PLC_STOP_PLC_FLAG, EscDevice.status_to_plc_device
       end
 
       def run_plc
-        @protocol.set_word_to_device 0, to_plc_status
+        @protocol.set_word_to_device 0, EscDevice.status_to_plc_device
         Timeout.timeout(5) do
-          v = @protocol.get_word_from_device from_plc_status
-          break if (v & CYCLE_RUN_FLAG) != 0
+          v = @protocol.get_word_from_device EscDevice.status_from_plc_device
+          break if (v & ESC_STATUS_FROM_PLC_CYCLE_RUN) != 0
           sleep 0.1
         end
       end
 
       def write_program
         word_data.each_slice(2*1024) do |chunk|
-          @protocol.set_words_to_device chunk, @program_area
+          @protocol.set_words_to_device chunk, EscDevice.program_area_device
         end
       end
 

data/lib/escalator/version.rb

@@ -22,5 +22,5 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module Escalator
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/escalator.rb

@@ -21,16 +21,8 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-require "escalator/version"
-require "escalator/cli"
-require "escalator/asm"
-require "escalator/intel_hex"
-require "escalator/config"
+dir = File.expand_path(File.dirname(__FILE__))
+$:.unshift dir unless $:.include? dir
 
-Escalator_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-
-module Escalator
-end
-
-
-Escalator::CLI.start
+require "plc/plc"
+require "escalator/escalator"

data/lib/plc/emulator/emu_device.rb

@@ -0,0 +1,121 @@
+#
+# Copyright (c) 2016 ITO SOFT DESIGN Inc.
+#
+# 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.
+
+require 'escalator/plc_device'
+
+include Escalator
+
+module Plc
+module Emulator
+
+  class EmuDevice < PlcDevice
+
+    attr_reader :in_value, :out_value
+
+    def initialize a, b = nil
+      super
+      @lock = Mutex.new
+      @in_value = 0
+      @out_value = 0
+    end
+
+    def reset
+      @lock.synchronize {
+        super
+        @in_value = nil
+        @out_value = 0
+      }
+    end
+
+    def value= value
+      set_value value
+    end
+
+    def bool kind=nil
+      v = value kind
+      case v
+      when nil, false, 0
+        false
+      else
+        true
+      end
+    end
+
+    def bool= value
+      @lock.synchronize { super }
+    end
+
+    def word kind=nil
+      value kind
+    end
+
+    def word= value
+      @lock.synchronize {
+        super
+      }
+    end
+
+    def value kind=nil
+      @lock.synchronize {
+        case kind
+        when :in
+          @in_value
+        when :out
+          @out_value
+        else
+          @value
+        end
+      }
+    end
+
+    def set_value value, kind=nil
+      @lock.synchronize {
+        case kind
+        when :in
+          @in_value = value
+        when :out
+          @out_value = value
+        else
+          @value = value
+        end
+      }
+    end
+
+    def sync_input
+      @lock.synchronize {
+        unless @in_value.nil?
+          @value = @in_value
+          @in_value = nil
+        end
+      }
+    end
+
+    def sync_output
+      @lock.synchronize {
+        @out_value = @value
+      }
+    end
+
+  end
+
+end
+end