Instrument-control Toolkit - serial
- Loadable Function:
serial =
serial([path], [baudrate], [timeout])
-
Open serial interface.
Inputs
path - the interface path of type String.
baudrate - the baudrate of interface. If omitted defaults to 115200.
timeout - the interface timeout value. If omitted defaults to blocking call.Outputs
The serial() shall return an instance of octave_serial class as the result serial.
Properties
The serial object has the following public properties:
- name
name assigned to the object
- type
instrument type ’serial’ (readonly)
- port
OS specific port name (readonly)
- status
status of the object ’open’ or ’closed’ (readonly)
- timeout
timeout value used for waiting for data
- bytesavailable
number of bytes currently available to read (readonly)
- stopbits
number of stopbits to use
- requesttosend
request to send state - ’on’ or ’off’
- parity
Parity setting ’none’, ’even’, ’odd’
- bytesize
Number of bits to a byte (7 or 8)
- baudrate
Baudrate setting
- dataterminalready
state of dataterminal ready - ’on’ or ’off’
- pinstatus
current state of pins (readonly)