plc_access 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f4f7913359b4f1b4f637c20481709661b056a264b76280ffe8a0948d2bbe1a3
-  data.tar.gz: b126188a9c855a3f2dd9a368edc32d022daf5b03274d0f4201aa34ee3dbff5ee
+  metadata.gz: c7944febc355a406f20d64952237fb1cb58d718c079d9b1743535ce495d5a153
+  data.tar.gz: d76735035b4e7749ef4beb234b5cad4392090fe892ae6321a3ae24e14a54cc25
 SHA512:
-  metadata.gz: dbca94f874f0a4792036f4bb99d46ff71f1d0360666c81bcef68b80fa9fad7cf3c272e2d5fa7d624409c80167715f928e5c53c95db8bdbf1f5f94c297a33ba62
-  data.tar.gz: 117d893285cc51e0de947495ac02b5e3348b6bf818ad1d7d20c1a77ad935fd56472d747922ebd3f9836331ff2d10d540e7aa7877374136689637515e4c7d024d
+  metadata.gz: a8a256b8f7e4cf5d3a7e1cbf6d7d21168ceaccb0927279c1427f293bb603622b648ae1d660649262d10204f8146f926d9f7ec6cf8ec38a2ae6089c475b0f4d39
+  data.tar.gz: 7d5e7fc1ca634bb9397f4f752b91efa4eecdc3535db7915e01f3e3a0f9b06b57ec250f8d69c4eafba5afbc313d30d17b2f1db629eaef66b15348dbf3da9ea6fa

data/CHANGES.md

@@ -1,5 +1,12 @@
 # CHANGES
 
+## 0.2.1
+
+- Add byte order support for string/ushort conversion per PLC type (Mitsubishi: little-endian, Keyence/Omron: big-endian)
+- Accept plc object in as_ushort/to_string to auto-detect byte order
+- Allow Protocol#[]= to pad with zeros or truncate when array size differs from count
+- Allow Protocol#[]= to accept arrays without specifying count
+
 ## 0.1.3
 
 - Rename Array#as_string to Array#to_string

data/Gemfile.lock

@@ -1,43 +1,49 @@
 PATH
   remote: .
   specs:
-    plc_access (0.1.1)
+    plc_access (0.2.1)
       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)
+    json (2.18.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    parallel (1.26.3)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
-    power_assert (2.0.1)
+      racc
+    power_assert (2.0.5)
+    racc (1.8.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)
+    regexp_parser (2.10.0)
+    rr (3.1.1)
+    rubocop (1.72.2)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.3.0.2)
       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)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 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)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
     serialport (1.3.2)
-    test-unit (3.5.3)
+    test-unit (3.6.7)
       power_assert
     test-unit-rr (1.0.5)
       rr (>= 1.1.1)
       test-unit (>= 2.5.2)
-    unicode-display_width (2.3.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
   ruby

data/README.md

@@ -73,13 +73,88 @@ plc["DM0", 10] = [0, 1, 2, 3, 4].as_int  # => [0, 0, 1, 0, 2, 0, 3, 0, 4, 0]
 
 plc["MR0", 10].to_int # => [0, 1, 2, 3, 4]
 
-# Set string to data memory (ten wors from DM0) as ushort values.
-plc["DM0", 10] = "PLC Access".as_ushort()
-# Get string from data memory (ten wors from DM0).
-plc["DM0", 10].to_string()
+# Set string to data memory (ten words from DM0) as ushort values.
+# The byte order for string conversion differs by PLC type
+# (e.g., Mitsubishi uses little-endian, Keyence/Omron use big-endian).
+# Pass plc to automatically use the correct byte order.
+plc["DM0", 10] = "PLC Access".as_ushort(plc)
+# Get string from data memory (ten words from DM0).
+plc["DM0", 10].to_string(plc)
+
+# You can also specify the length and plc together.
+plc["DM0", 5] = "PLC Access".as_ushort(10, plc)
+plc["DM0", 5].to_string(10, plc)
 
 ```
 
+## Supported PLCs
+
+### Keyence
+
+It supports Keyence PLCs with an Ethernet connection.
+
+```
+plc = PlcAccess::Protocol::Keyence::KvProtocol.new host: '192.168.0.10', port: 8501
+```
+
+### Mitsubishi
+
+It supports Mitsubishi PLCs with an Ethernet connection.
+
+```
+plc = PlcAccess::Protocol::Mitsubishi::McProtocol.new host: '192.168.0.10', port: 5010
+```
+
+It supports Mitsubishi Fx PLCs with a Serial connection.
+
+```
+plc = PlcAccess::Protocol::Mitsubishi::FxProtocol.new port: /dev/tty.usbxxxxx'
+```
+
+PLC configuration:
+- baudrate: 19200
+- bit: 7
+- parity: Odd
+- stop bit: 1
+
+![](images/fx_comm_setting.png)
+
+### Omron
+
+It supports Omron PLCs with an Ethernet connection.
+
+```
+plc = PlcAccess::Protocol::Omron::FinsTcpProtocol.new host: '192.168.0.10', port: 9600
+```
+
+It supports Omron PLCs with a C Mode serial connection.
+
+```
+plc = PlcAccess::Protocol::Omron::CModeProtocol.new port: /dev/tty.usbxxxxx'
+```
+
+### Plc Share
+
+Plc Share is a protocol conversion application. It runs on Windows and connects to various PLCs using a serial or Ethernet connection. You can then connect with the Plc Share Protocol, which extends Keyence’s protocol. You can specify a target PLC’s device.
+
+[Plc Share](http://iphone.itosoft.com/plcshare)
+
+![](images/plc_share.png)
+
+```
+plc = PlcAccess::Protocol::PlcShare::PlcShareProtocol.new host: '192.168.0.10', port: 10000, device_type: :fx
+```
+
+You can choose a target PLC by using the device type option.
+
+|device_type|Target PLCs|
+|:-:|:--|
+|:kv|Keyence PLCs|
+|:fx|Mitsubishi Fx PLCs|
+|:q|Mitsubishi Q/L/R PLCs|
+|:omron|Omron PLCs|
+
+
 ## 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).

data/lib/plc_access/act_as_type.rb

@@ -43,8 +43,17 @@ module ActAsType
       pack("f*").unpack("S*")
     end
 
-    def to_string length=nil, encoding=Encoding::UTF_8
-      s = pack("v*")
+    def to_string length=nil, encoding=Encoding::UTF_8, endian: :little
+      if length.respond_to?(:string_endian)
+        endian = length.string_endian
+        length = nil
+      end
+      if encoding.respond_to?(:string_endian)
+        endian = encoding.string_endian
+        encoding = Encoding::UTF_8
+      end
+      format = endian == :big ? "n*" : "v*"
+      s = pack(format)
       if length
         s = s[0, length].delete("\000")
       end
@@ -55,10 +64,19 @@ module ActAsType
 
   refine String do
 
-    def as_ushort length=nil, encoding=Encoding::UTF_8
-      a = self.encode(encoding).unpack("v*")
+    def as_ushort length=nil, encoding=Encoding::UTF_8, endian: :little
+      if length.respond_to?(:string_endian)
+        endian = length.string_endian
+        length = nil
+      end
+      if encoding.respond_to?(:string_endian)
+        endian = encoding.string_endian
+        encoding = Encoding::UTF_8
+      end
+      format = endian == :big ? "n*" : "v*"
+      a = self.encode(encoding).unpack(format)
       return a unless length
-      
+
       s = (length + 1) / 2
       a += [0] * [s - a.length, 0].max
       a[0, s]

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

@@ -170,6 +170,10 @@ module PlcAccess
           raise "ERROR: return #{res} for set_bits_to_device(#{words}, #{device.name})" unless res == ack_packet
         end
 
+        def string_endian
+          :little
+        end
+
         def device_by_name(name)
           case name
           when String

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

@@ -160,6 +160,10 @@ module PlcAccess
           end
         end
 
+        def string_endian
+          :little
+        end
+
         def device_by_name(name)
           case name
           when String

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

@@ -107,6 +107,10 @@ module PlcAccess
         def -(other)
           self.class.new suffix, [number - other, 0].max
         end
+
+        def string_endian
+          :little
+        end
       end
     end
   end

data/lib/plc_access/protocol/plc_device.rb

@@ -147,6 +147,10 @@ module PlcAccess
     alias word value
     alias word= value=
 
+    def string_endian
+      :big
+    end
+
     def text(len = 8)
       n = (len + 1) / 2
       d = self
@@ -155,14 +159,16 @@ module PlcAccess
         a << d.value
         d = d.next_device
       end
-      s = a.pack('n*').split("\x00").first
+      format = string_endian == :big ? 'n*' : 'v*'
+      s = a.pack(format).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*')
+      format = string_endian == :big ? 'n*' : 'v*'
+      a = value.unpack(format)
       d = self
       a.each do |v|
         d.value = v

data/lib/plc_access/protocol/plc_share/plc_share.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2025 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 'plc_share_protocol'

data/lib/plc_access/protocol/plc_share/plc_share_protocol.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2025 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 PlcShare
+      class PlcShareProtocol < PlcAccess::Protocol::Keyence::KvProtocol
+        attr_accessor :device_type
+
+        def initialize(options = {})
+          super
+          @socket = nil
+          @host = options[:host] || '192.168.0.10'
+          @port = options[:port] || 10000
+          self.device_type = options[:device_type] if options[:device_type]
+        end
+
+        # Device type
+        #   :kv  Keyence device
+        #   :fx  Mitsubishi Fx device
+        #   :q   Mitsubishi Q/L device
+        #   :omron   Omron device
+        def device_type= type
+          @device_type = type
+        end
+
+        def string_endian
+          case @device_type
+          when :fx, :q
+            :little
+          else
+            :big
+          end
+        end
+
+        private
+
+        def device_class
+          case @device_type
+          when :kv
+            PlcAccess::Protocol::Keyence::KvDevice
+          when :fx
+            PlcAccess::Protocol::Mitsubishi::FxDevice
+          when :q
+            PlcAccess::Protocol::Mitsubishi::QDevice
+          when :omron
+            PlcAccess::Protocol::Omron::OmronDevice
+          else
+            PlcAccess::Protocol::Keyence::KvDevice
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/plc_access/protocol/protocol.rb

@@ -58,6 +58,10 @@ module PlcAccess
 
       TIMEOUT = 1.0
 
+      def string_endian
+        :big
+      end
+
       # abstract methods
 
       def open; end
@@ -169,7 +173,7 @@ module PlcAccess
           v = [v] unless v.is_a? Array
           case args[0]
           when String
-            self[args[0], 1] = v
+            self[args[0], v.size] = v
           when Range
             self[args[0].first, args[0].count] = v
           else
@@ -181,7 +185,8 @@ module PlcAccess
           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
+          values += [0] * (c - values.size) if values.size < c
+          values = values[0, c] if values.size > c
 
           a = []
           if d.bit_device?
@@ -217,3 +222,4 @@ require 'plc_device'
 require 'keyence/keyence'
 require 'mitsubishi/mitsubishi'
 require 'omron/omron'
+require 'plc_share/plc_share'

data/lib/plc_access/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: plc_access
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Katsuyoshi Ito
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2026-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport
@@ -49,6 +48,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- images/fx_comm_setting.png
+- images/plc_share.png
 - lib/plc_access.rb
 - lib/plc_access/act_as_type.rb
 - lib/plc_access/protocol/keyence/keyence.rb
@@ -64,6 +65,8 @@ files:
 - lib/plc_access/protocol/omron/omron.rb
 - lib/plc_access/protocol/omron/omron_device.rb
 - lib/plc_access/protocol/plc_device.rb
+- lib/plc_access/protocol/plc_share/plc_share.rb
+- lib/plc_access/protocol/plc_share/plc_share_protocol.rb
 - lib/plc_access/protocol/protocol.rb
 - lib/plc_access/version.rb
 - plc_access.gemspec
@@ -74,7 +77,6 @@ metadata:
   homepage_uri: https://github.com/ito-soft-design/plc_access
   source_code_uri: https://github.com/ito-soft-design/plc_access
   changelog_uri: https://github.com/ito-soft-design/plc_access/CHANGES.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: The PlcAccess communicates with PLCs.
 test_files: []