Functions for handling with further basic settings

These functions are handling with basic settings as a whole. More...

Functions
ScStatus	scGetBasicSettings (int devIdx, ScBasicSettings *bsP)
	Retrieves the actual basic settings parameters. More...
ScStatus	scSetBasicSettings (int devIdx, ScBasicSettings *bsP)
	Sets and retrieves the actual basic settings parameters. More...
ScStatus	scGetNullRad (int devIdx, int *nullRadP)
	Retrieves the device's null radius (threshold). More...
ScStatus	scSetNullRad (int devIdx, int *nullRadP)
	Sets and retrieves the device's null radius (threshold). More...
ScStatus	scSetStdZero (int devIdx)
	Sets the actual displacement of the cap as the standard 0 value. More...

Detailed Description

These functions are handling with basic settings as a whole.

Function Documentation

scGetBasicSettings()

ScStatus scGetBasicSettings	(	int	devIdx,
		ScBasicSettings *	bsP
	)

Retrieves the actual basic settings parameters.

Example:

int             devIdx = 0;
ScBasicSettings bs;
ScStatus        status = scGetBasicSettings(devIdx, &bs);
if (status == SC_OK)
   printf("the threshold is %d\n", bs.mNullRadius);
else
   printf("error\n");

Parameters

devIdx

index of the device the parameters are requested

Return values

bsP	pointer to the basic settings parameters to be retrieved

Returns

SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

scGetNullRad()

ScStatus scGetNullRad	(	int	devIdx,
		int *	nullRadP
	)

Retrieves the device's null radius (threshold).

If the null radius is set to higher values you need a larger displacement of the cap to cause the device sending standard data.
Example:

int      devIdx = 0;
int      nullRad;
ScStatus status = scGetNullRad(devIdx, &nullRad);
if (status == SC_OK)
   printf("null radius: %d\n", nullRad);
else
   printf("error\n");

Parameters

devIdx

the index of the device to be requested

Return values

nullRadP

actual null radius (0..15)

Returns

SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

scSetBasicSettings()

ScStatus scSetBasicSettings	(	int	devIdx,
		ScBasicSettings *	bsP
	)

Sets and retrieves the actual basic settings parameters.

Example:

int             devIdx = 0;
ScBasicSettings bs;
ScStatus        status = scGetBasicSettings(devIdx, &bs); // get the actual values
if (status == SC_OK)
   printf("the threshold is %d\n", bs.mNullRadius);
else
   printf("error\n");
bs.mNullRadius = 10;                          // change one value
status = scSetBasicSettings(devIdx, &bs);     // write the values back
if (status == SC_OK)
   printf("the threshold is now %d\n", bs.mNullRadius);
else
   printf("error\n");

Parameters

devIdx

index of the device the parameters are requested

Return values

bsP	pointer to the sensitivity structure to be retrieved

Returns

SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX, SC_PARAMETER_OUT_OF_RANGE

References SC_COMMUNICATION_ERROR, SC_OK, SC_PARAMETER_OUT_OF_RANGE, and SC_WRONG_DEVICE_INDEX.

scSetNullRad()

ScStatus scSetNullRad	(	int	devIdx,
		int *	nullRadP
	)

Sets and retrieves the device's null radius (threshold).

If the null radius is set to higher values you need a larger displacement of the cap to cause the device sending standard data.
Example:

int devIdx  = 0;
int nullRad = 10;
ScStatus status = scSetNullRad(devIdx, &nullRad);
if (status == SC_OK)
   printf("null radius: %d\n", nullRad);
else
   printf("error\n");

Parameters

devIdx

the index of the device the data is to be set

Return values

nullRadP

actual null radius (0..15)

Returns

SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX, SC_PARAMETER_OUT_OF_RANGE

References MAX_NULL_RAD, MIN_NULL_RAD, SC_COMMUNICATION_ERROR, SC_OK, SC_PARAMETER_OUT_OF_RANGE, and SC_WRONG_DEVICE_INDEX.

scSetStdZero()

ScStatus scSetStdZero

(

int

devIdx

)

Sets the actual displacement of the cap as the standard 0 value.

All subsequent standard data is calculated relative to this 0 value.
Example:

int      devIdx  = 0;
ScStatus status = scSetStdZero(devIdx);
if (status == SC_OK)
   printf("ok\n");
else
   printf("error\n");

Parameters

devIdx

the index of the device the data is to be set

Returns

SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.