libtiepie
 All Files Functions Typedefs Groups
Input channels

Functions

uint16_t ScpGetChannelCount (TpDeviceHandle_t hDevice)
uint32_t ScpGetSharedChannelGroupCount (TpDeviceHandle_t hDevice)
uint32_t ScpGetSharedChannelGroup (TpDeviceHandle_t hDevice, uint32_t dwGroupIndex, uint16_t *pChannelNumbers, uint32_t dwLength)
bool8_t ScpChGetAutoRanging (TpDeviceHandle_t hDevice, uint16_t wCh)
bool8_t ScpChSetAutoRanging (TpDeviceHandle_t hDevice, uint16_t wCh, bool8_t bEnable)
uint32_t ScpChGetConnectorType (TpDeviceHandle_t hDevice, uint16_t wCh)
uint64_t ScpChGetCouplings (TpDeviceHandle_t hDevice, uint16_t wCh)
uint64_t ScpChGetCoupling (TpDeviceHandle_t hDevice, uint16_t wCh)
uint64_t ScpChSetCoupling (TpDeviceHandle_t hDevice, uint16_t wCh, uint64_t qwCoupling)
bool8_t ScpChGetEnabled (TpDeviceHandle_t hDevice, uint16_t wCh)
bool8_t ScpChSetEnabled (TpDeviceHandle_t hDevice, uint16_t wCh, bool8_t bEnable)
bool8_t ScpChIsDifferential (TpDeviceHandle_t hDevice, uint16_t wCh)
bool8_t ScpChIsDualRateCapable (TpDeviceHandle_t hDevice, uint16_t wCh)
double ScpChGetProbeGain (TpDeviceHandle_t hDevice, uint16_t wCh)
double ScpChSetProbeGain (TpDeviceHandle_t hDevice, uint16_t wCh, double dProbeGain)
uint32_t ScpChGetRanges (TpDeviceHandle_t hDevice, uint16_t wCh, double *pList, uint32_t dwLength)
uint32_t ScpChGetRangesEx (TpDeviceHandle_t hDevice, uint16_t wCh, uint64_t qwCoupling, double *pList, uint32_t dwLength)
double ScpChGetRange (TpDeviceHandle_t hDevice, uint16_t wCh)
double ScpChSetRange (TpDeviceHandle_t hDevice, uint16_t wCh, double dRange)

Detailed Description


Function Documentation

bool8_t ScpChGetAutoRanging ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Check whether auto ranging is enabled.

Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
Returns:
1 if enabled, 0 if disabled
uint32_t ScpChGetConnectorType ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get channel connector type.

See also:
Connector types
Parameters:
hDevicea device handle
Returns:
Channel connector type.
uint64_t ScpChGetCoupling ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get current coupling.

See also:
Coupling types
Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
Returns:
Current coupling, a CK_* value.
uint64_t ScpChGetCouplings ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get supported couplings.

See also:
Coupling types
Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
Returns:
Supported couplings, set of ORed CK_* values.
bool8_t ScpChGetEnabled ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Check whether channel is enabled.

Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
Returns:
1 if enabled, 0 if disabled.
double ScpChGetProbeGain ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get channel probe gain.

Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
Returns:
Current probe gain.
double ScpChGetRange ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get current range.

Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
Returns:
Current range.
uint32_t ScpChGetRanges ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
double *  pList,
uint32_t  dwLength 
)

Get supported ranges for current coupling.

Example:

uint32_t dwRangeCount = ScpChGetRanges( hDevice , wCh , NULL , 0 );
double Ranges[ dwRangeCount ];
dwRangeCount = ScpChGetRanges( hDevice , wCh , Ranges , dwRangeCount );
printf( "ScpChGetRanges (Ch%u):\n" , wCh + 1 );
for( uint32_t i = 0 ; i < dwRangeCount ; i++ )
printf( "- %f\n" , Ranges[ i ] );
See also:
ScpChGetRangesEx
Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
pListpointer to array
dwLengthnumber of elements in array
Returns:
Total number of ranges.
uint32_t ScpChGetRangesEx ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
uint64_t  qwCoupling,
double *  pList,
uint32_t  dwLength 
)

Get supported ranges by coupling.

See also:
ScpChGetRanges
Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
qwCouplingcoupling: a CK_* value
pListpointer to array
dwLengthnumber of elements in array
Returns:
total number of ranges
bool8_t ScpChIsDifferential ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Check whether the channel has a differential input.

Parameters:
hDevicea device handle
Returns:
1 if differential, else 0.
bool8_t ScpChIsDualRateCapable ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)
Parameters:
hDevicea device handle
bool8_t ScpChSetAutoRanging ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
bool8_t  bEnable 
)

Set auto ranging.

Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
bEnable?
Returns:
1 if enabled, 0 if disabled
uint64_t ScpChSetCoupling ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
uint64_t  qwCoupling 
)

Set coupling.

See also:
Coupling types
Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
qwCouplingcoupling: a CK_* value
Returns:
Current coupling, a CK_* value.
bool8_t ScpChSetEnabled ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
bool8_t  bEnable 
)

Set channel enable.

Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
bEnable?
Returns:
1 if enabled, 0 if disabled.
double ScpChSetProbeGain ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
double  dProbeGain 
)

Set channel probe gain.

Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
dProbeGainprobe gain
Returns:
Current probe gain.
double ScpChSetRange ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
double  dRange 
)

Set range.

Example:

double dRange = 10;
dRange = ScpChSetRange( hDevice , wCh , dRange );
printf( "ScpChSetRange = %f" , dRange );
Parameters:
hDevicea device handle
wChchannel number: 0..ScpGetChannelCount() - 1
dRangemaximum values that must fit within range
Returns:
current range
uint16_t ScpGetChannelCount ( TpDeviceHandle_t  hDevice)

Get total number of channels supported by the oscilloscope

Parameters:
hDevicea device handle
Returns:
number of channels
uint32_t ScpGetSharedChannelGroup ( TpDeviceHandle_t  hDevice,
uint32_t  dwGroupIndex,
uint16_t pChannelNumbers,
uint32_t  dwLength 
)
Parameters:
hDevicea device handle
uint32_t ScpGetSharedChannelGroupCount ( TpDeviceHandle_t  hDevice)
Parameters:
hDevicea device handle