External Interfaces Reference |
Read one line of text from the device and include the terminator
Syntax
Arguments
Description
tline = fgets(obj)
reads one line of text from the device connected to obj
, and returns the data to tline
. The returned data includes the terminator with the text line. To exclude the terminator, use fgetl
.
[tline,count] = fgets(obj)
returns the number of values read to count
.
[tline,count,msg] = fgets(obj)
returns a warning message to msg
if the read operation was unsuccessful.
Remarks
Before you can read text from the device, it must be connected to obj
with the fopen
function. A connected serial port object has a Status
property value of open
. An error is returned if you attempt to perform a read operation while obj
is not connected to the device.
If msg
is not included as an output argument and the read operation was not successful, then a warning message is returned to the command line.
The ValuesReceived
property value is increased by the number of values read - including the terminator - each time fgets
is issued.
If you use the help
command to display help for fgets
, then you need to supply the pathname shown below.
Rules for Completing a Read Operation with fgets
A read operation with fgets
blocks access to the MATLAB command line until:
Terminator
property is reached.
Timeout
property passes.
Example
Create the serial port object s
, connect s
to a Tektronix TDS 210 oscilloscope, and write the RS232?
command with the fprintf
function. RS232?
instructs the scope to return serial port communications settings.
Because the default value for the ReadAsyncMode
property is continuous
, data is automatically returned to the input buffer.
Use fgets
to read the data returned from the previous write operation, and include the terminator.
Disconnect s
from the scope, and remove s
from memory and the workspace.
Functions
Properties
BytesAvailable
, BytesAvailableFcn
, InputBufferSize
, Status
, Terminator
, Timeout
, ValuesReceived
fgetl (serial) | fopen (serial) |
© 1994-2005 The MathWorks, Inc.