ladder_drive 0.3.0

data/lib/ladder_drive/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 LadderDrive
+  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/ladder_drive/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 LadderDrive
+
+  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/ladder_drive/protocol/emulator/emu_protocol.rb

@@ -0,0 +1,54 @@
+# 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 LadderDrive
+module Protocol
+module Emulator
+
+  class EmuProtocol < LadderDrive::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
+
+      def local_device device
+        device
+      end
+
+  end
+
+end
+end
+end

data/lib/ladder_drive/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/ladder_drive/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/ladder_drive/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 LadderDrive
+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

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

@@ -0,0 +1,187 @@
+# 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 LadderDrive
+module Protocol
+module Keyence
+
+  class KvProtocol < Protocol
+
+    def initialize options={}
+      super
+      @host = options[:host] || "192.168.0.10"
+      @port = options[:port] || 8501
+      prepare_device_map
+    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 = 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 = local_device 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 device_class
+        KvDevice
+      end
+
+      def prepare_device_map
+        @conv_dev_dict ||= begin
+          h = {}
+          [
+            ["X", "R0", 1024],
+            ["Y", "R0", 1024],
+            ["M", "MR0", 1024],
+            ["C", "C0", 256],
+            ["T", "T0", 256],
+            ["L", "L0", 1024],
+            ["SC", "MR1024", 1024],
+            ["D", "DM0", 1024],
+            ["H", "DM1024", 1024],
+            ["SD", "DM2048", 1024],
+            ["PRG", "DM3072", 1024]    # ..D4095
+          ].each do |s,d,c|
+            h[s] = [KvDevice.new(d), c]
+          end
+          h
+        end
+      end
+
+      def local_device device
+        return device if device.is_a? KvDevice
+        d, c = @conv_dev_dict[device.suffix]
+        return nil unless device.number < c
+        ld = KvDevice.new(d.suffix, d.number + device.number)
+        device_by_name ld.name
+      end
+
+  end
+
+end
+end
+end