escalator 0.2.1 → 0.2.2

data/lib/escalator/config_target.rb

@@ -0,0 +1,93 @@
+#
+# 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 'active_support/core_ext/string/inflections'
+require 'yaml'
+require 'json'
+require 'protocol/protocol'
+
+include Escalator::Protocol::Mitsubishi
+include Escalator::Protocol::Keyence
+include Escalator::Protocol::Emulator
+
+module Escalator
+
+  class EscalatorConfigTarget
+
+    class << self
+
+      def finalize
+        proc {
+          EmuPlcServer.terminate
+        }
+      end
+
+    end
+
+    def initialize options={}
+      @target_info = options
+      ObjectSpace.define_finalizer(self, self.class.finalize)
+    end
+
+    def protocol
+      @protocol ||= begin
+        p = eval("#{@target_info[:protocol].camelize}.new")
+        p.host = @target_info[:host] if @target_info[:host]
+        p.port = @target_info[:port] if @target_info[:port]
+        p.log_level = @target_info[:log_level] if @target_info[:log_level]
+        p
+      rescue
+        nil
+      end
+    end
+
+    def uploader
+      @uploader ||= begin
+        u = Uploader.new
+        u.protocol = self.protocol
+        u
+      end
+    end
+
+    def method_missing(name, *args)
+      name = name.to_s unless name.is_a? String
+      case name.to_s
+      when /(.*)=$/
+        @target_info[$1.to_sym] = args.first
+      else
+        @target_info[name.to_sym]
+      end
+    end
+
+    def run
+      case self.name
+      when :emulator
+        Plc::Emulator::EmuPlcServer.launch
+      else
+        # DO NOTHIN
+        # Actual device is running independently.
+      end
+    end
+
+  end
+
+end

data/lib/escalator/console.rb

@@ -0,0 +1,124 @@
+#
+# 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 'singleton'
+require 'curses'
+
+module Escalator
+
+  attr_accessor :target
+
+  class Console
+    include Singleton
+
+    def self.finalize
+      proc {
+        #Curses.close_screen
+      }
+    end
+
+    def initialize
+      #Curses.init_screen
+      ObjectSpace.define_finalizer(self, self.class.finalize)
+    end
+
+    def run
+      l = true
+      trap(:INT) { puts "\n> " }
+
+      display_title
+
+      loop do
+        begin
+          print "> "
+          line = STDIN.gets
+          case line.chomp
+          when /^\s*exit\s*$/, /^\s*quit\s*$/, /^\s*q\s*$/
+            break
+          when /^r\s+(\w+)(\s+(\d+))?/
+            d = protocol.device_by_name EscDevice.new($1)
+            c = $2 ? $2.to_i : 1
+            values = protocol.get_from_devices d, c
+            puts values.join(" ")
+          when /^p\s+(\w+)(\s+(\d+))?/
+            d = protocol.device_by_name EscDevice.new($1)
+            t = $2 ? $2.to_f : 0.1
+            protocol.set_to_devices d, 1
+            sleep t
+            protocol.set_to_devices d, 0
+          when /^w\s+(\w+)/
+            d = protocol.device_by_name EscDevice.new($1)
+            v = $'.scan(/\d+/).map{|e| e.to_i}
+            protocol.set_to_devices d, v
+          when /^E\s+/
+            puts protocol.execute(line)
+          when /^help/, /^h/
+            display_help
+          end
+        rescue => e
+          puts "*** ERROR: #{e} ***"
+        end
+      end
+    end
+
+    private
+
+      def protocol
+        target.protocol
+      end
+
+      def display_title
+        puts <<EOB
+
+  Escalator is an abstract PLC.
+  This is a console to communicate with PLC.
+
+EOB
+      end
+
+      def display_help
+        puts <<EOB
+Commands:
+
+  r: Read values from device.
+     r device [count]
+       e.g.) it reads values from M0 to M7.
+             > r m0 8
+  w: Write values to device.
+     w device value1 value2 ...
+       e.g.) it write values from D0 to D7.
+             > w d0 1 2 3 4 5 6 7 8
+       e.g.) it write values from M0 to M7.
+             > w m0 0 0 0 1 1 0 1 1
+  p: Pulse out on device. Default duration is 0.1 sec
+     p device [duration]
+       e.g.) it write 1 to m0, then write 0 after 0.5 sec.
+             > w m0 0.5
+  q: Quit this. You can use quit and exit instead of q.
+  h: Show help. You can use help instead of h.
+
+EOB
+      end
+
+  end
+
+end

data/lib/escalator/escalator.rb

@@ -0,0 +1,36 @@
+#
+# 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.
+
+dir = File.expand_path(File.dirname(__FILE__))
+$:.unshift dir unless $:.include? dir
+
+require "version"
+require "cli"
+require "asm"
+require "intel_hex"
+require "plc_define"
+require "uploader"
+require "config"
+require "config_target"
+require "plc_device"
+require "protocol/protocol"
+require "console"

data/lib/escalator/plc_define.rb

@@ -0,0 +1,35 @@
+#
+# 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 PlcDefine
+
+    # status flags
+    # SD0
+    ESC_STATUS_TO_PLC_STOP_PLC_FLAG       = 2     # bit 1
+    ESC_STATUS_TO_PLC_CLEAR_PROGRAM       = 4     # bit 2  require bit 1 on
+    # SD1
+    ESC_STATUS_FROM_PLC_CYCLE_RUN         = 2
+    ESC_STATUS_FROM_PLC_ACK_CLEAR_PROGRAM = 4
+
+  end
+end

data/lib/escalator/plc_device.rb

@@ -0,0 +1,171 @@
+# 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
+
+  class PlcDevice
+
+    attr_reader :suffix, :number
+    attr_accessor :value
+
+    NUMBER_TYPE_DEC     = 0
+    NUMBER_TYPE_DEC_HEX = 1
+    NUMBER_TYPE_HEX     = 2
+
+    ESC_SUFFIXES = %w(X Y M - C T L SC CC TC D - CS TS H SD)
+
+    class << self
+
+      def status_to_plc_device
+        @status_to_plc_device ||= new "SD0"
+      end
+
+      def status_from_plc_device
+        @status_from_plc_device ||= new "SD1"
+      end
+
+      def program_area_device
+        @program_area_device ||= new "PRG0"
+      end
+
+    end
+
+    def initialize a, b = nil
+      @suffix = nil
+      @value = 0
+      case a
+      when Fixnum
+        @suffix = ESC_SUFFIXES[a]
+        @number = b
+      when String
+        if b
+          @suffix = a.upcase
+          @number = b
+        else
+          /([A-Z]+)?(\d+)/i =~ a
+          @suffix = ($1 || "").upcase
+          case number_type
+          when NUMBER_TYPE_DEC_HEX
+            n = $2.to_i
+            @number = (n / 100) * 16 + (n % 100)
+          when NUMBER_TYPE_HEX
+            @number = $2.to_i(16)
+          else
+            @number = $2.to_i
+          end
+        end
+      end
+    end
+
+    def name
+      case number_type
+      when NUMBER_TYPE_DEC
+        "#{@suffix}#{@number}"
+      when NUMBER_TYPE_DEC_HEX
+        a = [@number / 16, @number % 16]
+        ns = begin
+          s = a.last.to_s.rjust(2, "0")
+          s = a.first.to_s + s unless a.first == 0
+          s
+        end
+        "#{@suffix}#{ns}"
+      when NUMBER_TYPE_HEX
+        ns = @number.to_s(16)
+        ns = "0" + ns unless /^[0-9]/ =~ ns
+        "#{@suffix}#{ns}"
+      else
+        nil
+      end
+    end
+
+    def next_device
+      d = self.class.new @suffix, @number + 1
+      d
+    end
+
+    def bit_device?
+      SUFFIXES_FOR_BIT.include? @suffix
+    end
+
+    def + value
+      self.class.new self.suffix, self.number + value
+    end
+
+    def - value
+      self.class.new self.suffix, [self.number - value, 0].max
+    end
+
+    def input?
+      suffixes_for_input.include? @suffix
+    end
+
+    def bool
+      case @value
+      when Fixnum
+        @value != 0
+      else
+        !!@value
+      end
+    end
+    def bool= v; @value = v; end
+    alias :word :value
+    alias :word= :value=
+
+    def device_code
+      ESC_SUFFIXES.index @suffix
+    end
+
+    def reset
+      @value = 0
+    end
+
+    private
+
+      SUFFIXES_FOR_DEC      = %w(PRG M C T L SC CC TC D CS TS H SD)
+      SUFFIXES_FOR_DEC_HEX  = %w()
+      SUFFIXES_FOR_HEX      = %w(X Y)
+      SUFFIXES_FOR_BIT      = %w(X Y M C T L SC)
+      SUFFIXES_FOR_INPUT    = %w(X)
+
+      def suffixes_for_dec; SUFFIXES_FOR_DEC; end
+      def suffixes_for_dec_hex; SUFFIXES_FOR_DEC_HEX; end
+      def suffixes_for_hex; SUFFIXES_FOR_HEX; end
+      def suffixes_for_bit; SUFFIXES_FOR_BIT; end
+      def suffixes_for_input; SUFFIXES_FOR_INPUT; end
+
+      def suffixes
+        suffixes_for_dec + suffixes_for_dec_hex + suffixeds_for_hex
+      end
+
+      def number_type
+        return NUMBER_TYPE_DEC if suffixes_for_dec.include? @suffix
+        return NUMBER_TYPE_DEC_HEX if suffixes_for_dec_hex.include? @suffix
+        return NUMBER_TYPE_HEX if suffixes_for_hex.include? @suffix
+        nil
+      end
+
+  end
+
+  class EscDevice < PlcDevice; end
+
+end

data/lib/escalator/protocol/emulator/emu_protocol.rb

@@ -0,0 +1,49 @@
+# 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 Emulator
+
+  class EmuProtocol < Escalator::Protocol::Keyence::KvProtocol
+
+    def initialize options={}
+      options.merge host:"localhost", port:5555
+      super
+    end
+
+    def execute line
+      @socket.puts(line)
+      @socket.gets
+    end
+
+    private
+
+      def device_class
+        EscDevice
+      end
+  end
+
+end
+end
+end

data/lib/escalator/protocol/emulator/emulator.rb

@@ -0,0 +1,29 @@
+# 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.
+
+$:.unshift File.dirname(__FILE__)
+
+require 'socket'
+require 'logger'
+require 'timeout'
+require 'emu_protocol'

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

@@ -0,0 +1,31 @@
+# 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.
+
+dir = File.expand_path(File.dirname(__FILE__))
+$:.unshift dir unless $:.include? dir
+
+require 'socket'
+require 'logger'
+require 'timeout'
+require 'kv_device'
+require 'kv_protocol'

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

@@ -0,0 +1,51 @@
+# 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 KvDevice < PlcDevice
+
+    def initialize a, b = nil
+      super
+      @suffix = "R" if @suffix.nil? || @suffix.length == 0
+    end
+
+    private
+
+      SUFFIXES_FOR_DEC      = %w(DM EM FM ZF TM Z T TC TS C CC CS CTH CTC AT CM VM)
+      SUFFIXES_FOR_DEC_HEX  = %w(R MR LR CR)
+      SUFFIXES_FOR_HEX      = %w(B VB W)
+      SUFFIXES_FOR_BIT      = %w(R B MR LR CR VB)
+
+      def suffixes_for_dec; SUFFIXES_FOR_DEC; end
+      def suffixes_for_dec_hex; SUFFIXES_FOR_DEC_HEX; end
+      def suffixeds_for_hex; SUFFIXES_FOR_HEX; end
+      def suffixes_for_bit; SUFFIXES_FOR_BIT; end
+
+  end
+
+end
+end
+end