Functions for handling with further advanced settings

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

Functions
ScStatus	scGetAdvancedSettings (int devIdx, ScAdvancedSettings *asP)
	Retrieves the actual advanced settings parameters. More...
ScStatus	scSetAdvancedSettings (int devIdx, ScAdvancedSettings *asP)
	Sets and retrieves the actual advanced settings parameters. More...
ScStatus	scGetSendDelay (int devIdx, int *maxPeriodP, int *minPeriodP)
	Retrieves the devic's data rate parameters. More...
ScStatus	scSetSendDelay (int devIdx, int *maxPeriodP, int *minPeriodP)
	Sets and retrieves the devices's data rate parameters. More...

Detailed Description

These functions are handling with advanced settings as a whole.

Function Documentation

scGetAdvancedSettings()

ScStatus scGetAdvancedSettings	(	int	devIdx,
		ScAdvancedSettings *	asP
	)

Retrieves the actual advanced settings parameters.

Example:

int                devIdx = 0;
ScAdvancedSettings as;
ScStatus           status = scGetAdvancedSettings(devIdx, &as);
if (status == SC_OK)
   printf("send delay: %d\n", as.mSendDelay);
else
   printf("error\n");

Parameters

devIdx

index of the device the parameters are requested

Return values

asP	pointer to the advanced 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.

scGetSendDelay()

ScStatus scGetSendDelay	(	int	devIdx,
		int *	maxPeriodP,
		int *	minPeriodP
	)

Retrieves the devic's data rate parameters.

In the old spacemouse protocol both parameters given below are used as described, in the SpaceControl protocol only the first parameter is used.
Example:

int      devIdx = 0;
int      maxPeriod, minPeriod;
ScStatus status = scGetSendDelay(devIdx, &maxPeriod, &minPeriod);
if (status == SC_OK)
{   
   printf("max. period: %d\n", maxPeriod);
     printf("min. period: %d\n", minPeriod);
}
else
   printf("error\n");

Parameters

devIdx

the index of the device to be requested

Return values

maxPeriodP	SpaceMouse: after this time (20..500 ms) the device sends new standard data automatically if not all coordinates are 0. SpaceControl devices: The device will send the next data packet after the delay (20..405 ms) given here; values > 400 mean: send no data at all anymore.
minPeriodP	SpaceMouse: soonest after this time (20..500 ms) the spacemouse will send new standard data even if requested sooner. SpaceControl devices: not used.

Returns

SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

scSetAdvancedSettings()

ScStatus scSetAdvancedSettings	(	int	devIdx,
		ScAdvancedSettings *	asP
	)

Sets and retrieves the actual advanced settings parameters.

Example:

int                devIdx = 0;
ScAdvancedSettings as;
ScStatus           status = scGetAdvancedSettings(devIdx, &as); // get the actual values
if (status == SC_OK)
   printf("send delay: %d\n", as.mSendDelay);
else
   printf("error\n");
as.mSendDelay = 100;                          // change one value
status = scSetAdvancedSettings(devIdx, &as);  // write the values back
if (status == SC_OK)
   printf("the send delay is now %d\n", as.mSendDelay);
else
   printf("error\n");

Parameters

devIdx

index of the device the parameters are to be set

Return values

asP	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.

scSetSendDelay()

ScStatus scSetSendDelay	(	int	devIdx,
		int *	maxPeriodP,
		int *	minPeriodP
	)

Sets and retrieves the devices's data rate parameters.

In the old spacemouse protocol both parameters given below are used as described, in the SpaceControl protocol only the first parameter is used.
Example:

int      devIdx = 0;
int      maxPeriod, minPeriod;
ScStatus status = scSetSendDelay(devIdx, &maxPeriod, &minPeriod);
if (status == SC_OK)
{
   printf("max. period: %d\n", maxPeriod);
   printf("min. period: %d\n", minPeriod);
}
else
   printf("error\n");

Parameters

devIdx

the index of the device the data is to be set

Return values

maxPeriodP	SpaceMouse: after this time (20..500 ms) the device sends new standard data automatically if not all coordinates are 0. SpaceControl devices: The device will send the next data packet after the delay (20..405 ms) given here; values > 400 mean: send no data at all anymore.
minPeriodP	SpaceMouse: soonest after this time (20..500 ms) the spacemouse will send new standard data even if requested sooner. SpaceControl devices: not used.

Returns

SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX, SC_PARAMETER_OUT_OF_RANGE

References MAX_PERIOD, MIN_PERIOD, SC_COMMUNICATION_ERROR, SC_OK, SC_PARAMETER_OUT_OF_RANGE, and SC_WRONG_DEVICE_INDEX.