em-modbus 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d698b9a978473182107d24aee82f67a655619f0
+  data.tar.gz: 3a856759e8c7d4a9ff17ce5f3f7c6381f62b1653
+SHA512:
+  metadata.gz: b5dd2bba20667ce8145254c09c80d71e39602110712d51d0ca83d767c14432017f1ec8152e614d8849f54f6f77b0725a15936305b734f8357d0f5957db443748
+  data.tar.gz: 19773595273e11515d951600974779b8a21a9c3e3349622fa405a582881e232a743694e9ff06eb082a5c1367cf904f60700b14f1106e6fe7780a9d4e82b349d8

data/LICENSE.txt

@@ -1,373 +1,7 @@
-Mozilla Public License Version 2.0
-==================================
-
-1. Definitions
---------------
-
-1.1. "Contributor"
-    means each individual or legal entity that creates, contributes to
-    the creation of, or owns Covered Software.
-
-1.2. "Contributor Version"
-    means the combination of the Contributions of others (if any) used
-    by a Contributor and that particular Contributor's Contribution.
-
-1.3. "Contribution"
-    means Covered Software of a particular Contributor.
-
-1.4. "Covered Software"
-    means Source Code Form to which the initial Contributor has attached
-    the notice in Exhibit A, the Executable Form of such Source Code
-    Form, and Modifications of such Source Code Form, in each case
-    including portions thereof.
-
-1.5. "Incompatible With Secondary Licenses"
-    means
-
-    (a) that the initial Contributor has attached the notice described
-        in Exhibit B to the Covered Software; or
-
-    (b) that the Covered Software was made available under the terms of
-        version 1.1 or earlier of the License, but not also under the
-        terms of a Secondary License.
-
-1.6. "Executable Form"
-    means any form of the work other than Source Code Form.
-
-1.7. "Larger Work"
-    means a work that combines Covered Software with other material, in
-    a separate file or files, that is not Covered Software.
-
-1.8. "License"
-    means this document.
-
-1.9. "Licensable"
-    means having the right to grant, to the maximum extent possible,
-    whether at the time of the initial grant or subsequently, any and
-    all of the rights conveyed by this License.
-
-1.10. "Modifications"
-    means any of the following:
-
-    (a) any file in Source Code Form that results from an addition to,
-        deletion from, or modification of the contents of Covered
-        Software; or
-
-    (b) any new file in Source Code Form that contains any Covered
-        Software.
-
-1.11. "Patent Claims" of a Contributor
-    means any patent claim(s), including without limitation, method,
-    process, and apparatus claims, in any patent Licensable by such
-    Contributor that would be infringed, but for the grant of the
-    License, by the making, using, selling, offering for sale, having
-    made, import, or transfer of either its Contributions or its
-    Contributor Version.
-
-1.12. "Secondary License"
-    means either the GNU General Public License, Version 2.0, the GNU
-    Lesser General Public License, Version 2.1, the GNU Affero General
-    Public License, Version 3.0, or any later versions of those
-    licenses.
-
-1.13. "Source Code Form"
-    means the form of the work preferred for making modifications.
-
-1.14. "You" (or "Your")
-    means an individual or a legal entity exercising rights under this
-    License. For legal entities, "You" includes any entity that
-    controls, is controlled by, or is under common control with You. For
-    purposes of this definition, "control" means (a) the power, direct
-    or indirect, to cause the direction or management of such entity,
-    whether by contract or otherwise, or (b) ownership of more than
-    fifty percent (50%) of the outstanding shares or beneficial
-    ownership of such entity.
-
-2. License Grants and Conditions
---------------------------------
-
-2.1. Grants
-
-Each Contributor hereby grants You a world-wide, royalty-free,
-non-exclusive license:
-
-(a) under intellectual property rights (other than patent or trademark)
-    Licensable by such Contributor to use, reproduce, make available,
-    modify, display, perform, distribute, and otherwise exploit its
-    Contributions, either on an unmodified basis, with Modifications, or
-    as part of a Larger Work; and
-
-(b) under Patent Claims of such Contributor to make, use, sell, offer
-    for sale, have made, import, and otherwise transfer either its
-    Contributions or its Contributor Version.
-
-2.2. Effective Date
-
-The licenses granted in Section 2.1 with respect to any Contribution
-become effective for each Contribution on the date the Contributor first
-distributes such Contribution.
-
-2.3. Limitations on Grant Scope
-
-The licenses granted in this Section 2 are the only rights granted under
-this License. No additional rights or licenses will be implied from the
-distribution or licensing of Covered Software under this License.
-Notwithstanding Section 2.1(b) above, no patent license is granted by a
-Contributor:
-
-(a) for any code that a Contributor has removed from Covered Software;
-    or
-
-(b) for infringements caused by: (i) Your and any other third party's
-    modifications of Covered Software, or (ii) the combination of its
-    Contributions with other software (except as part of its Contributor
-    Version); or
-
-(c) under Patent Claims infringed by Covered Software in the absence of
-    its Contributions.
-
-This License does not grant any rights in the trademarks, service marks,
-or logos of any Contributor (except as may be necessary to comply with
-the notice requirements in Section 3.4).
-
-2.4. Subsequent Licenses
-
-No Contributor makes additional grants as a result of Your choice to
-distribute the Covered Software under a subsequent version of this
-License (see Section 10.2) or under the terms of a Secondary License (if
-permitted under the terms of Section 3.3).
-
-2.5. Representation
-
-Each Contributor represents that the Contributor believes its
-Contributions are its original creation(s) or it has sufficient rights
-to grant the rights to its Contributions conveyed by this License.
-
-2.6. Fair Use
-
-This License is not intended to limit any rights You have under
-applicable copyright doctrines of fair use, fair dealing, or other
-equivalents.
-
-2.7. Conditions
-
-Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
-in Section 2.1.
-
-3. Responsibilities
--------------------
-
-3.1. Distribution of Source Form
-
-All distribution of Covered Software in Source Code Form, including any
-Modifications that You create or to which You contribute, must be under
-the terms of this License. You must inform recipients that the Source
-Code Form of the Covered Software is governed by the terms of this
-License, and how they can obtain a copy of this License. You may not
-attempt to alter or restrict the recipients' rights in the Source Code
-Form.
-
-3.2. Distribution of Executable Form
-
-If You distribute Covered Software in Executable Form then:
-
-(a) such Covered Software must also be made available in Source Code
-    Form, as described in Section 3.1, and You must inform recipients of
-    the Executable Form how they can obtain a copy of such Source Code
-    Form by reasonable means in a timely manner, at a charge no more
-    than the cost of distribution to the recipient; and
-
-(b) You may distribute such Executable Form under the terms of this
-    License, or sublicense it under different terms, provided that the
-    license for the Executable Form does not attempt to limit or alter
-    the recipients' rights in the Source Code Form under this License.
-
-3.3. Distribution of a Larger Work
-
-You may create and distribute a Larger Work under terms of Your choice,
-provided that You also comply with the requirements of this License for
-the Covered Software. If the Larger Work is a combination of Covered
-Software with a work governed by one or more Secondary Licenses, and the
-Covered Software is not Incompatible With Secondary Licenses, this
-License permits You to additionally distribute such Covered Software
-under the terms of such Secondary License(s), so that the recipient of
-the Larger Work may, at their option, further distribute the Covered
-Software under the terms of either this License or such Secondary
-License(s).
-
-3.4. Notices
-
-You may not remove or alter the substance of any license notices
-(including copyright notices, patent notices, disclaimers of warranty,
-or limitations of liability) contained within the Source Code Form of
-the Covered Software, except that You may alter any license notices to
-the extent required to remedy known factual inaccuracies.
-
-3.5. Application of Additional Terms
-
-You may choose to offer, and to charge a fee for, warranty, support,
-indemnity or liability obligations to one or more recipients of Covered
-Software. However, You may do so only on Your own behalf, and not on
-behalf of any Contributor. You must make it absolutely clear that any
-such warranty, support, indemnity, or liability obligation is offered by
-You alone, and You hereby agree to indemnify every Contributor for any
-liability incurred by such Contributor as a result of warranty, support,
-indemnity or liability terms You offer. You may include additional
-disclaimers of warranty and limitations of liability specific to any
-jurisdiction.
-
-4. Inability to Comply Due to Statute or Regulation
----------------------------------------------------
-
-If it is impossible for You to comply with any of the terms of this
-License with respect to some or all of the Covered Software due to
-statute, judicial order, or regulation then You must: (a) comply with
-the terms of this License to the maximum extent possible; and (b)
-describe the limitations and the code they affect. Such description must
-be placed in a text file included with all distributions of the Covered
-Software under this License. Except to the extent prohibited by statute
-or regulation, such description must be sufficiently detailed for a
-recipient of ordinary skill to be able to understand it.
-
-5. Termination
---------------
-
-5.1. The rights granted under this License will terminate automatically
-if You fail to comply with any of its terms. However, if You become
-compliant, then the rights granted under this License from a particular
-Contributor are reinstated (a) provisionally, unless and until such
-Contributor explicitly and finally terminates Your grants, and (b) on an
-ongoing basis, if such Contributor fails to notify You of the
-non-compliance by some reasonable means prior to 60 days after You have
-come back into compliance. Moreover, Your grants from a particular
-Contributor are reinstated on an ongoing basis if such Contributor
-notifies You of the non-compliance by some reasonable means, this is the
-first time You have received notice of non-compliance with this License
-from such Contributor, and You become compliant prior to 30 days after
-Your receipt of the notice.
-
-5.2. If You initiate litigation against any entity by asserting a patent
-infringement claim (excluding declaratory judgment actions,
-counter-claims, and cross-claims) alleging that a Contributor Version
-directly or indirectly infringes any patent, then the rights granted to
-You by any and all Contributors for the Covered Software under Section
-2.1 of this License shall terminate.
-
-5.3. In the event of termination under Sections 5.1 or 5.2 above, all
-end user license agreements (excluding distributors and resellers) which
-have been validly granted by You or Your distributors under this License
-prior to termination shall survive termination.
-
-************************************************************************
-*                                                                      *
-*  6. Disclaimer of Warranty                                           *
-*  -------------------------                                           *
-*                                                                      *
-*  Covered Software is provided under this License on an "as is"       *
-*  basis, without warranty of any kind, either expressed, implied, or  *
-*  statutory, including, without limitation, warranties that the       *
-*  Covered Software is free of defects, merchantable, fit for a        *
-*  particular purpose or non-infringing. The entire risk as to the     *
-*  quality and performance of the Covered Software is with You.        *
-*  Should any Covered Software prove defective in any respect, You     *
-*  (not any Contributor) assume the cost of any necessary servicing,   *
-*  repair, or correction. This disclaimer of warranty constitutes an   *
-*  essential part of this License. No use of any Covered Software is   *
-*  authorized under this License except under this disclaimer.         *
-*                                                                      *
-************************************************************************
-
-************************************************************************
-*                                                                      *
-*  7. Limitation of Liability                                          *
-*  --------------------------                                          *
-*                                                                      *
-*  Under no circumstances and under no legal theory, whether tort      *
-*  (including negligence), contract, or otherwise, shall any           *
-*  Contributor, or anyone who distributes Covered Software as          *
-*  permitted above, be liable to You for any direct, indirect,         *
-*  special, incidental, or consequential damages of any character      *
-*  including, without limitation, damages for lost profits, loss of    *
-*  goodwill, work stoppage, computer failure or malfunction, or any    *
-*  and all other commercial damages or losses, even if such party      *
-*  shall have been informed of the possibility of such damages. This   *
-*  limitation of liability shall not apply to liability for death or   *
-*  personal injury resulting from such party's negligence to the       *
-*  extent applicable law prohibits such limitation. Some               *
-*  jurisdictions do not allow the exclusion or limitation of           *
-*  incidental or consequential damages, so this exclusion and          *
-*  limitation may not apply to You.                                    *
-*                                                                      *
-************************************************************************
-
-8. Litigation
--------------
-
-Any litigation relating to this License may be brought only in the
-courts of a jurisdiction where the defendant maintains its principal
-place of business and such litigation shall be governed by laws of that
-jurisdiction, without reference to its conflict-of-law provisions.
-Nothing in this Section shall prevent a party's ability to bring
-cross-claims or counter-claims.
-
-9. Miscellaneous
-----------------
-
-This License represents the complete agreement concerning the subject
-matter hereof. If any provision of this License is held to be
-unenforceable, such provision shall be reformed only to the extent
-necessary to make it enforceable. Any law or regulation which provides
-that the language of a contract shall be construed against the drafter
-shall not be used to construe this License against a Contributor.
-
-10. Versions of the License
----------------------------
-
-10.1. New Versions
-
-Mozilla Foundation is the license steward. Except as provided in Section
-10.3, no one other than the license steward has the right to modify or
-publish new versions of this License. Each version will be given a
-distinguishing version number.
-
-10.2. Effect of New Versions
-
-You may distribute the Covered Software under the terms of the version
-of the License under which You originally received the Covered Software,
-or under the terms of any subsequent version published by the license
-steward.
-
-10.3. Modified Versions
-
-If you create software not governed by this License, and you want to
-create a new license for such software, you may create and use a
-modified version of this License if you rename the license and remove
-any references to the name of the license steward (except to note that
-such modified license differs from this License).
-
-10.4. Distributing Source Code Form that is Incompatible With Secondary
-Licenses
-
-If You choose to distribute Source Code Form that is Incompatible With
-Secondary Licenses under the terms of this version of the License, the
-notice described in Exhibit B of this License must be attached.
-
-Exhibit A - Source Code Form License Notice
--------------------------------------------
-
-  This Source Code Form is subject to the terms of the Mozilla Public
-  License, v. 2.0. If a copy of the MPL was not distributed with this
-  file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-If it is not possible or desirable to put the notice in a particular
-file, then You may include the notice in a location (such as a LICENSE
-file in a relevant directory) where a recipient would be likely to look
-for such a notice.
-
-You may add additional accurate notices of copyright ownership.
-
-Exhibit B - "Incompatible With Secondary Licenses" Notice
----------------------------------------------------------
-
-  This Source Code Form is "Incompatible With Secondary Licenses", as
-  defined by the Mozilla Public License, v. 2.0.
+/*
+ * Copyright (c) 2017 Andy Rohr
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */

data/examples/client.rb

@@ -6,11 +6,25 @@ require 'modbus'
 class Client < Modbus::Client
 
   def poll
+    # transaction do |t|
+    #   request = t.read_holding_registers 0, 1
+    #
+    #   request.callback do |start_addr, reg_values|
+    #     puts "reg values @ #{start_addr}: #{reg_values.inspect}"
+    #     schedule_next_poll
+    #   end
+    #
+    #   request.errback do |error|
+    #     puts "error: #{error.inspect}"
+    #     schedule_next_poll
+    #   end
+    # end
+
     transaction do |t|
-      request = t.read_holding_registers 100, 1
+      request = t.read_input_status 0, 32
 
-      request.callback do |start_addr, reg_values|
-        puts "reg values @ #{start_addr}: #{reg_values.inspect}"
+      request.callback do |start_addr, bit_values|
+        puts "bit values @ #{start_addr}: #{bit_values.inspect}"
         schedule_next_poll
       end
 
@@ -19,6 +33,38 @@ class Client < Modbus::Client
         schedule_next_poll
       end
     end
+
+
+    # transaction do |t|
+    #   request = t.read_coils 0, 32
+    #
+    #   request.callback do |start_addr, bit_values|
+    #     puts "bit values @ #{start_addr}: #{bit_values.inspect}"
+    #     schedule_next_poll
+    #   end
+    #
+    #   request.errback do |error|
+    #     puts "error: #{error.inspect}"
+    #     schedule_next_poll
+    #   end
+    # end
+
+    # @addr ||= 0
+    # @addr = @addr.next
+    #
+    # transaction do |t|
+    #   request = t.write_single_coil @addr, 0xFF00
+    #
+    #   request.callback do |start_addr, value|
+    #     puts "Write successful: #{start_addr} 0x#{value.to_s(16)}"
+    #     schedule_next_poll
+    #   end
+    #
+    #   request.errback do |error|
+    #     puts "error: #{error.inspect}"
+    #     schedule_next_poll
+    #   end
+    # end
   end
 
 end
@@ -28,6 +74,7 @@ trap 'INT' do
 end
 
 EM.run do
-  client = Client.new 'tcp://localhost:1502'
+  # client = Client.new 'tcp://localhost:1502'
+  client = Client.new 'tcp://192.168.56.101:502'
   client.connect
 end

data/lib/modbus/pdu/pdu.rb

@@ -2,11 +2,14 @@
 # All rights reserved.
 
 require 'modbus/pdu/exception'
+require 'modbus/pdu/read_bits'
+require 'modbus/pdu/read_coils'
 require 'modbus/pdu/read_input_status'
 require 'modbus/pdu/read_registers'
 require 'modbus/pdu/read_input_registers'
 require 'modbus/pdu/read_holding_registers'
 require 'modbus/pdu/write_multiple_registers'
+require 'modbus/pdu/write_single_coil'
 
 module Modbus
 
@@ -18,20 +21,24 @@ module Modbus
     # Maps the Modbus function code to the corresponding class (for request messages)
     REQ_PDU_MAP = {}
     [
+      ReadCoilsRequest,
       ReadInputStatusRequest,
       ReadInputRegistersRequest,
       ReadHoldingRegistersRequest,
-      WriteMultipleRegistersRequest
+      WriteMultipleRegistersRequest,
+      WriteSingleCoilRequest
     ].each { |klass| REQ_PDU_MAP[klass::FUNC_CODE] = klass }
 
 
     # Maps the Modbus function code to the corresponding class (for response messages)
     RSP_PDU_MAP = {}
     [
+      ReadCoilsResponse,
       ReadInputStatusResponse,
       ReadInputRegistersResponse,
       ReadHoldingRegistersResponse,
-      WriteMultipleRegistersResponse
+      WriteMultipleRegistersResponse,
+      WriteSingleCoilResponse
     ].each { |klass| RSP_PDU_MAP[klass::FUNC_CODE] = klass }
 
 

data/lib/modbus/pdu/read_bits.rb

@@ -0,0 +1,143 @@
+# Copyright © 2016 Andy Rohr <andy.rohr@mindclue.ch>
+# All rights reserved.
+
+
+module Modbus
+
+  class PDU
+
+    # Base class PDU for modbus bit based functions (request message)
+    #
+    class ReadBitsRequest < PDU
+      attr_accessor :start_addr, :bit_count
+
+
+      # Initializes a new PDU instance. Decodes from protocol data if given.
+      #
+      # @param data [Modbus::ProtocolData] The protocol data to decode.
+      #
+      def initialize(data = nil, func_code = nil)
+        @start_addr = 0
+        @bit_count  = 0
+        super
+      end
+
+
+      # Decodes a PDU from protocol data.
+      #
+      # @param data [Modbus::ProtocolData] The protocol data to decode.
+      #
+      def decode(data)
+        @start_addr = data.shift_word
+        @bit_count  = data.shift_word
+      end
+
+
+      # Encodes a PDU into protocol data.
+      #
+      # @return [Modbus::ProtocolData] The protocol data representation of this object.
+      #
+      def encode
+        data = super
+        data.push_word @start_addr
+        data.push_word @bit_count
+        data
+      end
+
+
+      # Returns the length of the PDU in bytes.
+      #
+      # @return [Integer] The length.
+      #
+      def length
+        5
+      end
+
+
+      # Validates the PDU. Raises exceptions if validation fails.
+      #
+      def validate
+        fail ClientError, "Register count must be in (1..127), got '#{@bit_count.inspect}'" unless (1..127).include?(@bit_count)
+      end
+
+    end
+
+
+    # Base class PDU for modbus bit based functions (response message)
+    #
+    class ReadBitsResponse < PDU
+      attr_accessor :bit_values
+
+
+      # Initializes a new PDU instance. Decodes from protocol data if given.
+      #
+      # @param data [Modbus::ProtocolData] The protocol data to decode.
+      #
+      def initialize(data = nil, func_code = nil)
+        @bit_values = []
+        super
+      end
+
+
+      # Decodes a PDU from protocol data.
+      #
+      # @param data [Modbus::ProtocolData] The protocol data to decode.
+      #
+      def decode(data)
+        byte_count = data.shift_byte
+        byte_count.times do
+          byte = data.shift_byte
+
+          8.times do |bit|
+            @bit_values.push byte[bit] == 1
+          end
+        end
+      end
+
+
+      # Encodes a PDU into protocol data.
+      #
+      # @return [Modbus::ProtocolData] The protocol data representation of this object.
+      #
+      def encode
+        data = super
+        data.push_byte byte_count
+        @bit_values.each do |value|
+          data.push_byte value
+        end
+        data
+      end
+
+
+      # Returns the length of the register values in bytes.
+      #
+      # @return [Integer] The length.
+      #
+      def byte_count
+        @bit_values.size
+      end
+
+
+      # Returns the length of the PDU in bytes.
+      #
+      # @return [Integer] The length.
+      #
+      def length
+        # +1 for func_code, +1 for byte_count
+        byte_count + 2
+      end
+
+
+      # Validates the PDU. Raises exceptions if validation fails.
+      #
+      def validate
+
+      end
+
+    end
+
+  end
+
+end # Modbus
+
+

data/lib/modbus/pdu/read_coils.rb

@@ -0,0 +1,26 @@
+# Copyright © 2016 Andy Rohr <andy.rohr@mindclue.ch>
+# All rights reserved.
+
+
+module Modbus
+
+  class PDU
+
+    # PDU for modbus function "read coils" (request message)
+    #
+    class ReadCoilsRequest < ReadBitsRequest
+      FUNC_CODE = 0x01
+    end
+
+
+    # PDU for modbus function "read coils" (response message)
+    #
+    class ReadCoilsResponse < ReadBitsResponse
+      FUNC_CODE = 0x01
+    end
+
+  end
+
+end # Modbus
+
+

data/lib/modbus/pdu/read_input_status.rb

@@ -8,136 +8,15 @@ module Modbus
 
     # PDU for modbus function "read input status" (request message)
     #
-    class ReadInputStatusRequest < PDU
+    class ReadInputStatusRequest < ReadCoilsRequest
       FUNC_CODE = 0x02
-      
-      attr_accessor :start_addr, :bit_count
-
-
-      # Initializes a new PDU instance. Decodes from protocol data if given.
-      #
-      # @param data [Modbus::ProtocolData] The protocol data to decode.
-      #
-      def initialize(data = nil, func_code = nil)
-        @start_addr = 0
-        @bit_count  = 0
-        super
-      end
-
-
-      # Decodes a PDU from protocol data.
-      #
-      # @param data [Modbus::ProtocolData] The protocol data to decode.
-      #
-      def decode(data)
-        @start_addr = data.shift_word
-        @bit_count  = data.shift_word
-      end
-
-
-      # Encodes a PDU into protocol data.
-      #
-      # @return [Modbus::ProtocolData] The protocol data representation of this object.
-      #
-      def encode
-        data = super
-        data.push_word @start_addr
-        data.push_word @bit_count
-        data
-      end
-
-
-      # Returns the length of the PDU in bytes.
-      #
-      # @return [Integer] The length.
-      #
-      def length
-        5
-      end
-
-
-      # Validates the PDU. Raises exceptions if validation fails.
-      #
-      def validate
-        fail ClientError, "Register count must be in (1..127), got '#{@bit_count.inspect}'" unless (1..127).include?(@bit_count)
-      end
-
     end
 
 
     # PDU for modbus function "read input status" (response message)
     #
-    class ReadInputStatusResponse < PDU
+    class ReadInputStatusResponse < ReadBitsResponse
       FUNC_CODE = 0x02
-
-      attr_accessor :bit_values
-
-
-      # Initializes a new PDU instance. Decodes from protocol data if given.
-      #
-      # @param data [Modbus::ProtocolData] The protocol data to decode.
-      #
-      def initialize(data = nil, func_code = nil)
-        @bit_values = []
-        super
-      end
-
-
-      # Decodes a PDU from protocol data.
-      #
-      # @param data [Modbus::ProtocolData] The protocol data to decode.
-      #
-      def decode(data)
-        byte_count = data.shift_byte
-        byte_count.times do
-          byte = data.shift_byte
-
-          8.times do |bit|
-            @bit_values.push byte[bit] == 1
-          end
-        end
-      end
-
-
-      # Encodes a PDU into protocol data.
-      #
-      # @return [Modbus::ProtocolData] The protocol data representation of this object.
-      #
-      def encode
-        data = super
-        data.push_byte byte_count
-        @bit_values.each do |value|
-          data.push_byte value
-        end
-        data
-      end
-
-
-      # Returns the length of the register values in bytes.
-      #
-      # @return [Integer] The length.
-      #
-      def byte_count
-        @bit_values.size
-      end
-
-
-      # Returns the length of the PDU in bytes.
-      #
-      # @return [Integer] The length.
-      #
-      def length
-        # +1 for func_code, +1 for byte_count
-        byte_count + 2
-      end
-
-
-      # Validates the PDU. Raises exceptions if validation fails.
-      #
-      def validate
-
-      end
-
     end
 
   end

data/lib/modbus/pdu/read_registers.rb

@@ -6,7 +6,7 @@ module Modbus
 
   class PDU
 
-    # Base class PDU for modbus function "read holding register" (request message)
+    # Base class PDU for modbus register based functions (request message)
     #
     class ReadRegistersRequest < PDU
       attr_accessor :start_addr, :reg_count
@@ -63,7 +63,7 @@ module Modbus
     end
 
 
-    # PDU for modbus function "read holding register" (response message)
+    # Base class PDU for modbus register based functions (response message)
     #
     class ReadRegistersResponse < PDU
       attr_accessor :reg_values

data/lib/modbus/pdu/write_single_coil.rb

@@ -0,0 +1,77 @@
+# Copyright © 2016 Andy Rohr <andy.rohr@mindclue.ch>
+# All rights reserved.
+
+
+module Modbus
+
+  class PDU
+
+    # PDU for modbus function "read single coil" (request message)
+    #
+    class WriteSingleCoilRequest < PDU
+      FUNC_CODE = 0x05
+
+      attr_accessor :start_addr, :value
+
+
+      # Initializes a new PDU instance. Decodes from protocol data if given.
+      #
+      # @param data [Modbus::ProtocolData] The protocol data to decode.
+      #
+      def initialize(data = nil, func_code = nil)
+        @start_addr = 0
+        @value      = 0
+        super
+      end
+
+
+      # Decodes a PDU from protocol data.
+      #
+      # @param data [Modbus::ProtocolData] The protocol data to decode.
+      #
+      def decode(data)
+        @start_addr = data.shift_word
+        @value      = data.shift_word
+      end
+
+
+      # Encodes a PDU into protocol data.
+      #
+      # @return [Modbus::ProtocolData] The protocol data representation of this object.
+      #
+      def encode
+        data = super
+        data.push_word @start_addr
+        data.push_word @value
+        data
+      end
+
+
+      # Returns the length of the PDU in bytes.
+      #
+      # @return [Integer] The length.
+      #
+      def length
+        5
+      end
+
+
+      # Validates the PDU. Raises exceptions if validation fails.
+      #
+      def validate
+        fail ClientError, "Value must be 0x0000 or 0xFF00, got '#{@value}'" unless [0x0000, 0xFF00].include?(@value)
+      end
+
+    end
+
+
+    # PDU for modbus function "read single coil" (response message)
+    #
+    class WriteSingleCoilResponse < WriteSingleCoilRequest
+    end
+
+  end
+
+end # Modbus
+
+

data/lib/modbus/transaction/client.rb

@@ -37,7 +37,21 @@ module Modbus
       end
 
 
-      # Sends a request for the modbus function "read input status" asynchronusly. This method is non-blocking.
+      # Sends a request for the modbus function 1 "read coils" asynchronusly. This method is non-blocking.
+      #
+      # @param start_addr [Integer] The starting modbus register address to read registers from.
+      # @param bit_count [Integer] The number of input bits to read.
+      #
+      def read_coils(start_addr, bit_count)
+        pdu            = PDU::ReadCoilsRequest.new
+        pdu.start_addr = start_addr
+        pdu.bit_count  = bit_count
+
+        send_pdu pdu
+      end
+
+
+      # Sends a request for the modbus function 2 "read input status" asynchronusly. This method is non-blocking.
       #
       # @param start_addr [Integer] The starting modbus register address to read registers from.
       # @param bit_count [Integer] The number of input bits to read.
@@ -51,6 +65,34 @@ module Modbus
       end
 
 
+      # Sends a request for the modbus function 5 "write single coil" asynchronusly. This method is non-blocking.
+      #
+      # @param start_addr [Integer] The address of the coil to write.
+      # @param value [Integer] The value to write.
+      #
+      def write_single_coil(start_addr, value)
+        pdu            = PDU::WriteSingleCoilRequest.new
+        pdu.start_addr = start_addr
+        pdu.value      = value
+
+        send_pdu pdu
+      end
+
+
+      # Sends a request for the modbus function 4 "read input registers" asynchronusly. This method is non-blocking.
+      #
+      # @param start_addr [Integer] The starting modbus register address to read registers from.
+      # @param reg_count [Integer] The number of registers to read.
+      #
+      def read_input_registers(start_addr, reg_count)
+        pdu            = PDU::ReadInputRegistersRequest.new
+        pdu.start_addr = start_addr
+        pdu.reg_count  = reg_count
+
+        send_pdu pdu
+      end
+
+
       # Sends a request for the modbus function "read holding registers" asynchronusly. This method is non-blocking.
       #
       # @param start_addr [Integer] The starting modbus register address to read registers from.
@@ -121,12 +163,17 @@ module Modbus
       end
 
 
-      def handle_read_input_status
+      def handle_read_bits
         @response_adu.pdu.bit_values
       end
 
 
-      def handle_read_holding_registers
+      def handle_write_single_coil
+        @response_adu.pdu.value
+      end
+
+
+      def handle_read_registers
         @response_adu.pdu.reg_values
       end
 

data/lib/modbus/transaction/transaction.rb

@@ -10,25 +10,35 @@ module Modbus
 
     # Valid transactions (messages) and value handler config
     TRANSACTIONS = [
+      {
+        :request  => PDU::ReadCoilsRequest,
+        :response => PDU::ReadCoilsResponse,
+        :handler  => :handle_read_bits
+      },
       {
         :request  => PDU::ReadInputStatusRequest,
         :response => PDU::ReadInputStatusResponse,
-        :handler  => :handle_read_input_status
+        :handler  => :handle_read_bits
       },
       {
         :request  => PDU::ReadInputRegistersRequest,
         :response => PDU::ReadInputRegistersResponse,
-        :handler  => :handle_read_input_registers
+        :handler  => :handle_read_registers
       },
       {
         :request  => PDU::ReadHoldingRegistersRequest,
         :response => PDU::ReadHoldingRegistersResponse,
-        :handler  => :handle_read_holding_registers
+        :handler  => :handle_read_registers
       },
       {
         :request  => PDU::WriteMultipleRegistersRequest,
         :response => PDU::WriteMultipleRegistersResponse,
         :handler  => :handle_write_multiple_registers
+      },
+      {
+        :request  => PDU::WriteSingleCoilRequest,
+        :response => PDU::WriteSingleCoilResponse,
+        :handler  => :handle_write_single_coil
       }
     ]
 

data/lib/modbus/version.rb

@@ -3,5 +3,5 @@
 
 
 module Modbus
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,90 +1,79 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: em-modbus
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Andy Rohr
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2017-07-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  type: :runtime
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id001
-  prerelease: false
+date: 2017-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: eventmachine
-- !ruby/object:Gem::Dependency 
-  type: :development
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 6
-        version: "1.6"
-  requirement: *id002
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: bundler
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :development
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id003
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
   name: rake
-- !ruby/object:Gem::Dependency 
-  type: :development
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id004
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby implementation of the Modbus protocol.
-email: 
+email:
 - andy.rohr@mindclue.ch
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -107,11 +96,14 @@ files:
 - lib/modbus/modbus.rb
 - lib/modbus/pdu/exception.rb
 - lib/modbus/pdu/pdu.rb
+- lib/modbus/pdu/read_bits.rb
+- lib/modbus/pdu/read_coils.rb
 - lib/modbus/pdu/read_holding_registers.rb
 - lib/modbus/pdu/read_input_registers.rb
 - lib/modbus/pdu/read_input_status.rb
 - lib/modbus/pdu/read_registers.rb
 - lib/modbus/pdu/write_multiple_registers.rb
+- lib/modbus/pdu/write_single_coil.rb
 - lib/modbus/register/base.rb
 - lib/modbus/register/bit_register.rb
 - lib/modbus/register/register.rb
@@ -125,38 +117,29 @@ files:
 - spec/adi_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/arohr/em-modbus
-licenses: 
+licenses:
 - MPLv2
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.29
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Modbus Client and Server for eventmachine.
-test_files: 
+test_files:
 - spec/adi_spec.rb
 - spec/spec_helper.rb