plc_access 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f35c23c610072572e035350b54c7040e43a63a7fff03e6545975c479ee5a230
+  data.tar.gz: f9077c4ded62f71b8531102099a826bb93866a08d6035bd8e96626e986f867a7
+SHA512:
+  metadata.gz: 5934dfc5bf9a828ec264336a93bcd15289d7144032b6b054d3635c1dd218d718d442472673a2fc6b52c823786d16bea09771096d31a74bacaa18f53679276b67
+  data.tar.gz: 2eb98b439a85c974a27aaf619fff06b0303bbcdf66e24c4fc870d2e37af1c0b995f18a1a67936079710bdbdba41a0ece4188acb0a3b1daf294195c6fd6fc0aae

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kito@itosoft.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in plc_access.gemspec
+gemspec
+
+group :test do
+  gem 'test-unit'
+  gem 'test-unit-rr'
+end
+
+group :development do
+  gem 'rubocop', require: false
+end
+
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    plc_access (0.1.0)
+      serialport (~> 1.3, >= 1.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    power_assert (2.0.1)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rr (3.1.0)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    serialport (1.3.2)
+    test-unit (3.5.3)
+      power_assert
+    test-unit-rr (1.0.5)
+      rr (>= 1.1.1)
+      test-unit (>= 2.5.2)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  plc_access!
+  rake (~> 12.0)
+  rubocop
+  test-unit
+  test-unit-rr
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Katsuyoshi Ito
+
+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.

data/README.md

@@ -0,0 +1,69 @@
+# PlcAccess
+
+PlcAccess is library to make connection with PLCs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'plc_access'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install plc_access
+
+## Usage
+
+
+Mitsubishi MC Protocol:
+
+```
+require 'plc_access'
+
+plc = PlcAccess::Protocol::Mitsubishi::McProtocol.new host:"192.168.0.10"
+
+plc["M0"] = true
+plc["M0"]         # => true
+plc["M0", 10]     # => [true, false, ..., false]
+
+plc["D0"] = 123
+plc["D0"]       # => 123
+plc["D0", 10] = [0, 1, 2, ..., 9]
+plc["D0".."D9"]   => [0, 1, 2, ..., 9]
+```
+
+Keyence PLCs:
+
+```
+require 'plc_access'
+
+plc = PlcAccess::Protocol::Keyence::KvProtocol.new host:"192.168.0.10"
+
+plc["MR0"] = true
+plc["MR0"]         # => true
+plc["MR0", 10]     # => [true, false, ..., false]
+
+plc["DM0"] = 123
+plc["DM0"]       # => 123
+plc["DM0", 10] = [0, 1, 2, ..., 9]
+plc["DM0".."DM9"]   => [0, 1, 2, ..., 9]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ito-soft-design/plc_access. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ito-soft-design/plc_access/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PlcAccess project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ito-soft-design/plc_access/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: [:test]
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'plc_access'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/plc_access/protocol/keyence/keyence.rb

@@ -0,0 +1,33 @@
+# 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 'socket'
+require 'logger'
+require 'timeout'
+require 'kv_device'
+require 'kv_protocol'

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

@@ -0,0 +1,68 @@
+# 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
+  module Protocol
+    module Keyence
+      class KvDevice < PlcDevice
+        def initialize(a, b = nil)
+          super
+          @suffix = 'R' if @suffix.nil? || @suffix.length.zero?
+        end
+
+        def +(other)
+          self.class.new suffix, number + other
+        end
+
+        def -(other)
+          self.class.new suffix, [number - other, 0].max
+        end
+
+        private
+
+        SUFFIXES_FOR_DEC      = %w[DM EM FM ZF TM Z T TC TS C CC CS CTH CTC AT CM VM].freeze
+        SUFFIXES_FOR_DEC_HEX  = %w[R MR LR CR].freeze
+        SUFFIXES_FOR_HEX      = %w[B VB W].freeze
+        SUFFIXES_FOR_BIT      = %w[R B MR LR CR VB].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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,181 @@
+# 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
+  module Protocol
+    module Keyence
+      class KvProtocol < Protocol
+        def initialize(options = {})
+          super
+          @socket = nil
+          @host = options[:host] || '192.168.0.10'
+          @port = options[:port] || 8501
+        end
+
+        def open
+          open!
+        rescue StandardError
+          nil
+        end
+
+        def open!
+          @socket ||= TCPSocket.open(@host, @port)
+        end
+
+        def close
+          @socket&.close
+          @socket = nil
+        end
+
+        def get_bits_from_device(count, device)
+          c = (count + 15) / 16
+          words = get_words_from_device c, device
+          values = []
+          count.times do |i|
+            index = i / 16
+            bit = i % 16
+            values << ((words[index] & (1 << bit)) != 0)
+          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\n"
+            @logger.debug("> #{dump_packet packet}")
+            open
+            @socket.puts(packet)
+            res = receive
+            raise res unless /OK/i =~ res
+
+            device += 1
+          end
+        end
+        alias set_bit_to_device set_bits_to_device
+
+        def get_words_from_device(count, device)
+          packet = "RDS #{device.name}.H #{count}\r\n"
+          @logger.debug("> #{dump_packet packet}")
+          open
+          @socket.puts(packet)
+          res = receive
+          values = res.split(/\s+/).map { |v| v.to_i(16) }
+          @logger.debug("#{device.name}[#{count}] => #{values}")
+          values
+        end
+
+        def set_words_to_device(words, device)
+          words = [words] unless words.is_a? Array
+          packet = "WRS #{device.name}.H #{words.size} #{words.map { |w| w.to_s(16) }.join(' ')}\r\n"
+          @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(TIMEOUT) 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
+
+        def available_bits_range(suffix = nil)
+          case suffix
+          when 'TM'
+            1..512
+          when 'Z'
+            1..12
+          when 'T', 'TC', 'TS', 'C', 'CC', 'CS'
+            1..120
+          when 'CTH'
+            1..2
+          when 'CTC'
+            1..4
+          when 'AT'
+            1..8
+          else
+            1..1000
+          end
+        end
+
+        def available_words_range(suffix = nil)
+          case suffix
+          when 'TM'
+            1..256
+          when 'Z'
+            1..12
+          when 'T', 'TC', 'TS', 'C', 'CC', 'CS'
+            1..120
+          when 'CTH'
+            1..2
+          when 'CTC'
+            1..4
+          when 'AT'
+            1..8
+          else
+            1..500
+          end
+        end
+
+        private
+
+        def device_class
+          KvDevice
+        end
+      end
+    end
+  end
+end

data/lib/plc_access/protocol/mitsubishi/fx_device.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PlcAccess
+  module Protocol
+    module Mitsubishi
+      class FxDevice < QDevice
+        def name
+          @suffix + @number.to_s.rjust(4, '0')
+        end
+      end
+    end
+  end
+end