rmodbus 1.0.2 → 1.0.3

data/examples/simple-xpca-gateway.rb

@@ -0,0 +1,84 @@
+=begin
+It's very simple example of implementation XPCA gateway (see http://www.xpca.org)
+for communication with TCP ModBus devices
+It receives  REST requests (e.g http://127.0.0.1:4567/mb/127.0.0.1/8502/1/coils/6/17 )
+and returns data in JSON format addr : data:
+{"coils": {
+  "6":{
+    "value":0,
+    "timestamp":"2011-07-12 18:11:03 +0000",
+    "quality":"good"
+  },
+  "7":{
+    "value":0,
+    "timestamp":"2011-07-12 18:11:03 +0000",
+    "quality":"good"
+    }
+  ...
+}
+
+This code requies gems: rmodbus, sinatra and json
+2011 (c) Aleksey Timin
+=end
+
+require 'rubygems'
+require 'rmodbus'
+require 'sinatra'
+require 'json'
+
+# Launche TCP ModBus server for test
+IP = '127.0.0.1'
+PORT = 8502
+
+@srv = ModBus::TCPServer.new(PORT,1)
+
+@srv.holding_registers = Array.new(100) { |i| i = i + 1  }
+@srv.input_registers = Array.new(100) { |i| i = i + 1  }
+@srv.coils = Array.new(100) { |i| i = 0 }
+@srv.discrete_inputs = Array.new(100) { |i| i = 0  }
+
+@srv.start
+
+
+# Calc a GET request
+# @example
+# http://127.0.0.1:4567/mb/127.0.0.1/8502/1/coils/6/17
+#
+# HTTP route: GET http://localhost/mb/:ip/:port/:slave/:dataplace/:firstaddr/:lastaddr
+#
+# :ip - ip addr of ModBus TCP Server
+# :port - port of ModBUs TCP Server
+# :slave - id of slave device
+# :dataplace - valid values: coils, discrete_inputs, input_registers, holding_registers
+# :firstaddr - first addr of registers(contacts)
+# :lastaddr - last addr of registers(contacts)
+get '/mb/:ip/:port/:slave/:dataplace/:firstaddr/:lastaddr' do
+  resp = {}
+  begin
+    data = []
+    ModBus::TCPClient.new(params[:ip].to_s, params[:port].to_i) do |cl|
+      cl.with_slave(params[:slave].to_i) do |slave|
+        slave.debug = true
+        dataplace = slave.send params[:dataplace]
+        data = dataplace[params[:firstaddr].to_i .. params[:lastaddr].to_i]
+      end
+    end
+
+    resp = { params[:dataplace] => {}}
+    data.each_with_index do |v,i|
+      resp[params[:dataplace]][params[:firstaddr].to_i + i] = {
+        :value => v,
+        :timestamp => Time.now.utc.strftime("%Y-%m-%d %H:%M:%S %z"),
+        :quality => "good"
+      }
+    end
+  rescue Exception => e
+    resp = { :error => {
+      :type => e.class,
+      :message => e.message }
+    }
+  end
+
+  content_type "application/json"
+  resp.to_json
+end

data/lib/rmodbus/rtu_via_tcp_server.rb

@@ -33,10 +33,15 @@ module ModBus
     # Init server
     # @param [Integer] port listen port
     # @param [Integer] uid slave device
-    def initialize(port = 10002, uid = 1)
-      @uid = uid
-      super(port)
-    end
+    # @param [Hash] opts options of server
+    # @option opts [String] :host host of server default '127.0.0.1'
+    # @option opts [Float, Integer] :max_connection max of TCP connection with server default 4
+    def initialize(port = 10002, uid = 1, opts = {})
+			@uid = uid
+      opts[:host] = DEFAULT_HOST unless opts[:host]
+      opts[:max_connection] = 4 unless opts[:max_connection]
+			super(port, host = opts[:host], maxConnection = opts[:max_connection])
+		end
 
     protected
     # Serve requests

data/lib/rmodbus/tcp_server.rb

@@ -30,9 +30,14 @@ module ModBus
     # Init server
     # @param [Integer] port listen port
     # @param [Integer] uid slave device
-		def initialize(port = 502, uid = 1)
+    # @param [Hash] opts options of server
+    # @option opts [String] :host host of server default '127.0.0.1'
+    # @option opts [Float, Integer] :max_connection max of TCP connection with server default 4
+		def initialize(port = 502, uid = 1, opts = {})
 			@uid = uid
-			super(port)
+      opts[:host] = DEFAULT_HOST unless opts[:host]
+      opts[:max_connection] = 4 unless opts[:max_connection]
+			super(port, host = opts[:host], maxConnection = opts[:max_connection])
 		end
 
     # Serve requests

data/lib/rmodbus/version.rb

@@ -13,5 +13,5 @@
 # GNU General Public License for more details.
 module ModBus
   # Package version
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: rmodbus
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 2
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - A.Timin, J. Sanders, K. Reynolds
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-30 00:00:00 Z
+date: 2011-07-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: serialport
@@ -25,9 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -39,9 +31,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id002
@@ -53,9 +42,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id003
@@ -67,9 +53,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id004
@@ -81,9 +64,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id005
@@ -95,9 +75,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id006
@@ -109,9 +86,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id007
@@ -146,6 +120,7 @@ files:
 - lib/rmodbus/server.rb
 - lib/rmodbus/rtu_via_tcp_slave.rb
 - lib/rmodbus/tcp_slave.rb
+- examples/simple-xpca-gateway.rb
 - examples/perfomance_tcp.rb
 - examples/use_tcp_modbus.rb
 - examples/use_rtu_via_tcp_modbus.rb
@@ -182,26 +157,19 @@ 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 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: RModBus - free implementation of protocol ModBus
 test_files: []
 
-has_rdoc: