plc_access 0.1.0

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

@@ -0,0 +1,218 @@
+# 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.
+
+module PlcAccess
+  module Protocol
+    module Omron
+      class CModeProtocol < Protocol
+        attr_accessor :baudrate, :unit_no
+
+        DELIMITER = "\r"
+        TERMINATOR = "*\r"
+        TIMEOUT = 1.0
+
+        def initialize(options = {})
+          super
+          @port = options[:port] || `ls /dev/tty.usb*`.split("\n").map(&:chomp).first
+          @baudrate = 38_400
+          @unit_no = 0
+          @comm = nil
+        end
+
+        def open
+          open!
+        rescue StandardError
+          nil
+        end
+
+        def open!
+          return false unless @port
+
+          begin
+            # port, baudrate, bits, stop bits, parity(0:none, 1:even, 2:odd)
+            @comm ||= SerialPort.new(@port, @baudrate, 7, 2, 1).tap do |s|
+              s.read_timeout = (TIMEOUT * 1000.0).to_i
+            end
+          rescue StandardError => e
+            p e
+            nil
+          end
+        end
+
+        def close
+          @comm&.close
+          @comm = nil
+        end
+
+        def unit_no=(no)
+          @unit_no = [[no, 0].max, 31].min
+        end
+
+        def get_bits_from_device(count, device)
+          device = device_by_name device
+
+          # convert to the channel device
+          from = device.channel_device
+          to = (device + count).channel_device
+          c = [to - from, 1].max
+
+          # get value as words
+          words = get_words_from_device(c, device)
+
+          # convert to bit devices
+          index = device.bit
+          bits = []
+          count.times do
+            i = index / 16
+            b = index % 16
+            f = 1 << b
+            bits << ((words[i] & f) == f)
+            index += 1
+          end
+          bits
+        end
+
+        def get_words_from_device(count, device)
+          device = device_by_name(device).channel_device
+
+          # make read packet
+          packet = read_packet_with device
+          packet << "#{device.channel.to_s.rjust(4, '0')}#{count.to_s.rjust(4, '0')}"
+          packet << fcs_for(packet).to_s(16).upcase.rjust(2, '0')
+          packet << TERMINATOR
+          @logger.debug("> #{dump_packet packet}")
+
+          # send command
+          open
+          send packet
+
+          # receive response
+          words = []
+          terminated = false
+          loop do
+            res = receive
+            data = ''
+            if res
+              ec = error_code(res)
+              raise "Error response: #{ec.to_i(16).rjust(2, '0')}" unless ec.zero?
+
+              if res[-2, 2] == TERMINATOR
+                fcs = fcs_for(res[0..-5])
+                raise "Not matched FCS expected #{fcs.to_s(16).rjust(2, '0')}" unless fcs == res[-4, 2].to_i(16)
+
+                data = res[7..-5]
+                terminated = true
+              elsif res[-1, 1] == DELIMITER
+                fcs = fcs_for(res[0..-4])
+                raise "Not matched FCS expected #{fcs.to_s(16).rjust(2, '0')}" unless fcs == res[-3, 2].to_i(16)
+
+                data = res[7..-4]
+              end
+              len = data.length
+              index = 0
+              while index < len
+                words << data[index, 4].to_i(16)
+                index += 4
+              end
+              return words if terminated
+            else
+              break
+            end
+          end
+          []
+        end
+
+        private
+
+        def device_by_name(name)
+          case name
+          when String
+            d = OmronDevice.new name
+            d.valid? ? d : nil
+          else
+            # it may be already OmronDevice
+            name
+          end
+        end
+
+        def send(packet)
+          @comm.write(packet)
+          @comm.flush
+        end
+
+        def receive
+          res = ''
+          begin
+            Timeout.timeout(TIMEOUT) do
+              res = @comm.gets DELIMITER
+              #           loop do
+              #             res << @comm.getc# '\r' #gets
+              #             break if res[-1] == '\r'
+              #           end
+            end
+          #        res
+          rescue Timeout::Error
+            puts "*** ERROR: TIME OUT : #{res} ***"
+          end
+          @logger.debug("< #{dump_packet res}")
+          res
+        end
+
+        def read_packet_with(device)
+          packet = "@#{unit_no.to_s.rjust(2, '0')}R"
+          packet << case device.suffix
+                    when 'HR'
+                      'H'
+                    when 'AL'
+                      'L'
+                    when 'DM', 'D'
+                      'D'
+                    when 'AR'
+                      'J'
+                    when 'EM', 'E'
+                      'E'
+                    else
+                      'R'
+                    end
+        end
+
+        def fcs_for(packet)
+          fcs = packet.bytes.inject(0) do |a, b|
+            a ^ b
+          end
+          fcs & 0xff
+        end
+
+        def error_code(packet)
+          packet[1 + 2 + 2, 2].to_i(16)
+        end
+
+        def dump_packet(packet)
+          packet.inspect
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,353 @@
+# 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.
+
+module PlcAccess
+  module Protocol
+    module Omron
+      class FinsTcpProtocol < Protocol
+        attr_accessor :gateway_count, :destination_network, :destination_node, :destination_unit, :source_network,
+                      :source_node, :source_unit, :ethernet_module, :tcp_error_code
+
+        IOFINS_DESTINATION_NODE_FROM_IP = 0
+        IOFINS_SOURCE_AUTO_NODE         = 0
+
+        # Available ethernet module.
+        ETHERNET_ETN21  = 0
+        ETHERNET_CP1E   = 1
+        ETHERNET_CP1L   = 2
+        ETHERNET_CP1H   = 3
+
+        TIMEOUT = 5.0
+
+        def initialize(options = {})
+          super
+          @socket = nil
+          @host = options[:host] || '192.168.250.1'
+          @port = options[:port] || 9600
+          @gateway_count = 3
+          @destination_network = 0
+          @destination_node = 0
+          @destination_unit = 0
+          @source_network = 0
+          @source_node = IOFINS_SOURCE_AUTO_NODE
+          @source_unit = 0
+          @ethernet_module = ETHERNET_ETN21
+
+          @tcp_error_code = 0
+        end
+
+        def open
+          open!
+        rescue StandardError => e
+          p e
+          nil
+        end
+
+        def open!
+          if @socket.nil?
+            @socket = TCPSocket.open(@host, @port)
+            if @socket
+              self.source_node = IOFINS_SOURCE_AUTO_NODE
+              query_node
+            end
+          end
+          @socket
+        end
+
+        def close
+          @socket&.close
+          @socket = nil
+        end
+
+        def tcp_error?
+          tcp_error_code != 0
+        end
+
+        def create_query_node
+          header = ['FINS'.bytes.to_a, 0, 0, 0, 0xc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0].flatten
+          header[19] = source_node == IOFINS_SOURCE_AUTO_NODE ? 0 : source_node
+          header
+        end
+
+        def create_fins_frame(packet)
+          packet = packet.flatten
+          header = ['FINS'.bytes.to_a, 0, 0, 0, 0, 0, 0, 0, 2, 0, 0, 0, 0].flatten
+          header[4, 4] = int_to_a(packet.length + 8, 4)
+          header + packet
+        end
+
+        def get_bits_from_device(count, device)
+          open
+          unless available_bits_range.include? count
+            raise ArgumentError,
+                  "A count #{count} must be between #{available_bits_range.first} and #{available_bits_range.last} for #{__method__}"
+          end
+
+          device = device_by_name device
+          raise ArgumentError, "#{device.name} is not bit device!" unless device.bit_device?
+
+          command = [1, 1]
+          command << device_to_a(device)
+          command << int_to_a(count, 2)
+
+          send_packet create_fins_frame(fins_header + command)
+          res = receive
+
+          count.times.each_with_object([]) do |i, a|
+            a << (res[16 + 10 + 4 + i] != 0)
+          end
+        end
+
+        def get_words_from_device(count, device)
+          open
+          unless available_words_range.include? count
+            raise ArgumentError,
+                  "A count #{count} must be between #{available_words_range.first} and #{available_words_range.last} for #{__method__}"
+          end
+
+          device = device_by_name device
+          device = device.channel_device
+
+          command = [1, 1]
+          command << device_to_a(device)
+          command << int_to_a(count, 2)
+
+          send_packet create_fins_frame(fins_header + command)
+          res = receive
+          count.times.each_with_object([]) do |i, a|
+            a << to_int(res[16 + 10 + 4 + i * 2, 2])
+          end
+        end
+
+        def set_bits_to_device(bits, device)
+          open
+          count = bits.size
+          unless available_bits_range.include? count
+            raise ArgumentError,
+                  "A count #{count} must be between #{available_bits_range.first} and #{available_bits_range.last} for #{__method__}"
+          end
+
+          device = device_by_name device
+          raise ArgumentError, "#{device.name} is not bit device!" unless device.bit_device?
+
+          command = [1, 2]
+          command << device_to_a(device)
+          command << int_to_a(count, 2)
+          bits.each do |b|
+            command << (b ? 1 : 0)
+          end
+
+          send_packet create_fins_frame(fins_header + command)
+          receive
+        end
+
+        def set_words_to_device(words, device)
+          open
+          count = words.size
+          unless available_words_range.include? count
+            raise ArgumentError,
+                  "A count #{count} must be between #{available_words_range.first} and #{available_words_range.last} for #{__method__}"
+          end
+
+          device = device_by_name device
+          device = device.channel_device
+
+          command = [1, 2]
+          command << device_to_a(device)
+          command << int_to_a(count, 2)
+          words.each do |w|
+            command << int_to_a(w, 2)
+          end
+
+          send_packet create_fins_frame(fins_header + command)
+          receive
+        end
+
+        def query_node
+          send_packet create_query_node
+          res = receive
+          self.source_node = res[19]
+        end
+
+        def send_packet(packet)
+          @socket.write(packet.flatten.pack('c*'))
+          @socket.flush
+          @logger.debug("> #{dump_packet packet}")
+        end
+
+        def receive
+          res = []
+          len = 0
+          begin
+            Timeout.timeout(TIMEOUT) do
+              loop do
+                c = @socket.getc
+                next if c.nil? || c == ''
+
+                res << c.bytes.first
+                next if res.length < 8
+
+                len = to_int(res[4, 4])
+                next if res.length < 8 + len
+
+                tcp_command = to_int(res[8, 4])
+                case tcp_command
+                when 3 # ERROR
+                  raise "Invalidate tcp header: #{res}"
+                end
+                break
+              end
+            end
+            raise "Response error code: #{res[15]}" unless (res[15]).zero?
+
+            res
+          end
+          @logger.debug("< #{dump_packet res}")
+          res
+        end
+
+        # max length:
+        #  CS1W-ETN21, CJ1W-ETN21   : 2012
+        #  CP1W-CIF41 option board  : 540 (1004 if cpu is CP1L/H)
+
+        def available_bits_range(_device = nil)
+          case ethernet_module
+          when ETHERNET_ETN21
+            1..(2012 - 8)
+          when ETHERNET_CP1E
+            1..(540 - 8)
+          when ETHERNET_CP1L, ETHERNET_CP1H
+            1..(1004 - 8)
+          else
+            0..0
+          end
+        end
+
+        def available_words_range(_device = nil)
+          case ethernet_module
+          when ETHERNET_ETN21
+            1..((2012 - 8) / 2)
+          when ETHERNET_CP1E
+            1..((540 - 8) / 2)
+          when ETHERNET_CP1L, ETHERNET_CP1H
+            1..((1004 - 8) / 2)
+          else
+            0..0
+          end
+        end
+
+        def device_by_name(name)
+          case name
+          when String
+            d = OmronDevice.new name
+            d.valid? ? d : nil
+          else
+            # it may be already OmronDevice
+            name
+          end
+        end
+
+        private
+
+        def fins_header
+          buf = [
+            0x80, # ICF
+            0x00, # RSV
+            0x02, # GCT
+            0x00, # DNA
+            0x01, # DA1
+            0x00, # DA2
+            0x00, # SNA
+            0x01, # SA1
+            0x00, # SA2
+            0x00 # SID
+          ]
+          buf[2] = gateway_count - 1
+          buf[3] = destination_network
+          buf[4] = if destination_node == IOFINS_DESTINATION_NODE_FROM_IP
+                     destination_ipv4.split('.').last.to_i
+                   else
+                     destination_node
+                   end
+          buf[7] = source_node
+          buf[8] = source_unit
+
+          buf
+        end
+
+        def fins_tcp_cmnd_header
+          header = ['FINS'.bytes.to_a, 0, 0, 0, 0xc, 0, 0, 0, 2, 0, 0, 0, 0].flatten
+          header[19] = source_node == IOFINS_SOURCE_AUTO_NODE ? 0 : source_node
+          header
+        end
+
+        def device_code_of(device)
+          @@bit_codes ||= { nil => 0x30, '' => 0x30, 'W' => 0x31, 'H' => 0x32, 'A' => 0x33, 'T' => 0x09, 'C' => 0x09,
+                            'D' => 0x02, 'E' => 0x0a, 'TK' => 0x06 }
+          @@word_codes ||= { nil => 0xB0, '' => 0xB0, 'W' => 0xB1, 'H' => 0xB2, 'A' => 0xB3, 'TIM' => 0x89, 'CNT' => 0x89,
+                             'D' => 0x82, 'E' => 0x98, 'DR' => 0xbc }
+          if device.bit_device?
+            @@bit_codes[device.suffix]
+          else
+            @@word_codes[device.suffix]
+          end
+        end
+
+        def device_to_a(device)
+          a = []
+          a << device_code_of(device)
+          a << int_to_a(device.channel, 2)
+          a << (device.bit_device? ? (device.bit || 0) : 0)
+          a.flatten
+        end
+
+        def int_to_a(value, size)
+          a = []
+          (size - 1).downto 0 do |i|
+            a << ((value >> (i * 8)) & 0xff)
+          end
+          a
+        end
+
+        def to_int(a)
+          v = 0
+          a.each do |e|
+            v <<= 8
+            v += e
+          end
+          v
+        end
+
+        def dump_packet(packet)
+          a =
+            packet.map do |e|
+              e.to_s(16).rjust(2, '0')
+            end
+          "[#{a.join(', ')}]"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# 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.
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'omron_device'
+require 'c_mode_protocol'
+require 'fins_tcp_protocol'