nScopeAPI  v0.8
Functions
nScopeAPI_analogOutputs.h File Reference

contains function headers for controlling the nScope analog outputs More...

Functions

NSCOPE_API ErrorType nScope_set_AX_on (ScopeHandle nScope, int aChannel, bool aOn)
 Set the analog channel (on/off) More...
 
NSCOPE_API ErrorType nScope_get_AX_on (ScopeHandle nScope, int aChannel, bool *aOn)
 Get the analog channel (on/off) and store it in aOn. More...
 
NSCOPE_API ErrorType nScope_set_AX_frequency_in_hz (ScopeHandle nScope, int aChannel, double frequency)
 Set the analog channel output frequency. More...
 
NSCOPE_API ErrorType nScope_get_AX_frequency_in_hz (ScopeHandle nScope, int aChannel, double *frequency)
 Get the analog channel output frequency and store it in the given variable. More...
 
NSCOPE_API ErrorType nScope_set_AX_wave_type (ScopeHandle nScope, int aChannel, WaveType wave)
 Set the analog channel output wave type. More...
 
NSCOPE_API ErrorType nScope_get_AX_wave_type (ScopeHandle nScope, int aChannel, WaveType *wave)
 Get the analog channel output wave type. More...
 
NSCOPE_API ErrorType nScope_set_AX_unipolar (ScopeHandle nScope, int aChannel, bool isUnipolar)
 Set the analog channel unipolarity. More...
 
NSCOPE_API ErrorType nScope_get_AX_unipolar (ScopeHandle nScope, int aChannel, bool *isUnipolar)
 Get the analog channel unipolarity. More...
 
NSCOPE_API ErrorType nScope_set_AX_amplitude (ScopeHandle nScope, int aChannel, double amplitude)
 Set the analog channel amplitude. More...
 
NSCOPE_API ErrorType nScope_get_AX_amplitude (ScopeHandle nScope, int aChannel, double *amplitude)
 Get the analog channel amplitude. More...
 

Documentation

contains function headers for controlling the nScope analog outputs

Function Documentation

NSCOPE_API ErrorType nScope_get_AX_amplitude ( ScopeHandle  nScope,
int  aChannel,
double *  amplitude 
)

Get the analog channel amplitude.

Retreives the actual signal amplitude and puts it into the amplitude variable

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]aChannelthe channel (1 or 2) to query
[out]amplitudeactual signal amplitude in volts
NSCOPE_API ErrorType nScope_get_AX_frequency_in_hz ( ScopeHandle  nScope,
int  aChannel,
double *  frequency 
)

Get the analog channel output frequency and store it in the given variable.

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]aChannelthe channel (1 or 2) to query
[out]frequencypointer to double to store the actual signal frequency in hz
NSCOPE_API ErrorType nScope_get_AX_on ( ScopeHandle  nScope,
int  aChannel,
bool *  aOn 
)

Get the analog channel (on/off) and store it in aOn.

A true state means the analog channel is on and outputing voltage A false state means the analog channel is held at ground

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]aChannelthe channel (1 or 2) to query
[out]aOnpointer to a boolean to store the state of the analog channel
NSCOPE_API ErrorType nScope_get_AX_unipolar ( ScopeHandle  nScope,
int  aChannel,
bool *  isUnipolar 
)

Get the analog channel unipolarity.

Unipolar waves range from 0 to amplitude, bipolar waves range from -amplitude to amplitude

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]aChannelthe channel (1 or 2) to query
[out]isUnipolartrue if the wave is unipolar, false if it is not
NSCOPE_API ErrorType nScope_get_AX_wave_type ( ScopeHandle  nScope,
int  aChannel,
WaveType wave 
)

Get the analog channel output wave type.

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]aChannelthe channel (1 or 2) to query
[out]wavepointer to WaveType to store the current wave type
NSCOPE_API ErrorType nScope_set_AX_amplitude ( ScopeHandle  nScope,
int  aChannel,
double  amplitude 
)

Set the analog channel amplitude.

Unipolar waves range from 0 to amplitude, bipolar waves range from -amplitude to amplitude

Not all amplitude values can be acheived, nScope will automatically choose the closest approximation

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]aChannelthe channel (1 or 2) to set
[in]amplitudedesired signal amplitude in volts
NSCOPE_API ErrorType nScope_set_AX_frequency_in_hz ( ScopeHandle  nScope,
int  aChannel,
double  frequency 
)

Set the analog channel output frequency.

Not all frequency values can be acheived, nScope will automatically choose the closest approximation

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]aChannelthe channel (1 or 2) to set
[in]frequencydesired signal frequency in hz
NSCOPE_API ErrorType nScope_set_AX_on ( ScopeHandle  nScope,
int  aChannel,
bool  aOn 
)

Set the analog channel (on/off)

A true state means the analog channel is on and outputing voltage A false state means the analog channel is held at ground

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]aChannelthe channel (1 or 2) to turn on or off
[in]aOntrue: turn the channel on, false: turn it off
NSCOPE_API ErrorType nScope_set_AX_unipolar ( ScopeHandle  nScope,
int  aChannel,
bool  isUnipolar 
)

Set the analog channel unipolarity.

Unipolar waves range from 0 to amplitude, bipolar waves range from -amplitude to amplitude

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]aChannelthe channel (1 or 2) to set
[in]isUnipolartrue to set the output to be unipolar only, false to set it bipolar
NSCOPE_API ErrorType nScope_set_AX_wave_type ( ScopeHandle  nScope,
int  aChannel,
WaveType  wave 
)

Set the analog channel output wave type.

The output waves can be set to any one of the available WaveType

Returns
nScope ErrorType
Parameters
[in]nScopenScope handle
[in]aChannelthe channel (1 or 2) to set
[in]wavethe signal WaveType