configureTerminator
Set terminator for ASCII string communication with serial port
Syntax
Description
configureTerminator(
defines the terminator for both read and write communications with the specified serial
port. Allowed terminator values are device
,terminator
)"LF"
(default),
"CR"
, "CR/LF"
, and integer values from
0
to 255
. The syntax sets the
Terminator
property of device
.
After you set the terminator, use writeline
and
readline
to write and read ASCII terminated string data.
configureTerminator(
defines separate terminators for read and write communications.device
,readterminator,writeterminator
)
Examples
Set Same Terminator for Read and Write Communication
Create a connection to a serial port device using
serialport
.
device = serialport("COM3",9600)
device = Serialport with properties: Port: "COM3" BaudRate: 9600 NumBytesAvailable: 0 Show all properties, functions
Set both the read and write terminators to "CR/LF"
.
configureTerminator(device,"CR/LF")
Confirm the change.
device.Terminator
ans = "CR/LF"
Set Different Terminators for Read and Write Communication
Create a connection to a serial port device using
serialport
.
device = serialport("COM3",9600)
device = Serialport with properties: Port: "COM3" BaudRate: 9600 NumBytesAvailable: 0 Show all properties, functions
Set the read terminator to "CR"
and the write terminator to
10
.
configureTerminator(device,"CR",10)
Confirm the change.
device.Terminator
ans=1×2 cell array
{["CR"]} {[10]}
The first element in the array is the read terminator and the second is the write terminator.
Write and Read Line of ASCII Data from Serial Port Device
Create a connection to a serial port device. In this example, the serial port at
COM3
is connected to a loopback device.
device = serialport("COM3",9600)
device = Serialport with properties: Port: "COM3" BaudRate: 9600 NumBytesAvailable: 0 Show all properties, functions
Check the default ASCII terminator.
device.Terminator
ans = "LF"
Set the terminator to "CR"
and write a string of ASCII data. The
writeline
function automatically appends the terminator to the
data.
configureTerminator(device,"CR") writeline(device,"hello")
Write another string of ASCII data with the terminator automatically appended.
writeline(device,"world")
Since the port is connected to a loopback device, the data you write to the device
is returned to MATLAB®. Read a string of ASCII data. The readline
function
returns data until it reaches a terminator.
readline(device)
ans = "hello"
Read a string of ASCII data again to return the second string that you wrote.
readline(device)
ans = "world"
Clear the serial port connection.
clear device
Input Arguments
device
— Serial port connection
serialport
object
Serial port connection, specified as a serialport
object.
Example: configureTerminator(device,"CR")
sets the terminator on
the serial port connection device
.
terminator
— ASCII terminator
"LF"
(default) | "CR"
| "CR/LF"
| 0 to 255
ASCII terminator for read and write communication, specified as
"LF"
, "CR"
, "CR/LF"
, or a
numeric integer value from 0 to 255. Use this form when setting the same terminator for
both read and write. When reading from the serial port with a terminator value of
"CR/LF"
, the read terminates on the occurrence of
CR
and LF
together. When writing to the serial
port with a terminator value of "CR/LF"
, the write terminates by
adding both CR
and LF
. This input argument sets
the Terminator
property.
Example: configureTerminator(device,"CR/LF")
sets both the read
and write terminators to "CR/LF"
.
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| char
| string
readterminator,writeterminator
— ASCII terminators for read and write
"LF"
(default) | "CR"
| "CR/LF"
| 0 to 255
ASCII terminators for read or write communication, specified as
"LF"
, "CR"
, "CR/LF"
, or a
numeric integer value from 0 to 255. Use this form when setting different terminators
for read and write. When reading from the serial port with a terminator value of
"CR/LF"
, the read terminates on the occurrence of
CR
and LF
together. When writing to the serial
port with a terminator value of "CR/LF"
, the write terminates by
adding both CR
and LF
. This input argument sets
the Terminator
property.
Example: configureTerminator(device,"CR",10)
sets the read
terminator to "CR"
and write terminator to
10
.
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| char
| string
Version History
Introduced in R2019b
Commande MATLAB
Vous avez cliqué sur un lien qui correspond à cette commande MATLAB :
Pour exécuter la commande, saisissez-la dans la fenêtre de commande de MATLAB. Les navigateurs web ne supportent pas les commandes MATLAB.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)