configureTerminator

Set terminator for ASCII string communication with Bluetooth device

collapse all in page

Syntax

configureTerminator(device,terminator)
configureTerminator(device,readterminator,writeterminator)

Description

configureTerminator(device,terminator) defines the terminator for both read and write communications with the specified Bluetooth® device. 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.

example

Examples

collapse all

Create a connection to a nearby Bluetooth device. 

device = bluetooth("TestDevice")
device = 
  bluetooth with properties:

                 Name: "TestDevice"
              Address: "BC275C50533C"
              Channel: 1
    NumBytesAvailable: 0
      NumBytesWritten: 0

  Show all properties

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 nearby Bluetooth device. 

device = bluetooth("TestDevice")
device = 
  bluetooth with properties:

                 Name: "TestDevice"
              Address: "BC275C50533C"
              Channel: 1
    NumBytesAvailable: 0
      NumBytesWritten: 0

  Show all properties

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 nearby Bluetooth device. In this example, the HC-06 Bluetooth module is configured as a loopback device.

device = bluetooth("HC-06")
device = 
  bluetooth with properties:

                 Name: "HC-06"
              Address: "98D331FB3B77"
              Channel: 1
    NumBytesAvailable: 0
      NumBytesWritten: 0

  Show all properties

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 device is configured as 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 Bluetooth connection.

clear device

Input Arguments

collapse all

Bluetooth device connection, specified as a bluetooth object.

Example: configureTerminator(device,"CR") sets the terminator value for the Bluetooth 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 device with a terminator value of "CR/LF", the read terminates on the occurrence of CR and LF together. When writing to the device 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 device with a terminator value of "CR/LF", the read terminates on the occurrence of CR and LF together. When writing to the device 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 R2020b

See Also

Functions