Phidget RFID
[Specific Phidgets]

Typedefs
typedef struct _CPhidgetRFID *	CPhidgetRFIDHandle
Functions
int	CPhidgetRFID_create (CPhidgetRFIDHandle *phid)
int	CPhidgetRFID_getOutputCount (CPhidgetRFIDHandle phid, int *count)
int	CPhidgetRFID_getOutputState (CPhidgetRFIDHandle phid, int index, int *outputState)
int	CPhidgetRFID_setOutputState (CPhidgetRFIDHandle phid, int index, int outputState)
int	CPhidgetRFID_set_OnOutputChange_Handler (CPhidgetRFIDHandle phid, int(*fptr)(CPhidgetRFIDHandle phid, void *userPtr, int index, int outputState), void *userPtr)
int	CPhidgetRFID_getAntennaOn (CPhidgetRFIDHandle phid, int *antennaState)
int	CPhidgetRFID_setAntennaOn (CPhidgetRFIDHandle phid, int antennaState)
int	CPhidgetRFID_getLEDOn (CPhidgetRFIDHandle phid, int *LEDState)
int	CPhidgetRFID_setLEDOn (CPhidgetRFIDHandle phid, int LEDState)
int	CPhidgetRFID_getLastTag (CPhidgetRFIDHandle phid, unsigned char *tag)
int	CPhidgetRFID_getTagStatus (CPhidgetRFIDHandle phid, int *status)
int	CPhidgetRFID_set_OnTag_Handler (CPhidgetRFIDHandle phid, int(*fptr)(CPhidgetRFIDHandle phid, void *userPtr, unsigned char *tag), void *userPtr)
int	CPhidgetRFID_set_OnTagLost_Handler (CPhidgetRFIDHandle phid, int(*fptr)(CPhidgetRFIDHandle phid, void *userPtr, unsigned char *tag), void *userPtr)

---

Detailed Description

Calls specific to the Phidget RFID. See the product manual for more specific API details, supported functionality, units, etc.

---

Typedef Documentation

typedef struct _CPhidgetRFID* CPhidgetRFIDHandle

A Phidget RFID handle

---

Function Documentation

int CPhidgetRFID_create

(

CPhidgetRFIDHandle *

phid

)

Creates a Phidget RFID handle.

Parameters:

phid

A pointer to an unallocated Phidget RFID handle.

int CPhidgetRFID_getOutputCount	(	CPhidgetRFIDHandle	phid,
		int *	count
	)

Gets the number of outputs supported by this board.

Parameters:

	phid	An attached phidget rfid handle.
	count	The output count.

int CPhidgetRFID_getOutputState	(	CPhidgetRFIDHandle	phid,
		int	index,
		int *	outputState
	)

Gets the state of an output.

Parameters:

	phid	An attached phidget rfid handle.
	index	The output index.
	outputState	The output state. Possible values are PTRUE and PFALSE.

int CPhidgetRFID_setOutputState	(	CPhidgetRFIDHandle	phid,
		int	index,
		int	outputState
	)

Sets the state of an output.

Parameters:

	phid	An attached phidget rfid handle.
	index	The output index.
	outputState	The output state. Possible values are PTRUE and PFALSE.

int CPhidgetRFID_set_OnOutputChange_Handler	(	CPhidgetRFIDHandle	phid,
		int(*)(CPhidgetRFIDHandle phid, void *userPtr, int index, int outputState)	fptr,
		void *	userPtr
	)

Set an output change handler. This is called when an output changes.

Parameters:

	phid	An attached phidget rfid handle.
	fptr	Callback function pointer.
	userPtr	A pointer for use by the user - this value is passed back into the callback function.

int CPhidgetRFID_getAntennaOn	(	CPhidgetRFIDHandle	phid,
		int *	antennaState
	)

Gets the state of the antenna.

Parameters:

	phid	An attached phidget rfid handle.
	antennaState	The antenna state. Possible values are PTRUE and PFALSE.

int CPhidgetRFID_setAntennaOn	(	CPhidgetRFIDHandle	phid,
		int	antennaState
	)

Sets the state of the antenna. Note that the antenna must be enabled before tags will be read.

Parameters:

	phid	An attached phidget rfid handle.
	antennaState	The antenna state. Possible values are PTRUE and PFALSE.

int CPhidgetRFID_getLEDOn	(	CPhidgetRFIDHandle	phid,
		int *	LEDState
	)

Gets the state of the onboard LED.

Parameters:

	phid	An attached phidget rfid handle.
	LEDState	The LED state. Possible values are PTRUE and PFALSE.

int CPhidgetRFID_setLEDOn	(	CPhidgetRFIDHandle	phid,
		int	LEDState
	)

Sets the state of the onboard LED.

Parameters:

	phid	An attached phidget rfid handle.
	LEDState	The LED state. Possible values are PTRUE and PFALSE.

int CPhidgetRFID_getLastTag	(	CPhidgetRFIDHandle	phid,
		unsigned char *	tag
	)

Gets the last tag read by the reader. This tag may or may not still be on the reader.

Parameters:

	phid	An attached phidget rfid handle.
	tag	The tag.

int CPhidgetRFID_getTagStatus	(	CPhidgetRFIDHandle	phid,
		int *	status
	)

Gets the tag present status. This is whether or not a tag is being read by the reader.

Parameters:

	phid	An attached phidget rfid handle.
	status	The tag status. Possible values are PTRUE and PFALSE.

int CPhidgetRFID_set_OnTag_Handler	(	CPhidgetRFIDHandle	phid,
		int(*)(CPhidgetRFIDHandle phid, void *userPtr, unsigned char *tag)	fptr,
		void *	userPtr
	)

Set a tag handler. This is called when a tag is first detected by the reader.

Parameters:

	phid	An attached phidget rfid handle.
	fptr	Callback function pointer.
	userPtr	A pointer for use by the user - this value is passed back into the callback function.

int CPhidgetRFID_set_OnTagLost_Handler	(	CPhidgetRFIDHandle	phid,
		int(*)(CPhidgetRFIDHandle phid, void *userPtr, unsigned char *tag)	fptr,
		void *	userPtr
	)

Set a tag lost handler. This is called when a tag is no longer detected by the reader.

Parameters:

	phid	An attached phidget rfid handle.
	fptr	Callback function pointer.
	userPtr	A pointer for use by the user - this value is passed back into the callback function.