Phidget RFID
[Specific Phidgets]


Typedefs
typedef struct _CPhidgetRFID *	CPhidgetRFIDHandle
Enumerations
enum	CPhidgetRFID_Protocol { PHIDGET_RFID_PROTOCOL_EM4100 = 1, PHIDGET_RFID_PROTOCOL_ISO11785_FDX_B, PHIDGET_RFID_PROTOCOL_PHIDGETS }
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_getLastTag2 (CPhidgetRFIDHandle phid, char *tagString, CPhidgetRFID_Protocol protocol)
int	CPhidgetRFID_getTagStatus (CPhidgetRFIDHandle phid, int *status)
int	CPhidgetRFID_write (CPhidgetRFIDHandle phid, char *tagString, CPhidgetRFID_Protocol protocol, int lock)
int	CPhidgetRFID_set_OnTag2_Handler (CPhidgetRFIDHandle phid, int(fptr)(CPhidgetRFIDHandle phid, void userPtr, char tagString, CPhidgetRFID_Protocol protocol), void userPtr)
int	CPhidgetRFID_set_OnTagLost2_Handler (CPhidgetRFIDHandle phid, int(fptr)(CPhidgetRFIDHandle phid, void userPtr, char tagString, CPhidgetRFID_Protocol protocol), void userPtr)

Detailed Description

These calls are specific to the Phidget RFID object. See your device's User Guide for more specific API details, technical information, and revision details. The User Guide, along with other resources, can be found on the product page for your device.

Typedef Documentation

typedef struct _CPhidgetRFID* CPhidgetRFIDHandle

A Phidget RFID handle

Enumeration Type Documentation

enum CPhidgetRFID_Protocol

RFID encoding protocols supported by the PhidgetRFID Read-Write

Enumerator:

PHIDGET_RFID_PROTOCOL_EM4100	EM4100 (EM4102) 40-bit
PHIDGET_RFID_PROTOCOL_ISO11785_FDX_B	ISO11785 FDX-B encoding (Animal ID)
PHIDGET_RFID_PROTOCOL_PHIDGETS	PhidgetTAG Protocol 24 character ASCII

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_getLastTag2	(	CPhidgetRFIDHandle	phid,
		char **	tagString,
		CPhidgetRFID_Protocol *	protocol
	)

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.
	tagString	A pointer which will be set to point to a char array containing the tag string.
	protocol	The tag protocol.

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_write	(	CPhidgetRFIDHandle	phid,
		char *	tagString,
		CPhidgetRFID_Protocol	protocol,
		int	lock
	)

Program a tag. This requires a T5577 tag.

Parameters:

	phid	An attached phidget rfid handle.
	tagString	The tag data to write. EM4100 (40-bit hex): "90fd32987b" FDX-B (15 digit decimal): "999000000003471" Phidgets (7-bit ASCII, up to 24 characters): "I'm a PHIDGET tag"
	protocol	The tag protocol to write
	lock	Lock the tag so that it cannot be written again.

int CPhidgetRFID_set_OnTag2_Handler	(	CPhidgetRFIDHandle	phid,
		int()(CPhidgetRFIDHandle phid, void userPtr, char *tagString, CPhidgetRFID_Protocol protocol)	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_OnTagLost2_Handler	(	CPhidgetRFIDHandle	phid,
		int()(CPhidgetRFIDHandle phid, void userPtr, char *tagString, CPhidgetRFID_Protocol protocol)	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.

Phidget RFID [Specific Phidgets]

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Phidget RFID
[Specific Phidgets]