rs_232 3.0.0.pre2 → 3.0.0.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bcb80fd72cfb4f47935134fbe73abc7594b289c
-  data.tar.gz: 949a14cb21434e5a3af56701e265f44c06a50966
+  metadata.gz: 5840e52db6045e90f747a253b5ffac3e35451982
+  data.tar.gz: 4ab12360c4459dc9559d2b49edbb211cce7a54e5
 SHA512:
-  metadata.gz: 01e9454ede82eb0905af93a07e30783917e003f552e99f5bf5cedb1d253ab8e85c17bc5c684e46c5221bd25c91bd983ef13162d538ca4e3a94428b94f09ae07c
-  data.tar.gz: ae532ffee6ab6490641e6cbb32568ce0a357b30135980f6ddebe962a9751f19f4563ddccb4049a7c188bb1a6a6b6195d5516302e993bee28facda3203830ef49
+  metadata.gz: 3e44d1e9b4f2b54140b051a3faa776d3b677332b416a865e8b485d5cb992682b720bb16329848ea958f1780b43e8d6dc3ba59a0f361f947647ac81b8f7dd2390
+  data.tar.gz: 9bb919bdf5c099e25bd5b5711a7d9af244c1ddf3b01c6b833eabbc115b68e255cc8c1e6807af8b21a640a162bbbc5b2da679afecb4f8bc3bc1163e6ccae1f150

data/ext/rs_232/posix/Port.c

@@ -291,7 +291,7 @@ VALUE openIO(VALUE self)
     } else
     {
         port->status = PORT_CLOSED;
-        rb_raise(rb_eRuntimeError, "Unable to open comport: `%s`", port->settings.ComPort);
+        rb_raise(rb_eIOError, "Unable to open comport: `%s`", port->settings.ComPort);
     }
     
     return self;

data/ext/rs_232/windows/Port.c

@@ -77,7 +77,7 @@ void updateSettings(PortDescriptor *port)
 {
     
     if (PORT_OPEN != port->status)
-        rb_raise(rb_eRuntimeError, "Can not set due to comport is not open, status: %d\n", port->status);
+        rb_raise(rb_eIOError, "Can not set due to comport is not open, status: %d\n", port->status);
     
     
     if (port->toBeUpdated & T_BaudRate)
@@ -230,7 +230,7 @@ VALUE openIO(VALUE self)
     {
         
         port->status = PORT_CLOSED;
-        rb_raise(rb_eRuntimeError, "Unable to open comport: `%s`", port->settings.ComPort);
+        rb_raise(rb_eIOError, "Unable to open comport: `%s`", port->settings.ComPort);
         
     } else
     {

data/lib/rs_232.rb

@@ -7,17 +7,27 @@ module Rs232
   #
   # @example
   #
-  #   > port = Rs232.new('/dev/tty.ACM0', baud_rate: 9600)
-  #   #=> <#Rs232::Impl @port='/dev/tty.ACM0'>
+  #   > include Rs232
+  #   > port = new_serial_port('/dev/tty.ACM0', baud_rate: 9600)
+  #   #=> #<Rs232::Impl @port='/dev/tty.ACM0'>
   #   > port.open?
   #   #=> false
-  #   > port.connect
-  #   #=> <#Rs232::Impl @port='/dev/tty.ACM0'>
-  #   port.pending_bytes
+  #   > port.connect # rasing IOError in case of port couldn't be opened.
+  #   #=> #<Rs232::Impl @port='/dev/tty.ACM0'>
+  #   > port.pending_bytes
   #   #=> 15
-  #   port.read(15)
+  #   > port.read(15)
   #   #=> 'Hello, World!!!'
+  #   > port.write("Hi")
+  #   #=> 2
+  #   > port.close
+  #   #=> true
+  #   > port.open?
+  #   #=> false
   #
+  # @param [String] port name
+  # @param [Hash] opts with such keys as: baud_rate, parity, data_bits, stop_bits, flow_control, timeout
+  # @param [Proc] block is a function to apply on constructor finish
   def new_serial_port(port, opts = {}, &block)
     Impl.new(port, opts, &block)
   end
@@ -46,7 +56,6 @@ module Rs232
                    :read,
                    :write,
                    :flush,
-                   :close,
                    :open?,
                    :set_rts,
                    :set_dtr
@@ -58,7 +67,8 @@ module Rs232
       yield self if block_given?
     end
 
-    # @raise RuntimeError in case of open error
+    # @raise IOError in case of port was not open.
+    # @return [Impl] instance
     def connect
       return self if open?
       @impl.open.tap do |io|
@@ -72,6 +82,18 @@ module Rs232
       self
     end
 
+    # @return [Boolean]
+    def close
+      return !open? unless open?
+      0 == @impl.close
+    end
+
+    # @return [Fixnum] representing count of bytes in the buffer
+    def pending_bytes
+      @impl.available?
+    end
+
+    # @return [Hash] of configurations on the OS side.
     def settings
       {}.tap do |o|
         o[:baud_rate] = @impl.baud_rate
@@ -83,15 +105,6 @@ module Rs232
         o[:line_status] = @impl.line_status
       end.freeze
     end
-
-    def open?
-      @impl.open?
-    end
-
-    def close
-      return !open unless open?
-      0 == @impl.close
-    end
   end
 
   private_constant :Impl

data/lib/rs_232/version.rb

@@ -1,3 +1,3 @@
 module Rs232
-  VERSION = '3.0.0.pre2'.freeze
+  VERSION = '3.0.0.pre3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rs_232
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre2
+  version: 3.0.0.pre3
 platform: ruby
 authors:
 - Roman Lishtaba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2016-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler