ccutrer-serialport 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5883d7fba69f81de31f8f8d2a21f25e1734fb25adce3a3ec9f873a67c9e96b43
-  data.tar.gz: 780c226269254d5d413445159cdd8a3603d5e835c315eb00cc9c50557d1b1fbf
+  metadata.gz: 69c3b68becbcef8f755d29da38ddd0d1532efabb76daa1f4397b6fbc713f0893
+  data.tar.gz: ff3d20273bd129636c01836f5e29a5a4ac82ac16ae9840c63e6fa79f16537184
 SHA512:
-  metadata.gz: 27f8bb29ca45fff55a30b0825dc1087f74259de5a81bb1a6671f90c95a52bf4e832f21ca40c79e84e1e486d5da362199d631a90134df34e09ce4b2162721acdc
-  data.tar.gz: '08619960bba97f86e4752a14587b3b9d2a9b68723a76e681d7afe1e6f1f72a490c7cc23c9d43fc0155cc582db2e98e1323be9fcff23c45ce17a4d33dad711d1b'
+  metadata.gz: 2f30d416a29cd1bab53072caeff2bfd2ade151ba1d0f687bae4b3217493a0dc63979def24e4fca3d68528af7570abf0df85bb9d9542b4ec0261fb8b4edf92ba5
+  data.tar.gz: 3da04dcfa3ad985c233f6a8a7732b0b4abed9e5a41cba72804753bdab38a9b07cf3a5ba66f1b401f9f0356e3eea7e8fabd8a02d800ae06a1234098089caf7af2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ccutrer-serialport (1.0.0)
+    ccutrer-serialport (1.1.0)
       ffi (~> 1.9, >= 1.9.3)
 
 GEM

data/lib/ccutrer-serialport.rb

@@ -10,11 +10,16 @@ module CCutrer
 
     if ON_WINDOWS
       raise "rubyserial is not currently supported on windows"
-    elsif ON_LINUX
+    end
+
+    # order is important here
+    require 'ccutrer/serial_port/termios'
+    if ON_LINUX
       require 'ccutrer/serial_port/linux'
     else
       require 'ccutrer/serial_port/osx'
     end
+    require 'ccutrer/serial_port/posix'
   end
 end
 

data/lib/ccutrer/serial_port.rb

@@ -3,7 +3,7 @@
 require 'fcntl'
 
 class CCutrer::SerialPort < File
-  def initialize(address, baud: 9600, data_bits: 8, parity: :none, stop_bits: 1)
+  def initialize(address, baud: nil, data_bits: nil, parity: nil, stop_bits: nil)
     super(address, IO::RDWR | IO::NOCTTY | IO::NONBLOCK)
 
     raise IOError, "Not a serial port" unless tty?
@@ -11,35 +11,123 @@ class CCutrer::SerialPort < File
     fl = fcntl(Fcntl::F_GETFL, 0)
     fcntl(Fcntl::F_SETFL, ~Fcntl::O_NONBLOCK & fl)
 
-    @config = build_config(baud, data_bits, parity, stop_bits)
+    @termios = Termios::Termios.new
+    refresh
 
-    err = Posix.tcsetattr(fileno, Posix::TCSANOW, @config)
-    if err == -1
-      raise SystemCallError, FFI.errno
+    # base config
+    @termios[:c_iflag] = Termios::IGNPAR
+    @termios[:c_oflag] = 0
+    @termios[:c_cflag] =
+      Termios::CREAD |
+      Termios::CLOCAL
+    @termios[:c_lflag] = 0
+
+    @termios[:c_cc][Termios::VTIME] = 0
+    @termios[:c_cc][Termios::VMIN] = 0
+
+    configure do
+      self.baud = baud if baud
+      self.data_bits = data_bits if data_bits
+      self.parity = parity if parity
+      self.stop_bits = stop_bits if stop_bits
     end
+    raise Errno::EINVAL if baud && baud != self.baud
+    raise Errno::EINVAL if data_bits && data_bits != self.data_bits
+    raise Errno::EINVAL if parity && parity != self.parity
+    raise Errno::EINVAL if stop_bits && stop_bits != self.stop_bits
+  end
+
+  def configure
+    @configuring = true
+    yield
+    @configuring = false
+    apply
+    refresh
+  ensure
+    @configuring = false
+  end
+
+  def baud
+    Termios::BAUD_RATES.invert[Termios.cfgetispeed(@termios)]
+  end
+
+  def baud=(baud)
+    raise ArgumentError, "Invalid baud" unless Termios::BAUD_RATES.key?(baud)
+
+    err = Termios.cfsetispeed(@termios, Termios::BAUD_RATES[baud])
+    raise SystemCallError, FFI.errno if err == -1
+    err = Termios.cfsetospeed(@termios, Termios::BAUD_RATES[baud])
+    raise SystemCallError, FFI.errno if err == -1
+    apply  
+    refresh
+    self.baud
+  end
+
+  def data_bits
+    Termios::DATA_BITS.invert[@termios[:c_cflag] & Termios::CSIZE]
+  end
+
+  def data_bits=(data_bits)
+    raise ArgumentError, "Invalid data bits" unless Termios::DATA_BITS.key?(data_bits)
+
+    @termios[:c_cflag] &= ~Termios::CSIZE
+    @termios[:c_cflag] |= Termios::DATA_BITS[data_bits]
+    apply
+    refresh
+    self.data_bits
+  end
+
+  def parity
+    Termios::PARITY.invert[@termios[:c_cflag] & Termios::PARITY[:odd]]
+  end
+
+  def parity=(parity)
+    raise ArgumentError, "Invalid parity" unless Termios::PARITY.key?(parity)
+
+    @termios[:c_cflag] &= ~Termios::PARITY[:odd]
+    @termios[:c_cflag] |= Termios::PARITY[parity]
+    apply
+    refresh
+    self.parity
+  end
+
+  def stop_bits
+    (@termios[:c_cflag] & Termios::CSTOPB) != 0 ? 2 : 1
+  end
+
+  def stop_bits=(stop_bits)
+    raise ArgumentError, "Invalid stop bits" unless Termios::STOP_BITS.key?(stop_bits)
+
+    @termios[:c_cflag] &= ~Termios::CSTOPB
+    @termios[:c_cflag] |= Termios::STOP_BITS[stop_bits]
+    apply
+    refresh
+    self.stop_bits
+  end
+
+  def inspect
+    "#<#{self.class.name}:#{path} #{baud} #{data_bits}#{parity.to_s[0].upcase}#{stop_bits}>"
   end
 
   private
 
-  def build_config(baud_rate, data_bits, parity, stop_bits)
-    config = Posix::Termios.new
-
-    config[:c_iflag]  = Posix::IGNPAR
-    config[:c_ispeed] = Posix::BAUD_RATES[baud_rate]
-    config[:c_ospeed] = Posix::BAUD_RATES[baud_rate]
-    config[:c_cflag]  = Posix::DATA_BITS[data_bits] |
-      Posix::CREAD |
-      Posix::CLOCAL |
-      Posix::PARITY[parity] |
-      Posix::STOPBITS[stop_bits]
-
-    # Masking in baud rate on OS X would corrupt the settings.
-    if ON_LINUX
-      config[:c_cflag] = config[:c_cflag] | Posix::BAUD_RATES[baud_rate]
+  def apply
+    return if @configuring
+    err = Termios.tcsetattr(fileno, Termios::TCSANOW, @termios)
+    raise SystemCallError, FFI.errno if err == -1
+    self
+  rescue SystemCallError
+    begin
+      refresh
+    rescue SystemCallError
     end
+    raise
+  end
 
-    config[:cc_c][Posix::VMIN] = 0
-
-    config
+  def refresh
+    return if @configuring
+    err = Termios.tcgetattr(fileno, @termios)
+    raise SystemCallError, FFI.errno if err == -1
+    self
   end
 end

data/lib/ccutrer/serial_port/linux.rb

@@ -1,20 +1,33 @@
-# Copyright (c) 2014-2016 The Hybrid Group, 2020 Cody Cutrer
+# Copyright (c) 2014-2016 The Hybrid Group, 2020-2021 Cody Cutrer
 
-module CCutrer::SerialPort::Posix
-  extend FFI::Library
-  ffi_lib FFI::Library::LIBC
+module CCutrer::SerialPort::Termios
+  NCCS = 32
+
+  class Termios < FFI::Struct
+    layout  :c_iflag, :uint,
+            :c_oflag, :uint,
+            :c_cflag, :uint,
+            :c_lflag, :uint,
+            :c_line, :uchar,
+            :c_cc, [ :uchar, NCCS ],
+            :c_ispeed, :uint,
+            :c_ospeed, :uint
+  end
 
+  # c_cc characters
   VTIME = 5
-  TCSANOW = 0
-  TCSETS = 0x5402
+  VMIN = 6
+
+  # c_iflag bits
   IGNPAR = 0000004
-  PARENB = 0000400
-  PARODD = 0001000
+
+  # c_cflag bits
+  CSIZE  = 0000060
   CSTOPB = 0000100
   CREAD  = 0000200
+  PARENB = 0000400
+  PARODD = 0001000
   CLOCAL = 0004000
-  VMIN = 6
-  NCCS = 32
 
   DATA_BITS = {
     5 => 0000000,
@@ -58,27 +71,15 @@ module CCutrer::SerialPort::Posix
   }
 
   PARITY = {
-    :none => 0000000,
-    :even => PARENB,
-    :odd => PARENB | PARODD,
+    none: 0000000,
+    even: PARENB,
+    odd: PARENB | PARODD,
   }
 
-  STOPBITS = {
-    1 => 0x00000000,
+  STOP_BITS = {
+    1 => 0000000,
     2 => CSTOPB
   }
 
-  class Termios < FFI::Struct
-    layout  :c_iflag, :uint,
-            :c_oflag, :uint,
-            :c_cflag, :uint,
-            :c_lflag, :uint,
-            :c_line, :uchar,
-            :cc_c, [ :uchar, NCCS ],
-            :c_ispeed, :uint,
-            :c_ospeed, :uint
-  end
-
-  attach_function :tcsetattr, [ :int, :int, Termios ], :int, blocking: true
-  attach_function :tcgetattr, [ :int, Termios ], :int, blocking: true
+  TCSANOW = 0
 end

data/lib/ccutrer/serial_port/osx.rb

@@ -1,20 +1,33 @@
-# Copyright (c) 2014-2016 The Hybrid Group, 2020 Cody Cutrer
+# Copyright (c) 2014-2016 The Hybrid Group, 2020-2021 Cody Cutrer
 
-module CCutrer::SerialPort::Posix
-  extend FFI::Library
-  ffi_lib FFI::Library::LIBC
+module CCutrer::SerialPort::Termios
+  NCCS = 20
 
-  IGNPAR = 0x00000004
-  PARENB = 0x00001000
-  PARODD = 0x00002000
+  class Termios < FFI::Struct
+    layout  :c_iflag, :ulong,
+            :c_oflag, :ulong,
+            :c_cflag, :ulong,
+            :c_lflag, :ulong,
+            :c_line, :uchar,
+            :c_cc, [ :uchar, NCCS ],
+            :c_ispeed, :ulong,
+            :c_ospeed, :ulong
+  end
+
+  # c_cc characters
   VMIN = 16
   VTIME = 17
-  CLOCAL = 0x00008000
+
+  # c_iflag bits
+  IGNPAR = 0x00000004
+
+  # c_cflag bits
+  CSIZE  = 0x00000700
   CSTOPB = 0x00000400
   CREAD  = 0x00000800
-  CCTS_OFLOW = 0x00010000 # Clearing this disables RTS AND CTS.
-  TCSANOW = 0
-  NCCS = 20
+  PARENB = 0x00001000
+  PARODD = 0x00002000
+  CLOCAL = 0x00008000
 
   DATA_BITS = {
     5 => 0x00000000,
@@ -55,22 +68,10 @@ module CCutrer::SerialPort::Posix
     :odd => PARENB | PARODD,
   }
 
-  STOPBITS = {
+  STOP_BITS = {
     1 => 0x00000000,
     2 => CSTOPB
   }
 
-  class Termios < FFI::Struct
-    layout  :c_iflag, :ulong,
-            :c_oflag, :ulong,
-            :c_cflag, :ulong,
-            :c_lflag, :ulong,
-            :c_line, :uchar,
-            :cc_c, [ :uchar, NCCS ],
-            :c_ispeed, :ulong,
-            :c_ospeed, :ulong
-  end
-
-  attach_function :tcsetattr, [ :int, :int, Termios ], :int, blocking: true
-  attach_function :tcgetattr, [ :int, Termios ], :int, blocking: true
+  TCSANOW = 0
 end

data/lib/ccutrer/serial_port/posix.rb

@@ -0,0 +1,10 @@
+# Copyright (c) 2014-2016 The Hybrid Group, 2020-2021 Cody Cutrer
+
+module CCutrer::SerialPort::Termios
+  attach_function :cfgetispeed, [ Termios ], :uint, blocking: true
+  attach_function :cfgetospeed, [ Termios ], :uint, blocking: true
+  attach_function :cfsetispeed, [ Termios, :uint ], :int, blocking: true
+  attach_function :cfsetospeed, [ Termios, :uint ], :int, blocking: true
+  attach_function :tcsetattr, [ :int, :int, Termios ], :int, blocking: true
+  attach_function :tcgetattr, [ :int, Termios ], :int, blocking: true
+end

data/lib/ccutrer/serial_port/termios.rb

@@ -0,0 +1,6 @@
+# Copyright (c) 2014-2016 The Hybrid Group, 2020-2021 Cody Cutrer
+
+module CCutrer::SerialPort::Termios
+  extend FFI::Library
+  ffi_lib FFI::Library::LIBC
+end

data/lib/ccutrer/serial_port/version.rb

@@ -2,6 +2,6 @@
 
 module CCutrer
   class SerialPort < File
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ccutrer-serialport
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -78,6 +78,8 @@ files:
 - lib/ccutrer/serial_port.rb
 - lib/ccutrer/serial_port/linux.rb
 - lib/ccutrer/serial_port/osx.rb
+- lib/ccutrer/serial_port/posix.rb
+- lib/ccutrer/serial_port/termios.rb
 - lib/ccutrer/serial_port/version.rb
 - spec/serialport_spec.rb
 - spec/spec_helper.rb
@@ -100,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Linux/OS X RS-232 serial port communication