modbus 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5559848be6158b9fdf9c0d2a8d030b08769f181510cfba3a59f90a7a8af9e723
-  data.tar.gz: aade6afbf693c033ccb3bd4b021592d0dc09ceff7247ce4a9f66de3491e0bba2
+  metadata.gz: c71dd92fc7f440348037b3078fc7c107abe9c2dca3bea369ab23564c50127e0f
+  data.tar.gz: 9fd3040057c57989d602561d0b4f089ed8153a3fdb21aba14dc01fee36565603
 SHA512:
-  metadata.gz: 5b2ff3ee1a9dfcc6ce804879ec11158db23c1581ce4e9134d439fbc1035e7d8b150cd65a291d91dac3a6a2e150459768dcf83a10967f6469eb0c07a3fd55c11a
-  data.tar.gz: f2409419ec8923a69dccc82e6d340138e320126befa6f7f9add418419a24aa376ce1147f0b33d4f8f3e7451e905b9ea226b1a21f655628b1c0d8703f97510d5b
+  metadata.gz: 30fa15861003cbff24a03d1c4cb3f4e02e283c0c8fbb6635aacf4914f20d9f0eb007ee5b50aa93bb3891e45f129f23916a7450a0df1eaff9c8f8a3a4559e0e92
+  data.tar.gz: fa2138873ca114f9cdf37b94862c9edc1b83d0ce1c4f71363358e0a03a8644fb7df9682686f86d271f6123da5dc38074b22f397ca698b879569e829aa268a234

data/README.md

@@ -34,11 +34,20 @@ modbus.read(byte_string) do |adu|
 
     # Response PDU returned
     if adu.exception?
+        # Get error message
+        puts adu.value
+        # Error code
         puts adu.pdu.exception_code
     else
-        case adu.function_code
-        when 0x01
-            puts adu.pdu.read.data.bytes
+        case adu.function_name
+        when :read_coils
+            # raw response data
+            puts adu.pdu.get.data.bytes
+            # or values
+            puts adu.value # => [true, false, true, false, false, false, false, false]
+        when :read_input_registers
+            # Grab the 16 bit values
+            puts adu.value # => [1234, 8822]
         end
     end
 end

data/lib/modbus.rb

@@ -47,8 +47,13 @@ class Modbus
     # Decodes an ADU from wire format and sets the attributes of this object.
     #
     # @param data [String] The bytes to decode.
-    def read(data)
+    def read(data, serial: false)
         @buffer ||= String.new
+        # add mock TCP header
+        if serial
+            @buffer << "\x0\x0\x0\x0\x0"
+            @buffer << (data.bytesize - 2)
+        end
         @buffer << data
 
         error = nil

data/lib/modbus/adu.rb

@@ -1,6 +1,8 @@
 # encoding: ASCII-8BIT
 # frozen_string_literal: true
 
+require 'crc'
+
 class Modbus
     # TCP ADU are sent via TCP to registered port 502
     Modbus::ADU = Struct.new :header, :function_code, :pdu do
@@ -8,10 +10,17 @@ class Modbus
             pdu.is_a?(ExceptionPDU)
         end
 
-        def to_binary_s
+        def to_binary_s(serial: false)
             data = pdu.to_binary_s
             header.request_length = data.bytesize
-            "#{header.to_binary_s}#{data}"
+            if serial
+                # For serial line communication - no header
+                crc = ::CRC::CRC16_MODBUS.new
+                crc.update data
+                "#{data}#{crc.digest}"
+            else
+                "#{header.to_binary_s}#{data}"
+            end
         end
 
         def function_name

data/modbus.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
     s.name        = "modbus"
-    s.version     = '1.0.0'
+    s.version     = '1.0.1'
     s.authors     = ["Stephen von Takach"]
     s.email       = ["steve@aca.im"]
     s.licenses    = ["MIT"]
@@ -12,13 +12,12 @@ Gem::Specification.new do |s|
         Constructs Modbus standard datagrams that make it easy to communicate with devices on Modbus networks
     EOF
 
-
     s.add_dependency 'bindata', '~> 2.3'
+    s.add_dependency 'crc', '~> 0.4'
 
     s.add_development_dependency 'rspec', '~> 3.5'
     s.add_development_dependency 'rake',  '~> 12'
 
-
     s.files = Dir["{lib}/**/*"] + %w(modbus.gemspec README.md)
     s.test_files = Dir["spec/**/*"]
     s.extra_rdoc_files = ["README.md"]

data/spec/modbus_spec.rb

@@ -70,4 +70,15 @@ describe 'modbus protocol helper' do
         expect(@response.value).to eq([3, 256])
         expect(@response.function_name).to eq(:read_holding_registers)
     end
+
+    it "should generate a serial line request" do
+        data = @modbus.read_inputs(0).to_binary_s serial: true
+        expect(data).to eq("\xFF\x02\x00\x00\x00\x01\x14\xAC")
+    end
+
+    it "should parse a serial line response" do
+        serial_data = "\x1\x2\x3\xac\xdb\x35\x88\x22"
+        @modbus.read(serial_data, serial: true) { |adu| @response = adu }
+        expect(@response.to_binary_s serial: true).to eq(serial_data)
+    end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modbus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Stephen von Takach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-17 00:00:00.000000000 Z
+date: 2018-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: crc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement