getpinstatus

Get serial pin status

Since R2019b

Syntax

status = getpinstatus(device)

Description

status = getpinstatus(device) gets the serial pin status and returns it as a structure to status.

Examples

Get Serial Pin Status

Get the serial pin status for the specified port.

device = serialport("COM3",9600);
 ⋮
status = getpinstatus(device)

status = 

  struct with fields:

      ClearToSend: 1
     DataSetReady: 1
    CarrierDetect: 1
    RingIndicator: 0

Get Serial Pin Status Using VISA

Get the serial pin status for the specified port using the VISA-Serial interface.

device = visadev("COM3");
 ⋮
status = getpinstatus(device)

status = 

  struct with fields:

      ClearToSend: 1
     DataSetReady: 1
    CarrierDetect: 1
    RingIndicator: 0

Input Arguments

device — Serial port connection

serialport object | visadev object

Serial port, specified as a serialport object or visadev object.

Example: getpinstatus(device) returns the serial pin status for the serial port connection device.

Example: getpinstatus(device) returns the serial pin status for the VISA-Serial resource device.

Output Arguments

status — Pin status

structure

Pin status, returned as a structure with the logical type fields named ClearToSend, DataSetReady, CarrierDetect, and RingIndicator.

Version History

Introduced in R2019b