35
1072_0_Product_Manual - February 24, 2011 2:52 PM
API for the InterfaceKit 8/8/8
Functions
int InputCount() [get] : Constant = 8
Returns the number of digital inputs supported by this PhidgetInterfaceKit.
bool InputState(int InputIndex) [get]
Returns the state of a particular digital input. Digital inputs read True where they are activated and false when
they are in their default state.
int OutputCount() [get] : Constant = 8
Returns the number of digital outputs supported by this PhidgetInterfaceKit.
bool OutputState (int OutputIndex) [get,set]
Sets/returns the state of a digital output. Setting this to true will activate the output, False is the default state.
Reading the OutputState immediately after setting it will not return the value set - it will return the last state
reported by the Phidget.
int SensorCount() [get] : Constant = 8
Returns the number of sensors (Analog Inputs) supported by this PhidgetInterfaceKit. Note that there is no
way of determining is a sensor is attached, and what sensor is attached.
int SensorValue(int SensorIndex) [get]
Returns the sensed value of a particular Analog Input. SensorValue varies between 0-1000, corresponding to
the 0-5V input range of the Analog Input.
If you are using an Analog Sensor from Phidgets Inc., it’s manual will specify the formula used to convert
SensorValue into the measured property.
int SensorRawValue (int SensorIndex) [get]
Returns the full resolution of the Analog Input. This is a more accurate version of SensorValue. The valid
range is 0-4095. Note however that the analog outputs on the Interface Kit 8/8/8 are only 10-bit values and
this value represents an oversampling to 12-bit.
double SensorChangeTrigger (int SensorIndex) [get,set]
Returns the change trigger for an analog input. This is the amount that an inputs must change between
successive SensorChangeEvents. This is based on the 0-1000 range provided by getSensorValue. This value is
by default set to 10 for most Interface Kits with analog inputs. SensorChangeTrigger is sometimes referred to
as sensitivity.
int DataRate (int SensorIndex) [get,set]
Gets/sets the data rate for an analog input. This is corresponds to the fastest rate at which SensorChange
events will be fired. The data rate is superseded by SensorChangeTrigger, which can be set to 0 if a constant
data rate is required. Data Rate is in milliseconds and corresponds to the amount of time between events. Data
Rate is bounded by DataRateMax and DataRateMin. The analog inputs cannot all be set to the fastest data
rate at the same time - if this is attempted, an exception will be thrown when the data bandwidth has been
exceeded. For data rates less then the maximum, data is still sampled at the maximum speed, and averaged
between events for the user. Supported data rates are: 1, 2, 4, 8, and every multiple of 8 until DataRateMin.
Setting an unsupported data rate (ie. 3, 9, 17) will result in a thrown exception. Note that data rate is limited
to 16ms when opening over the Phidget Webservice.
int DataRateMax (int SensorIndex) [get]
The maximum data rate that can be set for an analog input, in milliseconds.
int DataRateMin (int SensorIndex) [get]
