Gx3722SerialOutGetArmState

Purpose

Returns the specified serial-out channel arm state.

Syntax

Gx3722SerialOutGetArmState (nHandle, nChannel, pnArmState, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Handle to a GX3722 board.  
nChannel
SHORT
Channel to get, channels are 0-2:
0.      GX3722_SERIAL_PAL_CH0: Channel 0.
1.      GX3722_SERIAL_PAL_CH1: Channel 1.
2.    GX3722_SERIAL_PAL_CH2: Channel 2.   
pnArmState
PSHORT
Returned arm state:
0.      GX3722_SERIAL_ARM_STATE_OFF: Arm is OFF, the channel will not response to any trigger.
1.    GX3722_SERIAL_ARM_STATE_ON: Arm is OFF, the channel will response to any trigger.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

When the specified channel arm state set to ON, and trigger mode set to continuous, each trigger (regardless of its source), will transmit the programmed data. If the trigger mode set to One-Short, after each trigger the Arm state will be set to Off state, require the user to set the Arm state again. This ensures that only a single trigger will be executed.

Channels 0-2 can be programmed to operate as serial-out transmitter or as Static I/O, see Gx3722SerialOutSetMode() API for more details. When any of Channels 0-2 are set to Serial-out, all 4 channels direction is set to output.

Example

See the Gx3722SerialOutGetStatus () API for complete example.

The following example returns channel 0 arm state:

 

SHORT nHandle, nStatus;

SHORT nArmState;

Gx3722SerialOutGetArmState (nHandle, GX3722_SERIAL_PAL_CH0, &nArmState, &nStatus);

 

See Also

Gx3722SerialOutReset, Gx3722SerialOutSetArmState, Gx3722SerialOutSetBitRate, Gx3722SerialOutSetData, Gx3722SerialOutSetDataBitsPulseWidth, Gx3722SerialOutSetMode, Gx3722SerialOutSetNumOfDataBits, Gx3722SerialOutSetShiftMode, Gx3722SerialOutSetTriggerDelay, Gx3722SerialOutSetTriggerSource, Gx3722SerialOutTrig, GxFpgaGetErrorString