@@ -33,7 +33,7 @@ is right out for now. Watch this space for further developments! == USAGE The following code will read a 10-character string from the specified port, -using the default port settings (9600/8/n/1) +using the default port settings (9600/8/n/1/no flow control) @port = RB232::Port.new('/dev/ttyUSB0') message = @port.read_string(10) @@ -43,7 +43,8 @@ You can provide alternative settings when you create a new port: RB232::Port.new('/dev/ttyS0', :baud_rate => 19200, :data_bits => 7, :parity => true, - :stop_bits => 2) + :stop_bits => 2, + :hardware_flow_control => true) See http://github.com/Floppy/rb232/tree/master/spec/port_spec.rb or RB232::Port documentation for more details. README @@ -71,11 +71,15 @@ describe RB232::Port do @port.stop_bits.should be(1) end + it "should have no flow control" do + @port.hardware_flow_control.should be_false + end + end describe "created with non-default options" do before :each do - @port = RB232::Port.new(TEST_PORT, :baud_rate => 19200, :data_bits => 7, :parity => true, :stop_bits => 2) + @port = RB232::Port.new(TEST_PORT, :baud_rate => 19200, :data_bits => 7, :parity => true, :stop_bits => 2, :hardware_flow_control => true) end it "should have a baud rate of 19200" do @@ -94,6 +98,10 @@ describe RB232::Port do @port.stop_bits.should be(2) end + it "should have flow control" do + @port.hardware_flow_control.should be_true + end + end describe "created with faulty options" do spec/port_spec.rb @@ -19,6 +19,7 @@ struct RB232_Port_Data { int data_bits; BOOL parity; int stop_bits; + BOOL hardware_flow_control; /* Internals */ int port_handle; struct termios settings; @@ -69,6 +70,7 @@ VALUE rb232_port_initialize_with_options(VALUE self, VALUE port, VALUE options) port_data->data_bits = rbx_int_from_hash_or_default(options, ID2SYM(rb_intern("data_bits")), 8); port_data->parity = rbx_bool_from_hash_or_default(options, ID2SYM(rb_intern("parity")), FALSE); port_data->stop_bits = rbx_int_from_hash_or_default(options, ID2SYM(rb_intern("stop_bits")), 1); + port_data->hardware_flow_control = rbx_bool_from_hash_or_default(options, ID2SYM(rb_intern("hardware_flow_control")), FALSE); /* Open the serial port */ port_data->port_handle = open(port_data->port_name, O_RDWR | O_NOCTTY | O_NONBLOCK); if (port_data->port_handle < 0) { @@ -161,6 +163,8 @@ VALUE rb232_port_initialize_with_options(VALUE self, VALUE port, VALUE options) default: rb_raise(rb_eArgError, "stop_bits must be 1 or 2"); } + /* Flow control */ + if (port_data->hardware_flow_control) port_data->settings.c_cflag |= CNEW_RTSCTS; /* Other settings */ port_data->settings.c_iflag = IGNPAR | ICRNL; port_data->settings.c_oflag = 0; @@ -230,7 +234,7 @@ VALUE rb232_port_get_data_bits(VALUE self) { * Get the parity setting, as set in the _options_ argument to Port#new. */ VALUE rb232_port_get_parity(VALUE self) { - /* Return baud rate */ + /* Return parity setting */ if (get_port_data(self)->parity == TRUE) return Qtrue; else @@ -245,6 +249,17 @@ VALUE rb232_port_get_stop_bits(VALUE self) { return rb_uint_new(get_port_data(self)->stop_bits); } +/* + * Get the hardware flow control setting, as set in the _options_ argument to Port#new. + */ +VALUE rb232_port_get_hardware_flow_control(VALUE self) { + /* Return flow control setting */ + if (get_port_data(self)->hardware_flow_control == TRUE) + return Qtrue; + else + return Qfalse; +} + /* * Read raw data from port */ src/port.c @@ -47,6 +47,11 @@ VALUE rb232_port_get_parity(VALUE self); VALUE rb232_port_get_stop_bits(VALUE self); /* + * Get the hardware flow control setting, as set in the _options_ argument to Port#new. + */ +VALUE rb232_port_get_hardware_flow_control(VALUE self); + +/* * Read _count_ raw byte values from the port. * Returns an array of values. Useful for binary protocols. * call-seq: src/port.h @@ -15,6 +15,7 @@ void Init_rb232() { rb_define_method(RB232_Port, "data_bits", rb232_port_get_data_bits, 0); /* in port.c */ rb_define_method(RB232_Port, "parity", rb232_port_get_parity, 0); /* in port.c */ rb_define_method(RB232_Port, "stop_bits", rb232_port_get_stop_bits, 0); /* in port.c */ + rb_define_method(RB232_Port, "hardware_flow_control", rb232_port_get_hardware_flow_control, 0); /* in port.c */ rb_define_method(RB232_Port, "read_bytes", rb232_port_read_bytes, 1); /* in port.c */ rb_define_method(RB232_Port, "read_string", rb232_port_read_string, 1); /* in port.c */ } src/rb232.c a91493a83329309e556243cc7a2e60a7063f4bad James Smith james@floppy.org.uk http://github.com/Floppy/rb232/commit/1becc4efc535897078b24d16bc1b0d21c7eb80f8 1becc4efc535897078b24d16bc1b0d21c7eb80f8 2009-10-29T15:31:13-07:00 2009-10-29T15:31:13-07:00 Add support for hardware flow control flag 042637d127719501d381b3aabeaaf7d0fc0d00ed James Smith james@floppy.org.uk