| MATLAB® | |
| On this page… |
|---|
Each serial port property description contains some or all of this information:
The property name
A description of the property
The property characteristics, including:
Read only — The condition under which the property is read only
A property can be read-only always, never, while the serial port object is open, or while the serial port object is recording. You can configure a property value using the set function or dot notation. You can return the current property value using the get function or dot notation.
Data type — the property data type
This is the data type you use when specifying a property value.
Valid property values including the default value
When property values are given by a predefined list, the default value is usually indicated by {}.
An example using the property
Related properties and functions
The serial port object properties are briefly described below, and organized into categories based on how they are used. Following this section the properties are listed alphabetically and described in detail.
| Communications Properties | |
|---|---|
Rate at which bits are transmitted | |
Number of data bits to transmit | |
Type of parity checking | |
Number of bits used to indicate the end of a byte | |
Terminator character |
| Write Properties | |
|---|---|
Number of bytes currently in the output buffer | |
Size of the output buffer in bytes | |
Waiting time to complete a read or write operation | |
Indicate if an asynchronous read or write operation is in progress | |
Total number of values written to the device |
| Read Properties | |
|---|---|
Number of bytes available in the input buffer | |
Size of the input buffer in bytes | |
Specify whether an asynchronous read operation is continuous or manual | |
Waiting time to complete a read or write operation | |
Indicate if an asynchronous read or write operation is in progress | |
Total number of values read from the device |
| Callback Properties | |
|---|---|
M-file callback function to execute when a break-interrupt event occurs | |
M-file callback function to execute when a specified number of bytes is available in the input buffer, or a terminator is read | |
Number of bytes that must be available in the input buffer to generate a bytes-available event | |
Specify if the bytes-available event is generated after a specified number of bytes is available in the input buffer, or after a terminator is read | |
M-file callback function to execute when an error event occurs | |
M-file callback function to execute when the output buffer is empty | |
M-file callback function to execute when the CD, CTS, DSR, or RI pins change state | |
M-file callback function to execute when a predefined period of time passes | |
Period of time between timer events |
| Control Pin Properties | |
|---|---|
State of the DTR pin | |
Data flow control method to use | |
State of the CD, CTS, DSR, and RI pins | |
State of the RTS pin |
| Recording Properties | |
|---|---|
Amount of information saved to a record file | |
Specify whether data and event information are saved to one record file or to multiple record files | |
Name of the record file | |
Indicate if data and event information are saved to a record file |
| General Purpose Properties | |
|---|---|
Order in which the device stores bytes | |
Descriptive name for the serial port object | |
Platform-specific serial port name | |
Indicate if the serial port object is connected to the device | |
Label to associate with a serial port object | |
Object type | |
Data you want to associate with a serial port object |
| Disconnecting and Cleaning Up | Properties — Alphabetical List | |
| © 1984-2008- The MathWorks, Inc. - Site Help - Patents - Trademarks - Privacy Policy - Preventing Piracy - RSS |