Communications Functions

---

Detailed Description

Use these functions to test communications and gather information about the device.

Functions
NDICMDC_API BOOL	NdiCmd_GetPortInfo (int handle, char *type_string, int *id)
	Get Port Info.
NDICMDC_API BOOL	NdiCmd_Sync (int handle)
	Synchronize.
NDICMDC_API BOOL	NdiCmd_CommTest (int handle, int first, int last, int step)
	Comm Test.
NDICMDC_API BOOL	NdiCmd_GetName (int handle, LPSTR name, int *version)
	Get Name.
NDICMDC_API BOOL	NdiCmd_Status (int handle, unsigned int *status)
	Status.

---

Function Documentation

NDICMDC_API BOOL NdiCmd_CommTest	(	int	handle,
		int	first,
		int	last,
		int	step
	)

Comm Test.

This function performs a rapid communications link test, by executing a series of WheelCommander Echo commands with values starting at first, ending at last, and increasing from first to last by step size increments.

Parameters:

	handle	an integer WheelCommander handle
	first	the first value to test with
	last	the last value to test with
	step	the increment amount

Returns:

NDICMDC_API BOOL NdiCmd_GetName	(	int	handle,
		LPSTR	name,
		int *	version
	)

Get Name.

This returns the device name and version for the device at the specified handle.

Parameters:

	handle	an integer WheelCommander handle
	name	a character pointer to the device name
	version	a pointer to an integer containing the version

Returns:

NDICMDC_API BOOL NdiCmd_GetPortInfo	(	int	handle,
		char *	type_string,
		int *	id
	)

Get Port Info.

This returns the current device type and id number this device is connected with.

Parameters:

	type_string	a pointer to a character buffer; length must be >= 64 characters.
	id	a pointer to an integer that receives the Id number

Returns:

TRUE if successful

NDICMDC_API BOOL NdiCmd_Status	(	int	handle,
		unsigned int *	status
	)

Status.

This returns the current status of the WheelCommander.

Parameters:

	handle	an integer WheelCommander handle
	status	a pointer to an unsigned int, returning the status bits

Returns:

NDICMDC_API BOOL NdiCmd_Sync

(

int

handle

)

Synchronize.

This command is used to confirm communications with the WheelCommander. It also clears out the WheelCommander's serial command buffer.

Parameters:

handle

an integer WheelCommander handle

Returns:

TRUE(1) if synchronization was successful.