Phidget InterfaceKit
[Specific Phidgets]


Typedefs

typedef struct
_CPhidgetInterfaceKit * 
CPhidgetInterfaceKitHandle

Functions

int CPhidgetInterfaceKit_create (CPhidgetInterfaceKitHandle *phid)
int CPhidgetInterfaceKit_getInputCount (CPhidgetInterfaceKitHandle phid, int *count)
int CPhidgetInterfaceKit_getInputState (CPhidgetInterfaceKitHandle phid, int index, int *inputState)
int CPhidgetInterfaceKit_set_OnInputChange_Handler (CPhidgetInterfaceKitHandle phid, int(*fptr)(CPhidgetInterfaceKitHandle phid, void *userPtr, int index, int inputState), void *userPtr)
int CPhidgetInterfaceKit_getOutputCount (CPhidgetInterfaceKitHandle phid, int *count)
int CPhidgetInterfaceKit_getOutputState (CPhidgetInterfaceKitHandle phid, int index, int *outputState)
int CPhidgetInterfaceKit_setOutputState (CPhidgetInterfaceKitHandle phid, int index, int outputState)
int CPhidgetInterfaceKit_set_OnOutputChange_Handler (CPhidgetInterfaceKitHandle phid, int(*fptr)(CPhidgetInterfaceKitHandle phid, void *userPtr, int index, int outputState), void *userPtr)
int CPhidgetInterfaceKit_getSensorCount (CPhidgetInterfaceKitHandle phid, int *count)
int CPhidgetInterfaceKit_getSensorValue (CPhidgetInterfaceKitHandle phid, int index, int *sensorValue)
int CPhidgetInterfaceKit_getSensorRawValue (CPhidgetInterfaceKitHandle phid, int index, int *sensorRawValue)
int CPhidgetInterfaceKit_set_OnSensorChange_Handler (CPhidgetInterfaceKitHandle phid, int(*fptr)(CPhidgetInterfaceKitHandle phid, void *userPtr, int index, int sensorValue), void *userPtr)
int CPhidgetInterfaceKit_getSensorChangeTrigger (CPhidgetInterfaceKitHandle phid, int index, int *trigger)
int CPhidgetInterfaceKit_setSensorChangeTrigger (CPhidgetInterfaceKitHandle phid, int index, int trigger)
int CPhidgetInterfaceKit_getRatiometric (CPhidgetInterfaceKitHandle phid, int *ratiometric)
int CPhidgetInterfaceKit_setRatiometric (CPhidgetInterfaceKitHandle phid, int ratiometric)
int CPhidgetInterfaceKit_getDataRate (CPhidgetInterfaceKitHandle phid, int index, int *milliseconds)
int CPhidgetInterfaceKit_setDataRate (CPhidgetInterfaceKitHandle phid, int index, int milliseconds)
int CPhidgetInterfaceKit_getDataRateMax (CPhidgetInterfaceKitHandle phid, int index, int *max)
int CPhidgetInterfaceKit_getDataRateMin (CPhidgetInterfaceKitHandle phid, int index, int *min)

Detailed Description

These calls are specific to the Phidget InterfaceKit 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 _CPhidgetInterfaceKit* CPhidgetInterfaceKitHandle

A Phidget InterfaceKit handle


Function Documentation

int CPhidgetInterfaceKit_create ( CPhidgetInterfaceKitHandle phid  ) 

Creates a Phidget InterfaceKit handle.

Parameters:
phid A pointer to an unallocated Phidget InterfaceKit handle.

int CPhidgetInterfaceKit_getInputCount ( CPhidgetInterfaceKitHandle  phid,
int *  count 
)

Gets the number of digital inputs supported by this board.

Parameters:
phid An attached phidget interface kit handle.
count The ditial input count.

int CPhidgetInterfaceKit_getInputState ( CPhidgetInterfaceKitHandle  phid,
int  index,
int *  inputState 
)

Gets the state of a digital input.

Parameters:
phid An attached phidget interface kit handle.
index The input index.
inputState The input state. Possible values are PTRUE and PFALSE.

int CPhidgetInterfaceKit_set_OnInputChange_Handler ( CPhidgetInterfaceKitHandle  phid,
int(*)(CPhidgetInterfaceKitHandle phid, void *userPtr, int index, int inputState)  fptr,
void *  userPtr 
)

Set a digital input change handler. This is called when a digital input changes.

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

int CPhidgetInterfaceKit_getOutputCount ( CPhidgetInterfaceKitHandle  phid,
int *  count 
)

Gets the number of digital outputs supported by this board.

Parameters:
phid An attached phidget interface kit handle.
count The output count.

int CPhidgetInterfaceKit_getOutputState ( CPhidgetInterfaceKitHandle  phid,
int  index,
int *  outputState 
)

Gets the state of a digital output.

Parameters:
phid An attached phidget interface kit handle.
index The output index.
outputState The output state. Possible values are PTRUE and PFALSE.

int CPhidgetInterfaceKit_setOutputState ( CPhidgetInterfaceKitHandle  phid,
int  index,
int  outputState 
)

Sets the state of a digital output.

Parameters:
phid An attached phidget interface kit handle.
index The otuput index.
outputState The output state. Possible values are PTRUE and PFALSE.

int CPhidgetInterfaceKit_set_OnOutputChange_Handler ( CPhidgetInterfaceKitHandle  phid,
int(*)(CPhidgetInterfaceKitHandle phid, void *userPtr, int index, int outputState)  fptr,
void *  userPtr 
)

Set a digital output change handler. This is called when a digital output changes.

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

int CPhidgetInterfaceKit_getSensorCount ( CPhidgetInterfaceKitHandle  phid,
int *  count 
)

Gets the number of sensor (analog) inputs supported by this board.

Parameters:
phid An attached phidget interface kit handle.
count The sensor input count.

int CPhidgetInterfaceKit_getSensorValue ( CPhidgetInterfaceKitHandle  phid,
int  index,
int *  sensorValue 
)

Gets a sensor value (0-1000).

Parameters:
phid An attached phidget interface kit handle.
index The sensor index.
sensorValue The sensor value.

int CPhidgetInterfaceKit_getSensorRawValue ( CPhidgetInterfaceKitHandle  phid,
int  index,
int *  sensorRawValue 
)

Gets a sensor raw value (12-bit).

Parameters:
phid An attached phidget interface kit handle.
index The sensor index.
sensorRawValue The sensor value.

int CPhidgetInterfaceKit_set_OnSensorChange_Handler ( CPhidgetInterfaceKitHandle  phid,
int(*)(CPhidgetInterfaceKitHandle phid, void *userPtr, int index, int sensorValue)  fptr,
void *  userPtr 
)

Set a sensor change handler. This is called when a sensor value changes by more then the change trigger.

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

int CPhidgetInterfaceKit_getSensorChangeTrigger ( CPhidgetInterfaceKitHandle  phid,
int  index,
int *  trigger 
)

Gets a sensor change trigger.

Parameters:
phid An attached phidget interface kit handle.
index The sensor index.
trigger The change trigger.

int CPhidgetInterfaceKit_setSensorChangeTrigger ( CPhidgetInterfaceKitHandle  phid,
int  index,
int  trigger 
)

Sets a sensor change trigger.

Parameters:
phid An attached phidget interface kit handle.
index The sensor index.
trigger The change trigger.

int CPhidgetInterfaceKit_getRatiometric ( CPhidgetInterfaceKitHandle  phid,
int *  ratiometric 
)

Gets the ratiometric state for this board.

Parameters:
phid An attached phidget interface kit handle.
ratiometric The ratiometric state. Possible values are PTRUE and PFALSE.

int CPhidgetInterfaceKit_setRatiometric ( CPhidgetInterfaceKitHandle  phid,
int  ratiometric 
)

Sets the ratiometric state for this board.

Parameters:
phid An attached phidget interface kit handle.
ratiometric The ratiometric state. Possible values are PTRUE and PFALSE.

int CPhidgetInterfaceKit_getDataRate ( CPhidgetInterfaceKitHandle  phid,
int  index,
int *  milliseconds 
)

Gets the Data Rate for an analog input.

Parameters:
phid An attached phidget interface kit handle.
index The sensor index.
milliseconds Data rate in ms.

int CPhidgetInterfaceKit_setDataRate ( CPhidgetInterfaceKitHandle  phid,
int  index,
int  milliseconds 
)

Sets the Data Rate for an analog input.

Parameters:
phid An attached phidget interface kit handle.
index The sensor index.
milliseconds Data rate in ms.

int CPhidgetInterfaceKit_getDataRateMax ( CPhidgetInterfaceKitHandle  phid,
int  index,
int *  max 
)

Gets the maximum supported data rate for an analog input

Parameters:
phid An attached phidget interface kit handle.
index The sensor index.
max Data rate in ms.

int CPhidgetInterfaceKit_getDataRateMin ( CPhidgetInterfaceKitHandle  phid,
int  index,
int *  min 
)

Gets the minimum supported data rate for an analog input

Parameters:
phid An attached phidget interface kit handle.
index The sensor index.
min Data rate in ms.


Generated on Tue Oct 1 15:05:41 2019 for Phidget21 by  doxygen 1.5.9