nScopeAPI  v0.8
Functions
nScopeAPI_trigger.h File Reference

contains function headers for controlling the nScope trigger function More...

Functions

NSCOPE_API ErrorType nScope_set_trigger_on (ScopeHandle nScope, bool triggerOn)
 Set the trigger on/off state. More...
 
NSCOPE_API ErrorType nScope_get_trigger_on (ScopeHandle nScope, bool *triggerOn)
 Get the trigger on/off state. More...
 
NSCOPE_API ErrorType nScope_set_trigger_source (ScopeHandle nScope, int triggerSource)
 Set the trigger source channel. More...
 
NSCOPE_API ErrorType nScope_get_trigger_source (ScopeHandle nScope, int *triggerSource)
 Get the trigger source channel. More...
 
NSCOPE_API ErrorType nScope_set_trigger_edge (ScopeHandle nScope, TriggerEdge triggerEdge)
 Set the trigger edge condition. More...
 
NSCOPE_API ErrorType nScope_get_trigger_edge (ScopeHandle nScope, TriggerEdge *triggerEdge)
 Get the trigger edge condition. More...
 
NSCOPE_API ErrorType nScope_set_trigger_level (ScopeHandle nScope, double triggerLevel)
 Set the trigger level. More...
 
NSCOPE_API ErrorType nScope_get_trigger_level (ScopeHandle nScope, double *triggerLevel)
 Get the trigger level. More...
 
NSCOPE_API ErrorType nScope_set_trigger_delay_ms (ScopeHandle nScope, double triggerDelay)
 Set the trigger delay in milliseconds. More...
 
NSCOPE_API ErrorType nScope_get_trigger_delay_ms (ScopeHandle nScope, double *triggerDelay)
 Get the trigger delay in milliseconds. More...
 
NSCOPE_API ErrorType nScope_set_trigger_delay_us (ScopeHandle nScope, double triggerDelay)
 Set the trigger delay in microseconds. More...
 
NSCOPE_API ErrorType nScope_get_trigger_delay_us (ScopeHandle nScope, double *triggerDelay)
 Get the trigger delay in microseconds. More...
 

Documentation

contains function headers for controlling the nScope trigger function

Function Documentation

NSCOPE_API ErrorType nScope_get_trigger_delay_ms ( ScopeHandle  nScope,
double *  triggerDelay 
)

Get the trigger delay in milliseconds.

The trigger delay sets the amount of time before the trigger event the scope records data

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[out]triggerDelaypointer to double to store the current trigger delay in milliseconds
NSCOPE_API ErrorType nScope_get_trigger_delay_us ( ScopeHandle  nScope,
double *  triggerDelay 
)

Get the trigger delay in microseconds.

The trigger delay sets the amount of time before the trigger event the scope records data

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[out]triggerDelaypointer to double to store the current trigger delay in microseconds
NSCOPE_API ErrorType nScope_get_trigger_edge ( ScopeHandle  nScope,
TriggerEdge triggerEdge 
)

Get the trigger edge condition.

The trigger edge condition specifies which edge (rising or falling) will trigger a sweep.

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[out]triggerEdgepointer to a TriggerEdge to store the result
NSCOPE_API ErrorType nScope_get_trigger_level ( ScopeHandle  nScope,
double *  triggerLevel 
)

Get the trigger level.

The trigger source is the channel that is used to trigger a sweep.

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[out]triggerLevelpointer to double to store the current trigger level
NSCOPE_API ErrorType nScope_get_trigger_on ( ScopeHandle  nScope,
bool *  triggerOn 
)

Get the trigger on/off state.

A true state means the triggering on and will trigger on the current source, level, and edge state.

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[out]triggerOnpointer to variable to store the state of the trigger
NSCOPE_API ErrorType nScope_get_trigger_source ( ScopeHandle  nScope,
int *  triggerSource 
)

Get the trigger source channel.

The trigger source is the channel that is used to trigger a sweep.

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[out]triggerSourcepointer to int to store the trigger source channel
NSCOPE_API ErrorType nScope_set_trigger_delay_ms ( ScopeHandle  nScope,
double  triggerDelay 
)

Set the trigger delay in milliseconds.

The trigger delay sets the amount of time before the trigger event the scope records data

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]triggerDelaytrigger delay in milliseconds
NSCOPE_API ErrorType nScope_set_trigger_delay_us ( ScopeHandle  nScope,
double  triggerDelay 
)

Set the trigger delay in microseconds.

The trigger delay sets the amount of time before the trigger event the scope records data

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]triggerDelaytrigger delay in microseconds
NSCOPE_API ErrorType nScope_set_trigger_edge ( ScopeHandle  nScope,
TriggerEdge  triggerEdge 
)

Set the trigger edge condition.

The trigger edge condition specifies which edge (rising or falling) will trigger a sweep.

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]triggerEdgenumber 1-4 specifying the trigger channel
NSCOPE_API ErrorType nScope_set_trigger_level ( ScopeHandle  nScope,
double  triggerLevel 
)

Set the trigger level.

The scope will be triggered when the source crosses the trigger level in the direction specified

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]triggerLevelvoltage to se the trigger crossing detection
NSCOPE_API ErrorType nScope_set_trigger_on ( ScopeHandle  nScope,
bool  triggerOn 
)

Set the trigger on/off state.

A true state means the triggering on and will trigger on the current source, level, and edge state.

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]triggerOntrue: set the trigger on, false: turn it off
NSCOPE_API ErrorType nScope_set_trigger_source ( ScopeHandle  nScope,
int  triggerSource 
)

Set the trigger source channel.

The trigger source is the channel that is used to trigger a sweep.

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]triggerSourcenumber 1-4 specifying the trigger channel