Method: Cosmos::SerialStream#initialize

Defined in:
lib/cosmos/streams/serial_stream.rb

#initialize(write_port_name, read_port_name, baud_rate, parity, stop_bits, write_timeout, read_timeout, flow_control = :NONE, data_bits = 8) ⇒ SerialStream

Returns a new instance of SerialStream.

Parameters:

  • write_port_name (String) —

    The name of the serial port to write. Pass nil if the stream is to be read only. On Windows the port name is typically 'COMX' where X can be any port number. On UNIX the port name is typically a device such as '/dev/ttyS0'.

  • read_port_name (String) —

    The name of the serial port to read. Pass nil if the stream is to be read only. On Windows the port name is typically 'COMX' where X can be any port number. On UNIX the port name is typically a device such as '/dev/ttyS0'.

  • baud_rate (Integer) —

    The serial port baud rate

  • parity (Symbol) —

    Must be :NONE, :EVEN, or :ODD

  • stop_bits (Integer) —

    Number of stop bits. Must be 1 or 2.

  • write_timeout (Integer) —

    Number of seconds to wait for the write to complete. Pass nil to create no timeout. The Cosmos::SerialDriver will continously try to send the data until it has been sent or an error occurs.

  • read_timeout (Integer) —

    Number of seconds to wait for the read to complete. Pass nil to create no timeout. The Cosmos::SerialDriver will continously try to read data until it has received data or an error occurs.

  • flow_control (Symbol) (defaults to: :NONE) —

    Currently supported :NONE and :RTSCTS (default :NONE)

  • data_bits (Integer) (defaults to: 8) —

    Number of data bits (default 8)



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/cosmos/streams/serial_stream.rb', line 49

def initialize(write_port_name,
               read_port_name,
               baud_rate,
               parity,
               stop_bits,
               write_timeout,
               read_timeout,
               flow_control = :NONE,
               data_bits = 8)
  super()

  # The SerialDriver class will validate the parameters
  @write_port_name = ConfigParser.handle_nil(write_port_name)
  @read_port_name  = ConfigParser.handle_nil(read_port_name)
  @baud_rate       = Integer(baud_rate)
  @parity          = parity
  @stop_bits       = stop_bits.to_i
  @write_timeout   = ConfigParser.handle_nil(write_timeout)
  @write_timeout   = @write_timeout.to_f if @write_timeout
  @read_timeout    = ConfigParser.handle_nil(read_timeout)
  @read_timeout    = @read_timeout.to_f if @read_timeout
  @flow_control    = flow_control.to_s.intern
  @data_bits       = data_bits.to_i

  if @write_port_name
    @write_serial_port = SerialDriver.new(@write_port_name,
                                          @baud_rate,
                                          @parity,
                                          @stop_bits,
                                          @write_timeout,
                                          @read_timeout,
                                          @flow_control,
                                          @data_bits)
  else
    @write_serial_port = nil
  end
  if @read_port_name
    if @read_port_name == @write_port_name
      @read_serial_port = @write_serial_port
    else
      @read_serial_port = SerialDriver.new(@read_port_name,
                                           @baud_rate,
                                           @parity,
                                           @stop_bits,
                                           @write_timeout,
                                           @read_timeout,
                                           @flow_control,
                                           @data_bits)
    end
  else
    @read_serial_port = nil
  end
  if @read_serial_port.nil? && @write_serial_port.nil?
    raise "Either a write port or read port must be given"
  end

  # We 'connect' when we create the stream
  @connected = true

  # Mutex on write is needed to protect from commands coming in from more
  # than one tool
  @write_mutex = Mutex.new
end