Main Content

PinStatusFcn

Specify callback function to execute when CD, CTS, DSR, or RI pin changes state

Description

You configure PinStatusFcn to execute a 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 instrument control 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 pin state as either on or off

  • The time the event occurred using the format day-month-year hour:minute:second:millisecond

Characteristics

Usage

Serial port

Read only

Never

Data type

Callback function

Values

The default value is an empty character vector.

See Also

Functions

record