PinStatusFcn (External Interfaces)

Specify the M-file callback function to execute when the CD, CTS, DSR, or RI pins change state

Description

You configure PinStatusFcn to execute an M-file callback function when a pin status event occurs. A pin status event occurs when the Carrier Detect (CD), Clear to Send (CTS), Data Set Ready (DSR) or Ring Indicator (RI) pin changes state. A serial port pin changes state when it is asserted or unasserted. Information about the state of these pins is recorded in the PinStatus property.

Note A pin status event can be generated at any time during the serial port session.

If the RecordStatus property value is on, and a pin status event occurs, the record file records this information:

The event type as PinStatus
The pin that changed its state, and the pin state as either on or off
The time the event occurred using the format day-month-year hour:minute:second:millisecond

Refer to Creating and Executing Callback Functions to learn how to create a callback function.

Characteristics

Read only
Never

Data type
Callback function

Read only	Never
Data type	Callback function

Values

The default value is an empty string.

See Also

Functions

record

Properties

PinStatus, RecordStatus

PinStatus Port