Main Content

configureTerminator

Set terminator for ASCII string communication with VISA resource

    Description

    example

    configureTerminator(v,terminator) defines the terminator for both read and write communications with the VISA resource v. Allowed terminator values are "LF" (default), "CR", "CR/LF", and integer values from 0 to 255. The syntax sets the Terminator property of v.

    After you set the terminator, use writeline and readline to write and read ASCII-terminated string data.

    example

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

    Examples

    collapse all

    Create a connection to a VISA resource. This example shows a connection to a device with the alias COM4 using the VISA-Serial interface.

    v = visadev("COM4");

    Set both the read and write terminators to "CR/LF".

    configureTerminator(v,"CR/LF")

    Confirm the change.

    v.Terminator
    ans = 
    "CR/LF"
    

    Create a connection to a VISA resource. This example shows a connection to a device with the alias COM4 using the VISA-Serial interface.

    v = visadev("COM4");

    Set the read terminator to "CR" and the write terminator to 10.

    configureTerminator(v,"CR",10)

    Confirm the change.

    v.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.

    Input Arguments

    collapse all

    VISA resource, specified as a visadev object.

    Example: configureTerminator(v,"CR/LF") sets the terminator value for the VISA resource v.

    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 remote host with a terminator value of "CR/LF", the read terminates on an occurrence of CR and LF together. When writing to the remote host 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(v,"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 remote host with a terminator value of "CR/LF", the read terminates on an occurrence of CR and LF together. When writing to the remote host 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(v,"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 R2021a