source/spinpts.c File Reference

Main module for the spinpts libary. This module contains implementations of the functions that make up the API. More...

#include <math.h>
#include <stdio.h>
#include <unistd.h>
#include "spinpts.h"
#include "FTD2XX/FTD2XX.h"

Functions
SPINPTS_API int	set_pts (double frequency, int phase, PTSDevice *device)
SPINPTS_API char *	spinpts_get_error ()
SPINPTS_API char *	spinpts_get_version ()

---

Detailed Description

Main module for the spinpts libary. This module contains implementations of the functions that make up the API.

Date

2008/02/26 15:55:26

To get the latest version of this code, or to contact us for support, please visit http://www.spincore.com

---

Function Documentation

SPINPTS_API int set_pts	(	double	frequency,
		int	phase,
		PTSDevice *	device
	)

Set the frequency and phase to a PTS Device. The PTSDevice parameter is optional. Specifying a PTS Device structure will include frequency and phase bounds checking when setting the device.

Parameters:

	frequency	Double values (greater than 0.)
	phase	Must be equal to 0, 90, 180, 270
	device	(OPTIONAL) Pointer to PTSDevice structure. This argument can be NULL.

Returns:

Returns 0 if no error occured. If an error occurs, returns an error code defined in spinpts.h

SPINPTS_API char* spinpts_get_error

(

)

Decodes error codes defined in spinpts.h

Returns:

Returns a pointer to a C string containing the error description.

SPINPTS_API char* spinpts_get_version

(

)

Gets the current version of the SpinPTS API being used.

Returns:

Returns a pointer to a C string containing the version string.

---