1018 User Guide - Revision history

Mparadis at 14:24, 9 May 2018

2018-05-09T14:24:48Z

← Older revision		Revision as of 14:24, 9 May 2018
Line 1:		Line 1:
			__NOINDEX__
	[[Category:UserGuide]]		[[Category:UserGuide]]
	{{UserguideTOC\|1018.jpg\|1018}}		{{UserguideTOC\|1018.jpg\|1018}}

Mparadis: /* Product History */

2014-04-01T16:42:56Z

Product History

← Older revision		Revision as of 16:42, 1 April 2014
Line 138:		Line 138:
	==Product History==		==Product History==
	{{UGhist}}		{{UGhist}}
	{{~~UGrow~~\|July 2007 \|0\|824\|Product Release}}		{{UGrow2\|1018_0\|July 2007 \|0\|824\|Product Release}}
	{{~~UGrow~~\|September 2007\|0\|825\|SPI Overclocking issue fixed}}		{{UGrow2\|1018_0\|September 2007\|0\|825\|SPI Overclocking issue fixed}}
	{{~~UGrow~~\|May 2008 \|1\|826\|Added RC Filtering to Digital Inputs, PCB X Dimension increased to 3.27” }}		{{UGrow2\|1018_1\|May 2008 \|1\|826\|Added RC Filtering to Digital Inputs, PCB X Dimension increased to 3.27” }}
	{{~~UGrow~~\|April 2010 \|2\|900\|Configurable data sampling speed. Replace USB connector with Mini-USB connector }}		{{UGrow2\|1018_2\|April 2010 \|2\|900\|Configurable data sampling speed. Replace USB connector with Mini-USB connector }}
	{{~~UGrow~~\|April 2010 \|2\|901\|Fixed bugs relating to changing the ratiometric setting and overflow reporting }}		{{UGrow2\|1018_2\|April 2010 \|2\|901\|Fixed bugs relating to changing the ratiometric setting and overflow reporting }}
	{{~~UGrow~~\|September 2010\|2\|902\|Fixed certain output set commands from PC being ignored}}		{{UGrow2\|1018_2\|September 2010\|2\|902\|Fixed certain output set commands from PC being ignored}}
	{{~~UGrow~~\|November 2010 \|2\|903\|USB Product Name descriptor changed from "Phidget" to "PhidgetInterfaceKit" }}		{{UGrow2\|1018_2\|November 2010 \|2\|903\|USB Product Name descriptor changed from "Phidget" to "PhidgetInterfaceKit" }}
	{{~~UGrow~~\|May 2011 \|2\|904\|getLabelString fixed for labels longer than 7 characters }}		{{UGrow2\|1018_2\|May 2011 \|2\|904\|getLabelString fixed for labels longer than 7 characters }}

Mparadis: /* Product History */

2012-10-16T17:19:34Z

Product History

← Older revision		Revision as of 17:19, 16 October 2012
Line 142:		Line 142:
	{{UGrow\|May 2008 \|1\|826\|Added RC Filtering to Digital Inputs, PCB X Dimension increased to 3.27” }}		{{UGrow\|May 2008 \|1\|826\|Added RC Filtering to Digital Inputs, PCB X Dimension increased to 3.27” }}
	{{UGrow\|April 2010 \|2\|900\|Configurable data sampling speed. Replace USB connector with Mini-USB connector }}		{{UGrow\|April 2010 \|2\|900\|Configurable data sampling speed. Replace USB connector with Mini-USB connector }}
			{{UGrow\|April 2010 \|2\|901\|Fixed bugs relating to changing the ratiometric setting and overflow reporting }}
			{{UGrow\|September 2010\|2\|902\|Fixed certain output set commands from PC being ignored}}
			{{UGrow\|November 2010 \|2\|903\|USB Product Name descriptor changed from "Phidget" to "PhidgetInterfaceKit" }}
			{{UGrow\|May 2011 \|2\|904\|getLabelString fixed for labels longer than 7 characters }}

Mparadis: /* Technical Details */

2012-08-21T15:28:45Z

Technical Details

← Older revision		Revision as of 15:28, 21 August 2012
Line 69:		Line 69:
	==Technical Details==		==Technical Details==

	If you want to know more about the input/output capabilities of the 1018 InterfaceKit, check the [[Digital Input Primer]], [[Digital ~~Input~~ Primer]], and the [[Analog Input Primer]].		If you want to know more about the input/output capabilities of the 1018 InterfaceKit, check the [[Digital Input Primer]], [[Digital Output Primer]], and the [[Analog Input Primer]].

	==API==		==API==

Burley at 15:11, 10 August 2012

2012-08-10T15:11:50Z

← Older revision		Revision as of 15:11, 10 August 2012
Line 1:		Line 1:
	[[Category:UserGuide]]		[[Category:UserGuide]]
			{{UserguideTOC\|1018.jpg\|1018}}
	==Getting Started==		==Getting Started==

Mparadis at 15:39, 26 July 2012

2012-07-26T15:39:47Z

← Older revision		Revision as of 15:39, 26 July 2012
Line 1:		Line 1:
			[[Category:UserGuide]]

	==Getting Started==		==Getting Started==

Mparadis at 17:43, 20 July 2012

2012-07-20T17:43:53Z

← Older revision		Revision as of 17:43, 20 July 2012
Line 50:		Line 50:
	and the formula are displayed under the		and the formula are displayed under the
	drop down menu.		drop down menu.
	\|[[File:1018 1 Advanced Sensor Screen.jpg\|400px\|link=]]		\|[[File:1018 2 Advanced Sensor Screen.jpg\|400px\|link=]]
	}}		}}

Mparadis at 17:40, 20 July 2012

2012-07-20T17:40:17Z

← Older revision		Revision as of 17:40, 20 July 2012
Line 50:		Line 50:
	and the formula are displayed under the		and the formula are displayed under the
	drop down menu.		drop down menu.
	\|[[File:~~1018_2_Sensor_InterfaceKit_Screen~~.jpg\|400px\|link=]]		\|[[File:1018 1 Advanced Sensor Screen.jpg\|400px\|link=]]
	}}		}}

Mparadis at 16:26, 20 July 2012

2012-07-20T16:26:34Z

← Older revision		Revision as of 16:26, 20 July 2012
Line 67:		Line 67:
	==Technical Details==		==Technical Details==

			If you want to know more about the input/output capabilities of the 1018 InterfaceKit, check the [[Digital Input Primer]], [[Digital Input Primer]], and the [[Analog Input Primer]].

	==API==		==API==

Mparadis: Created page with "==Getting Started== ===Checking the Contents=== {{UGbox| '''You should have received:''' * A PhidgetInterfaceKit 8/8/8 board * A Mini-USB Cable | '''In order to test your new..."

2012-07-20T16:23:12Z

Created page with "==Getting Started== ===Checking the Contents=== {{UGbox| '''You should have received:''' * A PhidgetInterfaceKit 8/8/8 board * A Mini-USB Cable | '''In order to test your new..."

New page

==Getting Started==

===Checking the Contents===
{{UGbox|
'''You should have received:'''
* A PhidgetInterfaceKit 8/8/8 board
* A Mini-USB Cable
|
'''In order to test your new Phidget you will also need:'''
* A piece of wire to test the digital inputs
* An LED to test the digital outputs
* An Analog Sensor to test the analog inputs.
||}}

===Connecting the Pieces===
{{UGbox|
# Connect the Analog Sensor to the analog input port 6 using a Phidgets sensor cable. The analog ports are numbered from 0 to 7 starting from the left.
# Connect the InterfaceKit board to the PC using the Mini-USB cable.
# Connect one end of the wire to digital input port 0 and the other end to the ground connection.
# Connect the LED by inserting the long LED wire into the digital output 0 and the shorter wire into Ground.
|[[File:1018_2_Connecting_The_Hardware.jpg|400px|link=]]
||}}

===Testing Using Windows 2000 / XP / Vista / 7===

{{UGwin}}

===Running Phidgets Sample Program===

{{UGwin2|'''InterfaceKit-full'''}}

{{UGbox6|
Double Click on the [[File:Ph.jpg|link=]] icon to activate the Phidget Control Panel and make sure that the Phidget InterfaceKit 8/8/8 is properly attached to your PC.
|[[File:1018_2_Control_Panel_Screen.jpg|400px|link=]]
|
# Double Click on '''PhidgetInterfaceKit 8/8/8''' in the Phidget Control Panel to bring up InterfaceKit-full and check that the box labelled Attached contains the word True.
# Test the digital output by clicking on the white box to turn on the LED. Clicking again will turn the LED off. The bottom row shows the status of the request, while the top row displays the status of the digital output as reported by the device.
# Test the digital input by disconnecting the wire end connected to the digital input connector. The tick mark in the box will go away.
# Click on the Ratiometric Box if your sensor is ratiometric. Check the sensor product manual if you are not sure.
# Test the Analog Input by activating your sensor and check your results in Analog In number 6.
# You can adjust the input sensitivity by moving the slider pointer. This is the amount that an input must change to trigger an event that will modify the value in the Analog In box.
# Click on Sensors to launch the Advanced Sensor Form.
|[[File:1018_2_InterfaceKit_Screen.jpg|400px|link=]]
|
# In the drop down menu, select the Sensor you have attached to the analog input port 0 of the 1018. In our case we select the 1129 - Touch Sensor.
# The state of the Touch Sensor is shown here.

'''Note:''' If you have connected a sensor
that uses a formula, the calculated value
and the formula are displayed under the
drop down menu.
|[[File:1018_2_Sensor_InterfaceKit_Screen.jpg|400px|link=]]
}}

===Testing Using Mac OS X===

{{UGmac|Phidget InterfaceKit 8/8/8|InterfaceKit-full }}

===Using Linux===

{{UGlinux}}

===Using Windows Mobile / CE 5.0 / CE 6.0===

{{UGce}}

==Technical Details==

==API==
{{UGapih}}

===Functions===
{{UGapi|int InputCount() [get] : Constant <nowiki>=</nowiki> 8
|Returns the number of digital inputs supported by this PhidgetInterfaceKit.
}}

{{UGapi|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.
}}

{{UGapi|int OutputCount() [get] : Constant <nowiki>=</nowiki> 8
|Returns the number of digital outputs supported by this PhidgetInterfaceKit.
}}

{{UGapi|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.
}}

{{UGapi|int SensorCount() [get] : Constant <nowiki>=</nowiki> 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.
}}

{{UGapi|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.
}}

{{UGapi|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.
}}

{{UGapi|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.
}}

{{UGapi|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.
}}

{{UGapi|int DataRateMax (int SensorIndex) [get]
|The maximum data rate that can be set for an analog input, in milliseconds.
}}

{{UGapi|int DataRateMin (int SensorIndex) [get]
|The minimum data rate that can be set for an analog input, in milliseconds. This is usually 1000.
}}

{{UGapi|bool Ratiometric() [get,set]
|Sets/returns the state of Ratiometric. Ratiometric <nowiki>=</nowiki> true configures the Analog Inputs to measure relative to VCC (nominal 5V). Ratiometric <nowiki>=</nowiki> false configures the Analog Inputs to measure relative to an internal precision 5V reference. Ratiometric is not updated from the Phidget. It is recommended to explicitly set Ratiometric when the Interfacekit is opened. After changing the ratiometric state, wait until the ratiometric property matches what was set before reading analog data.
}}

===Events===
{{UGapi|OnInputChange(int InputIndex, bool State) [event]
|An event that is issued when the state of a digital input changes.
}}

{{UGapi|OnOutputChange(int OutputIndex, bool State), [event]
|An event that is issued when the state of a digital output changes.
}}

{{UGapi|OnSensorChange(int SensorIndex, int SensorValue), [event]
|An event that is issued when the returned value from a sensor (Analog Input) varies by more than the SensorChangeTrigger property.
}}

==Product History==
{{UGhist}}
{{UGrow|July 2007 |0|824|Product Release}}
{{UGrow|September 2007|0|825|SPI Overclocking issue fixed}}
{{UGrow|May 2008 |1|826|Added RC Filtering to Digital Inputs, PCB X Dimension increased to 3.27” }}
{{UGrow|April 2010 |2|900|Configurable data sampling speed. Replace USB connector with Mini-USB connector }}

← Older revision		Revision as of 16:42, 1 April 2014
Line 138:		Line 138:
	==Product History==		==Product History==
	{{UGhist}}		{{UGhist}}
	{{~~UGrow~~\|July 2007 \|0\|824\|Product Release}}		{{UGrow2\|1018_0\|July 2007 \|0\|824\|Product Release}}
	{{~~UGrow~~\|September 2007\|0\|825\|SPI Overclocking issue fixed}}		{{UGrow2\|1018_0\|September 2007\|0\|825\|SPI Overclocking issue fixed}}
	{{~~UGrow~~\|May 2008 \|1\|826\|Added RC Filtering to Digital Inputs, PCB X Dimension increased to 3.27” }}		{{UGrow2\|1018_1\|May 2008 \|1\|826\|Added RC Filtering to Digital Inputs, PCB X Dimension increased to 3.27” }}
	{{~~UGrow~~\|April 2010 \|2\|900\|Configurable data sampling speed. Replace USB connector with Mini-USB connector }}		{{UGrow2\|1018_2\|April 2010 \|2\|900\|Configurable data sampling speed. Replace USB connector with Mini-USB connector }}
	{{~~UGrow~~\|April 2010 \|2\|901\|Fixed bugs relating to changing the ratiometric setting and overflow reporting }}		{{UGrow2\|1018_2\|April 2010 \|2\|901\|Fixed bugs relating to changing the ratiometric setting and overflow reporting }}
	{{~~UGrow~~\|September 2010\|2\|902\|Fixed certain output set commands from PC being ignored}}		{{UGrow2\|1018_2\|September 2010\|2\|902\|Fixed certain output set commands from PC being ignored}}
	{{~~UGrow~~\|November 2010 \|2\|903\|USB Product Name descriptor changed from "Phidget" to "PhidgetInterfaceKit" }}		{{UGrow2\|1018_2\|November 2010 \|2\|903\|USB Product Name descriptor changed from "Phidget" to "PhidgetInterfaceKit" }}
	{{~~UGrow~~\|May 2011 \|2\|904\|getLabelString fixed for labels longer than 7 characters }}		{{UGrow2\|1018_2\|May 2011 \|2\|904\|getLabelString fixed for labels longer than 7 characters }}