Main Content

configureTerminator

Set terminator for ASCII string communication with serial port

Description

example

configureTerminator(device,terminator) defines the terminator for both read and write communications with the specified serial port. Allowed terminator values are "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.

example

configureTerminator(device,readterminator,writeterminator) defines separate terminators for read and write communications.

Examples

collapse all

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"

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.

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

collapse all

Serial port connection, specified as a serialport object.

Example: configureTerminator(device,"CR") sets the terminator on the serial port connection device.

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

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

Introduced in R2019b