plc_access 0.1.0

data/lib/plc_access/protocol/omron/omron_device.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2019 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.
+
+# Supported models : CP1E
+
+module PlcAccess
+  module Protocol
+    module Omron
+      class OmronDevice < PlcDevice
+        attr_reader :suffix, :channel, :bit
+
+        SUFFIXES = %w[M H D T C A].freeze
+
+        def initialize(a, b = nil, c = nil)
+          case a
+          when Array
+          #         case a.size
+          #         when 4
+          #           @suffix = suffix_for_code(a[3])
+          #           @channel = ((a[2] << 8 | a[1]) << 8) | a[0]
+          #         end
+          else
+            if b
+              @suffix = a.upcase if a
+              @channel = b.to_i
+              @bit = c.to_i if c
+            elsif /^(M|H|D|T|C|A)?([0-9]+)(\.([0-9]{1,2}))?$/i =~ a
+              @suffix = ::Regexp.last_match(1).upcase if ::Regexp.last_match(1)
+              @channel = ::Regexp.last_match(2).to_i
+              @bit = ::Regexp.last_match(4).to_i if ::Regexp.last_match(4)
+            end
+          end
+          case @suffix
+          when 'T', 'C'
+            raise "#{name} is not allowed as a bit device." if @bit
+          end
+        end
+
+        def channel_device
+          return self unless bit_device?
+
+          self.class.new suffix, channel
+        end
+
+        def valid?
+          !!channel
+        end
+
+        def name
+          if bit
+            "#{suffix}#{channel}.#{bit.to_s.rjust(2, '0')}"
+          else
+            "#{suffix}#{channel}"
+          end
+        end
+
+        def next_device
+          self + 1
+        end
+
+        def bit_device?
+          !!bit
+        end
+
+        def suffix_for_code(code)
+          index = SUFFIX_CODES.index code
+          index ? SUFFIXES[index] : nil
+        end
+
+        def suffix_code
+          index = SUFFIXES.index suffix
+          index ? SUFFIX_CODES[index] : 0
+        end
+
+        def +(other)
+          if bit
+            v = channel * 16 + bit + other
+            c = v / 16
+            b = v % 16
+            self.class.new suffix, c, b
+          else
+            self.class.new suffix, channel + other
+          end
+        end
+
+        def -(other)
+          case other
+          when OmronDevice
+            d = other
+            raise "Can't subtract between different device type." if bit_device? ^ d.bit_device?
+
+            if bit
+              (channel * 16 + bit) - (d.channel * 16 + d.bit)
+            else
+              channel - d.channel
+            end
+          else
+            other = other.to_i
+            if bit
+              v = [channel * 16 + bit - other, 0].max
+              c = v / 16
+              b = v % 16
+              self.class.new suffix, c, b
+            else
+              self.class.new suffix, [channel - other, 0].max
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plc_access/protocol/plc_device.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+# 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 PlcAccess
+  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].freeze
+
+    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 Integer
+        @suffix = ESC_SUFFIXES[a]
+        @number = b
+      when String, Symbol
+        a = a.to_s # convert to string if it's a symbol
+        if b
+          @suffix = a.upcase
+          @number = b
+        else
+          /([A-Z]+)?([0-9A-F]+)/i =~ a
+          @suffix = (::Regexp.last_match(1) || '').upcase
+          case number_type
+          when NUMBER_TYPE_DEC_HEX
+            n = ::Regexp.last_match(2).to_i
+            @number = (n / 100) * 16 + (n % 100)
+          when NUMBER_TYPE_HEX
+            @number = ::Regexp.last_match(2).to_i(16)
+          else
+            @number = ::Regexp.last_match(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.zero?
+          s
+        end
+        "#{@suffix}#{ns}"
+      when NUMBER_TYPE_HEX
+        ns = @number.to_s(16).upcase
+        ns = "0#{ns}" unless /^[0-9]/ =~ ns
+        "#{@suffix}#{ns}"
+      end
+    end
+
+    # NOTE: override at subclass
+    #       It should get from plc
+    def device_by_suffix_number(suffix, number)
+      self.class.new suffix, number
+    end
+
+    def next_device
+      device_by_suffix_number @suffix, @number + 1
+    end
+
+    def bit_device?
+      suffixes_for_bit.include? @suffix
+    end
+
+    def +(other)
+      device_by_suffix_number suffix, number + other
+    end
+
+    def -(other)
+      device_by_suffix_number suffix, [number - other, 0].max
+    end
+
+    def input?
+      suffixes_for_input.include? @suffix
+    end
+
+    def value
+      case @value
+      when true
+        1
+      when false, nil
+        0
+      else
+        @value
+      end
+    end
+
+    def bool
+      case @value
+      when Integer
+        @value != 0
+      else
+        !!@value
+      end
+    end
+
+    def bool=(v)
+      @value = v
+    end
+    alias word value
+    alias word= value=
+
+    def text(len = 8)
+      n = (len + 1) / 2
+      d = self
+      a = []
+      n.times do
+        a << d.value
+        d = d.next_device
+      end
+      s = a.pack('n*').split("\x00").first
+      s ? s[0, len] : ''
+    end
+
+    def set_text(value, len = 8)
+      value = value[0, len]
+      value << "\00" unless value.length.even?
+      a = value.unpack('n*')
+      d = self
+      a.each do |v|
+        d.value = v
+        d = d.next_device
+      end
+    end
+
+    def text=(value)
+      set_text value
+    end
+
+    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].freeze
+    SUFFIXES_FOR_DEC_HEX  = %w[].freeze
+    SUFFIXES_FOR_HEX      = %w[X Y].freeze
+    SUFFIXES_FOR_BIT      = %w[X Y M C T L SC].freeze
+    SUFFIXES_FOR_INPUT    = %w[X].freeze
+
+    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
+end

data/lib/plc_access/protocol/protocol.rb

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+
+# 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 = __dir__
+$LOAD_PATH.unshift dir unless $LOAD_PATH.include? dir
+
+module PlcAccess
+  module Protocol
+    class Protocol
+      attr_accessor :host, :port
+
+      def initialize(options = {})
+        @logger = Logger.new($stdout)
+        self.log_level = options[:log_level] || :info
+      end
+
+      attr_reader :log_level
+
+      def log_level=(level)
+        @log_level = level.is_a?(String) ? level.to_sym : level
+        case @log_level
+        when :debug
+          @logger.level = Logger::DEBUG
+        when :error
+          @logger.level = Logger::ERROR
+        when :fatal
+          @logger.level = Logger::FATAL
+        when :info
+          @logger.level = Logger::INFO
+        when :unknown
+          @logger.level = Logger::UNKNOWN
+        when :warn
+          @logger.level = Logger::WARN
+        end
+      end
+
+      TIMEOUT = 1.0
+
+      # abstract methods
+
+      def open; end
+      def close; end
+
+      def get_bit_from_device(device)
+        get_bits_from_device(1, device_by_name(device)).first
+      end
+
+      def get_bits_from_device(count, device); end
+
+      def set_bit_to_device(bit, device)
+        set_bits_to_device [bit], device
+      end
+
+      def set_bits_to_device(bits, device); end
+
+      def get_word_from_device(device)
+        get_words_from_device(1, device_by_name(device)).first
+      end
+
+      def get_words_from_device(count, device); end
+
+      def set_word_to_device(word, device)
+        set_words_to_device [word], device
+      end
+
+      def set_words_to_device(words, device); end
+
+      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)
+        values = [values] unless values.is_a? Array
+        d = device_by_name device
+        if d.bit_device?
+          values = values.map { |v| case v; when 1 then true; when 0 then false; else; v; end }
+          set_bits_to_device values, d
+        else
+          set_words_to_device values, d
+        end
+      end
+
+      def available_bits_range(_device = nil)
+        -Float::INFINITY..Float::INFINITY
+      end
+
+      def available_words_range(_device = nil)
+        -Float::INFINITY..Float::INFINITY
+      end
+
+      def [](*args)
+        case args.size
+        when 1
+          # protocol["DM0"]
+          # protocol["DM0".."DM9"]
+          case args[0]
+          when String
+            self[args[0], 1].first
+          when Range
+            self[args[0].first, args[0].count]
+          else
+            raise ArgumentError, "#{args[0]} must be String or Range."
+          end
+        when 2
+          # protocol["DM0", 10]
+          d = device_by_name args[0]
+          c = args[1]
+          a = []
+          if d.bit_device?
+            b = available_bits_range(d).last
+            until c.zero?
+              n_c = [b, c].min
+              a += get_bits_from_device(n_c, d)
+              d += n_c
+              c -= n_c
+            end
+          else
+            b = available_words_range(d).last
+            until c.zero?
+              n_c = [b, c].min
+              a += get_words_from_device(n_c, d)
+              d += n_c
+              c -= n_c
+            end
+          end
+          a
+        else
+          raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 1 or 2)"
+        end
+      end
+
+      def []=(*args)
+        case args.size
+        when 2
+          # protocol["DM0"] = 0
+          # protocol["DM0".."DM9"] = [0, 1, .., 9]
+          v = args[1]
+          v = [v] unless v.is_a? Array
+          case args[0]
+          when String
+            self[args[0], 1] = v
+          when Range
+            self[args[0].first, args[0].count] = v
+          else
+            raise ArgumentError, "#{args[1]} must be String or Array."
+          end
+        when 3
+          # protocol["DM0", 10] = [0, 1, .., 9]
+          d = device_by_name args[0]
+          c = args[1]
+          values = args[2]
+          values = [values] unless values.is_a? Array
+          raise ArgumentError, "Count #{c} is not match #{args[2].size}." unless c == values.size
+
+          a = []
+          if d.bit_device?
+            values.each_slice(available_bits_range(d).last) do |sv|
+              set_bits_to_device(sv, d)
+              d += sv.size
+            end
+          else
+            values.each_slice(available_words_range(d).last) do |sv|
+              set_words_to_device(sv, d)
+              d += sv.size
+            end
+          end
+          a
+        else
+          raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 2 or 3)"
+        end
+      end
+
+      def destination_ipv4
+        Socket.gethostbyname(host)[3].unpack('C4').join('.')
+      end
+
+      def self_ipv4
+        Socket.getaddrinfo(Socket.gethostname, 'echo', Socket::AF_INET)[0][3]
+      end
+    end
+  end
+end
+
+require 'serialport'
+require 'plc_device'
+require 'keyence/keyence'
+require 'mitsubishi/mitsubishi'
+require 'omron/omron'

data/lib/plc_access/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PlcAccess
+  VERSION = '0.1.0'
+end

data/lib/plc_access.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# 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 = __dir__
+$LOAD_PATH.unshift dir unless $LOAD_PATH.include? dir
+
+require 'plc_access/protocol/protocol'
+require 'plc_access/version'

data/plc_access.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/plc_access/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'plc_access'
+  spec.version       = PlcAccess::VERSION
+  spec.authors       = ['Katsuyoshi Ito']
+  spec.email         = ['kito@itosoft.com']
+
+  spec.summary       = 'The PlcAccess communicates with PLCs.'
+  spec.description   = 'The PlcAccess communicates with PLCs. You can get values or states of PLC devices.'
+  spec.homepage      = 'https://github.com/ito-soft-design/plc_access'
+  spec.license       = 'MIT'
+
+  spec.add_runtime_dependency 'serialport', '~> 1.3', '>= 1.3.1'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ito-soft-design/plc_access'
+  spec.metadata['changelog_uri'] = 'https://github.com/ito-soft-design/plc_access/CHANGES.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end