plc_access 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f35c23c610072572e035350b54c7040e43a63a7fff03e6545975c479ee5a230
-  data.tar.gz: f9077c4ded62f71b8531102099a826bb93866a08d6035bd8e96626e986f867a7
+  metadata.gz: 508b6323047d55f073eb5d46d05919284b5d09c9c5cdf417df67a60642d1c097
+  data.tar.gz: '017940d773f256fec40e4fd0ac70a6efe491354401a20c9b23a99a47fe0b66c8'
 SHA512:
-  metadata.gz: 5934dfc5bf9a828ec264336a93bcd15289d7144032b6b054d3635c1dd218d718d442472673a2fc6b52c823786d16bea09771096d31a74bacaa18f53679276b67
-  data.tar.gz: 2eb98b439a85c974a27aaf619fff06b0303bbcdf66e24c4fc870d2e37af1c0b995f18a1a67936079710bdbdba41a0ece4188acb0a3b1daf294195c6fd6fc0aae
+  metadata.gz: f73eca7c987f0ae58e02ff3e0b4526fce468c75d19cf16f45f0d80cff5655b5b7b6536a020fc69be177ac47e900df18737aef637d63a55a128b2b02ee63e7da0
+  data.tar.gz: 8595aa8ca039870ec747a1646a36923ee8558f98099ebc593dae70c9df435402fd749019a6b539e0017e4ed0d4879b3196aa38f1c384f55fc668cf10a09380e7

data/CHANGES.md

@@ -0,0 +1,7 @@
+# CHANGES
+
+## 0.1.2
+
+- Be able to access the type value that you want to get.
+  - Use to_xxx for reading from the PLC.
+  - Use as_xxx for writing to the PLC.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plc_access (0.1.0)
+    plc_access (0.1.1)
       serialport (~> 1.3, >= 1.3.1)
 
 GEM
@@ -50,4 +50,4 @@ DEPENDENCIES
   test-unit-rr
 
 BUNDLED WITH
-   2.1.4
+   2.4.22

data/README.md

@@ -33,9 +33,9 @@ plc["M0"]         # => true
 plc["M0", 10]     # => [true, false, ..., false]
 
 plc["D0"] = 123
-plc["D0"]       # => 123
+plc["D0"]         # => 123
 plc["D0", 10] = [0, 1, 2, ..., 9]
-plc["D0".."D9"]   => [0, 1, 2, ..., 9]
+plc["D0".."D9"]   # => [0, 1, 2, ..., 9]
 ```
 
 Keyence PLCs:
@@ -50,9 +50,34 @@ plc["MR0"]         # => true
 plc["MR0", 10]     # => [true, false, ..., false]
 
 plc["DM0"] = 123
-plc["DM0"]       # => 123
+plc["DM0"]         # => 123
 plc["DM0", 10] = [0, 1, 2, ..., 9]
-plc["DM0".."DM9"]   => [0, 1, 2, ..., 9]
+plc["DM0".."DM9"]  # => [0, 1, 2, ..., 9]
+```
+
+### Types
+
+If you want to read or write the value as a specified type, use to_ushort, to_short, to_uint, to_int, and to_float for reading and as_ushort, as_short, as_uint, as_int, and as_float for writing.   
+And don't forget to put the line ```using PlcAccess::ActAsType``` before using it.
+
+```
+using PlcAccess::ActAsType
+
+# [0, 1, 2, 3, 4] is treated as five int elements.
+# #as_int converts int to two ushort elements. So it gets the total as ten ushort elements.
+
+plc["DM0", 10] = [0, 1, 2, 3, 4].as_int  # => [0, 0, 1, 0, 2, 0, 3, 0, 4, 0]
+
+# plc["MR0", 10] returns as ten ushort elements.
+# #to_int converts two ushort values to one int value. So it gets the total as five int elements.
+
+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()
+
 ```
 
 ## Contributing

data/lib/plc_access/act_as_type.rb

@@ -0,0 +1,70 @@
+module PlcAccess
+
+module ActAsType
+  refine Array do
+
+    def to_ushort
+      pack("S*").unpack("S*")
+    end
+
+    def to_short
+      pack("S*").unpack("s*")
+    end
+
+    def to_uint
+      pack("S*").unpack("L*")
+    end
+
+    def to_int
+      pack("S*").unpack("l*")
+    end
+
+    def to_float
+      pack("S*").unpack("f*")
+    end
+
+    def as_ushort
+      pack("S*").unpack("S*")
+    end
+
+    def as_short
+      pack("s*").unpack("S*")
+    end
+
+    def as_uint
+      pack("L*").unpack("S*")
+    end
+
+    def as_int
+      pack("l*").unpack("S*")
+    end
+
+    def as_float
+      pack("f*").unpack("S*")
+    end
+
+    def as_string length=nil, encoding=Encoding::UTF_8
+      s = pack("v*")
+      if length
+        s = s[0, length].delete("\000")
+      end
+      s.force_encoding(encoding).encode(Encoding::UTF_8)
+    end
+  
+  end
+
+  refine String do
+
+    def to_ushort length=nil, encoding=Encoding::UTF_8
+      a = self.encode(encoding).unpack("v*")
+      return a unless length
+      
+      s = (length + 1) / 2
+      a += [0] * [s - a.length, 0].max
+      a[0, s]
+    end
+  
+  end
+end
+
+end

data/lib/plc_access/version.rb

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

data/lib/plc_access.rb

@@ -28,3 +28,4 @@ $LOAD_PATH.unshift dir unless $LOAD_PATH.include? dir
 
 require 'plc_access/protocol/protocol'
 require 'plc_access/version'
+require 'plc_access/act_as_type'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plc_access
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Katsuyoshi Ito
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport
@@ -40,6 +40,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGES.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -49,6 +50,7 @@ files:
 - bin/console
 - bin/setup
 - lib/plc_access.rb
+- lib/plc_access/act_as_type.rb
 - lib/plc_access/protocol/keyence/keyence.rb
 - lib/plc_access/protocol/keyence/kv_device.rb
 - lib/plc_access/protocol/keyence/kv_protocol.rb
@@ -87,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: The PlcAccess communicates with PLCs.