Phidgets Legacy Support - User contributions [en]

Main Page

2012-05-03T15:34:25Z

Djrudiak: /* Old Pages */

<table>
<tr><td>
__TOC__
</td>
<td valign=top align=center width=40%>
{{#widget:Google Gadget|url=http://www.calebegg.com/countdown.xml&up_eve=end%20of%20Sprint%2018&up_mon=5&up_dat=11&up_yer=2012&synd=open&w=200&h=75&title=&lang=all&country=ALL&border=%23ffffff%7C3px%2C1px+solid+%23999999&output=js|height=50}}
</td></tr>
</table>
==Phwiki==

* [[Phidget Development Process]]
: [[Processes]]
: [[Standards]]
* [[Getting_Started_with_Phidgets|Phidgets Documentation Project]]
* [[Style_Guide|Documentation Style Guide]]
* [[Projects Status]]
*[[PhidgetTesting Overhaul]]
*[[Website Redesign Ideas]]
*[[Products]] - Repository for product artifacts
*[[Logbook Details]]
*[[R&D Specializations]]
*[[Phidgets Bored Room Awesomification]]

==Internal Systems Documentation==

[[File:trac.png|link=|alt=]] Bug Tracker for [http://sl/trac# Brian] or [http://trac/# everyone else]

[[File:trac.png|link=|alt=]] [[How to use Trac]]
*[[InternalTools]] documentation.
*Phidgets Inc. Internal [[Network]] information.
*[[Phone system]]
*[[Product Photography]]
*[[OpenVPN new user HOWTO]]
*[[Product Keys & Site Logins]]

==People's Lists of Pages==

===Patrick===

* [[Patrick's List]]
:[[Phidget21]]
:[[SBC]]
:[[SBC2]]
:[[Programming@Phidgets - serials and MAC addresses]]
:[[iPhone Developer Program]]
:[[Release Build Documentation]]
:[[Delphi]]
:[[LTIB]]

===Erik===
*[[Erik's Logbook]]
*[[Erik's List]]
:[[Erik's HW TODO]]

===Fraser===

*[[Fraser - General]]
*[[Fraser - NXP]]
*[[Fraser - Spatial]]
*[[NXP Getting Started]]
*[[Fraser - Zigbee/Bluetooth]]

===Mike Paradis===
*[[Mike's List]]

===Brian===

===Cora===

[[User:Cora|Cora's List]]

===Dan J. Rudiak===
#'''Real Pages'''
#* [[Documentation_Log|Documentation Log]]
#'''Wiki Information'''
#* [[Icon Gallery]]
#* [[Progress Bars]]
#[[User:Djrudiak|Dan's List]]

===Old Pages===
* [[User:Djrudiak|Dan's List]]
* [[Michael Shan's List]]
* [[Evan's List]]
*[[Adam's List]]

===Leo===
*[[Leo's Documentation]]
*[[Test Lab information]]
*[[Internal EMC Testing Status]]
*[[Travel Notes]]
*[[Leo's Logbook]]

== Getting started ==

Consult the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for information on using the wiki software.

* [http://www.mediawiki.org/wiki/Help:Configuration_settings Configuration settings list]
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]
* [http://mail.wikipedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]

Main Page

2012-05-03T15:33:46Z

Djrudiak: /* Old Pages */

<table>
<tr><td>
__TOC__
</td>
<td valign=top align=center width=40%>
{{#widget:Google Gadget|url=http://www.calebegg.com/countdown.xml&up_eve=end%20of%20Sprint%2018&up_mon=5&up_dat=11&up_yer=2012&synd=open&w=200&h=75&title=&lang=all&country=ALL&border=%23ffffff%7C3px%2C1px+solid+%23999999&output=js|height=50}}
</td></tr>
</table>
==Phwiki==

* [[Phidget Development Process]]
: [[Processes]]
: [[Standards]]
* [[Getting_Started_with_Phidgets|Phidgets Documentation Project]]
* [[Style_Guide|Documentation Style Guide]]
* [[Projects Status]]
*[[PhidgetTesting Overhaul]]
*[[Website Redesign Ideas]]
*[[Products]] - Repository for product artifacts
*[[Logbook Details]]
*[[R&D Specializations]]
*[[Phidgets Bored Room Awesomification]]

==Internal Systems Documentation==

[[File:trac.png|link=|alt=]] Bug Tracker for [http://sl/trac# Brian] or [http://trac/# everyone else]

[[File:trac.png|link=|alt=]] [[How to use Trac]]
*[[InternalTools]] documentation.
*Phidgets Inc. Internal [[Network]] information.
*[[Phone system]]
*[[Product Photography]]
*[[OpenVPN new user HOWTO]]
*[[Product Keys & Site Logins]]

==People's Lists of Pages==

===Patrick===

* [[Patrick's List]]
:[[Phidget21]]
:[[SBC]]
:[[SBC2]]
:[[Programming@Phidgets - serials and MAC addresses]]
:[[iPhone Developer Program]]
:[[Release Build Documentation]]
:[[Delphi]]
:[[LTIB]]

===Erik===
*[[Erik's Logbook]]
*[[Erik's List]]
:[[Erik's HW TODO]]

===Fraser===

*[[Fraser - General]]
*[[Fraser - NXP]]
*[[Fraser - Spatial]]
*[[NXP Getting Started]]
*[[Fraser - Zigbee/Bluetooth]]

===Mike Paradis===
*[[Mike's List]]

===Brian===

===Cora===

[[User:Cora|Cora's List]]

===Dan J. Rudiak===
#'''Real Pages'''
#* [[Documentation_Log|Documentation Log]]
#'''Wiki Information'''
#* [[Icon Gallery]]
#* [[Progress Bars]]
#[[User:Djrudiak|Dan's List]]

===Old Pages===
* [[User:Djrudiak|Dan's List]]
* [[Michael's List]]
* [[Evan's List]]
*[[Adam's List]]

===Leo===
*[[Leo's Documentation]]
*[[Test Lab information]]
*[[Internal EMC Testing Status]]
*[[Travel Notes]]
*[[Leo's Logbook]]

== Getting started ==

Consult the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for information on using the wiki software.

* [http://www.mediawiki.org/wiki/Help:Configuration_settings Configuration settings list]
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]
* [http://mail.wikipedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]

Main Page

2012-05-03T15:32:22Z

Djrudiak: /* Dan */

<table>
<tr><td>
__TOC__
</td>
<td valign=top align=center width=40%>
{{#widget:Google Gadget|url=http://www.calebegg.com/countdown.xml&up_eve=end%20of%20Sprint%2018&up_mon=5&up_dat=11&up_yer=2012&synd=open&w=200&h=75&title=&lang=all&country=ALL&border=%23ffffff%7C3px%2C1px+solid+%23999999&output=js|height=50}}
</td></tr>
</table>
==Phwiki==

* [[Phidget Development Process]]
: [[Processes]]
: [[Standards]]
* [[Getting_Started_with_Phidgets|Phidgets Documentation Project]]
* [[Style_Guide|Documentation Style Guide]]
* [[Projects Status]]
*[[PhidgetTesting Overhaul]]
*[[Website Redesign Ideas]]
*[[Products]] - Repository for product artifacts
*[[Logbook Details]]
*[[R&D Specializations]]
*[[Phidgets Bored Room Awesomification]]

==Internal Systems Documentation==

[[File:trac.png|link=|alt=]] Bug Tracker for [http://sl/trac# Brian] or [http://trac/# everyone else]

[[File:trac.png|link=|alt=]] [[How to use Trac]]
*[[InternalTools]] documentation.
*Phidgets Inc. Internal [[Network]] information.
*[[Phone system]]
*[[Product Photography]]
*[[OpenVPN new user HOWTO]]
*[[Product Keys & Site Logins]]

==People's Lists of Pages==

===Patrick===

* [[Patrick's List]]
:[[Phidget21]]
:[[SBC]]
:[[SBC2]]
:[[Programming@Phidgets - serials and MAC addresses]]
:[[iPhone Developer Program]]
:[[Release Build Documentation]]
:[[Delphi]]
:[[LTIB]]

===Erik===
*[[Erik's Logbook]]
*[[Erik's List]]
:[[Erik's HW TODO]]

===Fraser===

*[[Fraser - General]]
*[[Fraser - NXP]]
*[[Fraser - Spatial]]
*[[NXP Getting Started]]
*[[Fraser - Zigbee/Bluetooth]]

===Mike Paradis===
*[[Mike's List]]

===Brian===

===Cora===

[[User:Cora|Cora's List]]

===Dan J. Rudiak===
#'''Real Pages'''
#* [[Documentation_Log|Documentation Log]]
#'''Wiki Information'''
#* [[Icon Gallery]]
#* [[Progress Bars]]
#[[User:Djrudiak|Dan's List]]

===Old Pages===
* [[Michael's List]]
* [[Evan's List]]
*[[Adam's List]]

===Leo===
*[[Leo's Documentation]]
*[[Test Lab information]]
*[[Internal EMC Testing Status]]
*[[Travel Notes]]
*[[Leo's Logbook]]

== Getting started ==

Consult the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for information on using the wiki software.

* [http://www.mediawiki.org/wiki/Help:Configuration_settings Configuration settings list]
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]
* [http://mail.wikipedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]

Main Page

2012-05-03T15:32:02Z

Djrudiak:

<table>
<tr><td>
__TOC__
</td>
<td valign=top align=center width=40%>
{{#widget:Google Gadget|url=http://www.calebegg.com/countdown.xml&up_eve=end%20of%20Sprint%2018&up_mon=5&up_dat=11&up_yer=2012&synd=open&w=200&h=75&title=&lang=all&country=ALL&border=%23ffffff%7C3px%2C1px+solid+%23999999&output=js|height=50}}
</td></tr>
</table>
==Phwiki==

* [[Phidget Development Process]]
: [[Processes]]
: [[Standards]]
* [[Getting_Started_with_Phidgets|Phidgets Documentation Project]]
* [[Style_Guide|Documentation Style Guide]]
* [[Projects Status]]
*[[PhidgetTesting Overhaul]]
*[[Website Redesign Ideas]]
*[[Products]] - Repository for product artifacts
*[[Logbook Details]]
*[[R&D Specializations]]
*[[Phidgets Bored Room Awesomification]]

==Internal Systems Documentation==

[[File:trac.png|link=|alt=]] Bug Tracker for [http://sl/trac# Brian] or [http://trac/# everyone else]

[[File:trac.png|link=|alt=]] [[How to use Trac]]
*[[InternalTools]] documentation.
*Phidgets Inc. Internal [[Network]] information.
*[[Phone system]]
*[[Product Photography]]
*[[OpenVPN new user HOWTO]]
*[[Product Keys & Site Logins]]

==People's Lists of Pages==

===Patrick===

* [[Patrick's List]]
:[[Phidget21]]
:[[SBC]]
:[[SBC2]]
:[[Programming@Phidgets - serials and MAC addresses]]
:[[iPhone Developer Program]]
:[[Release Build Documentation]]
:[[Delphi]]
:[[LTIB]]

===Erik===
*[[Erik's Logbook]]
*[[Erik's List]]
:[[Erik's HW TODO]]

===Fraser===

*[[Fraser - General]]
*[[Fraser - NXP]]
*[[Fraser - Spatial]]
*[[NXP Getting Started]]
*[[Fraser - Zigbee/Bluetooth]]

===Mike Paradis===
*[[Mike's List]]

===Brian===

===Cora===

[[User:Cora|Cora's List]]

===Dan===
#'''Real Pages'''
#* [[Documentation_Log|Documentation Log]]
#'''Wiki Information'''
#* [[Icon Gallery]]
#* [[Progress Bars]]
#[[User:Djrudiak|Dan's List]]

===Old Pages===
* [[Michael's List]]
* [[Evan's List]]
*[[Adam's List]]

===Leo===
*[[Leo's Documentation]]
*[[Test Lab information]]
*[[Internal EMC Testing Status]]
*[[Travel Notes]]
*[[Leo's Logbook]]

== Getting started ==

Consult the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for information on using the wiki software.

* [http://www.mediawiki.org/wiki/Help:Configuration_settings Configuration settings list]
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]
* [http://mail.wikipedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]

Main Page

2012-05-02T21:00:20Z

Djrudiak:

<table>
<tr><td>
__TOC__

==Phwiki==

* [[Phidget Development Process]]
: [[Processes]]
: [[Standards]]
* [[Getting_Started_with_Phidgets|Phidgets Documentation Project]]
* [[Style_Guide|Documentation Style Guide]]
* [[Projects Status]]
*[[PhidgetTesting Overhaul]]
*[[Website Redesign Ideas]]
*[[Products]] - Repository for product artifacts
*[[Logbook Details]]
*[[R&D Specializations]]
*[[Phidgets Bored Room Awesomification]]

</td>
<td valign=top align=center width=40%>
{{#widget:Google Gadget|url=http://www.calebegg.com/countdown.xml&up_eve=end%20of%20Sprint%2017&up_mon=5&up_dat=11&up_yer=2012&synd=open&w=200&h=75&title=&lang=all&country=ALL&border=%23ffffff%7C3px%2C1px+solid+%23999999&output=js|height=50}}

{{#widget:Google Calendar|width=100%|id=phidgets.com_p6l4ek7ufge35mc5f6trssirl8@group.calendar.google.com|color=333333|id=en_gb.canadian#holiday@group.v.calendar.google.com|color=A32929|id=en_gb.china#holiday@group.v.calendar.google.com|color=856508|id=en_gb.usa#holiday@group.v.calendar.google.com|color=060D5E|view=AGENDA|timezone=America/Edmonton|showtitle=false|shownav=false|showdate=false|showtabs=false|showcals=false|showprint=false|showtz=false|border=false}}
</td></tr>
</table>

==Internal Systems Documentation==

[[File:trac.png|link=|alt=]] Bug Tracker for [http://sl/trac# Brian] or [http://trac/# everyone else]

[[File:trac.png|link=|alt=]] [[How to use Trac]]
*[[InternalTools]] documentation.
*Phidgets Inc. Internal [[Network]] information.
*[[Phone system]]
*[[Product Photography]]
*[[OpenVPN new user HOWTO]]
*[[Product Keys & Site Logins]]

==People's Lists of Pages==

===Patrick===

* [[Patrick's List]]
:[[Phidget21]]
:[[SBC]]
:[[SBC2]]
:[[Programming@Phidgets - serials and MAC addresses]]
:[[iPhone Developer Program]]
:[[Release Build Documentation]]
:[[Delphi]]
:[[LTIB]]

===Erik===
*[[Erik's Logbook]]
*[[Erik's List]]
:[[Erik's HW TODO]]

===Fraser===

*[[Fraser - General]]
*[[Fraser - NXP]]
*[[Fraser - Spatial]]
*[[NXP Getting Started]]
*[[Fraser - Zigbee/Bluetooth]]

===Mike Paradis===
*[[Mike's List]]

===Brian===

===Cora===

[[User:Cora|Cora's List]]

===Dan===
#'''Real Pages'''
#* [[Documentation_Log|Documentation Log]]
#'''Wiki Information'''
#* [[Icon Gallery]]
#* [[Progress Bars]]
#[[User:Djrudiak|Dan's List]]

===Old Pages===
* [[Michael's List]]
* [[Evan's List]]
*[[Adam's List]]

===Leo===
*[[Leo's Documentation]]
*[[Test Lab information]]
*[[Internal EMC Testing Status]]
*[[Travel Notes]]
*[[Leo's Logbook]]

== Getting started ==

Consult the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for information on using the wiki software.

* [http://www.mediawiki.org/wiki/Help:Configuration_settings Configuration settings list]
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]
* [http://mail.wikipedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]

Language - Delphi

2012-05-02T15:43:38Z

Djrudiak: /* Getting Started */

[[Category:Language]]
{{OSLang|[[File:Icon-Delphi.png|64px|alt=|link=]]|'''[http://www.embarcadero.com/products/delphi Embarcadero Delphi]''' is an integrated development environment for console, desktop graphical, web application, and mobile applications.}}
==Support==
Delphi has a complete API for all Phidgets devices, and code samples for AdvancedServo, Servo, PhidgetInterfaceKit, and RFID.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/COM_API_Manual.pdf API Manual]
* [http://www.phidgets.com/downloads/examples/Delphi_2.1.8.20110615.zip Delphi Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General Phidget Programming]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==

The Phidget examples were written using Borland Delphi 2005 and 7, and this tutorial assumes its use.
The ActiveX objects installed with the Phidget libraries are not automatically imported into Delphi, so to begin you will need to manually import them:

#Go to Component→Import ActiveX Control...
#Select the Phidget Library 2.1 and click install
#In the next popup select the “install into new package” tab
#Give the package a suitable name and description such as “Phidgets”, and then click OK
#Compile and Install the newly created package if not done so automatically.

In Delphi 2005/2006:

#Go to File→New→Package - Delphi for Win32. Rename and save the package using File→Save Project As...
#Import the ActiveX component, go to Component→Import Component.
#Choose Inport ActiveX Control and click Next
#Select Phidget Library 2.1 and click Next
#Click Next
#Select ‘Add unit to [Package Name] project’ and click Finish.
#Install the ActiveX package you have created by right-mouse-clicking the package name in the Project Manager pane and selecting ‘Install’.
#Delphi should now display a confirmation that the package was installed. Click ok and save the package.
#When you open a new or existing application, you should now see all the Phidget device control objects listed under the ActiveX category.

In newer versions of Delphi:

#Go to Component→Import Component...
#Choose “Import ActiveX Control” and click Next
#Pick Phidget Library 2.1 from the list and click Next
#Set the palette Page to ActiveX and check the Generate Component Wrappers option
#Choose Install into a new package and click next
#Give the package a name and description such as “Phidgets”, and then click Finish

Once installed, all future projects will be able to use the Phidget ActiveX objects.

===Coding For Your Phidget===

Before you can use the Phidget, you must declare and initialize its ActiveX object.
The simplest method is to place the control from the ActiveX component tab on to your form.
For this tutorial, create a PhidgetInterfaceKit control (PhidgetInterfaceKit1) and then add a text edit field to the form for the purpose of capturing simple output.
The object name for any type of Phidget is listed in the API manual.
Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

Next, we need to tell the program to try and connect to the Phidget through a call to open().
The open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that calling open does not guarantee you can use the Phidget immediately.
We can handle it by either using event driven programming and tracking the AttachEvents and DetachEvents, or by calling waitForAttachment.
WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.

<div class="source"><syntaxhighlight lang=delphi>

procedure TForm1.FormCreate(Sender: TObject);
begin
PhidgetInterfaceKit1.Open(-1);
PhidgetInterfaceKit1.WaitForAttachment(3000);
end;

</syntaxhighlight></div>
The parameters can also be used to open the first Phidget of a type it can find, open based on its serial number, or even open across the network.
The API manual lists all of the available modes that open provides.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This prevents any other instances from retrieving data from the Phidget, including other programs.
The one connection per device limit does not apply when exclusively using the Phidget Webservice.
You can call Close any time outside of the Phidget’s own event handlers to end the connection.

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
This allows the program to execute other tasks until the Phidget fires a new event.

In Delphi, when the event library was installed it added Phidget ActiveX components for each type of Phidget.
These ActiveX components will show up in the toolbox under the ActiveX tab.
The ActiveX object for your Phidget can be added to the form and then hooked to the event handlers you wish to use like any other control.
For a Phidget21COMIPhidgetInterfaceKitEvents control, the event handler looks like the following:

<div class="source"><syntaxhighlight lang=delphi>

procedure TForm1.PhidgetInterfaceKit1SensorChange(ASender: TObject; Index,
SensorValue: Integer);
begin
Edit1.Text := IntToStr(Index) + ': ' + IntToStr(SensorValue);
end;

</syntaxhighlight></div>
With this method, the code inside PhidgetInterfaceKit1SensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the COM API manual for a full list of events and their general usage.

===Working directly with the Phidget===

Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming.
Simply use the CallString such as SensorValue[Index] or OutputState[Index] for PhidgetInterfaceKits.

<div class="source"><syntaxhighlight lang=delphi>

PhidgetInterfaceKit1.OutputState[0] := true;

</syntaxhighlight></div>
===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another PhidgetInterfaceKit ActiveX object to be added to the project.
The new instance can then be set up, opened and used in the same fashion as the previous one.
If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===

The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfacekit, you would place a PhidgetRFID ActiveX object instead of a PhidgetInterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

===Enabling Logging===

Often it’s a good idea to enable logging during development for debugging purposes.
This log, depending on the level set, will record certain events and errors from Phidgets.
In Delphi, this is accomplished by calling EnableLogging(logLevel, filename) on the Phidget object.

<div class="source"><syntaxhighlight lang=delphi>

PhidgetInterfaceKit1.EnableLogging(6, 'testlog.txt');

</syntaxhighlight></div>
Similarly, you can call DisableLogging() at the end of your program to shut it off.
Should you need to contact Phidgets for support, including this log is very helpful for revealing the cause of the problem.
Please see the Programming Manual for a general discussion on Phidget logging and the levels provided.

==Building your Project==
Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Language - C Sharp (.NET Compact Framework)

2012-05-02T15:39:17Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-CSharp.png|64x64px|link=|alt=]]|C#(.NET Compact Framework) is a modern, object-oriented programming language developed by [http://www.microsoft.com Microsoft] intended for developing applications for smart devices.}}
__TOC__

==Introduction==

{{LanguageSupport|C#(.NET Compact Framework)|the complete Phidget API, including events|all Phidget devices.|the .NET Compact Framework. This frameworks is supported on devices with the Windows CE operating system. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]]|}}

==Quick Downloads==
{{QuickDownloads|C#(.NET Compact Framework)|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip .NET}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip|Phidget Windows CE|(all architectures)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20120216.CAB|Windows CE|Installer(ARMV4I)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20120216.CAB|Windows CE|Installer(x86)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20120216.CAB|Windows CE|Installer(MIPSII)}}
}}
The source code for the Phidget Kernel driver for Windows CE is also provided:
* [http://www.phidgets.com/downloads/libraries/Phidget21CEkernalsource_2.1.8.20120216.zip Kernel Driver Source(all architectures)]

==Getting started with C#(.NET Compact Framework)==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

To develop applications on Windows CE, you will need a Windows(2000/XP/Vista/7) system in order to perform development on. The drivers can be easily installed onto the Windows CE system by using the installers in the [[#Libraries and Drivers | Libraries and Drivers]] section. You will also need the (.NET Compact Framework Libraries) on your development system to code against.

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
C#(.NET Compact Framework) programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time.
* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver.
* <b>{{Code|Phidget21CE.NET.dll}}</b> is the .NET(Compact Framework) Phidgets library.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].

If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip files]. Inside the zip file, please use the files that pertain to your architecture. These files should be placed in the {{Code|\Windows}} folder.

===Visual Studio 2005/2008/2010===

=====Use Our Examples=====

We will start by downloading the examples and building an executable for them on the development machine. Visual Studio will be used for development. We will then transfer the executable onto the Windows CE machine to run.

Please start by downloading the [http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip examples] and unpack them into a folder. While these examples were written in Visual Studio 2005 and 2008, Visual Studio 2010 will easily open and upgrade them. To load all projects in Visual Studio, go to File → Open → Project, and open {{Code|WindowsCE.NET Examples.sln}} or {{Code|WindowsCE.NET Examples_vs2008.sln}} for Visual Studio 2005 and 2008, respectively.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.

[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]

The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C#(.NET Compact Framework) example.

Start by setting the {{Code|HelloWorld}} project as your start up project.

Next, build the example project. Right click the {{Code|HelloWorld}} project and select {{Code|Build}} to create an executable.

[[File:VS2005 CSharpCompact Build.PNG|link=|alt=Build]]

Then in Windows Explorer, navigate to the {{Code|project directory\bin\Debug}} folder if you are targeting a debug configuration. The folder will be {{Code|project directory\bin\Release}} if you are targeting a release configuration. Regardless of whether you are targeting debug or release, you will find an executable named {{Code|HelloWorld.exe}}. Transfer this file onto the Windows CE system.

The only thing left to do is to run the example! Double click on the executable on the Windows CE system to run it.

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices!

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]]. Currently, the only devices we have example code is for the PhidgetInterfaceKit, PhidgetRFID, PhidgetTextLCD. Please ensure that you have set your start up project to be the one that matches your device before compiling.

Once you have the C#(.NET Compact Framework) examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

On the development computer, when you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget C#(.NET Compact Framework) libraries. To begin:

1. Generate a new smart device Windows CE C# Console Applications project with a descriptive name such as PhidgetTest.

[[File:VS2005 CSharpCompact New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:VS2005 CSharpCompact Add Reference 1.PNG|link=|alt=Add Reference]]

3. Download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip {{Code|Phidget21CE.NET.dll}}] file. The file is contained in the zip file.

4. Under the .NET tab, select {{Code|Phidget21CE.NET.dll}}.

[[File:VS2005 CSharpCompact Add Reference 2.PNG|link=|alt=Add Reference]]

5. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Your main reference for writing C# code will be our .NET API information, with syntax for all of our functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in C#|[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

Here, you can find further examples. Coding in C#(.NET Compact Framework) is very similar to coding in C#, so you can take a look at our resources on the [[#Language - C Sharp | C# section]].

===Example Flow===

{{ExamplePseudocode|In C#(.NET Compact Framework), you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget .NET library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in C#(.NET Compact Framework) is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

==Code Snippets==

==Common Problems and Solutions/Workarounds==

==={{ProblemSolution|All Operating Systems|The Phidgets.Events.ErrorEventHandler conflicts with System.IO.ErrorEventHandler.}}===

<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new ErrorEventHandler(spatial_Error);

...
void spatial_Error(object sender, ErrorEventArgs e){
...
}
</syntaxhighlight>
</div>

The above code produces the following errors:

{{Code|'ErrorEventHandler' is an ambiguous reference between 'System.IO.ErrorEventHandler' and 'Phidgets.Events.ErrorEventHandler'}}.

and

{{Code|'ErrorEventArgs' is an ambiguous reference between 'System.IO.ErrorEventArgs' and 'Phidgets.Events.ErrorEventArgs'}}.

The error is due to the {{Code|System.IO}} and {{Code|Phidgets.Events}} namespaces both having a class called {{Code|ErrorEventHandler}}.

To get around this issue, use the fully qualified namespace when referring to the {{Code|ErrorEventHandler}} and {{Code|ErrorEventArgs}} classes:
<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new Phidgets.Events.ErrorEventHandler(spatial_Error);
...

void spatial_Error(object sender, Phidgets.Events.ErrorEventArgs e){
...
}

</syntaxhighlight>
</div>

Language - Applescript

2012-05-02T15:10:12Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Applescript.png|64x64px]]|Applescript is a scripting language for OS X designed primarily for interfacing between applications.}}
==Support==
Applescript has a complete API and sample code for all Phidgets devices.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* API Manual (Link to API download)
* API Reference (Link to online API reference (if applicable))
* Example Programs written in this language
* You can find a high level discussion about programming with Phidgets in general on the [[General Phidget Programming]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==
The Phidget examples were written using AppleScript 2.1.2 under AppleScript Editor 2.3, and this tutorial assumes their use. Other versions and development environments should work as well and would be set up in a similar manner.

*First, open the AppleScript editor to create a new script.
*Coding with Phidgets is made possible by the interaction of Apple Events between AppleScript and • the PhidgetsOSA application. Type the following to interact with PhidgetsOSA:

<div class="source"><syntaxhighlight lang=applescript>

tell application "PhidgetsOSA"
end tell

</syntaxhighlight></div>

The project now has access to Phidgets and we are ready to begin coding. For the rest of this document, unless otherwise stated, it will be assumed that all code will be typed inside this tell block.

===Coding For Your Phidget===
A Phidget object will need to be declared. For example, we can declare a PhidgetInterfaceKit:

<div class="source"><syntaxhighlight lang=applescript>

set ifkit to make new phidget interfacekit

</syntaxhighlight></div>

The object name for any type of Phidget is listed in the PhidgetsOSA dictionary. Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

Next, the Phidget object needs to be initialized and the program needs to try and connect to the Phidget through a call to open.
Open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately.
We can handle this by using event driven programming and tracking the Attach Events and Detach Events, or by specifying the wait parameter.
The wait parameter will block for a certain amount of time until a connection is made to the Phidget. For example, we can connect to a PhidgetInterfaceKit with:

<div class="source"><syntaxhighlight lang=applescript>

tell ifkit to open

</syntaxhighlight></div>

The different types of open can be used with parameters to try and get the first device it can find, open based on its serial number, or even open across the network.
For more information on connecting across a network, please see the "Working with Phidget WebService" guide on the programming section at www.phidgets.com.
The PhidgetsOSA dictionary lists all of the available modes that open provides.
Examples of the usage of different types of open are listed below:

We can tell the ifkit to block for 5000ms until a connection has been made to the PhidgetInterfaceKit with:

<div class="source"><syntaxhighlight lang=applescript>

tell ifkit to open wait 1000 --wait for 5000ms

</syntaxhighlight></div>

We can also connect to a PhidgetInterfaceKit over the WebService with a serial number of 99999 on a server with an IP Address of 192.168.3.180 and a port that is opened on 5001 with:

<div class="source"><syntaxhighlight lang=applescript>

tell ifkit to open serial number 99999 server address "192.168.3.180" server port 5001

</syntaxhighlight></div>
It is also possible to connect using the server id. For example, we can connect to a PhidgetInterfaceKit on a password protected server with:

<div class="source"><syntaxhighlight lang=applescript>

tell ifkit to open server id "TestMac" password "pw"

</syntaxhighlight></div>

At the end of your script, don’t forget to call close to free any locks on the Phidget.

<div class="source"><syntaxhighlight lang=applescript>

tell ifkit to close
delete ifkit

</syntaxhighlight></div>

Phidgets can also be freed from the [[#PhidgetsOSA Menu Bar|PhidgetsOSA Menu Bar]].

===Event Driven Programming===
We recommend the use of event driven programming when working with Phidgets.
We can hook an event handler at loading with the following code:

<div class="source"><syntaxhighlight lang=applescript>

tell ifkit to make new interfacekit sensor change handler with properties {script file:thisScript}

</syntaxhighlight></div>

And after the tell block at end of the script, the callback method is defined as follows:

<div class="source"><syntaxhighlight lang=applescript>

using terms from application "PhidgetsOSA"
on interfacekit sensor changed ind to val on ifkit
log "Sensor Index: " & ind & ", Sensor Value: " & val
end interfacekit sensor changed
end using terms from

</syntaxhighlight></div>

With this function, the code inside the interfacekit sensor changed handler will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the PhidgetsOSA dictionary and the AppleScript examples for a list of events and their usage.

Please keep in mind that events are triggered from the PhidgetsOSA application and not from AppleScript. Thus, the AppleScript editor won't be able to receive replies when the script runs. In addition, any changes you make to the event code must be saved in order for the changes to take effect.

===Working directly with the Phidget===
Some values can be read and sent directly to the Phidget.
For example, sensor values from the PhidgetInterfaceKit can be read with:

<div class="source"><syntaxhighlight lang=applescript>

log "The first sensor has a value of: " & first interfacekit sensor's value

</syntaxhighlight></div>

These functions can be used inside a polling loop as an alternative to event driven programming.

===Using the same Phidget in more than one Application===
One important thing to remember is that when working with Phidgets, a call to open will reserve the device until closed. This prevents any other instances from retrieving data from the Phidget, including other programs.
If your goal is to use the same Phidget among multiple AppleScripts and/or other applications, there are two approaches.
:1. Implement logic in the script that will use the same Phidget object if the script detects that a Phidget of the same type has already been initialized.
For example,

<div class="source"><syntaxhighlight lang=applescript>

if first phidget interfacekit exists then
set ifkit to the first phidget interfacekit
else
set ifkit to make the phidget interfacekit
open ifkit
end if

</syntaxhighlight></div>

:2. The one connection per device limit does not apply when exclusively using the open Phidget Webservice. For more information, please see the "Connecting to the Phidgets" section of this document.

===Working with multiple Phidgets===
Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another InterfaceKit instance to be defined and initialized.
The new instance can then be set up, opened and used in the same process as the previous one.
If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===
The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfacekit, you would declare an RFID object instead of an InterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

===PhidgetsOSA Menu Bar===
[[Image:applescript_bar.jpg]]

The PhidgetsOSA menu bar appears whenever AppleScript accesses the PhidgetsOSA application.
The menu bar is used to monitor the status of any accessed Phidgets.

Additionally, it can be used to free the lock on a Phidget or quit the PhidgetsOSA application.

==Building your Project==
Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Template:ExamplePseudocode

2012-04-25T20:47:49Z

Djrudiak:

The Hello World example has this general structure so you can follow along. We also have [[General Phidget Programming|an in-depth general introduction]] to writing Phidget code (like open, read data, etc), as well as the {{{3}}} for specific syntax:

<div class="source">
{| class="source" style="margin-left:15px;"

|- valign="top"
|<font face="courier new" family="monospace">

<span style="color:#090;">// ----- '''Event''' and Other Functions -----</span>

Create any Language-Specific Functions (exception handling)

Create General '''Attach''', '''Detach''', and '''Error''' Handling Functions:
:On attach: Print Hello Message
:On detach: Print Goodbye Message

</font>
| width="15px" |  
|
<font face="courier new" family="monospace">
<span style="color:#00F;">{{{1}}}</span>
</font>
|- valign="top"
|style=white-space:nowrap|<font face="courier new" family="monospace">

<span style="color:#090;">// ----- '''Main''' Code -----</span><br><br>
'''Create''' Manager Software Object<br>
Hook '''Event''' Functions created above to Device<br>
'''Open''' Device<br>

;Wait for 'Enter' key character input
:Handle on-going attach and detach events
:Print Hello and Goodbye messages
:Exit upon input

'''Close''' Device

Delete Device

</font>
| width="15px" |  
|
<font face="courier new" family="monospace">
<span style="color:#00F;">{{{2}}}</span>
</font>
|}
</div>

Template:ExamplePseudocode

2012-04-25T20:46:53Z

Djrudiak:

The Hello World example has this general structure so you can follow along. We also have [[General Phidget Programming|an in-depth general introduction]] to writing Phidget code (like open, read data, etc), as well as the {{{3}}} for specific syntax:

<div class="source">
<font size="0">
{| class="source" style="margin-left:15px;"

|- valign="top"
|<font face="courier new" family="monospace">

<span style="color:#090;">// ----- '''Event''' and Other Functions -----</span>

Create any Language-Specific Functions (exception handling)

Create General '''Attach''', '''Detach''', and '''Error''' Handling Functions:
:On attach: Print Hello Message
:On detach: Print Goodbye Message

</font>
| width="15px" |  
|
<font face="courier new" family="monospace">
<span style="color:#00F;">{{{1}}}</span>
</font>
|- valign="top"
|style=white-space:nowrap|<font face="courier new" family="monospace">

<span style="color:#090;">// ----- '''Main''' Code -----</span><br><br>
'''Create''' Manager Software Object<br>
Hook '''Event''' Functions created above to Device<br>
'''Open''' Device<br>

;Wait for 'Enter' key character input
:Handle on-going attach and detach events
:Print Hello and Goodbye messages
:Exit upon input

'''Close''' Device

Delete Device

</font>
| width="15px" |  
|
<font face="courier new" family="monospace">
<span style="color:#00F;">{{{2}}}</span>
</font>
|}
</font>
</div>

Language - C Sharp

2012-04-24T21:07:53Z

Djrudiak: /* Use Our Examples */

[[Category:Language]]
{{OSLang|[[File:icon-CSharp.png|64x64px|link=|alt=]]|C# is a modern, object-oriented programming language developed by [[http://www.microsoft.com Microsoft]].}}
__TOC__

==Introduction==

{{LanguageSupport|C#|the complete Phidget API, including events|all Phidget devices.|the .NET or Mono framework. Both of the frameworks are supported on Windows. For Linux and OS X, only the Mono framework can be used. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]], [[#Visual Studio 2003 | Visual Studio 2003]], [[#MonoDevelop | MonoDevelop]] and the [[#Mono | Mono command line compilers]]|}}

==Quick Downloads==
{{QuickDownloads|C#|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip .NET}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip|.NET Framework Files|}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
{{LinuxQuickDownloads}}
}}

==Getting started with C#==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

Instructions are divided up by operating system. Choose:
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#OS X |OS X]]
*[[#Linux | Linux]] (including PhidgetSBC)

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
C# programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. By default, it is placed in {{Code|C:\Windows\System32}}.
You will also need one of the following two files, depending on the .NET framework version you are targeting:
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidget library for .NET framework <i><b>2.0</b></i> or higher. Your compiler has to know where this file is. By default, it is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidget library for .NET framework <i><b>1.1</b></i>. Your compiler has to know where this file is. By default, is is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
You can optionally install the following files:
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio/MonoDevelop. This documentation is also visible in the Object Browser in Visual Studio. By default, it is placed into {{Code|C:\Program Files\Phidgets}}.
* <b>{{Code|Policy.2.1.Phidget21.NET.dll}}</b> is the policy assembly for {{Code|Phidget21.NET.dll}}. Our installer places this file in the Global Assembly Cache(GAC) directory. It directs any programs compiled against version 2.1.0 or higher of {{Code|Phidget21.NET.dll}} to use the most recent installed version.

If you do not want to use our installer, you can download the five [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20111220.zip files].

Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.

===Visual Studio 2005/2008/2010===

Microsoft makes free versions of Visual Studio available known as Express Editions. The Express editions are suitable for most applications, but are limited in features for more complex applications. Please see [http://www.microsoft.com/visualstudio Microsoft Visual Studio] for more information.

=====Use Our Examples=====

Please start by downloading the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. While these examples were written in Visual Studio 2005 and 2008, Visual Studio 2010 will easily open and upgrade them. To load all projects in Visual Studio, go to File → Open → Project, and open {{Code|AllExamples/AllExamples.sln}} or {{Code|AllExamples/AllExamples_vs2008.sln}} for Visual Studio 2005 and 2008, respectively.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.

[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]

The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example.

Start by setting the {{Code|HelloWorld}} project as your start up project.

The only thing left to do is to run the example! Click on Debug → Start Debugging. Please note that the projects, by default try to find the {{Code|Phidget21.NET.dll}} in the {{Code|C:\Program Files\Phidgets}}. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to {{Code|Phidget21.NET.dll}}. Please see the [[#Write Your Own Code | Write Your Own Code ]] section for details.

[[File:CSharp VS2005 Run.PNG|link=|alt=Run]]

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:

[[File:CSharp VS2005 HelloWorld Output.PNG|link=|alt=HelloWorld Output]]

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]]. Please ensure that you have set your start up project to be the one that matches your device before compiling.

Once you have the C# examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget C# libraries. To begin:

1. Generate a new Visual C# Windows Applications project with a descriptive name such as PhidgetTest.

[[File:CSharp VS2005 New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:CSharp VS2005 Add Reference.PNG|link=|alt=Add Reference]]

3. Under the .NET tab, select {{Code|Phidget21.NET.dll}}.
If you used our installer, these files are installed in {{Code|C:\Program Files\Phidgets}}, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.

[[File:CSharp VS2005 Add Reference 2.PNG|link=|alt=Add Reference]]

4. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

===Visual Studio 2003===

=====Use Our Examples=====

1. Download the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. If you are not sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. As the examples were written in newer versions of Visual Studio, Visual Studio 2003 is not able to open the examples. Fortunately, you can import the simple examples to a Visual Studio 2003 project. It will be difficult to import the full examples as you will need to recreate the GUI components. In the [[#Use Our Examples 2 | Use Our Examples]] section, it will be assumed that the simple examples are used. You will need this example source code to be copied into your C# project later on.

2. Next, a new project will need to be created. Generate a new Visual C# console application project with a descriptive name such as PhidgetTest.

[[File:CSharp_VS2003 New Project.PNG|link=|alt=New Project]]

3. Add a reference to the Phidget .NET library.

[[File:CSharp_VS2003 Add Reference 1.PNG|link=|alt=Add Reference]]

4. Under the .NET tab, select {{Code|Phidget21.NET1.1.dll}}. If you used our installer, by default, this file is placed in {{Code|C:\Program Files\Phidgets}}. If it is in another location, please change the path to the file's location accordingly.

[[File:CSharp_VS2003 Add Reference 2.PNG|link=|alt=Add Reference]]

5. To import the simple example program into your project, please: open up {{Code|Class1.cs}}.

6. Traverse to the example in Windows Explorer and locate the {{Code|Program.cs}} file.

[[File:CSharp VS2003 Source Code.PNG|link=|alt=Source Code]]

7. Copy and paste the contents from that file into {{Code|Class1.cs}}.

8. Comment out the following line as it is not supported in .NET 1.1:
<div class="source">
<syntaxhighlight lang=csharp>
using System.Collections.Generic;
</syntaxhighlight>
</div>

[[File:CSharp VS2003 Source Code 2.PNG|link=|alt=Source Code]]

9. Now, you can run the example. Click on Debug → Start.

[[File:CSharp VS2003 Run.PNG|link=|alt=Run]]

Once you have the C# examples running, we have a [[#Follow the Examples|teaching ]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget .NET library. Please see the [[#Use Our Examples 2 | Use Our Examples ]] section for instructions.

Then, in your code, you will need to include the Phidget .NET library:
<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

===Mono===

This section will provide instructions on how to compile using the {{Code|mcs}} compiler. Other compilers such as {{Code|gmcs}}, {{Code|smcs}}, and {{Code|dmcs}} all work in the same way.

=====Use Our Examples=====

Download the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. Please only use the simple examples. The full examples uses Windows Forms, which Mono and the Gtk# toolkit are not completely compatible with. Locate the {{Code|Program.cs}} file as this contains the example source code. Copy the file into your working directory, and rename it to {{Code|example.cs}}.
<br/>

Place the {{Code|Phidget21.NET.dll}} in the same directory as your source code.

To compile and build an executable, run:
<div class="source">
<syntaxhighlight lang=bash>
mcs /out:example.exe /r:phidget21.NET.dll example.cs
</syntaxhighlight>
</div>

If you have the {{Code|Phidget21.NET.dll}} installed in another location, please change the path to the file's location accordingly.

Afterwards, you will have an executable named {{Code|example.exe}} that you can run. Type the following to run the program:
<div class="source">
<syntaxhighlight lang=bash>
mono example.exe
</syntaxhighlight>
</div>

Once you have the C# examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget .NET library. Please see the [[#Use Our Examples 3 | Use Our Example ]] section for instructions.

In your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

===MonoDevelop===

=====Use Our Examples=====

Download the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. These examples were written in Visual Studio 2005 and 2008, but are also compatible with MonoDevelop.

To load all projects in MonoDevelop, go to File → Open, and open {{Code|AllExamples/AllExamples.sln}}

This will load all of the examples available for C#, and then you can set your main project to be the one that matches your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. If you are running under the .NET framework, you can use either the full or simple examples. Otherwise, if you are running under the Mono framework, please only use the simple examples. The full examples uses Windows Forms, which is not completely compatible with Mono's Gtk#.

[[File:CSharp MonoDevelop Win Start Up.PNG|link=|alt=Start Up Project]]

The only thing left to do is to run the examples! Right click the project, and click on {{Code|Run With}} and select the target framework. Please note that the projects, by default try to find the {{Code|Phidget21.NET.dll}} in the {{Code|C\Program Files\Phidgets}}. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to {{Code|Phidget21.NET.dll}}. Please see the [[#Write Your Own Code 4 | Write Your Own Code]] section for details.

[[File:CSharp MonoDevelop Win Run As.PNG|link=|alt=Run As]]

Once you have the C# examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget .NET library. To begin:

1. Create a new C# empty project with a descriptive name such as PhidgetTest.

[[File:CSharp MonoDevelop Win New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:CSharp MonoDevelop Win Reference.PNG|link=|alt=Add Reference]]

3. Select {{Code|Phidget21.NET.dll}}. If you used our installer, by default, this file is placed in {{Code|C:\Program Files\Phidgets}}. If it is in another location, please change the path to the file's location accordingly.

[[File:CSharp MonoDevelop Win Reference 2.PNG|link=|alt=Add Reference]]

4. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

==OS X==

C# has excellent support on OS X through the Mono framework.

The first step in using C# on Mac is to install the Phidget .NET libraries. Compile and install them as explained on the [[Device List|getting started guide for your device]]. Then, the [[OS - OS X]] page also describes the different Phidget files, their installed locations, and their roles....

==Linux==

C# has support on Linux through the Mono framework.

===Use Our Examples===

The first step in using C# with Phidgets on Linux is to make sure that you have all of Mono installed. Although you probably have already done this if you're a C# programmer, you want to make sure you have all of the packages you'll need. Try:

<div class="source">
<syntaxhighlight lang=bash>
sudo apt-get mono-complete
</syntaxhighlight>
</div>

Next, you'll want to install the main Phidget Libraries. Compile and install them as explained on the main [[OS - Linux | Linux page]]. That Linux page also describes the different Phidget files, their installed locations, and their roles.

Then, you will need the Phidget .NET libraries. These are part of the Windows library zip file download:

* [http://www.phidgets.com/downloads/libraries/Phidget21-windevel.zip Phidget Windows Library Zip File]

Extract the library zip file. Descriptions for the files are available on the [[OS - Windows]] page, but for now we only need the {{Code|Phidget21.NET.dll}} file to run the Phidget C# examples in Mono. So remember where you unzipped these Windows libraries - you will need to copy the {{Code|Phidget21.NET.dll}} file into your example directory shortly.

Next, you'll want to download and extract the Phidget C# Examples (For Windows, not for .NET Compact):

* [http://www.phidgets.com/downloads/examples/CSharp.zip C Sharp Examples for Windows]

To check that your Linux, Phidget, and Mono setup is all working together, you'll want to run the C# examples. Specifically, you'll want to run the ''simple'' C# examples. Find the source code for your device. The source file will be named the same as the software object for your device. If you are not sure what the software object for your device is, it can be found in the Software/API section on the [[Device List|Product Page]] for your device.

Let's say you're running the Temperature Sensor example (for the 1048 or 1051). The source code for the example is in the directory:

:{{Code|TemperatureSensorExamples}} → {{Code|TemperatureSensor-simple}} → {{Code|TemperatureSensor-simple}} → {{Code|Program.cs}}

Other examples will be in directories named appropriately for their software object name. Once you have found the example you want to run, copy the {{Code|Phidget21.NET.dll}} file that you unzipped earlier into that example directory where the {{Code|Program.cs}} file is.

Then, compile the code. When compiling, you need to link to the Phidget library. As the Phidget21.NET file is an "additional assembly" in C#/Mono, you can link to the assembly using the {{Code|-r}} "reference" switch:

<div class="source">
<syntaxhighlight lang=bash>
gmcs Program.cs -r:Phidget21.NET.dll
</syntaxhighlight>
</div>

This will compile a {{Code|*.exe}} file - in this case, {{Code|Program.exe}}. This you can then run under Mono:

<div class="source">
<syntaxhighlight lang=bash>
sudo mono Program.exe
</syntaxhighlight>
</div>

Remember that the {{Code|sudo}} is needed unless you have your [[OS - Linux#Setting udev Rules|udev rules set on your Linux system]].

If you will be compiling with an IDE such as GTK# or MonoDevelop, we don't have explicit instructions by IDE for Linux. However, you will probably find the [[#MonoDevelop | MonoDevelop]] section in the Windows portion above useful.

===Write Your Own Code===

When writing your code from scratch, you start it as you would any C# code on Linux, such as within a text editor like Emacs, Vi, Gedit, or Kate. In your .cs source code file, you must include a reference to the Phidget Library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

Then, you would compile your completed C# code the same way as the examples above.

Mono also has a few different IDEs which you can use to develop code, and these are especially useful if you are doing GUI development. We provide instructions for MonoDevelop - one such IDE - being used [[#MonoDevelop|under Windows]].

To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Follow the Examples|teaching section]] to help you follow the provided C# examples and which has resources such as the API reference.

==Windows CE==

===Description of Library Files===
C# programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. By default, it is placed in {{Code|C:\Windows\System32}}.
You will also need one of the following two files, depending on the .NET framework version you are targeting:
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidget library for .NET framework <i><b>2.0</b></i> or higher. Your compiler has to know where this file is. By default, it is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidget library for .NET framework <i><b>1.1</b></i>. Your compiler has to know where this file is. By default, it is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
You can optionally install the following files:
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio/MonoDevelop. This documentation is also visible in the Object Browser in Visual Studio. By default, it is placed into {{Code|C:\Program Files\Phidgets}}.
* <b>{{Code|Policy.2.1.Phidget21.NET.dll}}</b> is the policy assembly for {{Code|Phidget21.NET.dll}}. Our installer places this file in the Global Assembly Cache(GAC) directory. It directs any programs compiled against version 2.1.0 or higher of {{Code|Phidget21.NET.dll}} to use the most recent installed version.

If you do not want to use our installer, you can download the five [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20111220.zip files].

Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.

===Visual Studio 2005/2008/2010===

Microsoft makes free versions of Visual Studio available known as Express Editions. The Express editions are suitable for most applications, but are limited in features for more complex applications. Please see [http://www.microsoft.com/visualstudio Microsoft Visual Studio] for more information.

=====Use Our Examples=====

Please start by downloading the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. While these examples were written in Visual Studio 2005 and 2008, Visual Studio 2010 will easily open and upgrade them. To load all projects in Visual Studio, go to File → Open → Project, and open {{Code|AllExamples/AllExamples.sln}} or {{Code|AllExamples/AllExamples_vs2008.sln}} for Visual Studio 2005 and 2008, respectively.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.
[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]

The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example.

Start by setting the {{Code|HelloWorld}} project as your start up project.

The only thing left to do is to run the example! Click on Debug → Start Debugging. Please note that the projects, by default try to find the {{Code|Phidget21.NET.dll}} in the {{Code|C:\Program Files\Phidgets}}. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to {{Code|Phidget21.NET.dll}}. Please see the [[#Write Your Own Code | Write Your Own Code ]] section for details.

[[File:CSharp VS2005 Run.PNG|link=|alt=Run]]

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:

[[File:CSharp VS2005 HelloWorld Output.PNG|link=|alt=HelloWorld Output]]

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]]. Please ensure that you have set your start up project to be the one that matches your device before compiling.

Once you have the C# examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget C# libraries. To begin:

1. Generate a new Visual C# Windows Applications project with a descriptive name such as PhidgetTest.

[[File:CSharp VS2005 New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:CSharp VS2005 Add Reference.PNG|link=|alt=Add Reference]]

3. Under the .NET tab, select {{Code|Phidget21.NET.dll}}.
If you used our installer, these files are installed in {{Code|C:\Program Files\Phidgets}}, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.

[[File:CSharp VS2005 Add Reference 2.PNG|link=|alt=Add Reference]]

4. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the C# Phidget functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in C#|[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

===Example Flow===

{{ExamplePseudocode|In C#, you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget .NET library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in C# is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

===Code Snippets===

==Common Problems and Solutions/Workarounds==

==={{ProblemSolution|All Operating Systems|The Phidgets.Events.ErrorEventHandler conflicts with System.IO.ErrorEventHandler.}}===

<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new ErrorEventHandler(spatial_Error);

...
void spatial_Error(object sender, ErrorEventArgs e){
...
}
</syntaxhighlight>
</div>

The above code produces the following errors:

{{Code|'ErrorEventHandler' is an ambiguous reference between 'System.IO.ErrorEventHandler' and 'Phidgets.Events.ErrorEventHandler'}}.

and

{{Code|'ErrorEventArgs' is an ambiguous reference between 'System.IO.ErrorEventArgs' and 'Phidgets.Events.ErrorEventArgs'}}.

The error is due to the {{Code|System.IO}} and {{Code|Phidgets.Events}} namespaces both having a class called {{Code|ErrorEventHandler}}.

To get around this issue, use the fully qualified namespace when referring to the {{Code|ErrorEventHandler}} and {{Code|ErrorEventArgs}} classes:
<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new Phidgets.Events.ErrorEventHandler(spatial_Error);
...

void spatial_Error(object sender, Phidgets.Events.ErrorEventArgs e){
...
}

</syntaxhighlight>
</div>

Language - C Sharp (.NET Compact Framework)

2012-04-24T21:07:30Z

Djrudiak: /* Use Our Examples */

[[Category:Language]]
{{OSLang|[[File:icon-CSharp.png|64x64px|link=|alt=]]|C#(.NET Compact Framework) is a modern, object-oriented programming language developed by [[http://www.microsoft.com Microsoft]] intended for developing applications for smart devices.}}
__TOC__

==Introduction==

{{LanguageSupport|C#(.NET Compact Framework)|the complete Phidget API, including events|all Phidget devices.|the .NET Compact Framework. This frameworks is supported on devices with the Windows CE operating system. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]]|}}

==Quick Downloads==
{{QuickDownloads|C#(.NET Compact Framework)|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip .NET}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip|Phidget Windows CE|(all architectures)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20120216.CAB|Windows CE|Installer(ARMV4I)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20120216.CAB|Windows CE|Installer(x86)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20120216.CAB|Windows CE|Installer(MIPSII)}}
}}
The source code for the Phidget Kernel driver for Windows CE is also provided:
* [http://www.phidgets.com/downloads/libraries/Phidget21CEkernalsource_2.1.8.20120216.zip Kernel Driver Source(all architectures)]

==Getting started with C#(.NET Compact Framework)==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

To develop applications on Windows CE, you will need a Windows(2000/XP/Vista/7) system in order to perform development on. The drivers can be easily installed onto the Windows CE system by using the installers in the [[#Libraries and Drivers | Libraries and Drivers]] section. You will also need the (.NET Compact Framework Libraries) on your development system to code against.

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
C#(.NET Compact Framework) programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time.
* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver.
* <b>{{Code|Phidget21CE.NET.dll}}</b> is the .NET(Compact Framework) Phidgets library.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].

If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip files]. Inside the zip file, please use the files that pertain to your architecture. These files should be placed in the {{Code|\Windows}} folder.

===Visual Studio 2005/2008/2010===

=====Use Our Examples=====

We will start by downloading the examples and building an executable for them on the development machine. Visual Studio will be used for development. We will then transfer the executable onto the Windows CE machine to run.

Please start by downloading the [http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip examples] and unpack them into a folder. While these examples were written in Visual Studio 2005 and 2008, Visual Studio 2010 will easily open and upgrade them. To load all projects in Visual Studio, go to File → Open → Project, and open {{Code|WindowsCE.NET Examples.sln}} or {{Code|WindowsCE.NET Examples_vs2008.sln}} for Visual Studio 2005 and 2008, respectively.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.

[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]

The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C#(.NET Compact Framework) example.

Start by setting the {{Code|HelloWorld}} project as your start up project.

Next, build the example project. Right click the {{Code|HelloWorld}} project and select {{Code|Build}} to create an executable.

[[File:VS2005 CSharpCompact Build.PNG|link=|alt=Build]]

Then in Windows Explorer, navigate to the {{Code|project directory\bin\Debug}} folder if you are targeting a debug configuration. The folder will be {{Code|project directory\bin\Release}} if you are targeting a release configuration. Regardless of whether you are targeting debug or release, you will find an executable named {{Code|HelloWorld.exe}}. Transfer this file onto the Windows CE system.

The only thing left to do is to run the example! Double click on the executable on the Windows CE system to run it.

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices!

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]]. Currently, the only devices we have example code is for the PhidgetInterfaceKit, PhidgetRFID, PhidgetTextLCD. Please ensure that you have set your start up project to be the one that matches your device before compiling.

Once you have the C#(.NET Compact Framework) examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

On the development computer, when you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget C#(.NET Compact Framework) libraries. To begin:

1. Generate a new smart device Windows CE C# Console Applications project with a descriptive name such as PhidgetTest.

[[File:VS2005 CSharpCompact New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:VS2005 CSharpCompact Add Reference 1.PNG|link=|alt=Add Reference]]

3. Download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip {{Code|Phidget21CE.NET.dll}}] file. The file is contained in the zip file.

4. Under the .NET tab, select {{Code|Phidget21CE.NET.dll}}.

[[File:VS2005 CSharpCompact Add Reference 2.PNG|link=|alt=Add Reference]]

5. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the C#(.NET Compact Framework) Phidget functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in C#|[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

Here, you can find further examples. Coding in C#(.NET Compact Framework) is very similar to coding in C#, so you can take a look at our resources on the [[#Language - C Sharp | C# section]].

===Example Flow===

{{ExamplePseudocode|In C#(.NET Compact Framework), you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget .NET library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in C#(.NET Compact Framework) is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

==Code Snippets==

==Common Problems and Solutions/Workarounds==

==={{ProblemSolution|All Operating Systems|The Phidgets.Events.ErrorEventHandler conflicts with System.IO.ErrorEventHandler.}}===

<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new ErrorEventHandler(spatial_Error);

...
void spatial_Error(object sender, ErrorEventArgs e){
...
}
</syntaxhighlight>
</div>

The above code produces the following errors:

{{Code|'ErrorEventHandler' is an ambiguous reference between 'System.IO.ErrorEventHandler' and 'Phidgets.Events.ErrorEventHandler'}}.

and

{{Code|'ErrorEventArgs' is an ambiguous reference between 'System.IO.ErrorEventArgs' and 'Phidgets.Events.ErrorEventArgs'}}.

The error is due to the {{Code|System.IO}} and {{Code|Phidgets.Events}} namespaces both having a class called {{Code|ErrorEventHandler}}.

To get around this issue, use the fully qualified namespace when referring to the {{Code|ErrorEventHandler}} and {{Code|ErrorEventArgs}} classes:
<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new Phidgets.Events.ErrorEventHandler(spatial_Error);
...

void spatial_Error(object sender, Phidgets.Events.ErrorEventArgs e){
...
}

</syntaxhighlight>
</div>

Language - Visual Basic (.NET Compact Framework)

2012-04-20T21:48:26Z

Djrudiak: /* Use Our Examples */

[[Category:Language]]
{{OSLang|[[File:icon-Visual Basic Net.png|64x64px|link=|alt=]]|Visual Basic(.NET Compact Framework) is a modern, object-oriented programming language developed by [[http://www.microsoft.com Microsoft]] intended for developing applications for smart devices.}}
__TOC__

==Introduction==

{{LanguageSupport|Visual Basic(.NET Compact Framework)|the complete Phidget API, including events|all Phidget devices.|the .NET Compact Framework. This frameworks is supported on devices with the Windows CE operating system. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]]|}}

==Quick Downloads==
{{QuickDownloads|Visual Basic(.NET Compact Framework)|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip .NET}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip|Phidget Windows CE|(all architectures)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20120216.CAB|Windows CE|Installer(ARMV4I)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20120216.CAB|Windows CE|Installer(x86)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20120216.CAB|Windows CE|Installer(MIPSII)}}
}}
The source code for the Phidget Kernel driver for Windows CE is also provided:
* [http://www.phidgets.com/downloads/libraries/Phidget21CEkernalsource_2.1.8.20120216.zip Kernel Driver Source(all architectures)]

==Getting started with Visual Basic(.NET Compact Framework)==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

To develop applications on Windows CE, you will need a Windows(2000/XP/Vista/7) system in order to perform development on. The drivers can be easily installed onto the Windows CE system by using the installers in the [[#Libraries and Drivers | Libraries and Drivers]] section. You will also need the (.NET Compact Framework Libraries) on your development system to code against.

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
Visual Basic(.NET Compact Framework) programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time.
* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver.
* <b>{{Code|Phidget21CE.NET.dll}}</b> is the .NET(Compact Framework) Phidgets library.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].

If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip files]. Inside the zip file, please use the files that pertain to your architecture. These files should be placed in the {{Code|\Windows}} folder.

===Visual Studio 2008/2010===

=====Use Our Examples=====

We will start by downloading the examples and building an executable for them on the development machine. Visual Studio will be used for development. We will then transfer the executable onto the Windows CE machine to run.

Please start by downloading the [http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip examples] and unpack them into a folder. While these examples were written in Visual Studio 2008, Visual Studio 2010 will easily open and upgrade them. Please note that we do not have examples for Visual Studio 2005.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2008 project.

[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]

The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} Visual Basic(.NET Compact Framework) example.

Next, build the example project. Right click the {{Code|HelloWorld}} project and select {{Code|Build}} to create an executable.

[[File:VS2008 VBNETCompact Build.PNG|link=|alt=Build]]

Then in Windows Explorer, navigate to the {{Code|project directory\bin\Debug}} folder if you are targeting a debug configuration. The folder will be {{Code|project directory\bin\Release}} if you are targeting a release configuration. Regardless of whether you are targeting debug or release, you will find an executable named {{Code|HelloWorld.exe}}. Transfer this file onto the Windows CE system.

The only thing left to do is to run the example! Double click on the executable on the Windows CE system to run it.

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices!

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]]. Currently, the only devices we have example code is for the PhidgetInterfaceKit, PhidgetRFID, PhidgetTextLCD. Please ensure that you have set your start up project to be the one that matches your device before compiling.

Once you have the Visual Basic(.NET Compact Framework) examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

On the development computer, when you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget Visual Basic(.NET Compact Framework) libraries. To begin:

1. Generate a new smart device Visual Basic Console Applications project with a descriptive name such as PhidgetTest.

[[File:VS2008 VBNETCompact New Project 1.PNG|link=|alt=New Project]]

[[File:VS2008 VBNETCompact New Project 2.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:VS2008 VBNETCompact Add Reference 1.PNG|link=|alt=Add Reference]]

3. Download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip {{Code|Phidget21CE.NET.dll}}] file. The file is contained in the zip file.

4. Under the .NET tab, select {{Code|Phidget21CE.NET.dll}}.

[[File:VS2008 VBNETCompact Add Reference 2.PNG|link=|alt=Add Reference]]

5. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the Visual Basic(.NET Compact Framework) Phidget functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in Visual Basic|[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

Here, you can find further examples. Coding in Visual Basic(.NET Compact Framework) is very similar to coding in Visual Basic, so you can take a look at our resources on the [[#Language - Visual Basic .NET | section]].

===Example Flow===

{{ExamplePseudocode|In Visual Basic(.NET Compact Framework), you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget .NET library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in Visual Basic(.NET Compact Framework) is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

==Code Snippets==

==Common Problems and Solutions/Workarounds==

==={{ProblemSolution|All Operating Systems|The Phidgets.Events.ErrorEventHandler conflicts with System.IO.ErrorEventHandler.}}===

<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new ErrorEventHandler(spatial_Error);

...
void spatial_Error(object sender, ErrorEventArgs e){
...
}
</syntaxhighlight>
</div>

The above code produces the following errors:

{{Code|'ErrorEventHandler' is an ambiguous reference between 'System.IO.ErrorEventHandler' and 'Phidgets.Events.ErrorEventHandler'}}.

and

{{Code|'ErrorEventArgs' is an ambiguous reference between 'System.IO.ErrorEventArgs' and 'Phidgets.Events.ErrorEventArgs'}}.

The error is due to the {{Code|System.IO}} and {{Code|Phidgets.Events}} namespaces both having a class called {{Code|ErrorEventHandler}}.

To get around this issue, use the fully qualified namespace when referring to the {{Code|ErrorEventHandler}} and {{Code|ErrorEventArgs}} classes:
<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new Phidgets.Events.ErrorEventHandler(spatial_Error);
...

void spatial_Error(object sender, Phidgets.Events.ErrorEventArgs e){
...
}

</syntaxhighlight>
</div>

Language - C Sharp (.NET Compact Framework)

2012-04-20T21:46:15Z

Djrudiak: /* Use Our Examples */

[[Category:Language]]
{{OSLang|[[File:icon-CSharp.png|64x64px|link=|alt=]]|C#(.NET Compact Framework) is a modern, object-oriented programming language developed by [[http://www.microsoft.com Microsoft]] intended for developing applications for smart devices.}}
__TOC__

==Introduction==

{{LanguageSupport|C#(.NET Compact Framework)|the complete Phidget API, including events|all Phidget devices.|the .NET Compact Framework. This frameworks is supported on devices with the Windows CE operating system. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]]|}}

==Quick Downloads==
{{QuickDownloads|C#(.NET Compact Framework)|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip .NET}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip|Phidget Windows CE|(all architectures)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20120216.CAB|Windows CE|Installer(ARMV4I)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20120216.CAB|Windows CE|Installer(x86)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20120216.CAB|Windows CE|Installer(MIPSII)}}
}}
The source code for the Phidget Kernel driver for Windows CE is also provided:
* [http://www.phidgets.com/downloads/libraries/Phidget21CEkernalsource_2.1.8.20120216.zip Kernel Driver Source(all architectures)]

==Getting started with C#(.NET Compact Framework)==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

To develop applications on Windows CE, you will need a Windows(2000/XP/Vista/7) system in order to perform development on. The drivers can be easily installed onto the Windows CE system by using the installers in the [[#Libraries and Drivers | Libraries and Drivers]] section. You will also need the (.NET Compact Framework Libraries) on your development system to code against.

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
C#(.NET Compact Framework) programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time.
* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver.
* <b>{{Code|Phidget21CE.NET.dll}}</b> is the .NET(Compact Framework) Phidgets library.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].

If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip files]. Inside the zip file, please use the files that pertain to your architecture. These files should be placed in the {{Code|\Windows}} folder.

===Visual Studio 2005/2008/2010===

=====Use Our Examples=====

We will start by downloading the examples and building an executable for them on the development machine. Visual Studio will be used for development. We will then transfer the executable onto the Windows CE machine to run.

Please start by downloading the [http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip examples] and unpack them into a folder. While these examples were written in Visual Studio 2005 and 2008, Visual Studio 2010 will easily open and upgrade them. To load all projects in Visual Studio, go to File → Open → Project, and open {{Code|WindowsCE.NET Examples.sln}} or {{Code|WindowsCE.NET Examples_vs2008.sln}} for Visual Studio 2005 and 2008, respectively.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.
[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]

The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C#(.NET Compact Framework) example.

Start by setting the {{Code|HelloWorld}} project as your start up project.

Next, build the example project. Right click the {{Code|HelloWorld}} project and select {{Code|Build}} to create an executable.

[[File:VS2005 CSharpCompact Build.PNG|link=|alt=Build]]

Then in Windows Explorer, navigate to the {{Code|project directory\bin\Debug}} folder if you are targeting a debug configuration. The folder will be {{Code|project directory\bin\Release}} if you are targeting a release configuration. Regardless of whether you are targeting debug or release, you will find an executable named {{Code|HelloWorld.exe}}. Transfer this file onto the Windows CE system.

The only thing left to do is to run the example! Double click on the executable on the Windows CE system to run it.

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices!

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]]. Currently, the only devices we have example code is for the PhidgetInterfaceKit, PhidgetRFID, PhidgetTextLCD. Please ensure that you have set your start up project to be the one that matches your device before compiling.

Once you have the C#(.NET Compact Framework) examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

On the development computer, when you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget C#(.NET Compact Framework) libraries. To begin:

1. Generate a new smart device Windows CE C# Console Applications project with a descriptive name such as PhidgetTest.

[[File:VS2005 CSharpCompact New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:VS2005 CSharpCompact Add Reference 1.PNG|link=|alt=Add Reference]]

3. Download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip {{Code|Phidget21CE.NET.dll}}] file. The file is contained in the zip file.

4. Under the .NET tab, select {{Code|Phidget21CE.NET.dll}}.

[[File:VS2005 CSharpCompact Add Reference 2.PNG|link=|alt=Add Reference]]

5. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the C#(.NET Compact Framework) Phidget functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in C#|[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

Here, you can find further examples. Coding in C#(.NET Compact Framework) is very similar to coding in C#, so you can take a look at our resources on the [[#Language - C Sharp | C# section]].

===Example Flow===

{{ExamplePseudocode|In C#(.NET Compact Framework), you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget .NET library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in C#(.NET Compact Framework) is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

==Code Snippets==

==Common Problems and Solutions/Workarounds==

==={{ProblemSolution|All Operating Systems|The Phidgets.Events.ErrorEventHandler conflicts with System.IO.ErrorEventHandler.}}===

<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new ErrorEventHandler(spatial_Error);

...
void spatial_Error(object sender, ErrorEventArgs e){
...
}
</syntaxhighlight>
</div>

The above code produces the following errors:

{{Code|'ErrorEventHandler' is an ambiguous reference between 'System.IO.ErrorEventHandler' and 'Phidgets.Events.ErrorEventHandler'}}.

and

{{Code|'ErrorEventArgs' is an ambiguous reference between 'System.IO.ErrorEventArgs' and 'Phidgets.Events.ErrorEventArgs'}}.

The error is due to the {{Code|System.IO}} and {{Code|Phidgets.Events}} namespaces both having a class called {{Code|ErrorEventHandler}}.

To get around this issue, use the fully qualified namespace when referring to the {{Code|ErrorEventHandler}} and {{Code|ErrorEventArgs}} classes:
<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new Phidgets.Events.ErrorEventHandler(spatial_Error);
...

void spatial_Error(object sender, Phidgets.Events.ErrorEventArgs e){
...
}

</syntaxhighlight>
</div>

Language - Visual Basic (.NET Compact Framework)

2012-04-20T21:41:07Z

Djrudiak: /* Use Our Examples */

[[Category:Language]]
{{OSLang|[[File:icon-Visual Basic Net.png|64x64px|link=|alt=]]|Visual Basic(.NET Compact Framework) is a modern, object-oriented programming language developed by [[http://www.microsoft.com Microsoft]] intended for developing applications for smart devices.}}
__TOC__

==Introduction==

{{LanguageSupport|Visual Basic(.NET Compact Framework)|the complete Phidget API, including events|all Phidget devices.|the .NET Compact Framework. This frameworks is supported on devices with the Windows CE operating system. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]]|}}

==Quick Downloads==
{{QuickDownloads|Visual Basic(.NET Compact Framework)|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip .NET}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip|Phidget Windows CE|(all architectures)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20120216.CAB|Windows CE|Installer(ARMV4I)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20120216.CAB|Windows CE|Installer(x86)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20120216.CAB|Windows CE|Installer(MIPSII)}}
}}
The source code for the Phidget Kernel driver for Windows CE is also provided:
* [http://www.phidgets.com/downloads/libraries/Phidget21CEkernalsource_2.1.8.20120216.zip Kernel Driver Source(all architectures)]

==Getting started with Visual Basic(.NET Compact Framework)==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

To develop applications on Windows CE, you will need a Windows(2000/XP/Vista/7) system in order to perform development on. The drivers can be easily installed onto the Windows CE system by using the installers in the [[#Libraries and Drivers | Libraries and Drivers]] section. You will also need the (.NET Compact Framework Libraries) on your development system to code against.

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
Visual Basic(.NET Compact Framework) programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time.
* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver.
* <b>{{Code|Phidget21CE.NET.dll}}</b> is the .NET(Compact Framework) Phidgets library.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].

If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip files]. Inside the zip file, please use the files that pertain to your architecture. These files should be placed in the {{Code|\Windows}} folder.

===Visual Studio 2008/2010===

=====Use Our Examples=====

We will start by downloading the examples and building an executable for them on the development machine. Visual Studio will be used for development. We will then transfer the executable onto the Windows CE machine to run.

Please start by downloading the [http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip examples] and unpack them into a folder. While these examples were written in Visual Studio 2008, Visual Studio 2010 will easily open and upgrade them. Please note that we do not have examples for Visual Studio 2005.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2008 project.

[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]

The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} Visual Basic(.NET Compact Framework) example.

Next, build the example project. Right click the {{Code|HelloWorld}} project and select {{Code|Build}} to create an executable.

[[File:VS2008 VBNETCompact Build.PNG|link=|alt=Build]]

Then in Windows Explorer, navigate to the {{Code|project directory\bin\Debug}} folder if you are are targeting a debug configuration. The folder will be {{Code|project directory\bin\Release}} if you are targeting a release configuration. Regardless of whether you are targeting debug or release, you will find an executable named {{Code|HelloWorld.exe}}. Transfer this file onto the Windows CE system.

The only thing left to do is to run the example! Double click on the executable on the Windows CE system to run it.

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices!

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]]. Currently, the only devices we have example code is for the PhidgetInterfaceKit, PhidgetRFID, PhidgetTextLCD. Please ensure that you have set your start up project to be the one that matches your device before compiling.

Once you have the Visual Basic(.NET Compact Framework) examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

On the development computer, when you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget Visual Basic(.NET Compact Framework) libraries. To begin:

1. Generate a new smart device Visual Basic Console Applications project with a descriptive name such as PhidgetTest.

[[File:VS2008 VBNETCompact New Project 1.PNG|link=|alt=New Project]]

[[File:VS2008 VBNETCompact New Project 2.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:VS2008 VBNETCompact Add Reference 1.PNG|link=|alt=Add Reference]]

3. Download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip {{Code|Phidget21CE.NET.dll}}] file. The file is contained in the zip file.

4. Under the .NET tab, select {{Code|Phidget21CE.NET.dll}}.

[[File:VS2008 VBNETCompact Add Reference 2.PNG|link=|alt=Add Reference]]

5. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the Visual Basic(.NET Compact Framework) Phidget functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in Visual Basic|[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

Here, you can find further examples. Coding in Visual Basic(.NET Compact Framework) is very similar to coding in Visual Basic, so you can take a look at our resources on the [[#Language - Visual Basic .NET | section]].

===Example Flow===

{{ExamplePseudocode|In Visual Basic(.NET Compact Framework), you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget .NET library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in Visual Basic(.NET Compact Framework) is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

==Code Snippets==

==Common Problems and Solutions/Workarounds==

==={{ProblemSolution|All Operating Systems|The Phidgets.Events.ErrorEventHandler conflicts with System.IO.ErrorEventHandler.}}===

<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new ErrorEventHandler(spatial_Error);

...
void spatial_Error(object sender, ErrorEventArgs e){
...
}
</syntaxhighlight>
</div>

The above code produces the following errors:

{{Code|'ErrorEventHandler' is an ambiguous reference between 'System.IO.ErrorEventHandler' and 'Phidgets.Events.ErrorEventHandler'}}.

and

{{Code|'ErrorEventArgs' is an ambiguous reference between 'System.IO.ErrorEventArgs' and 'Phidgets.Events.ErrorEventArgs'}}.

The error is due to the {{Code|System.IO}} and {{Code|Phidgets.Events}} namespaces both having a class called {{Code|ErrorEventHandler}}.

To get around this issue, use the fully qualified namespace when referring to the {{Code|ErrorEventHandler}} and {{Code|ErrorEventArgs}} classes:
<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new Phidgets.Events.ErrorEventHandler(spatial_Error);
...

void spatial_Error(object sender, Phidgets.Events.ErrorEventArgs e){
...
}

</syntaxhighlight>
</div>

Language - C Sharp

2012-04-20T21:27:27Z

Djrudiak: /* Windows CE */

[[Category:Language]]
{{OSLang|[[File:icon-CSharp.png|64x64px|link=|alt=]]|C# is a modern, object-oriented programming language developed by [[http://www.microsoft.com Microsoft]].}}
__TOC__

==Introduction==

{{LanguageSupport|C#|the complete Phidget API, including events|all Phidget devices.|the .NET or Mono framework. Both of the frameworks are supported on Windows. For Linux and OS X, only the Mono framework can be used. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]], [[#Visual Studio 2003 | Visual Studio 2003]], [[#MonoDevelop | MonoDevelop]] and the [[#Mono | Mono command line compilers]]|}}

==Quick Downloads==
{{QuickDownloads|C#|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip .NET}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip|.NET Framework Files|}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
{{LinuxQuickDownloads}}
}}

==Getting started with C#==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

Instructions are divided up by operating system. Choose:
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#OS X |OS X]]
*[[#Linux | Linux]] (including PhidgetSBC)

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
C# programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. By default, it is placed in {{Code|C:\Windows\System32}}.
You will also need one of the following two files, depending on the .NET framework version you are targeting:
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidget library for .NET framework <i><b>2.0</b></i> or higher. Your compiler has to know where this file is. By default, it is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidget library for .NET framework <i><b>1.1</b></i>. Your compiler has to know where this file is. By default, is is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
You can optionally install the following files:
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio/MonoDevelop. This documentation is also visible in the Object Browser in Visual Studio. By default, it is placed into {{Code|C:\Program Files\Phidgets}}.
* <b>{{Code|Policy.2.1.Phidget21.NET.dll}}</b> is the policy assembly for {{Code|Phidget21.NET.dll}}. Our installer places this file in the Global Assembly Cache(GAC) directory. It directs any programs compiled against version 2.1.0 or higher of {{Code|Phidget21.NET.dll}} to use the most recent installed version.

If you do not want to use our installer, you can download the five [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20111220.zip files].

Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.

===Visual Studio 2005/2008/2010===

Microsoft makes free versions of Visual Studio available known as Express Editions. The Express editions are suitable for most applications, but are limited in features for more complex applications. Please see [http://www.microsoft.com/visualstudio Microsoft Visual Studio] for more information.

=====Use Our Examples=====

Please start by downloading the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. While these examples were written in Visual Studio 2005 and 2008, Visual Studio 2010 will easily open and upgrade them. To load all projects in Visual Studio, go to File → Open → Project, and open {{Code|AllExamples/AllExamples.sln}} or {{Code|AllExamples/AllExamples_vs2008.sln}} for Visual Studio 2005 and 2008, respectively.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.
[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]

The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example.

Start by setting the {{Code|HelloWorld}} project as your start up project.

The only thing left to do is to run the example! Click on Debug → Start Debugging. Please note that the projects, by default try to find the {{Code|Phidget21.NET.dll}} in the {{Code|C:\Program Files\Phidgets}}. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to {{Code|Phidget21.NET.dll}}. Please see the [[#Write Your Own Code | Write Your Own Code ]] section for details.

[[File:CSharp VS2005 Run.PNG|link=|alt=Run]]

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:

[[File:CSharp VS2005 HelloWorld Output.PNG|link=|alt=HelloWorld Output]]

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]]. Please ensure that you have set your start up project to be the one that matches your device before compiling.

Once you have the C# examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget C# libraries. To begin:

1. Generate a new Visual C# Windows Applications project with a descriptive name such as PhidgetTest.

[[File:CSharp VS2005 New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:CSharp VS2005 Add Reference.PNG|link=|alt=Add Reference]]

3. Under the .NET tab, select {{Code|Phidget21.NET.dll}}.
If you used our installer, these files are installed in {{Code|C:\Program Files\Phidgets}}, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.

[[File:CSharp VS2005 Add Reference 2.PNG|link=|alt=Add Reference]]

4. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

===Visual Studio 2003===

=====Use Our Examples=====

1. Download the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. If you are not sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. As the examples were written in newer versions of Visual Studio, Visual Studio 2003 is not able to open the examples. Fortunately, you can import the simple examples to a Visual Studio 2003 project. It will be difficult to import the full examples as you will need to recreate the GUI components. In the [[#Use Our Examples 2 | Use Our Examples]] section, it will be assumed that the simple examples are used. You will need this example source code to be copied into your C# project later on.

2. Next, a new project will need to be created. Generate a new Visual C# console application project with a descriptive name such as PhidgetTest.

[[File:CSharp_VS2003 New Project.PNG|link=|alt=New Project]]

3. Add a reference to the Phidget .NET library.

[[File:CSharp_VS2003 Add Reference 1.PNG|link=|alt=Add Reference]]

4. Under the .NET tab, select {{Code|Phidget21.NET1.1.dll}}. If you used our installer, by default, this file is placed in {{Code|C:\Program Files\Phidgets}}. If it is in another location, please change the path to the file's location accordingly.

[[File:CSharp_VS2003 Add Reference 2.PNG|link=|alt=Add Reference]]

5. To import the simple example program into your project, please: open up {{Code|Class1.cs}}.

6. Traverse to the example in Windows Explorer and locate the {{Code|Program.cs}} file.

[[File:CSharp VS2003 Source Code.PNG|link=|alt=Source Code]]

7. Copy and paste the contents from that file into {{Code|Class1.cs}}.

8. Comment out the following line as it is not supported in .NET 1.1:
<div class="source">
<syntaxhighlight lang=csharp>
using System.Collections.Generic;
</syntaxhighlight>
</div>

[[File:CSharp VS2003 Source Code 2.PNG|link=|alt=Source Code]]

9. Now, you can run the example. Click on Debug → Start.

[[File:CSharp VS2003 Run.PNG|link=|alt=Run]]

Once you have the C# examples running, we have a [[#Follow the Examples|teaching ]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget .NET library. Please see the [[#Use Our Examples 2 | Use Our Examples ]] section for instructions.

Then, in your code, you will need to include the Phidget .NET library:
<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

===Mono===

This section will provide instructions on how to compile using the {{Code|mcs}} compiler. Other compilers such as {{Code|gmcs}}, {{Code|smcs}}, and {{Code|dmcs}} all work in the same way.

=====Use Our Examples=====

Download the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. Please only use the simple examples. The full examples uses Windows Forms, which Mono and the Gtk# toolkit are not completely compatible with. Locate the {{Code|Program.cs}} file as this contains the example source code. Copy the file into your working directory, and rename it to {{Code|example.cs}}.
<br/>

Place the {{Code|Phidget21.NET.dll}} in the same directory as your source code.

To compile and build an executable, run:
<div class="source">
<syntaxhighlight lang=bash>
mcs /out:example.exe /r:phidget21.NET.dll example.cs
</syntaxhighlight>
</div>

If you have the {{Code|Phidget21.NET.dll}} installed in another location, please change the path to the file's location accordingly.

Afterwards, you will have an executable named {{Code|example.exe}} that you can run. Type the following to run the program:
<div class="source">
<syntaxhighlight lang=bash>
mono example.exe
</syntaxhighlight>
</div>

Once you have the C# examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget .NET library. Please see the [[#Use Our Examples 3 | Use Our Example ]] section for instructions.

In your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

===MonoDevelop===

=====Use Our Examples=====

Download the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. These examples were written in Visual Studio 2005 and 2008, but are also compatible with MonoDevelop.

To load all projects in MonoDevelop, go to File → Open, and open {{Code|AllExamples/AllExamples.sln}}

This will load all of the examples available for C#, and then you can set your main project to be the one that matches your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. If you are running under the .NET framework, you can use either the full or simple examples. Otherwise, if you are running under the Mono framework, please only use the simple examples. The full examples uses Windows Forms, which is not completely compatible with Mono's Gtk#.

[[File:CSharp MonoDevelop Win Start Up.PNG|link=|alt=Start Up Project]]

The only thing left to do is to run the examples! Right click the project, and click on {{Code|Run With}} and select the target framework. Please note that the projects, by default try to find the {{Code|Phidget21.NET.dll}} in the {{Code|C\Program Files\Phidgets}}. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to {{Code|Phidget21.NET.dll}}. Please see the [[#Write Your Own Code 4 | Write Your Own Code]] section for details.

[[File:CSharp MonoDevelop Win Run As.PNG|link=|alt=Run As]]

Once you have the C# examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget .NET library. To begin:

1. Create a new C# empty project with a descriptive name such as PhidgetTest.

[[File:CSharp MonoDevelop Win New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:CSharp MonoDevelop Win Reference.PNG|link=|alt=Add Reference]]

3. Select {{Code|Phidget21.NET.dll}}. If you used our installer, by default, this file is placed in {{Code|C:\Program Files\Phidgets}}. If it is in another location, please change the path to the file's location accordingly.

[[File:CSharp MonoDevelop Win Reference 2.PNG|link=|alt=Add Reference]]

4. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

==OS X==

C# has excellent support on OS X through the Mono framework.

The first step in using C# on Mac is to install the Phidget .NET libraries. Compile and install them as explained on the [[Device List|getting started guide for your device]]. Then, the [[OS - OS X]] page also describes the different Phidget files, their installed locations, and their roles....

==Linux==

C# has support on Linux through the Mono framework.

===Use Our Examples===

The first step in using C# with Phidgets on Linux is to make sure that you have all of Mono installed. Although you probably have already done this if you're a C# programmer, you want to make sure you have all of the packages you'll need. Try:

<div class="source">
<syntaxhighlight lang=bash>
sudo apt-get mono-complete
</syntaxhighlight>
</div>

Next, you'll want to install the main Phidget Libraries. Compile and install them as explained on the main [[OS - Linux | Linux page]]. That Linux page also describes the different Phidget files, their installed locations, and their roles.

Then, you will need the Phidget .NET libraries. These are part of the Windows library zip file download:

* [http://www.phidgets.com/downloads/libraries/Phidget21-windevel.zip Phidget Windows Library Zip File]

Extract the library zip file. Descriptions for the files are available on the [[OS - Windows]] page, but for now we only need the {{Code|Phidget21.NET.dll}} file to run the Phidget C# examples in Mono. So remember where you unzipped these Windows libraries - you will need to copy the {{Code|Phidget21.NET.dll}} file into your example directory shortly.

Next, you'll want to download and extract the Phidget C# Examples (For Windows, not for .NET Compact):

* [http://www.phidgets.com/downloads/examples/CSharp.zip C Sharp Examples for Windows]

To check that your Linux, Phidget, and Mono setup is all working together, you'll want to run the C# examples. Specifically, you'll want to run the ''simple'' C# examples. Find the source code for your device. The source file will be named the same as the software object for your device. If you are not sure what the software object for your device is, it can be found in the Software/API section on the [[Device List|Product Page]] for your device.

Let's say you're running the Temperature Sensor example (for the 1048 or 1051). The source code for the example is in the directory:

:{{Code|TemperatureSensorExamples}} → {{Code|TemperatureSensor-simple}} → {{Code|TemperatureSensor-simple}} → {{Code|Program.cs}}

Other examples will be in directories named appropriately for their software object name. Once you have found the example you want to run, copy the {{Code|Phidget21.NET.dll}} file that you unzipped earlier into that example directory where the {{Code|Program.cs}} file is.

Then, compile the code. When compiling, you need to link to the Phidget library. As the Phidget21.NET file is an "additional assembly" in C#/Mono, you can link to the assembly using the {{Code|-r}} "reference" switch:

<div class="source">
<syntaxhighlight lang=bash>
gmcs Program.cs -r:Phidget21.NET.dll
</syntaxhighlight>
</div>

This will compile a {{Code|*.exe}} file - in this case, {{Code|Program.exe}}. This you can then run under Mono:

<div class="source">
<syntaxhighlight lang=bash>
sudo mono Program.exe
</syntaxhighlight>
</div>

Remember that the {{Code|sudo}} is needed unless you have your [[OS - Linux#Setting udev Rules|udev rules set on your Linux system]].

If you will be compiling with an IDE such as GTK# or MonoDevelop, we don't have explicit instructions by IDE for Linux. However, you will probably find the [[#MonoDevelop | MonoDevelop]] section in the Windows portion above useful.

===Write Your Own Code===

When writing your code from scratch, you start it as you would any C# code on Linux, such as within a text editor like Emacs, Vi, Gedit, or Kate. In your .cs source code file, you must include a reference to the Phidget Library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

Then, you would compile your completed C# code the same way as the examples above.

Mono also has a few different IDEs which you can use to develop code, and these are especially useful if you are doing GUI development. We provide instructions for MonoDevelop - one such IDE - being used [[#MonoDevelop|under Windows]].

To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Follow the Examples|teaching section]] to help you follow the provided C# examples and which has resources such as the API reference.

==Windows CE==

===Description of Library Files===
C# programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. By default, it is placed in {{Code|C:\Windows\System32}}.
You will also need one of the following two files, depending on the .NET framework version you are targeting:
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidget library for .NET framework <i><b>2.0</b></i> or higher. Your compiler has to know where this file is. By default, it is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidget library for .NET framework <i><b>1.1</b></i>. Your compiler has to know where this file is. By default, it is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
You can optionally install the following files:
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio/MonoDevelop. This documentation is also visible in the Object Browser in Visual Studio. By default, it is placed into {{Code|C:\Program Files\Phidgets}}.
* <b>{{Code|Policy.2.1.Phidget21.NET.dll}}</b> is the policy assembly for {{Code|Phidget21.NET.dll}}. Our installer places this file in the Global Assembly Cache(GAC) directory. It directs any programs compiled against version 2.1.0 or higher of {{Code|Phidget21.NET.dll}} to use the most recent installed version.

If you do not want to use our installer, you can download the five [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20111220.zip files].

Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.

===Visual Studio 2005/2008/2010===

Microsoft makes free versions of Visual Studio available known as Express Editions. The Express editions are suitable for most applications, but are limited in features for more complex applications. Please see [http://www.microsoft.com/visualstudio Microsoft Visual Studio] for more information.

=====Use Our Examples=====

Please start by downloading the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. While these examples were written in Visual Studio 2005 and 2008, Visual Studio 2010 will easily open and upgrade them. To load all projects in Visual Studio, go to File → Open → Project, and open {{Code|AllExamples/AllExamples.sln}} or {{Code|AllExamples/AllExamples_vs2008.sln}} for Visual Studio 2005 and 2008, respectively.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.
[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]

The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example.

Start by setting the {{Code|HelloWorld}} project as your start up project.

The only thing left to do is to run the example! Click on Debug → Start Debugging. Please note that the projects, by default try to find the {{Code|Phidget21.NET.dll}} in the {{Code|C:\Program Files\Phidgets}}. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to {{Code|Phidget21.NET.dll}}. Please see the [[#Write Your Own Code | Write Your Own Code ]] section for details.

[[File:CSharp VS2005 Run.PNG|link=|alt=Run]]

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:

[[File:CSharp VS2005 HelloWorld Output.PNG|link=|alt=HelloWorld Output]]

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]]. Please ensure that you have set your start up project to be the one that matches your device before compiling.

Once you have the C# examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget C# libraries. To begin:

1. Generate a new Visual C# Windows Applications project with a descriptive name such as PhidgetTest.

[[File:CSharp VS2005 New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:CSharp VS2005 Add Reference.PNG|link=|alt=Add Reference]]

3. Under the .NET tab, select {{Code|Phidget21.NET.dll}}.
If you used our installer, these files are installed in {{Code|C:\Program Files\Phidgets}}, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.

[[File:CSharp VS2005 Add Reference 2.PNG|link=|alt=Add Reference]]

4. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the C# Phidget functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in C#|[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

===Example Flow===

{{ExamplePseudocode|In C#, you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget .NET library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in C# is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

===Code Snippets===

==Common Problems and Solutions/Workarounds==

==={{ProblemSolution|All Operating Systems|The Phidgets.Events.ErrorEventHandler conflicts with System.IO.ErrorEventHandler.}}===

<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new ErrorEventHandler(spatial_Error);

...
void spatial_Error(object sender, ErrorEventArgs e){
...
}
</syntaxhighlight>
</div>

The above code produces the following errors:

{{Code|'ErrorEventHandler' is an ambiguous reference between 'System.IO.ErrorEventHandler' and 'Phidgets.Events.ErrorEventHandler'}}.

and

{{Code|'ErrorEventArgs' is an ambiguous reference between 'System.IO.ErrorEventArgs' and 'Phidgets.Events.ErrorEventArgs'}}.

The error is due to the {{Code|System.IO}} and {{Code|Phidgets.Events}} namespaces both having a class called {{Code|ErrorEventHandler}}.

To get around this issue, use the fully qualified namespace when referring to the {{Code|ErrorEventHandler}} and {{Code|ErrorEventArgs}} classes:
<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new Phidgets.Events.ErrorEventHandler(spatial_Error);
...

void spatial_Error(object sender, Phidgets.Events.ErrorEventArgs e){
...
}

</syntaxhighlight>
</div>

OS - Windows CE

2012-04-20T20:56:14Z

Djrudiak: /* Using the WebService */

[[Category:OS]]
{{OSLang|[[File:Icon-Windows CE.png‎|64x64px|link=]]|On Windows CE, Phidgets can be either plugged directly into a USB Port or run over a network using the [[#WebService | WebService]].}}
__TOC__

Phidgets are designed to run on '''Windows CE 5.0 or newer'''.

==Getting Started (Libraries and Drivers)==

If this is your first Phidget, we highly recommend working through the Getting Started guide [[Device List|for your specific Phidget device]].

In addition to owning a Windows CE system, you will also need a Windows (2000/XP/Vista/7) system for developing and deploying Windows CE applications.

If you are already a pro, and just want the Windows CE installer:

* [http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20110615.CAB ARM4VI]
* [http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20110615.CAB x86]
* [http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20110615.CAB MIPSII]

The above installers are intended for the target Windows CE system.

For special cases where you want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section. You will also have to download the Windows CE Libraries on your development machine.
*[http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip Phidget21 Windows CE Libraries] (All architectures)
*[http://www.phidgets.com/downloads/libraries/Phidget21CEkernalsource_2.1.8.20120216.zip Kernel Driver Source]
*[http://www.phidgets.com/Drivers_Info.html#wince Software License]

===Installing===

To install the libraries on the Windows CE machine, follow these steps:

1. Download one of the Phidget installer for your system, depending on whether your system is ARM4VI, x86, or MIPSII.
* [http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20110615.CAB ARM4VI]
* [http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20110615.CAB x86]
* [http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20110615.CAB MIPSII]

2. Open up the {{Code|CAB}} installer, and proceed through the wizard. If you have installed the Phidgets library before on the same system, it may mention that the Phidget libraries are already installed. This is safe to ignore. Please note that by default, the installer places the [[#Description of Library files | Phidget libraries]] in {{Code|\Program Files\Phidgets}}.

3. Once the installation is complete, you are ready to program with Phidgets.

For a description of what was installed onto your system, please see the [[#Description of Library files | Description of Library Files]] section.

Proceed onto to the [[#Phidget Control Panel | next]] section where an example program will be run to confirm that the libraries were installed correctly.

===Checking===

To confirm the libraries were installed and work correctly, you can check if the software component works.

If you have the Phidgets library installed on your system, you can verify that the software component is working by running the {{Code|\Program Files\Phidgets\HelloWorld.exe}} application and seeing if the Phidget device is listed in the output. You can run the application by simply double clicking on it in Windows Explorer. Note that if the Phidget is already plugged into the system, you will have to re-attach it after the Phidget libraries are installed.

If the Phidget is plugged into an USB port and you are not able to see that the Phidget is in the list, there may be a hardware issue.

====Troubleshooting====

If the examples '''do not''' work but USB '''does''' work (i.e. your computer can consistently see the device in the [[#Hardware|hardware]]), take a moment to check the basics:
* You are using Windows CE 5.0 or greater.
* You have the correct package installed according to your system's architecture.
* No other programs, drivers, or processes are using that USB port in software
* The Phidget libraries are the latest version (visit the [[#Getting Started (Libraries and Drivers)| getting started section]] to download them)

* Check the [[#Common Problems and Solutions|common problems]] section below, some specific combinations can cause problems

If your problem doesn't seem to be fixed by these steps, make sure that the Phidget is seen '''consistently''' by USB (if it is erratic, try our [[General Troubleshooting|general troubleshooting guide]]). If you are still having problems after using the troubleshooting guide, please [[Contact Information|ask us]]!

==Programming Languages==

Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.

After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language. You can learn more about what is needed to program in a particular language by choosing the language of your preference below. If you need help choosing a language, please look at the [[Software Overview#Language Support |language comparison table]].

Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.

On Windows CE, we recommend the following languages:

*[[Language - C Sharp (.NET Compact Framework)|C Sharp (.NET Compact Framework)]]
*[[Language - C/C++|C/C++]]
*[[Language - Visual Basic (.NET Compact Framework)|Visual Basic (.NET Compact Framework)]]

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network.

Drivers for the Phidget WebService on Windows CE are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. The WebService is started with the {{Code|PhidgetWebservice21.exe}} application.

You can connect to a Phidget hosted on another computer if you know the IP address/host name of the host computer.

This section helps you install, check, and use the WebService on Windows CE, but we also have an overview of the [[Phidget WebService]] in general.

===Turning the WebService On and Off===

The WebService can be turned on and off using command line. If you used our installer, the WebService utility is automatically installed in {{Code|\Program Files\Phidgets}}.

You can get command line help with {{Code|PhidgetWebservice21.exe}} using the -h option:

<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21 -h
</syntaxhighlight>

<syntaxhighlight lang=text>
'phidgetwebservice21' is a Phidget and Dictionary server from Phidgets Inc. See www.phidgets.com for more information.
Usage: phidgetwebservice21 [OPTION]
All parameters are optional. The default parameters are: port=5001, ServerName=(Computer Name) and no password

Options:
-p Port
-n Server Name
-P Password
-v Debug mode
-h Display this help
</syntaxhighlight>
</div>

Please note that as Windows CE does not support the use of mDNS, the -n option cannot be used.

To find the defaults used by {{Code|phidget21webservice}}, the command line is the fastest way to learn the IP address of your computer:
*For your IP address, type {{Code|ipconfig}} in the command line.
**A line in the return text, will say something like {{Code|IP Address ........ 192.168.2.198}}, which is your IP.

Here are some usage examples. The Windows command line is used. Traverse to the Phidget installation directory(By default, it is located in {{Code|\Program Files\Phidgets}}).

To start the WebService with default parameters:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe
</syntaxhighlight>
</div>

To start the WebService on port 5002:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe -p 5002
</syntaxhighlight>
</div>

To stop the WebService, simply close the command line window or press {{Code|Ctrl}} and {{Code|c}} at the same time in the command line window.

===Using the WebService===

To use a Phidget over the WebService, you'll want to:

* Start the WebService on the computer that directly connects to the Phidget
* Run your program on the remote computer that will control the Phidget over the network

The easiest way to test these steps on Windows CE is simply to start the WebService and run the Phidget program on the same computer. Later, you can replace one of the two ends with a different computer and/or operating system.

To quickly create code to run remotely, we will need to modify the example code. We will go over how to modify the C#(.NET Compact Framework) in Visual Studio. Please go ahead and download the [http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip example code]. Extract it, and open up the {{Code|\CE\HelloWorld\HelloWorld.sln}} in Visual Studio.

Find the line in our {{Code|HelloWorld}} example that says:

<div class="source">
<syntaxhighlight lang=bash>
manager.open();
</syntaxhighlight>
</div>

and change it to be:

<div class="source">
<syntaxhighlight lang=bash>
manager.open("127.0.0.1", 5001);
</syntaxhighlight>
</div>

The IP address "127.0.0.1" simply loops back to the same computer, and 5001 is the default port as found from using {{Code|phidget21webservice -h}} in [[#Setting Up the WebService|the Setting Up the WebService]] section.

Build the project in Visual Studio. This will create an executable in the {{Code|Project Folder\bin\Debug}}(if you are running in debug mode).

1. Start a command line window to run this test. First, traverse to the {{Code|\Program Files\Phidgets}} directory and start the WebService.

This will broadcast any Phidget events, and receive any Phidget requests, both over the network.

2. Transfer the newly created executable onto the Windows CE system. Double click on the application to run it.

3. Now, plug in the Phidget to the Windows CE system! The {{Code|Phidget21webservice}} program captures the {{Code|Attach}} event and other events and sends them out over the network and the example application will receive them.

4. You can confirm that the WebService was indeed behind this exchange by killing the WebService process while still allowing the remote program to run. Simply, in the command line window, press {{Code|Ctrl}} and {{Code|c}} at the same time.

Note that since Windows CE does not have mDNS and cannot be detected using the Windows Control Panel or the OS X Preference Pane.

===Debugging the WebService===

In addition to enabling [[General Phidget Programming#Logging|logging]] in your Phidget code, you can get additional debugging information from the WebService itself. This additional debugging can be enabled by specifying the {{Code|-v}} option:

<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe -v -n "myServer"
</syntaxhighlight>
</div>

The debugging information is shown command line output.

==Advanced Uses==

===Manual File Installation===

The Phidget installer installs the most commonly used files onto your system. However, there may be special cases where you want to install the Phidget libraries without the installers. Please take a look at the [[#Description of Installer files | Description of Installer files]] sections to see which files you will need to install yourself.

Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|\WINDOWS}} directory. Additional files are needed for the language that you choose. Please refer to the documentation provided by your [[Device List|language]] to determine what files are needed and the steps needed to install them onto your system.

You can find the {{Code|phidget21.dll}} in the link below:

*[http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20110615.zip Phidget21 Libraries] (32-Bit and 64-Bit development files without an installer)

{{Code|PhidgetWebService21.exe}} is also provided in the link above.

===Deploying the Program===

For simple programs in .NET, if the compiled Windows CE program runs on the development machine, then it should behave the same way on the target machine with the exception of the need for Invokes. It is also recommended that the program be debugged over a remote connection to the device. Make sure to include the {{Code|phidget21CE.NET.dll}} with your distribution.

If you receive a {{Code|Can't find PInvoke DLL}} error on deployment, check to make sure that the Phidget Framework {{Code|.dlls}} are installed to the device (normally in the Windows folder). Running the {{Code|CAB}} installer is the easiest way to ensure the files are installed and registered correctly.

You can use the Phidget WebService to connect to remote Phidgets if USB ports are not available. Note that Windows CE does not support mDNS and by extension some {{Code|open()}} calls. In .NET, use {{Code|open(serial,"IPAddress", port, "pass")}}.

===Deploying the Program on an Emulator===

Your success for running Phidgets on an emulator may vary based on the type of the device being emulated, and whether it supports USB devices or the installation of the Phidget Framework. Here, if you receive a {{Code|Can't find PInvoke DLL}} error during execution, this means the emulator image does not have the Phidget Framework installed. One approach installing it
on an emulator is to set up a shared folder (File → Configure... → General → Shared folder) with the ARMV4I or x86 Framework inside, then browse to its location and run the installer. Also, if you’re running the Phidget WebService, you may want to have the network connection shared between the PC and device through ActiveSync.

===Compiling Your Own OS Build===

Often you’ll also find that after power cycling the device, the state of the operating system is reset and the Phidget drivers are lost. As a matter of convenience, it’s possible to include the Phidget drivers into the OS build so that they do not need to be reloaded every time. Building an OS image is often a complicated task and is not covered in detail here. However, if you are going to try this process it will involve using the SDK for the device, including the ARMV4I or x86 .dlls, and inserting entries into the registry for USB detection of Phidgets. The easiest way of getting the .dlls and registry entries is to copy them off the device after installing the {{Code|CAB}} file. The CE kernel source can also be found at the [#Getting Started (Libraries and Drivers) | beginning] of this page

==Common Problems and Solutions==

===Issue: The Phidget Windows CE libraries need to be installed everytime the system restarts===
This is discussed in the [[#Compiling Your Own OS Build | Compiling Your Own OS Build]] section.

===Issue: The Phidget is not attaching to my Program===
If the Phidgets are already plugged into the USB port of the Windows CE device, the Phidgets will need to be re-attached to the device once the Phidget libraries are installed. This is so that the drivers can detect that the Phidgets are connected.

==Appendix==

===Description of Installer files===

Here is the list of files and their description for each file that is distributed through the iOS drivers.
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is placed in {{Code|\Windows}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebService]].
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is.
* <b>{{Code|phidget21.h}}</b> lists all the Phidget API function calls available to your code. Your compiler also has to know where this file is.
* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver. It is placed in {{Code|\Windows}}.
* <b>{{Code|Phidget21CE.NET.dll}}</b> is the .NET(Compact Framework) Phidgets library. It is placed in {{Code|\Windows}}.

OS - Windows CE

2012-04-20T20:54:21Z

Djrudiak: Undo revision 19199 by Djrudiak (talk)

[[Category:OS]]
{{OSLang|[[File:Icon-Windows CE.png‎|64x64px|link=]]|On Windows CE, Phidgets can be either plugged directly into a USB Port or run over a network using the [[#WebService | WebService]].}}
__TOC__

Phidgets are designed to run on '''Windows CE 5.0 or newer'''.

==Getting Started (Libraries and Drivers)==

If this is your first Phidget, we highly recommend working through the Getting Started guide [[Device List|for your specific Phidget device]].

In addition to owning a Windows CE system, you will also need a Windows (2000/XP/Vista/7) system for developing and deploying Windows CE applications.

If you are already a pro, and just want the Windows CE installer:

* [http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20110615.CAB ARM4VI]
* [http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20110615.CAB x86]
* [http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20110615.CAB MIPSII]

The above installers are intended for the target Windows CE system.

For special cases where you want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section. You will also have to download the Windows CE Libraries on your development machine.
*[http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip Phidget21 Windows CE Libraries] (All architectures)
*[http://www.phidgets.com/downloads/libraries/Phidget21CEkernalsource_2.1.8.20120216.zip Kernel Driver Source]
*[http://www.phidgets.com/Drivers_Info.html#wince Software License]

===Installing===

To install the libraries on the Windows CE machine, follow these steps:

1. Download one of the Phidget installer for your system, depending on whether your system is ARM4VI, x86, or MIPSII.
* [http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20110615.CAB ARM4VI]
* [http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20110615.CAB x86]
* [http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20110615.CAB MIPSII]

2. Open up the {{Code|CAB}} installer, and proceed through the wizard. If you have installed the Phidgets library before on the same system, it may mention that the Phidget libraries are already installed. This is safe to ignore. Please note that by default, the installer places the [[#Description of Library files | Phidget libraries]] in {{Code|\Program Files\Phidgets}}.

3. Once the installation is complete, you are ready to program with Phidgets.

For a description of what was installed onto your system, please see the [[#Description of Library files | Description of Library Files]] section.

Proceed onto to the [[#Phidget Control Panel | next]] section where an example program will be run to confirm that the libraries were installed correctly.

===Checking===

To confirm the libraries were installed and work correctly, you can check if the software component works.

If you have the Phidgets library installed on your system, you can verify that the software component is working by running the {{Code|\Program Files\Phidgets\HelloWorld.exe}} application and seeing if the Phidget device is listed in the output. You can run the application by simply double clicking on it in Windows Explorer. Note that if the Phidget is already plugged into the system, you will have to re-attach it after the Phidget libraries are installed.

If the Phidget is plugged into an USB port and you are not able to see that the Phidget is in the list, there may be a hardware issue.

====Troubleshooting====

If the examples '''do not''' work but USB '''does''' work (i.e. your computer can consistently see the device in the [[#Hardware|hardware]]), take a moment to check the basics:
* You are using Windows CE 5.0 or greater.
* You have the correct package installed according to your system's architecture.
* No other programs, drivers, or processes are using that USB port in software
* The Phidget libraries are the latest version (visit the [[#Getting Started (Libraries and Drivers)| getting started section]] to download them)

* Check the [[#Common Problems and Solutions|common problems]] section below, some specific combinations can cause problems

If your problem doesn't seem to be fixed by these steps, make sure that the Phidget is seen '''consistently''' by USB (if it is erratic, try our [[General Troubleshooting|general troubleshooting guide]]). If you are still having problems after using the troubleshooting guide, please [[Contact Information|ask us]]!

==Programming Languages==

Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.

After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language. You can learn more about what is needed to program in a particular language by choosing the language of your preference below. If you need help choosing a language, please look at the [[Software Overview#Language Support |language comparison table]].

Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.

On Windows CE, we recommend the following languages:

*[[Language - C Sharp (.NET Compact Framework)|C Sharp (.NET Compact Framework)]]
*[[Language - C/C++|C/C++]]
*[[Language - Visual Basic (.NET Compact Framework)|Visual Basic (.NET Compact Framework)]]

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network.

Drivers for the Phidget WebService on Windows CE are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. The WebService is started with the {{Code|PhidgetWebservice21.exe}} application.

You can connect to a Phidget hosted on another computer if you know the IP address/host name of the host computer.

This section helps you install, check, and use the WebService on Windows CE, but we also have an overview of the [[Phidget WebService]] in general.

===Turning the WebService On and Off===

The WebService can be turned on and off using command line. If you used our installer, the WebService utility is automatically installed in {{Code|\Program Files\Phidgets}}.

You can get command line help with {{Code|PhidgetWebservice21.exe}} using the -h option:

<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21 -h
</syntaxhighlight>

<syntaxhighlight lang=text>
'phidgetwebservice21' is a Phidget and Dictionary server from Phidgets Inc. See www.phidgets.com for more information.
Usage: phidgetwebservice21 [OPTION]
All parameters are optional. The default parameters are: port=5001, ServerName=(Computer Name) and no password

Options:
-p Port
-n Server Name
-P Password
-v Debug mode
-h Display this help
</syntaxhighlight>
</div>

Please note that as Windows CE does not support the use of mDNS, the -n option cannot be used.

To find the defaults used by {{Code|phidget21webservice}}, the command line is the fastest way to learn the IP address of your computer:
*For your IP address, type {{Code|ipconfig}} in the command line.
**A line in the return text, will say something like {{Code|IP Address ........ 192.168.2.198}}, which is your IP.

Here are some usage examples. The Windows command line is used. Traverse to the Phidget installation directory(By default, it is located in {{Code|\Program Files\Phidgets}}).

To start the WebService with default parameters:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe
</syntaxhighlight>
</div>

To start the WebService on port 5002:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe -p 5002
</syntaxhighlight>
</div>

To stop the WebService, simply close the command line window or press {{Code|Ctrl}} and {{Code|c}} at the same time in the command line window.

===Using the WebService===

To use a Phidget over the WebService, you'll want to:

* Start the WebService on the computer that directly connects to the Phidget
* Run your program on the remote computer that will control the Phidget over the network

The easiest way to test these steps on Windows CE is simply to start the WebService and run the Phidget program on the same computer. Later, you can replace one of the two ends with a different computer and/or operating system.

To quickly create code to run remotely, we will need to modify the example code. We will go over how to modify the C#(.NET Compact Framework) in Visual Studio. Please go ahead and download the [http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip example code]. Extract it, and open up the {{Code|\CE\HelloWorld\HelloWorld.sln}} in Visual Studio.

Find the line in our {{Code|HelloWorld}} example that says:

<div class="source">
<syntaxhighlight lang=bash>
manager.open();
</syntaxhighlight>
</div>

and change it to be:

<div class="source">
<syntaxhighlight lang=bash>
manager.open("127.0.0.1", 5001);
</syntaxhighlight>
</div>

The IP address "127.0.0.1" simply loops back to the same computer, and 5001 is the default port as found from using {{Code|phidget21webservice -h}} in [[#Setting Up the WebService|the Setting Up the WebService]] section.

Build the project in Visual Studio. This will create an executable in the {{Code|Project Folder\bin\Debug}}(if you are running in debug mode).

1. Start a command line window to run this test. First, traverse to the {{Code|\Program Files\Phidgets}} directory and start the Webservice.

This will broadcast any Phidget events, and receive any Phidget requests, both over the network.

2. Transfer the newly created executable onto the Windows CE system. Double click on the application to run it.

3. Now, plug in the Phidget to the Windows CE system! The {{Code|Phidget21webservice}} program captures the {{Code|Attach}} event and other events and sends them out over the network and the example application will receive them:

4. You can confirm that the Webservice was indeed behind this exchange by killing the Webservice process while still allowing the remote program to run. Simply, in the command line window, press {{Code|Ctrl}} and {{Code|c}} at the same time.

Note that since Windows CE does not have mDNS and cannot be detected using the Windows Control Panel or the OS X Preference Pane.

===Debugging the WebService===

In addition to enabling [[General Phidget Programming#Logging|logging]] in your Phidget code, you can get additional debugging information from the WebService itself. This additional debugging can be enabled by specifying the {{Code|-v}} option:

<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe -v -n "myServer"
</syntaxhighlight>
</div>

The debugging information is shown command line output.

==Advanced Uses==

===Manual File Installation===

The Phidget installer installs the most commonly used files onto your system. However, there may be special cases where you want to install the Phidget libraries without the installers. Please take a look at the [[#Description of Installer files | Description of Installer files]] sections to see which files you will need to install yourself.

Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|\WINDOWS}} directory. Additional files are needed for the language that you choose. Please refer to the documentation provided by your [[Device List|language]] to determine what files are needed and the steps needed to install them onto your system.

You can find the {{Code|phidget21.dll}} in the link below:

*[http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20110615.zip Phidget21 Libraries] (32-Bit and 64-Bit development files without an installer)

{{Code|PhidgetWebService21.exe}} is also provided in the link above.

===Deploying the Program===

For simple programs in .NET, if the compiled Windows CE program runs on the development machine, then it should behave the same way on the target machine with the exception of the need for Invokes. It is also recommended that the program be debugged over a remote connection to the device. Make sure to include the {{Code|phidget21CE.NET.dll}} with your distribution.

If you receive a {{Code|Can't find PInvoke DLL}} error on deployment, check to make sure that the Phidget Framework {{Code|.dlls}} are installed to the device (normally in the Windows folder). Running the {{Code|CAB}} installer is the easiest way to ensure the files are installed and registered correctly.

You can use the Phidget WebService to connect to remote Phidgets if USB ports are not available. Note that Windows CE does not support mDNS and by extension some {{Code|open()}} calls. In .NET, use {{Code|open(serial,"IPAddress", port, "pass")}}.

===Deploying the Program on an Emulator===

Your success for running Phidgets on an emulator may vary based on the type of the device being emulated, and whether it supports USB devices or the installation of the Phidget Framework. Here, if you receive a {{Code|Can't find PInvoke DLL}} error during execution, this means the emulator image does not have the Phidget Framework installed. One approach installing it
on an emulator is to set up a shared folder (File → Configure... → General → Shared folder) with the ARMV4I or x86 Framework inside, then browse to its location and run the installer. Also, if you’re running the Phidget WebService, you may want to have the network connection shared between the PC and device through ActiveSync.

===Compiling Your Own OS Build===

Often you’ll also find that after power cycling the device, the state of the operating system is reset and the Phidget drivers are lost. As a matter of convenience, it’s possible to include the Phidget drivers into the OS build so that they do not need to be reloaded every time. Building an OS image is often a complicated task and is not covered in detail here. However, if you are going to try this process it will involve using the SDK for the device, including the ARMV4I or x86 .dlls, and inserting entries into the registry for USB detection of Phidgets. The easiest way of getting the .dlls and registry entries is to copy them off the device after installing the {{Code|CAB}} file. The CE kernel source can also be found at the [#Getting Started (Libraries and Drivers) | beginning] of this page

==Common Problems and Solutions==

===Issue: The Phidget Windows CE libraries need to be installed everytime the system restarts===
This is discussed in the [[#Compiling Your Own OS Build | Compiling Your Own OS Build]] section.

===Issue: The Phidget is not attaching to my Program===
If the Phidgets are already plugged into the USB port of the Windows CE device, the Phidgets will need to be re-attached to the device once the Phidget libraries are installed. This is so that the drivers can detect that the Phidgets are connected.

==Appendix==

===Description of Installer files===

Here is the list of files and their description for each file that is distributed through the iOS drivers.
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is placed in {{Code|\Windows}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebService]].
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is.
* <b>{{Code|phidget21.h}}</b> lists all the Phidget API function calls available to your code. Your compiler also has to know where this file is.
* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver. It is placed in {{Code|\Windows}}.
* <b>{{Code|Phidget21CE.NET.dll}}</b> is the .NET(Compact Framework) Phidgets library. It is placed in {{Code|\Windows}}.

OS - Windows CE

2012-04-20T20:53:42Z

Djrudiak:

[[Category:OS]]
{{OSLang|[[File:Icon-Windows CE.png?|64x64px|link=]]|On Windows CE, Phidgets can be either plugged directly into a USB Port or run over a network using the [[#WebService | WebService]].}}
__TOC__

Phidgets are designed to run on '''Windows CE 5.0 or newer'''.

==Getting Started (Libraries and Drivers)==

If this is your first Phidget, we highly recommend working through the Getting Started guide [[Device List|for your specific Phidget device]].

In addition to owning a Windows CE system, you will also need a Windows (2000/XP/Vista/7) system for developing and deploying Windows CE applications.

If you are already a pro, and just want the Windows CE installer:

* [http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20110615.CAB ARM4VI]
* [http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20110615.CAB x86]
* [http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20110615.CAB MIPSII]

The above installers are intended for the target Windows CE system.

For special cases where you want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section. You will also have to download the Windows CE Libraries on your development machine.
*[http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip Phidget21 Windows CE Libraries] (All architectures)
*[http://www.phidgets.com/downloads/libraries/Phidget21CEkernalsource_2.1.8.20120216.zip Kernel Driver Source]
*[http://www.phidgets.com/Drivers_Info.html#wince Software License]

===Installing===

To install the libraries on the Windows CE machine, follow these steps:

1. Download one of the Phidget installer for your system, depending on whether your system is ARM4VI, x86, or MIPSII.
* [http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20110615.CAB ARM4VI]
* [http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20110615.CAB x86]
* [http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20110615.CAB MIPSII]

2. Open up the {{Code|CAB}} installer, and proceed through the wizard. If you have installed the Phidgets library before on the same system, it may mention that the Phidget libraries are already installed. This is safe to ignore. Please note that by default, the installer places the [[#Description of Library files | Phidget libraries]] in {{Code|\Program Files\Phidgets}}.

3. Once the installation is complete, you are ready to program with Phidgets.

For a description of what was installed onto your system, please see the [[#Description of Library files | Description of Library Files]] section.

Proceed onto to the [[#Phidget Control Panel | next]] section where an example program will be run to confirm that the libraries were installed correctly.

===Checking===

To confirm the libraries were installed and work correctly, you can check if the software component works.

If you have the Phidgets library installed on your system, you can verify that the software component is working by running the {{Code|\Program Files\Phidgets\HelloWorld.exe}} application and seeing if the Phidget device is listed in the output. You can run the application by simply double clicking on it in Windows Explorer. Note that if the Phidget is already plugged into the system, you will have to re-attach it after the Phidget libraries are installed.

If the Phidget is plugged into an USB port and you are not able to see that the Phidget is in the list, there may be a hardware issue.

====Troubleshooting====

If the examples '''do not''' work but USB '''does''' work (i.e. your computer can consistently see the device in the [[#Hardware|hardware]]), take a moment to check the basics:
* You are using Windows CE 5.0 or greater.
* You have the correct package installed according to your system's architecture.
* No other programs, drivers, or processes are using that USB port in software
* The Phidget libraries are the latest version (visit the [[#Getting Started (Libraries and Drivers)| getting started section]] to download them)

* Check the [[#Common Problems and Solutions|common problems]] section below, some specific combinations can cause problems

If your problem doesn't seem to be fixed by these steps, make sure that the Phidget is seen '''consistently''' by USB (if it is erratic, try our [[General Troubleshooting|general troubleshooting guide]]). If you are still having problems after using the troubleshooting guide, please [[Contact Information|ask us]]!

==Programming Languages==

Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.

After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language. You can learn more about what is needed to program in a particular language by choosing the language of your preference below. If you need help choosing a language, please look at the [[Software Overview#Language Support |language comparison table]].

Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.

On Windows CE, we recommend the following languages:

*[[Language - C Sharp (.NET Compact Framework)|C Sharp (.NET Compact Framework)]]
*[[Language - C/C++|C/C++]]
*[[Language - Visual Basic (.NET Compact Framework)|Visual Basic (.NET Compact Framework)]]

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network.

Drivers for the Phidget WebService on Windows CE are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. The WebService is started with the {{Code|PhidgetWebService21.exe}} application.

You can connect to a Phidget hosted on another computer if you know the IP address/host name of the host computer.

This section helps you install, check, and use the WebService on Windows CE, but we also have an overview of the [[Phidget WebService]] in general.

===Turning the WebService On and Off===

The WebService can be turned on and off using command line. If you used our installer, the WebService utility is automatically installed in {{Code|\Program Files\Phidgets}}.

You can get command line help with {{Code|PhidgetWebService21.exe}} using the -h option:

<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebService21 -h
</syntaxhighlight>

<syntaxhighlight lang=text>
'phidgetWebService21' is a Phidget and Dictionary server from Phidgets Inc. See www.phidgets.com for more information.
Usage: phidgetWebService21 [OPTION]
All parameters are optional. The default parameters are: port=5001, ServerName=(Computer Name) and no password

Options:
-p Port
-n Server Name
-P Password
-v Debug mode
-h Display this help
</syntaxhighlight>
</div>

Please note that as Windows CE does not support the use of mDNS, the -n option cannot be used.

To find the defaults used by {{Code|phidget21WebService}}, the command line is the fastest way to learn the IP address of your computer:
*For your IP address, type {{Code|ipconfig}} in the command line.
**A line in the return text, will say something like {{Code|IP Address ........ 192.168.2.198}}, which is your IP.

Here are some usage examples. The Windows command line is used. Traverse to the Phidget installation directory(By default, it is located in {{Code|\Program Files\Phidgets}}).

To start the WebService with default parameters:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebService21.exe
</syntaxhighlight>
</div>

To start the WebService on port 5002:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebService21.exe -p 5002
</syntaxhighlight>
</div>

To stop the WebService, simply close the command line window or press {{Code|Ctrl}} and {{Code|c}} at the same time in the command line window.

===Using the WebService===

To use a Phidget over the WebService, you'll want to:

* Start the WebService on the computer that directly connects to the Phidget
* Run your program on the remote computer that will control the Phidget over the network

The easiest way to test these steps on Windows CE is simply to start the WebService and run the Phidget program on the same computer. Later, you can replace one of the two ends with a different computer and/or operating system.

To quickly create code to run remotely, we will need to modify the example code. We will go over how to modify the C#(.NET Compact Framework) in Visual Studio. Please go ahead and download the [http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip example code]. Extract it, and open up the {{Code|\CE\HelloWorld\HelloWorld.sln}} in Visual Studio.

Find the line in our {{Code|HelloWorld}} example that says:

<div class="source">
<syntaxhighlight lang=bash>
manager.open();
</syntaxhighlight>
</div>

and change it to be:

<div class="source">
<syntaxhighlight lang=bash>
manager.open("127.0.0.1", 5001);
</syntaxhighlight>
</div>

The IP address "127.0.0.1" simply loops back to the same computer, and 5001 is the default port as found from using {{Code|phidget21WebService -h}} in [[#Setting Up the WebService|the Setting Up the WebService]] section.

Build the project in Visual Studio. This will create an executable in the {{Code|Project Folder\bin\Debug}}(if you are running in debug mode).

1. Start a command line window to run this test. First, traverse to the {{Code|\Program Files\Phidgets}} directory and start the WebService.

This will broadcast any Phidget events, and receive any Phidget requests, both over the network.

2. Transfer the newly created executable onto the Windows CE system. Double click on the application to run it.

3. Now, plug in the Phidget to the Windows CE system! The {{Code|Phidget21WebService}} program captures the {{Code|Attach}} event and other events and sends them out over the network and the example application will receive them:

4. You can confirm that the WebService was indeed behind this exchange by killing the WebService process while still allowing the remote program to run. Simply, in the command line window, press {{Code|Ctrl}} and {{Code|c}} at the same time.

Note that since Windows CE does not have mDNS and cannot be detected using the Windows Control Panel or the OS X Preference Pane.

===Debugging the WebService===

In addition to enabling [[General Phidget Programming#Logging|logging]] in your Phidget code, you can get additional debugging information from the WebService itself. This additional debugging can be enabled by specifying the {{Code|-v}} option:

<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebService21.exe -v -n "myServer"
</syntaxhighlight>
</div>

The debugging information is shown command line output.

==Advanced Uses==

===Manual File Installation===

The Phidget installer installs the most commonly used files onto your system. However, there may be special cases where you want to install the Phidget libraries without the installers. Please take a look at the [[#Description of Installer files | Description of Installer files]] sections to see which files you will need to install yourself.

Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|\WINDOWS}} directory. Additional files are needed for the language that you choose. Please refer to the documentation provided by your [[Device List|language]] to determine what files are needed and the steps needed to install them onto your system.

You can find the {{Code|phidget21.dll}} in the link below:

*[http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20110615.zip Phidget21 Libraries] (32-Bit and 64-Bit development files without an installer)

{{Code|PhidgetWebService21.exe}} is also provided in the link above.

===Deploying the Program===

For simple programs in .NET, if the compiled Windows CE program runs on the development machine, then it should behave the same way on the target machine with the exception of the need for Invokes. It is also recommended that the program be debugged over a remote connection to the device. Make sure to include the {{Code|phidget21CE.NET.dll}} with your distribution.

If you receive a {{Code|Can't find PInvoke DLL}} error on deployment, check to make sure that the Phidget Framework {{Code|.dlls}} are installed to the device (normally in the Windows folder). Running the {{Code|CAB}} installer is the easiest way to ensure the files are installed and registered correctly.

You can use the Phidget WebService to connect to remote Phidgets if USB ports are not available. Note that Windows CE does not support mDNS and by extension some {{Code|open()}} calls. In .NET, use {{Code|open(serial,"IPAddress", port, "pass")}}.

===Deploying the Program on an Emulator===

Your success for running Phidgets on an emulator may vary based on the type of the device being emulated, and whether it supports USB devices or the installation of the Phidget Framework. Here, if you receive a {{Code|Can't find PInvoke DLL}} error during execution, this means the emulator image does not have the Phidget Framework installed. One approach installing it
on an emulator is to set up a shared folder (File → Configure... → General → Shared folder) with the ARMV4I or x86 Framework inside, then browse to its location and run the installer. Also, if you’re running the Phidget WebService, you may want to have the network connection shared between the PC and device through ActiveSync.

===Compiling Your Own OS Build===

Often you’ll also find that after power cycling the device, the state of the operating system is reset and the Phidget drivers are lost. As a matter of convenience, it’s possible to include the Phidget drivers into the OS build so that they do not need to be reloaded every time. Building an OS image is often a complicated task and is not covered in detail here. However, if you are going to try this process it will involve using the SDK for the device, including the ARMV4I or x86 .dlls, and inserting entries into the registry for USB detection of Phidgets. The easiest way of getting the .dlls and registry entries is to copy them off the device after installing the {{Code|CAB}} file. The CE kernel source can also be found at the [#Getting Started (Libraries and Drivers) | beginning] of this page

==Common Problems and Solutions==

===Issue: The Phidget Windows CE libraries need to be installed everytime the system restarts===
This is discussed in the [[#Compiling Your Own OS Build | Compiling Your Own OS Build]] section.

===Issue: The Phidget is not attaching to my Program===
If the Phidgets are already plugged into the USB port of the Windows CE device, the Phidgets will need to be re-attached to the device once the Phidget libraries are installed. This is so that the drivers can detect that the Phidgets are connected.

==Appendix==

===Description of Installer files===

Here is the list of files and their description for each file that is distributed through the iOS drivers.
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is placed in {{Code|\Windows}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebService]].
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is.
* <b>{{Code|phidget21.h}}</b> lists all the Phidget API function calls available to your code. Your compiler also has to know where this file is.
* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver. It is placed in {{Code|\Windows}}.
* <b>{{Code|Phidget21CE.NET.dll}}</b> is the .NET(Compact Framework) Phidgets library. It is placed in {{Code|\Windows}}.

OS - Windows CE

2012-04-20T20:52:54Z

Djrudiak:

[[Category:OS]]
{{OSLang|[[File:Icon-Windows CE.png‎|64x64px|link=]]|On Windows CE, Phidgets can be either plugged directly into a USB Port or run over a network using the [[#WebService | WebService]].}}
__TOC__

Phidgets are designed to run on '''Windows CE 5.0 or newer'''.

==Getting Started (Libraries and Drivers)==

If this is your first Phidget, we highly recommend working through the Getting Started guide [[Device List|for your specific Phidget device]].

In addition to owning a Windows CE system, you will also need a Windows (2000/XP/Vista/7) system for developing and deploying Windows CE applications.

If you are already a pro, and just want the Windows CE installer:

* [http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20110615.CAB ARM4VI]
* [http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20110615.CAB x86]
* [http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20110615.CAB MIPSII]

The above installers are intended for the target Windows CE system.

For special cases where you want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section. You will also have to download the Windows CE Libraries on your development machine.
*[http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip Phidget21 Windows CE Libraries] (All architectures)
*[http://www.phidgets.com/downloads/libraries/Phidget21CEkernalsource_2.1.8.20120216.zip Kernel Driver Source]
*[http://www.phidgets.com/Drivers_Info.html#wince Software License]

===Installing===

To install the libraries on the Windows CE machine, follow these steps:

1. Download one of the Phidget installer for your system, depending on whether your system is ARM4VI, x86, or MIPSII.
* [http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20110615.CAB ARM4VI]
* [http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20110615.CAB x86]
* [http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20110615.CAB MIPSII]

2. Open up the {{Code|CAB}} installer, and proceed through the wizard. If you have installed the Phidgets library before on the same system, it may mention that the Phidget libraries are already installed. This is safe to ignore. Please note that by default, the installer places the [[#Description of Library files | Phidget libraries]] in {{Code|\Program Files\Phidgets}}.

3. Once the installation is complete, you are ready to program with Phidgets.

For a description of what was installed onto your system, please see the [[#Description of Library files | Description of Library Files]] section.

Proceed onto to the [[#Phidget Control Panel | next]] section where an example program will be run to confirm that the libraries were installed correctly.

===Checking===

To confirm the libraries were installed and work correctly, you can check if the software component works.

If you have the Phidgets library installed on your system, you can verify that the software component is working by running the {{Code|\Program Files\Phidgets\HelloWorld.exe}} application and seeing if the Phidget device is listed in the output. You can run the application by simply double clicking on it in Windows Explorer. Note that if the Phidget is already plugged into the system, you will have to re-attach it after the Phidget libraries are installed.

If the Phidget is plugged into an USB port and you are not able to see that the Phidget is in the list, there may be a hardware issue.

====Troubleshooting====

If the examples '''do not''' work but USB '''does''' work (i.e. your computer can consistently see the device in the [[#Hardware|hardware]]), take a moment to check the basics:
* You are using Windows CE 5.0 or greater.
* You have the correct package installed according to your system's architecture.
* No other programs, drivers, or processes are using that USB port in software
* The Phidget libraries are the latest version (visit the [[#Getting Started (Libraries and Drivers)| getting started section]] to download them)

* Check the [[#Common Problems and Solutions|common problems]] section below, some specific combinations can cause problems

If your problem doesn't seem to be fixed by these steps, make sure that the Phidget is seen '''consistently''' by USB (if it is erratic, try our [[General Troubleshooting|general troubleshooting guide]]). If you are still having problems after using the troubleshooting guide, please [[Contact Information|ask us]]!

==Programming Languages==

Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.

After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language. You can learn more about what is needed to program in a particular language by choosing the language of your preference below. If you need help choosing a language, please look at the [[Software Overview#Language Support |language comparison table]].

Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.

On Windows CE, we recommend the following languages:

*[[Language - C Sharp (.NET Compact Framework)|C Sharp (.NET Compact Framework)]]
*[[Language - C/C++|C/C++]]
*[[Language - Visual Basic (.NET Compact Framework)|Visual Basic (.NET Compact Framework)]]

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network.

Drivers for the Phidget WebService on Windows CE are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. The WebService is started with the {{Code|PhidgetWebservice21.exe}} application.

You can connect to a Phidget hosted on another computer if you know the IP address/host name of the host computer.

This section helps you install, check, and use the WebService on Windows CE, but we also have an overview of the [[Phidget WebService]] in general.

===Turning the WebService On and Off===

The WebService can be turned on and off using command line. If you used our installer, the WebService utility is automatically installed in {{Code|\Program Files\Phidgets}}.

You can get command line help with {{Code|PhidgetWebservice21.exe}} using the -h option:

<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21 -h
</syntaxhighlight>

<syntaxhighlight lang=text>
'phidgetwebservice21' is a Phidget and Dictionary server from Phidgets Inc. See www.phidgets.com for more information.
Usage: phidgetwebservice21 [OPTION]
All parameters are optional. The default parameters are: port=5001, ServerName=(Computer Name) and no password

Options:
-p Port
-n Server Name
-P Password
-v Debug mode
-h Display this help
</syntaxhighlight>
</div>

Please note that as Windows CE does not support the use of mDNS, the -n option cannot be used.

To find the defaults used by {{Code|phidget21webservice}}, the command line is the fastest way to learn the IP address of your computer:
*For your IP address, type {{Code|ipconfig}} in the command line.
**A line in the return text, will say something like {{Code|IP Address ........ 192.168.2.198}}, which is your IP.

Here are some usage examples. The Windows command line is used. Traverse to the Phidget installation directory(By default, it is located in {{Code|\Program Files\Phidgets}}).

To start the WebService with default parameters:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe
</syntaxhighlight>
</div>

To start the WebService on port 5002:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe -p 5002
</syntaxhighlight>
</div>

To stop the WebService, simply close the command line window or press {{Code|Ctrl}} and {{Code|c}} at the same time in the command line window.

===Using the WebService===

To use a Phidget over the WebService, you'll want to:

* Start the WebService on the computer that directly connects to the Phidget
* Run your program on the remote computer that will control the Phidget over the network

The easiest way to test these steps on Windows CE is simply to start the WebService and run the Phidget program on the same computer. Later, you can replace one of the two ends with a different computer and/or operating system.

To quickly create code to run remotely, we will need to modify the example code. We will go over how to modify the C#(.NET Compact Framework) in Visual Studio. Please go ahead and download the [http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip example code]. Extract it, and open up the {{Code|\CE\HelloWorld\HelloWorld.sln}} in Visual Studio.

Find the line in our {{Code|HelloWorld}} example that says:

<div class="source">
<syntaxhighlight lang=bash>
manager.open();
</syntaxhighlight>
</div>

and change it to be:

<div class="source">
<syntaxhighlight lang=bash>
manager.open("127.0.0.1", 5001);
</syntaxhighlight>
</div>

The IP address "127.0.0.1" simply loops back to the same computer, and 5001 is the default port as found from using {{Code|phidget21webservice -h}} in [[#Setting Up the WebService|the Setting Up the WebService]] section.

Build the project in Visual Studio. This will create an executable in the {{Code|Project Folder\bin\Debug}}(if you are running in debug mode).

1. Start a command line window to run this test. First, traverse to the {{Code|\Program Files\Phidgets}} directory and start the Webservice.

This will broadcast any Phidget events, and receive any Phidget requests, both over the network.

2. Transfer the newly created executable onto the Windows CE system. Double click on the application to run it.

3. Now, plug in the Phidget to the Windows CE system! The {{Code|Phidget21webservice}} program captures the {{Code|Attach}} event and other events and sends them out over the network and the example application will receive them:

4. You can confirm that the Webservice was indeed behind this exchange by killing the Webservice process while still allowing the remote program to run. Simply, in the command line window, press {{Code|Ctrl}} and {{Code|c}} at the same time.

Note that since Windows CE does not have mDNS and cannot be detected using the Windows Control Panel or the OS X Preference Pane.

===Debugging the WebService===

In addition to enabling [[General Phidget Programming#Logging|logging]] in your Phidget code, you can get additional debugging information from the WebService itself. This additional debugging can be enabled by specifying the {{Code|-v}} option:

<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe -v -n "myServer"
</syntaxhighlight>
</div>

The debugging information is shown command line output.

==Advanced Uses==

===Manual File Installation===

The Phidget installer installs the most commonly used files onto your system. However, there may be special cases where you want to install the Phidget libraries without the installers. Please take a look at the [[#Description of Installer files | Description of Installer files]] sections to see which files you will need to install yourself.

Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|\WINDOWS}} directory. Additional files are needed for the language that you choose. Please refer to the documentation provided by your [[Device List|language]] to determine what files are needed and the steps needed to install them onto your system.

You can find the {{Code|phidget21.dll}} in the link below:

*[http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20110615.zip Phidget21 Libraries] (32-Bit and 64-Bit development files without an installer)

{{Code|PhidgetWebService21.exe}} is also provided in the link above.

===Deploying the Program===

For simple programs in .NET, if the compiled Windows CE program runs on the development machine, then it should behave the same way on the target machine with the exception of the need for Invokes. It is also recommended that the program be debugged over a remote connection to the device. Make sure to include the {{Code|phidget21CE.NET.dll}} with your distribution.

If you receive a {{Code|Can't find PInvoke DLL}} error on deployment, check to make sure that the Phidget Framework {{Code|.dlls}} are installed to the device (normally in the Windows folder). Running the {{Code|CAB}} installer is the easiest way to ensure the files are installed and registered correctly.

You can use the Phidget WebService to connect to remote Phidgets if USB ports are not available. Note that Windows CE does not support mDNS and by extension some {{Code|open()}} calls. In .NET, use {{Code|open(serial,"IPAddress", port, "pass")}}.

===Deploying the Program on an Emulator===

Your success for running Phidgets on an emulator may vary based on the type of the device being emulated, and whether it supports USB devices or the installation of the Phidget Framework. Here, if you receive a {{Code|Can't find PInvoke DLL}} error during execution, this means the emulator image does not have the Phidget Framework installed. One approach installing it
on an emulator is to set up a shared folder (File → Configure... → General → Shared folder) with the ARMV4I or x86 Framework inside, then browse to its location and run the installer. Also, if you’re running the Phidget WebService, you may want to have the network connection shared between the PC and device through ActiveSync.

===Compiling Your Own OS Build===

Often you’ll also find that after power cycling the device, the state of the operating system is reset and the Phidget drivers are lost. As a matter of convenience, it’s possible to include the Phidget drivers into the OS build so that they do not need to be reloaded every time. Building an OS image is often a complicated task and is not covered in detail here. However, if you are going to try this process it will involve using the SDK for the device, including the ARMV4I or x86 .dlls, and inserting entries into the registry for USB detection of Phidgets. The easiest way of getting the .dlls and registry entries is to copy them off the device after installing the {{Code|CAB}} file. The CE kernel source can also be found at the [#Getting Started (Libraries and Drivers) | beginning] of this page

==Common Problems and Solutions==

===Issue: The Phidget Windows CE libraries need to be installed everytime the system restarts===
This is discussed in the [[#Compiling Your Own OS Build | Compiling Your Own OS Build]] section.

===Issue: The Phidget is not attaching to my Program===
If the Phidgets are already plugged into the USB port of the Windows CE device, the Phidgets will need to be re-attached to the device once the Phidget libraries are installed. This is so that the drivers can detect that the Phidgets are connected.

==Appendix==

===Description of Installer files===

Here is the list of files and their description for each file that is distributed through the iOS drivers.
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is placed in {{Code|\Windows}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebService]].
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is.
* <b>{{Code|phidget21.h}}</b> lists all the Phidget API function calls available to your code. Your compiler also has to know where this file is.
* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver. It is placed in {{Code|\Windows}}.
* <b>{{Code|Phidget21CE.NET.dll}}</b> is the .NET(Compact Framework) Phidgets library. It is placed in {{Code|\Windows}}.

OS - iOS

2012-04-20T20:14:51Z

Djrudiak:

[[Category:OS]]
{{OSLang|[[File:Icon-iOS.png|64x64px|link=OS - iOS]]|iOS is the operating system used on iOS devices such as the iPad, iPhone, and iPod touch.}}
__TOC__

Phidgets are designed to run on devices with an iOS version of 3.0 or later. It is strongly recommended that your device have the latest iOS version available to the device installed. As iOS devices do not have USB ports, the Phidgets will have to be connected on a computer with USB ports, and the iOS device will be able to interact with the Phidget over the [[Phidget_WebService|WebService]]. If you are looking for a compact and an inexpensive way to host Phidgets over a network, take a look at our [[1072 0 - PhidgetSBC2|Single Board Computer]].

==Getting Started (Libraries and Drivers)==

If this is your first Phidget, we highly recommend working through the Getting Started guide [[Device List|for your specific Phidget device]].

If you are already a pro, and just want the iOS drivers:

*[http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip iOS Libraries]

===Installing===

iOS code is developed on an OS X machine, and so getting your Phidget to work locally on the OS X machine first will help you distinguish any issues from network ones later. The OS X machine will need the Phidget drivers installed, please see the [[OS - OS X | OS X]] page for more information.

You will also need to [http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip iOS drivers] to code your program against.
The "installation" of the Phidget iOS libraries is simply linking and distributing the libraries with your project. As the most common platform to do this is through Xcode, we provide brief instructions on how to easily follow along with our already-linked examples later.

To install the libraries, follow these steps on the development computer:

1. Download the Phidget [http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip drivers for iOS].

2. Unzip the file, and you will find three things:

# Libraries for the iOS device and iOS simulator.
# Example Xcode project for the PhidgetInterfaceKit and PhidgetManager.
# Skeleton Xcode project - contains the minimal project settings already filled in for Phidgets development.

Feel free to browse around within the folders to get a sense of what will be going on the iOS side. We describe how to link and use these library files later on the [[Language - iOS#Write Your Own Code | Write your own iOS code]] section of the iOS Cocoa Touch page. For now, having found them means you can copy and install them to any project directory you want.

First, though, it will be useful to check to make sure Phidgets work with your iOS system.

===Checking===

When you run a Phidgets iOS example, you transfer and link the libraries and code all at the same time. This should <i>just work</i> with our examples, but if problems arise this section gives more detail on pinpointing the source of the problem. We recommend starting with running the software examples right away - if the software works, you know the hardware works too.

====Software====

The easiest way to see whether your libraries are set up correctly within our examples or your own project is just to download them to the iOS device and run them. Detailed instructions for this (including choosing the right {{Code|HelloWorld}} project to run) are on the [[Language - iOS]] page. That page will be your next step - but if the examples do not run using the instructions, return here to debug your hardware.

====Hardware====

If you are having problems running the examples, you should check the hardware of the host computer.

When using the [[#WebService|WebService]] to control a Phidget, the problem may be with the USB connection on the remote computer. Make sure both the server-side of (a) the webservice and (b) the USB connection are working by using the instructions on the [[OS - OS X|OS X page]]

====Troubleshooting====

If the examples '''do not''' work but USB '''does''' work (i.e. your remote computer or iOS device can consistently see the device in the [[#Hardware|hardware]]), take a moment to check the basics:
* No other programs, drivers, or processes are using the Phidget on the host computer.
* You have copied and linked the Phidget iOS libraries (as described on the [[Language - iOS]] page)
* The Phidget libraries are the latest version (visit the [[#Getting Started (Libraries and Drivers)| getting started section]] to download them)
* Ensure that the webservice drivers and the iOS libraries are both the latest version
* Ensure that you have the most up to date iOS version installed for your device.
* Check the [[#Common Problems and Solutions|common problems]] section below, some specific combinations can cause problems

If your problem doesn't seem to be fixed by these steps, make sure that the Phidget is seen '''consistently''' by USB in [[#Hardware|hardware]] (if it is erratic, try our [[General Troubleshooting|general troubleshooting guide]]). If you are still having problems after using the troubleshooting guide, please [[Contact Information|ask us]]!

==Programming Languages==

iOS programs are written in [[Language - iOS|Objective C]] using the Cocoa Touch framework. You can read on within this page to learn how to use iOS with the Webservice, or you can jump ahead right now to the [[Language - iOS|iOS]] page and start writing code!

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network.<br>This section helps you use the WebService on iOS, but we also have an overview of the [[Phidget WebService]] in general.

Currently, iOS devices cannot ''host'' the WebService, but they can use data streaming from another computer over the WebService.

===Setting Up the WebService===

Using an iOS device, your network-controlled Phidget system will probably look something like this:

[[Image:webservice_general_pctoios.png|600px|link=|alt=]]

To begin,

1. Start the WebService on the host computer
* How to do this [[OS - Windows#WebService|on Windows]]
* How to do this [[OS - OS X#WebService|on Mac OS]]
* How to do this [[OS - Linux#WebService|on Linux]]
* How to do this [[OS - Phidget SBC#WebService|on the Phidget Single Board Computer]]

2. Download and unzip the [http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip iOS Examples] anywhere on the development computer.

3. Open up the {{Code|HelloWorld.xcodeproj}} into Xcode. Select either an iOS device or iOS simulator as the destination. For more information, please see the [[Language - iOS#Use OurExamples|Use Our Examples]] section of the iOS language page.

4. In Xcode, hit the {{Code|Run}} button to transfer the application to the device or simulator as well as run it.

===Using the WebService===

After performing the steps above, you will be using the WebService already. Plugging in the Phidget to the host computer will give you a screen like this:

[[File:iOS Webservice Example HelloWorld Output.png|link=|alt=HelloWorld Output]]

The above screenshot shows that a number of Phidgets are attached to the USB ports of computer connected to the network. Go ahead and detach the Phidgets from the USB port of the host computer, and see what happens.

===Debugging the WebService===

Since an iOS device can only be a user and not a host of the WebService, you should use debugging server side. Refer to the webservice sections for each operating system:
* [[OS - Windows#WebService|Windows]]
* [[OS - OS X#WebService|Mac OS]]
* [[OS - Linux#WebService|Linux]]
* [[OS - Phidget SBC#WebService|Phidget Single Board Computer]]
In addition, if you are having WebService problems, you will probably find the webservice section of our [[General Troubleshooting#WebService Troubleshooting|General Troubleshooting Guide]] helpful as well.

==Advanced Uses==

==Common Problems and Solutions==

==Appendix==

===Description of Installer files===

Here is the list of files and their description for each file that is distributed through the iOS drivers.
* <b>{{Code|iphoneos/libPhidget21.a}}</b> contains the actual Phidget library, which is used at run-time. This library is used when you are testing the example on the actual iOS device.
* <b>{{Code|iphonesimulator/libPhidget21.a}}</b> contains the actual Phidget library, which is used at run-time. This library is used when you are testing the example an iOS simulator.
* <b>{{Code|phidget21.h}}</b> lists all the Phidget API function calls available to your code. Your compiler also has to know where this file is.
* <b>{{Code|SkeletonProject}}</b> is a Xcode project containing the bare minimum project settings already filled in to code with the Phidget library.

OS - iOS

2012-04-20T20:14:22Z

Djrudiak:

[[Category:OS]]
{{OSLang|[[File:Icon-iOS.png|64x64px|link=OS - iOS]]|iOS is the operating system used on iOS devices such as the iPad, iPhone, and iPod touch.}}
__TOC__

Phidgets are designed to run on devices with an iOS version of 3.0 or later. It is strongly recommended that your device have the latest iOS version available to the device installed. As iOS devices do not have USB ports, the Phidgets will have to be connected on a computer with USB ports, and the iOS device will be able to interact with the Phidget over the [[WebService]]. If you are looking for a compact and an inexpensive way to host Phidgets over a network, take a look at our [[1072 0 - PhidgetSBC2|Single Board Computer]].

==Getting Started (Libraries and Drivers)==

If this is your first Phidget, we highly recommend working through the Getting Started guide [[Device List|for your specific Phidget device]].

If you are already a pro, and just want the iOS drivers:

*[http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip iOS Libraries]

===Installing===

iOS code is developed on an OS X machine, and so getting your Phidget to work locally on the OS X machine first will help you distinguish any issues from network ones later. The OS X machine will need the Phidget drivers installed, please see the [[OS - OS X | OS X]] page for more information.

You will also need to [http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip iOS drivers] to code your program against.
The "installation" of the Phidget iOS libraries is simply linking and distributing the libraries with your project. As the most common platform to do this is through Xcode, we provide brief instructions on how to easily follow along with our already-linked examples later.

To install the libraries, follow these steps on the development computer:

1. Download the Phidget [http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip drivers for iOS].

2. Unzip the file, and you will find three things:

# Libraries for the iOS device and iOS simulator.
# Example Xcode project for the PhidgetInterfaceKit and PhidgetManager.
# Skeleton Xcode project - contains the minimal project settings already filled in for Phidgets development.

Feel free to browse around within the folders to get a sense of what will be going on the iOS side. We describe how to link and use these library files later on the [[Language - iOS#Write Your Own Code | Write your own iOS code]] section of the iOS Cocoa Touch page. For now, having found them means you can copy and install them to any project directory you want.

First, though, it will be useful to check to make sure Phidgets work with your iOS system.

===Checking===

When you run a Phidgets iOS example, you transfer and link the libraries and code all at the same time. This should <i>just work</i> with our examples, but if problems arise this section gives more detail on pinpointing the source of the problem. We recommend starting with running the software examples right away - if the software works, you know the hardware works too.

====Software====

The easiest way to see whether your libraries are set up correctly within our examples or your own project is just to download them to the iOS device and run them. Detailed instructions for this (including choosing the right {{Code|HelloWorld}} project to run) are on the [[Language - iOS]] page. That page will be your next step - but if the examples do not run using the instructions, return here to debug your hardware.

====Hardware====

If you are having problems running the examples, you should check the hardware of the host computer.

When using the [[#WebService|WebService]] to control a Phidget, the problem may be with the USB connection on the remote computer. Make sure both the server-side of (a) the webservice and (b) the USB connection are working by using the instructions on the [[OS - OS X|OS X page]]

====Troubleshooting====

If the examples '''do not''' work but USB '''does''' work (i.e. your remote computer or iOS device can consistently see the device in the [[#Hardware|hardware]]), take a moment to check the basics:
* No other programs, drivers, or processes are using the Phidget on the host computer.
* You have copied and linked the Phidget iOS libraries (as described on the [[Language - iOS]] page)
* The Phidget libraries are the latest version (visit the [[#Getting Started (Libraries and Drivers)| getting started section]] to download them)
* Ensure that the webservice drivers and the iOS libraries are both the latest version
* Ensure that you have the most up to date iOS version installed for your device.
* Check the [[#Common Problems and Solutions|common problems]] section below, some specific combinations can cause problems

If your problem doesn't seem to be fixed by these steps, make sure that the Phidget is seen '''consistently''' by USB in [[#Hardware|hardware]] (if it is erratic, try our [[General Troubleshooting|general troubleshooting guide]]). If you are still having problems after using the troubleshooting guide, please [[Contact Information|ask us]]!

==Programming Languages==

iOS programs are written in [[Language - iOS|Objective C]] using the Cocoa Touch framework. You can read on within this page to learn how to use iOS with the Webservice, or you can jump ahead right now to the [[Language - iOS|iOS]] page and start writing code!

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network.<br>This section helps you use the WebService on iOS, but we also have an overview of the [[Phidget WebService]] in general.

Currently, iOS devices cannot ''host'' the WebService, but they can use data streaming from another computer over the WebService.

===Setting Up the WebService===

Using an iOS device, your network-controlled Phidget system will probably look something like this:

[[Image:webservice_general_pctoios.png|600px|link=|alt=]]

To begin,

1. Start the WebService on the host computer
* How to do this [[OS - Windows#WebService|on Windows]]
* How to do this [[OS - OS X#WebService|on Mac OS]]
* How to do this [[OS - Linux#WebService|on Linux]]
* How to do this [[OS - Phidget SBC#WebService|on the Phidget Single Board Computer]]

2. Download and unzip the [http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip iOS Examples] anywhere on the development computer.

3. Open up the {{Code|HelloWorld.xcodeproj}} into Xcode. Select either an iOS device or iOS simulator as the destination. For more information, please see the [[Language - iOS#Use OurExamples|Use Our Examples]] section of the iOS language page.

4. In Xcode, hit the {{Code|Run}} button to transfer the application to the device or simulator as well as run it.

===Using the WebService===

After performing the steps above, you will be using the WebService already. Plugging in the Phidget to the host computer will give you a screen like this:

[[File:iOS Webservice Example HelloWorld Output.png|link=|alt=HelloWorld Output]]

The above screenshot shows that a number of Phidgets are attached to the USB ports of computer connected to the network. Go ahead and detach the Phidgets from the USB port of the host computer, and see what happens.

===Debugging the WebService===

Since an iOS device can only be a user and not a host of the WebService, you should use debugging server side. Refer to the webservice sections for each operating system:
* [[OS - Windows#WebService|Windows]]
* [[OS - OS X#WebService|Mac OS]]
* [[OS - Linux#WebService|Linux]]
* [[OS - Phidget SBC#WebService|Phidget Single Board Computer]]
In addition, if you are having WebService problems, you will probably find the webservice section of our [[General Troubleshooting#WebService Troubleshooting|General Troubleshooting Guide]] helpful as well.

==Advanced Uses==

==Common Problems and Solutions==

==Appendix==

===Description of Installer files===

Here is the list of files and their description for each file that is distributed through the iOS drivers.
* <b>{{Code|iphoneos/libPhidget21.a}}</b> contains the actual Phidget library, which is used at run-time. This library is used when you are testing the example on the actual iOS device.
* <b>{{Code|iphonesimulator/libPhidget21.a}}</b> contains the actual Phidget library, which is used at run-time. This library is used when you are testing the example an iOS simulator.
* <b>{{Code|phidget21.h}}</b> lists all the Phidget API function calls available to your code. Your compiler also has to know where this file is.
* <b>{{Code|SkeletonProject}}</b> is a Xcode project containing the bare minimum project settings already filled in to code with the Phidget library.

OS - OS X

2012-04-20T20:08:36Z

Djrudiak: /* WebService */

[[Category:OS]]

{{OSLang|[[File:Icon-Mac-OS.png‎|64x64px|link=]]|On OS X, Phidgets can be either plugged directly into a USB Port or run over a network using the [[#WebService|WebService]].}}

__TOC__

Phidgets are designed to run on '''OS X 10.4 Tiger or newer''', and can run on PPC, 32-bit, and 64-bit systems.

==Getting Started (Libraries and Drivers)==

If this is your first Phidget, we highly recommend working through the Getting Started guide [[Device List|for your specific Phidget device]]. If you already have the Preference Pane Installed and know how to use it, then you've already followed the guide and are ready to learn more about the workings behind the Preference Pane, the Phidget WebService, and more - all specific to OS X.

If you are already a pro, and just want the drivers:

*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20120216.dmg OS X Installer]
*[http://www.phidgets.com/Drivers_Info.html#osx Software License]

===Installing===

The Phidget installer will install the core Phidget files onto your system.

To install the libraries, follow these steps:

1. Download the Phidget installer for your system:
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20120216.dmg OS X Installer]

2. Open up the installer, and double click on {{Code|Phidgets.mpkg}} to install the libraries.

[[File:OSX Install 1.png|link=|alt=OS X Install]]

3. Proceed through the wizard.

[[File:OSX Install 2.png|link=|alt=OS X Install]]

4. Once the installation is complete, you are ready to program with Phidgets. To find out what files got installed, please see [[#Description of Installer files | Description of Installer files]] in the Appendix section.

Proceed onto to the [[#Phidget Preference Pane | next]] section where the Phidget Preference Pane will be discussed.

====Phidget Preference Pane====

The Phidget Preference Pane is a tool to quickly determine whether your system is able to communicate with Phidgets, and also act as a debugging tool.

Once the Phidget libraries are installed using the installer, open up the {{Code|System Preferences}} window.

[[File:OSX System Preferences.png|link=|alt=OS X System Preferences]]

Click on the {{Code|Phidgets}} icon in the {{Code|Other}} section to bring up the Phidgets Preference Pane.

[[File:OSX PreferencePane General.png|link=|alt=OS X PreferencePane General]]

The {{Code|general}} tab shows the list of Phidgets currently physically attached to the computer. You can also view the currently installed Phidget library version. You can double click on a Phidget device to open up an example program for the device.

[[File:OSX PreferencePane Example.png|link=|alt=OS X PreferencePane Example]]

In the above screenshot, the RFID example was opened. These examples are intended for demonstration and debugging purposes. If you have not yet already, please see the '''Getting Started''' guide [[Device List|for your device]]. It is important to keep in mind that when an example Phidget application is opened from the Phidget Preference Pane or opened from any of your Phidget applications that you develop, it holds a lock on the Phidget. This prevents any other program from accessing the Phidget. Please ensure that this example application is closed(the Phidget Preference Pane can still be running) when you are running your own applications.

The next tab is the {{Code|Web Service}} tab, which allows you to control Phidgets over a network.

[[File:OSX PreferencePane Webservice Stopped.png|link=|alt=OS X PreferencePane WebService Stopped]]

Here, you can start and stop the WebService. Details are provided in the [[#WebService | WebService]] section. This screen also tells you whether the Phidget WebService is currently running.

The next tab is the {{Code|Labels}} tab. In this section, you can view the currently assigned labels of any Phidget attached to your computer. It is also possible to set the labels of Phidgets here too. You might want to set a label to a Phidget device because you can refer to it by its label as opposed to its serial number.

[[File:OSX PreferencePane Labels Local.png|link=|alt=OS X PreferencePane WebService Labels Local]]

You can also view the labels of any Phidget connected through the WebService

[[File:OSX PreferencePane Labels Remote.png|link=|alt=OS X PreferencePane WebService Labels Remote]]

The {{Code|Bonjour}} tab gives a list of all currently attached Phidgets that are connected to the WebService. You can also double click on the Phidget to connect to it over the network using one or more computers, but still use the Phidget on the computer it is directly connected to.

[[File:OSX PreferencePane Bonjour.png|link=|alt=OS X PreferencePane Bonjour]]

The last tab is the {{Code|PhidgetSBC}} tab, which displays the complete list of PhidgetSBCs connected to the network.

[[File:OSX PreferencePane PhidgetSBC.png|link=|alt=OS X PreferencePane PhidgetSBC]]

You can double click on the PhidgetSBC to bring up the PhidgetSBC Administration Console log-in page in your default browser.

[[File:PhidgetSBCAdminConsole.PNG|link=|alt=PhidgetSBC Admin Console]]

The PhidgetSBC Administration Console is where you can go to configure the PhidgetSBC. For more details, please see the [[1072 0 - Getting Started | PhidgetSBC]] section.

===Checking===

To confirm the libraries were installed and work correctly, you can check both the hardware and software components of the interface. It is worth checking the software side first, because if it works then you know the hardware side is also okay.

====Software====

If you have the Phidgets library installed on your system, you can verify that the software component is working by seeing if the Phidget device is listed in the General tab of the Phidget Preference Pane.

[[File:OSX PreferencePane General.png ‎|link=|alt=OS X Preference Pane General]]

The above screenshot shows that a PhidgetRFID and a PhidgetInterfaceKit are attached to the computer. If you see your Phidget in the list, you can continue to the [[#Programming Languages | programming languages]] section to learn more. If you are not able to see that the Phidget is in the list, there may be a hardware issue. Please see the [[#Hardware| hardware]] section for more details.

====Hardware====

You can verify that your computer detects that the Phidget is plugged in through a USB connection by going to the OS X System Profiler. You can access the System Profiler by selecting {{Code|About This Mac}} under the Apple icon.

[[File:OSX About This Mac.png‎|link=|alt=OS X About This Mac]]

The new window will open up.

[[File:OSX More Info.png|link=|alt=OS X More Info]]

Select {{Code|More Info}}. The System Profiler will show up. In the USB section, you will be able to find all connected USB devices.

[[File:OSX USB Devices.png ‎|link=|alt=OS X Attached USB Devices]]

In the above screenshot, The PhidgetInterfaceKit and PhidgetRFID are connected to the USB ports.

If you don't see the Phidget in the list, then take a look at the [[#Troubleshooting|troubleshooting]] section below, as well as the '''Communications''' section of our [[General Troubleshooting#Communications Troubleshooting|general troubleshooting page]].

====Troubleshooting====

If the example programs '''do not''' work but USB '''does''' work (i.e. your computer can consistently see the device in the [[#Hardware|hardware]]), take a moment to check the basics:
* You are using OS X 10.4 or newer.
* No other programs, drivers, or processes are using that USB port in software
* The Phidget libraries are the latest version (visit the [[#Getting Started (Libraries and Drivers)| getting started section]] to download them)

* Check the [[#Common Problems and Solutions|common problems]] section below, some specific combinations can cause problems

If your problem doesn't seem to be fixed by these steps, make sure that the Phidget is seen '''consistently''' by USB (if it is erratic, try our [[General Troubleshooting|general troubleshooting guide]]). If you are still having problems after using the troubleshooting guide, please [[Contact Information|ask us]]!

==Programming Languages==
Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.

After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language. You can learn more about what is needed to program in a particular language by choosing the language of your preference below. If you need help choosing a language, please look at the [[Software Overview#Language Support |language comparison table]].

We recommend the following languages for OS X:
* [[Language - Applescript|AppleScript]]
* [[Language - C/C++|C/C++]]
* [[Language - C#|C#(Using Mono)]]
* [[Language - Cocoa | Cocoa]]
* [[Language - Flash AS3 | Flash AS3]]
* [[Language - Flex AS3 | Flex AS3]]
* [[Language - LiveCode | LiveCode]]
* [[Language - Java | Java]]
* [[Language - Max/MSP|Max/MSP]]
* [[Language - Python | Python]]
* [[Language - Ruby|Ruby]]

You can also use these languages, but they do not support [[General Phidget Programming#Event Driven Code | event driven code]], and must use [[General Phidget Programming#Logic Code | logic code]] only:

*[[Language - MATLAB|MATLAB]]
*[[Language - Simulink|Simulink]]

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network.

Drivers for the Phidget WebService on OS X are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. If you see the Phidget Preference Pane in System Preferences, then you already have the WebService drivers installed.

There are two ways that you can connect to a Phidget hosted on another computer. The first method is by using the IP address/host name and port of the host computer. The second method makes the use of [http://en.wikipedia.org/wiki/Multicast_DNS mDNS], which allows Phidgets to be found and opened on the network by a server id instead of an IP address/host name. When using a server id, both the client and server will need to be running an implementation of zero configuration networking. The Phidget WebService takes advantage of [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] software, which is built-in to OS X. It is a tool developed by Apple to locate devices, such as Phidgets, on a network.

This section helps you install, check, and use the WebService on Windows, but we also have an overview of the [[Phidget WebService]] in general.

===Turning the WebService On and Off===

There are two methods that can be used to turn the WebService on and off. The first method is through the Phidget Preference Pane. In the {{Code|WebService}} tab, you can start or stop the WebService. You can also choose to have the WebService start up automatically upon system boot up by selecting the {{Code|Start Automatically}} checkbox.

[[File:OSX PreferencePane Webservice Stopped.png|link=|alt=OS X PreferencePane WebService]]

The second method of turning the WebService on and off is through command line. After using our installer, the WebService utility is automatically installed in {{Code|/usr/bin/phidget21webservice}}.

You can get command line help with {{Code|phidgetwebservice21}} using the -h option:

<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21 -h
</syntaxhighlight>

<syntaxhighlight lang=text>
'phidgetwebservice21' is a Phidget and Dictionary server from Phidgets Inc. See www.phidgets.com for more information.
Usage: phidgetwebservice21 [OPTION]
All parameters are optional. The default parameters are: port=5001, ServerName=(Computer Name) and no password

Options:
-p Port
-n Server Name
-P Password
-v Debug mode
-h Display this help
</syntaxhighlight>
</div>

Mapping out which command line options to which Phidget Preference Pane option is as follows:

-p: {{Code|Port}} field

-n: {{Code|ServerID}} field

-P: {{Code|Password}} field

-v: Not supported under the Phidget Preference Pane

To find the defaults used by {{Code|phidget21webservice}}, the command line is the fastest way to learn the default server name and IP address of your computer:
*For the default server name, use {{Code|hostname}} on the command line.
*For your IP address, use {{Code|ifconfig -a}} on the command line.
**A line in the return text, under your main internet connection (usually {{Code|eth0}}) will say something like {{Code|inet addr:192.168.3.178}}, which is your IP.

Here are some usage examples:

To start the WebService with default parameters:
<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21
</syntaxhighlight>
</div>

To start the WebService with a server name of {{Code|myServer}}:
<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21-n myServer
</syntaxhighlight>
</div>

To stop the WebService, simply close the command line window or press {{Code|Control}} and {{Code|c}} at the same time in the command line window.

===Using the WebService===

To use a Phidget over the WebService, you'll want to:
* Have two different computers connected to the same network. We will call the computer that has the Phidget directly connected to the USB port the host. The client will be the computer that runs a Phidget application to connect to the Phidget attached to the host. Please note that if you only have a single computer, you can also connect to the Phidget over the WebService. The computer will simply act as both a host and client. This will allow you to bypass the [[General Phidget Programming # Details for Open() | one application per Phidget limitation]].

* Start the WebService on the computer that directly connects to the Phidget
* Run your program on the remote computer that will control the Phidget over the network

The easiest way to test these steps on OS X is to set up the WebService and run the Phidget program on the client. Please follow these steps:

1. On the host, open up the Phidget Preference Pane and traverse to the {{Code|Web Service}} tab.

[[File:OSX PreferencePane Webservice Stopped.png |link=|alt=OS X Preference Pane WebService]]

2. Leave all fields the way they are, and click on {{Code|Start WebService}} to run the WebService.

3. You can determine that the WebService is running by looking at the status on the right side.

[[File:OSX PreferencePane Webservice Running.png|link=|alt=OS X PreferencePane WebService Running]]

4. Ensure that the Phidget is plugged in to the host.

5. On the client's Phidget Preference Pane, open up the {{Code|Bonjour}} tab. You will see the Phidget that is plugged into the host as one of the entries listed. Double click it to open the example application.

[[File:OSX PreferencePane Bonjour.png ‎‎ |link=|alt=OS X PreferencePane Bonjour.png ‎]]

6. The example application will open up, and you will be able to communicate with the Phidget over the WebService.

[[File:OSX PreferencePane Example.png ‎ |link=|alt=OS X PreferencePane Example]]

7. You can confirm that the WebService was indeed behind this exchange by terminating the WebService process while still allowing the remote program to run. On the host's Phidget Preference Pane, traverse to the {{Code|WebService}} tab. Hit {{Code|Stop WebService}} to terminate the WebService.

[[File:OSX PreferencePane Webservice Running.png|link=|alt=OS X PreferencePane WebService Running]]

8. Take a look at the example application on the client. Since the application can no longer connect to the WebService, there is nothing attached.

[[File:OSX PreferencePane Example Stopped.png |link=|alt=OS X PreferencePane Example Stopped]]

===Debugging the WebService===

In addition to enabling [[General Phidget Programming#Logging|logging]] in your Phidget code, you can get additional debugging information from the WebService itself. This additional debugging can only be enabled from the command line approach to start the WebService. Debug information is enabled by specifying the {{Code|-v}} option:

<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21 -v -n "myServer"
</syntaxhighlight>
</div>

The debugging information will be shown as output in the command line console.

==Advanced Uses==

==Appendix==

===Description of Installer files===

Here is the list of files and their description for each file the installer puts onto your system.
===Description of Library files===

This section will explain the files that were placed onto your system as part of the installation process.
* <b>{{Code|Phidget21.framework}}</b> contains the actual Phidget library, which is used at run-time. It is placed into {{Code|/Library/Frameworks}}.
* <b>{{Code|Phidget.kext}}</b> is the kernel extension. It is placed into {{Code|/System/Library/Extensions}}.
* <b>{{Code|libphidget21.jnilib}}</b> is the JNI library for Java. It is placed into {{Code|/Library/Java/Extensions}}.
* <b>{{Code|Phidgets.prefpane}}</b> is the Phidgets Preference Pane. It is placed into {{Code|/Library/PreferencePanes}}.
* <b>{{Code|phidgetwebservice21}}</b> is the Phidget WebService. It is placed into {{Code|/usr/bin}}.
* <b>{{Code|PhidgetsOSA.app}}</b> is the the Phidgets agent for AppleScript. It is placed into {{Code|/Library/ScriptingAdditions}}.

==Common Problems and Solutions==

None, yet.

OS - OS X

2012-04-20T20:08:07Z

Djrudiak: /* WebService */

[[Category:OS]]

{{OSLang|[[File:Icon-Mac-OS.png‎|64x64px|link=]]|On OS X, Phidgets can be either plugged directly into a USB Port or run over a network using the [[#WebService|WebService]].}}

__TOC__

Phidgets are designed to run on '''OS X 10.4 Tiger or newer''', and can run on PPC, 32-bit, and 64-bit systems.

==Getting Started (Libraries and Drivers)==

If this is your first Phidget, we highly recommend working through the Getting Started guide [[Device List|for your specific Phidget device]]. If you already have the Preference Pane Installed and know how to use it, then you've already followed the guide and are ready to learn more about the workings behind the Preference Pane, the Phidget WebService, and more - all specific to OS X.

If you are already a pro, and just want the drivers:

*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20120216.dmg OS X Installer]
*[http://www.phidgets.com/Drivers_Info.html#osx Software License]

===Installing===

The Phidget installer will install the core Phidget files onto your system.

To install the libraries, follow these steps:

1. Download the Phidget installer for your system:
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20120216.dmg OS X Installer]

2. Open up the installer, and double click on {{Code|Phidgets.mpkg}} to install the libraries.

[[File:OSX Install 1.png|link=|alt=OS X Install]]

3. Proceed through the wizard.

[[File:OSX Install 2.png|link=|alt=OS X Install]]

4. Once the installation is complete, you are ready to program with Phidgets. To find out what files got installed, please see [[#Description of Installer files | Description of Installer files]] in the Appendix section.

Proceed onto to the [[#Phidget Preference Pane | next]] section where the Phidget Preference Pane will be discussed.

====Phidget Preference Pane====

The Phidget Preference Pane is a tool to quickly determine whether your system is able to communicate with Phidgets, and also act as a debugging tool.

Once the Phidget libraries are installed using the installer, open up the {{Code|System Preferences}} window.

[[File:OSX System Preferences.png|link=|alt=OS X System Preferences]]

Click on the {{Code|Phidgets}} icon in the {{Code|Other}} section to bring up the Phidgets Preference Pane.

[[File:OSX PreferencePane General.png|link=|alt=OS X PreferencePane General]]

The {{Code|general}} tab shows the list of Phidgets currently physically attached to the computer. You can also view the currently installed Phidget library version. You can double click on a Phidget device to open up an example program for the device.

[[File:OSX PreferencePane Example.png|link=|alt=OS X PreferencePane Example]]

In the above screenshot, the RFID example was opened. These examples are intended for demonstration and debugging purposes. If you have not yet already, please see the '''Getting Started''' guide [[Device List|for your device]]. It is important to keep in mind that when an example Phidget application is opened from the Phidget Preference Pane or opened from any of your Phidget applications that you develop, it holds a lock on the Phidget. This prevents any other program from accessing the Phidget. Please ensure that this example application is closed(the Phidget Preference Pane can still be running) when you are running your own applications.

The next tab is the {{Code|Web Service}} tab, which allows you to control Phidgets over a network.

[[File:OSX PreferencePane Webservice Stopped.png|link=|alt=OS X PreferencePane WebService Stopped]]

Here, you can start and stop the WebService. Details are provided in the [[#WebService | WebService]] section. This screen also tells you whether the Phidget WebService is currently running.

The next tab is the {{Code|Labels}} tab. In this section, you can view the currently assigned labels of any Phidget attached to your computer. It is also possible to set the labels of Phidgets here too. You might want to set a label to a Phidget device because you can refer to it by its label as opposed to its serial number.

[[File:OSX PreferencePane Labels Local.png|link=|alt=OS X PreferencePane WebService Labels Local]]

You can also view the labels of any Phidget connected through the WebService

[[File:OSX PreferencePane Labels Remote.png|link=|alt=OS X PreferencePane WebService Labels Remote]]

The {{Code|Bonjour}} tab gives a list of all currently attached Phidgets that are connected to the WebService. You can also double click on the Phidget to connect to it over the network using one or more computers, but still use the Phidget on the computer it is directly connected to.

[[File:OSX PreferencePane Bonjour.png|link=|alt=OS X PreferencePane Bonjour]]

The last tab is the {{Code|PhidgetSBC}} tab, which displays the complete list of PhidgetSBCs connected to the network.

[[File:OSX PreferencePane PhidgetSBC.png|link=|alt=OS X PreferencePane PhidgetSBC]]

You can double click on the PhidgetSBC to bring up the PhidgetSBC Administration Console log-in page in your default browser.

[[File:PhidgetSBCAdminConsole.PNG|link=|alt=PhidgetSBC Admin Console]]

The PhidgetSBC Administration Console is where you can go to configure the PhidgetSBC. For more details, please see the [[1072 0 - Getting Started | PhidgetSBC]] section.

===Checking===

To confirm the libraries were installed and work correctly, you can check both the hardware and software components of the interface. It is worth checking the software side first, because if it works then you know the hardware side is also okay.

====Software====

If you have the Phidgets library installed on your system, you can verify that the software component is working by seeing if the Phidget device is listed in the General tab of the Phidget Preference Pane.

[[File:OSX PreferencePane General.png ‎|link=|alt=OS X Preference Pane General]]

The above screenshot shows that a PhidgetRFID and a PhidgetInterfaceKit are attached to the computer. If you see your Phidget in the list, you can continue to the [[#Programming Languages | programming languages]] section to learn more. If you are not able to see that the Phidget is in the list, there may be a hardware issue. Please see the [[#Hardware| hardware]] section for more details.

====Hardware====

You can verify that your computer detects that the Phidget is plugged in through a USB connection by going to the OS X System Profiler. You can access the System Profiler by selecting {{Code|About This Mac}} under the Apple icon.

[[File:OSX About This Mac.png‎|link=|alt=OS X About This Mac]]

The new window will open up.

[[File:OSX More Info.png|link=|alt=OS X More Info]]

Select {{Code|More Info}}. The System Profiler will show up. In the USB section, you will be able to find all connected USB devices.

[[File:OSX USB Devices.png ‎|link=|alt=OS X Attached USB Devices]]

In the above screenshot, The PhidgetInterfaceKit and PhidgetRFID are connected to the USB ports.

If you don't see the Phidget in the list, then take a look at the [[#Troubleshooting|troubleshooting]] section below, as well as the '''Communications''' section of our [[General Troubleshooting#Communications Troubleshooting|general troubleshooting page]].

====Troubleshooting====

If the example programs '''do not''' work but USB '''does''' work (i.e. your computer can consistently see the device in the [[#Hardware|hardware]]), take a moment to check the basics:
* You are using OS X 10.4 or newer.
* No other programs, drivers, or processes are using that USB port in software
* The Phidget libraries are the latest version (visit the [[#Getting Started (Libraries and Drivers)| getting started section]] to download them)

* Check the [[#Common Problems and Solutions|common problems]] section below, some specific combinations can cause problems

If your problem doesn't seem to be fixed by these steps, make sure that the Phidget is seen '''consistently''' by USB (if it is erratic, try our [[General Troubleshooting|general troubleshooting guide]]). If you are still having problems after using the troubleshooting guide, please [[Contact Information|ask us]]!

==Programming Languages==
Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.

After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language. You can learn more about what is needed to program in a particular language by choosing the language of your preference below. If you need help choosing a language, please look at the [[Software Overview#Language Support |language comparison table]].

We recommend the following languages for OS X:
* [[Language - Applescript|AppleScript]]
* [[Language - C/C++|C/C++]]
* [[Language - C#|C#(Using Mono)]]
* [[Language - Cocoa | Cocoa]]
* [[Language - Flash AS3 | Flash AS3]]
* [[Language - Flex AS3 | Flex AS3]]
* [[Language - LiveCode | LiveCode]]
* [[Language - Java | Java]]
* [[Language - Max/MSP|Max/MSP]]
* [[Language - Python | Python]]
* [[Language - Ruby|Ruby]]

You can also use these languages, but they do not support [[General Phidget Programming#Event Driven Code | event driven code]], and must use [[General Phidget Programming#Logic Code | logic code]] only:

*[[Language - MATLAB|MATLAB]]
*[[Language - Simulink|Simulink]]

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network.

Drivers for the Phidget WebService on OS X are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. If you see the Phidget Preference Pane in System Preferences, then you already have the WebService drivers installed.

There are two ways that you can connect to a Phidget hosted on another computer. The first method is by using the IP address/host name and port of the host computer. The second method makes the use of [http://en.wikipedia.org/wiki/Multicast_DNS mDNS], which allows Phidgets to be found and opened on the network by a server id instead of an IP address/host name. When using a server id, both the client and server will need to be running an implementation of zero configuration networking. The Phidget WebService takes advantage of [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] software, which is built-in to OS X. It is a tool, developed by Apple to locate devices, such as Phidgets, on a network.

This section helps you install, check, and use the WebService on Windows, but we also have an overview of the [[Phidget WebService]] in general.

===Turning the WebService On and Off===

There are two methods that can be used to turn the WebService on and off. The first method is through the Phidget Preference Pane. In the {{Code|WebService}} tab, you can start or stop the WebService. You can also choose to have the WebService start up automatically upon system boot up by selecting the {{Code|Start Automatically}} checkbox.

[[File:OSX PreferencePane Webservice Stopped.png|link=|alt=OS X PreferencePane WebService]]

The second method of turning the WebService on and off is through command line. After using our installer, the WebService utility is automatically installed in {{Code|/usr/bin/phidget21webservice}}.

You can get command line help with {{Code|phidgetwebservice21}} using the -h option:

<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21 -h
</syntaxhighlight>

<syntaxhighlight lang=text>
'phidgetwebservice21' is a Phidget and Dictionary server from Phidgets Inc. See www.phidgets.com for more information.
Usage: phidgetwebservice21 [OPTION]
All parameters are optional. The default parameters are: port=5001, ServerName=(Computer Name) and no password

Options:
-p Port
-n Server Name
-P Password
-v Debug mode
-h Display this help
</syntaxhighlight>
</div>

Mapping out which command line options to which Phidget Preference Pane option is as follows:

-p: {{Code|Port}} field

-n: {{Code|ServerID}} field

-P: {{Code|Password}} field

-v: Not supported under the Phidget Preference Pane

To find the defaults used by {{Code|phidget21webservice}}, the command line is the fastest way to learn the default server name and IP address of your computer:
*For the default server name, use {{Code|hostname}} on the command line.
*For your IP address, use {{Code|ifconfig -a}} on the command line.
**A line in the return text, under your main internet connection (usually {{Code|eth0}}) will say something like {{Code|inet addr:192.168.3.178}}, which is your IP.

Here are some usage examples:

To start the WebService with default parameters:
<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21
</syntaxhighlight>
</div>

To start the WebService with a server name of {{Code|myServer}}:
<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21-n myServer
</syntaxhighlight>
</div>

To stop the WebService, simply close the command line window or press {{Code|Control}} and {{Code|c}} at the same time in the command line window.

===Using the WebService===

To use a Phidget over the WebService, you'll want to:
* Have two different computers connected to the same network. We will call the computer that has the Phidget directly connected to the USB port the host. The client will be the computer that runs a Phidget application to connect to the Phidget attached to the host. Please note that if you only have a single computer, you can also connect to the Phidget over the WebService. The computer will simply act as both a host and client. This will allow you to bypass the [[General Phidget Programming # Details for Open() | one application per Phidget limitation]].

* Start the WebService on the computer that directly connects to the Phidget
* Run your program on the remote computer that will control the Phidget over the network

The easiest way to test these steps on OS X is to set up the WebService and run the Phidget program on the client. Please follow these steps:

1. On the host, open up the Phidget Preference Pane and traverse to the {{Code|Web Service}} tab.

[[File:OSX PreferencePane Webservice Stopped.png |link=|alt=OS X Preference Pane WebService]]

2. Leave all fields the way they are, and click on {{Code|Start WebService}} to run the WebService.

3. You can determine that the WebService is running by looking at the status on the right side.

[[File:OSX PreferencePane Webservice Running.png|link=|alt=OS X PreferencePane WebService Running]]

4. Ensure that the Phidget is plugged in to the host.

5. On the client's Phidget Preference Pane, open up the {{Code|Bonjour}} tab. You will see the Phidget that is plugged into the host as one of the entries listed. Double click it to open the example application.

[[File:OSX PreferencePane Bonjour.png ‎‎ |link=|alt=OS X PreferencePane Bonjour.png ‎]]

6. The example application will open up, and you will be able to communicate with the Phidget over the WebService.

[[File:OSX PreferencePane Example.png ‎ |link=|alt=OS X PreferencePane Example]]

7. You can confirm that the WebService was indeed behind this exchange by terminating the WebService process while still allowing the remote program to run. On the host's Phidget Preference Pane, traverse to the {{Code|WebService}} tab. Hit {{Code|Stop WebService}} to terminate the WebService.

[[File:OSX PreferencePane Webservice Running.png|link=|alt=OS X PreferencePane WebService Running]]

8. Take a look at the example application on the client. Since the application can no longer connect to the WebService, there is nothing attached.

[[File:OSX PreferencePane Example Stopped.png |link=|alt=OS X PreferencePane Example Stopped]]

===Debugging the WebService===

In addition to enabling [[General Phidget Programming#Logging|logging]] in your Phidget code, you can get additional debugging information from the WebService itself. This additional debugging can only be enabled from the command line approach to start the WebService. Debug information is enabled by specifying the {{Code|-v}} option:

<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21 -v -n "myServer"
</syntaxhighlight>
</div>

The debugging information will be shown as output in the command line console.

==Advanced Uses==

==Appendix==

===Description of Installer files===

Here is the list of files and their description for each file the installer puts onto your system.
===Description of Library files===

This section will explain the files that were placed onto your system as part of the installation process.
* <b>{{Code|Phidget21.framework}}</b> contains the actual Phidget library, which is used at run-time. It is placed into {{Code|/Library/Frameworks}}.
* <b>{{Code|Phidget.kext}}</b> is the kernel extension. It is placed into {{Code|/System/Library/Extensions}}.
* <b>{{Code|libphidget21.jnilib}}</b> is the JNI library for Java. It is placed into {{Code|/Library/Java/Extensions}}.
* <b>{{Code|Phidgets.prefpane}}</b> is the Phidgets Preference Pane. It is placed into {{Code|/Library/PreferencePanes}}.
* <b>{{Code|phidgetwebservice21}}</b> is the Phidget WebService. It is placed into {{Code|/usr/bin}}.
* <b>{{Code|PhidgetsOSA.app}}</b> is the the Phidgets agent for AppleScript. It is placed into {{Code|/Library/ScriptingAdditions}}.

==Common Problems and Solutions==

None, yet.

OS - OS X

2012-04-20T20:03:02Z

Djrudiak: /* Software */

[[Category:OS]]

{{OSLang|[[File:Icon-Mac-OS.png‎|64x64px|link=]]|On OS X, Phidgets can be either plugged directly into a USB Port or run over a network using the [[#WebService|WebService]].}}

__TOC__

Phidgets are designed to run on '''OS X 10.4 Tiger or newer''', and can run on PPC, 32-bit, and 64-bit systems.

==Getting Started (Libraries and Drivers)==

If this is your first Phidget, we highly recommend working through the Getting Started guide [[Device List|for your specific Phidget device]]. If you already have the Preference Pane Installed and know how to use it, then you've already followed the guide and are ready to learn more about the workings behind the Preference Pane, the Phidget WebService, and more - all specific to OS X.

If you are already a pro, and just want the drivers:

*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20120216.dmg OS X Installer]
*[http://www.phidgets.com/Drivers_Info.html#osx Software License]

===Installing===

The Phidget installer will install the core Phidget files onto your system.

To install the libraries, follow these steps:

1. Download the Phidget installer for your system:
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20120216.dmg OS X Installer]

2. Open up the installer, and double click on {{Code|Phidgets.mpkg}} to install the libraries.

[[File:OSX Install 1.png|link=|alt=OS X Install]]

3. Proceed through the wizard.

[[File:OSX Install 2.png|link=|alt=OS X Install]]

4. Once the installation is complete, you are ready to program with Phidgets. To find out what files got installed, please see [[#Description of Installer files | Description of Installer files]] in the Appendix section.

Proceed onto to the [[#Phidget Preference Pane | next]] section where the Phidget Preference Pane will be discussed.

====Phidget Preference Pane====

The Phidget Preference Pane is a tool to quickly determine whether your system is able to communicate with Phidgets, and also act as a debugging tool.

Once the Phidget libraries are installed using the installer, open up the {{Code|System Preferences}} window.

[[File:OSX System Preferences.png|link=|alt=OS X System Preferences]]

Click on the {{Code|Phidgets}} icon in the {{Code|Other}} section to bring up the Phidgets Preference Pane.

[[File:OSX PreferencePane General.png|link=|alt=OS X PreferencePane General]]

The {{Code|general}} tab shows the list of Phidgets currently physically attached to the computer. You can also view the currently installed Phidget library version. You can double click on a Phidget device to open up an example program for the device.

[[File:OSX PreferencePane Example.png|link=|alt=OS X PreferencePane Example]]

In the above screenshot, the RFID example was opened. These examples are intended for demonstration and debugging purposes. If you have not yet already, please see the '''Getting Started''' guide [[Device List|for your device]]. It is important to keep in mind that when an example Phidget application is opened from the Phidget Preference Pane or opened from any of your Phidget applications that you develop, it holds a lock on the Phidget. This prevents any other program from accessing the Phidget. Please ensure that this example application is closed(the Phidget Preference Pane can still be running) when you are running your own applications.

The next tab is the {{Code|Web Service}} tab, which allows you to control Phidgets over a network.

[[File:OSX PreferencePane Webservice Stopped.png|link=|alt=OS X PreferencePane WebService Stopped]]

Here, you can start and stop the WebService. Details are provided in the [[#WebService | WebService]] section. This screen also tells you whether the Phidget WebService is currently running.

The next tab is the {{Code|Labels}} tab. In this section, you can view the currently assigned labels of any Phidget attached to your computer. It is also possible to set the labels of Phidgets here too. You might want to set a label to a Phidget device because you can refer to it by its label as opposed to its serial number.

[[File:OSX PreferencePane Labels Local.png|link=|alt=OS X PreferencePane WebService Labels Local]]

You can also view the labels of any Phidget connected through the WebService

[[File:OSX PreferencePane Labels Remote.png|link=|alt=OS X PreferencePane WebService Labels Remote]]

The {{Code|Bonjour}} tab gives a list of all currently attached Phidgets that are connected to the WebService. You can also double click on the Phidget to connect to it over the network using one or more computers, but still use the Phidget on the computer it is directly connected to.

[[File:OSX PreferencePane Bonjour.png|link=|alt=OS X PreferencePane Bonjour]]

The last tab is the {{Code|PhidgetSBC}} tab, which displays the complete list of PhidgetSBCs connected to the network.

[[File:OSX PreferencePane PhidgetSBC.png|link=|alt=OS X PreferencePane PhidgetSBC]]

You can double click on the PhidgetSBC to bring up the PhidgetSBC Administration Console log-in page in your default browser.

[[File:PhidgetSBCAdminConsole.PNG|link=|alt=PhidgetSBC Admin Console]]

The PhidgetSBC Administration Console is where you can go to configure the PhidgetSBC. For more details, please see the [[1072 0 - Getting Started | PhidgetSBC]] section.

===Checking===

To confirm the libraries were installed and work correctly, you can check both the hardware and software components of the interface. It is worth checking the software side first, because if it works then you know the hardware side is also okay.

====Software====

If you have the Phidgets library installed on your system, you can verify that the software component is working by seeing if the Phidget device is listed in the General tab of the Phidget Preference Pane.

[[File:OSX PreferencePane General.png ‎|link=|alt=OS X Preference Pane General]]

The above screenshot shows that a PhidgetRFID and a PhidgetInterfaceKit are attached to the computer. If you see your Phidget in the list, you can continue to the [[#Programming Languages | programming languages]] section to learn more. If you are not able to see that the Phidget is in the list, there may be a hardware issue. Please see the [[#Hardware| hardware]] section for more details.

====Hardware====

You can verify that your computer detects that the Phidget is plugged in through a USB connection by going to the OS X System Profiler. You can access the System Profiler by selecting {{Code|About This Mac}} under the Apple icon.

[[File:OSX About This Mac.png‎|link=|alt=OS X About This Mac]]

The new window will open up.

[[File:OSX More Info.png|link=|alt=OS X More Info]]

Select {{Code|More Info}}. The System Profiler will show up. In the USB section, you will be able to find all connected USB devices.

[[File:OSX USB Devices.png ‎|link=|alt=OS X Attached USB Devices]]

In the above screenshot, The PhidgetInterfaceKit and PhidgetRFID are connected to the USB ports.

If you don't see the Phidget in the list, then take a look at the [[#Troubleshooting|troubleshooting]] section below, as well as the '''Communications''' section of our [[General Troubleshooting#Communications Troubleshooting|general troubleshooting page]].

====Troubleshooting====

If the example programs '''do not''' work but USB '''does''' work (i.e. your computer can consistently see the device in the [[#Hardware|hardware]]), take a moment to check the basics:
* You are using OS X 10.4 or newer.
* No other programs, drivers, or processes are using that USB port in software
* The Phidget libraries are the latest version (visit the [[#Getting Started (Libraries and Drivers)| getting started section]] to download them)

* Check the [[#Common Problems and Solutions|common problems]] section below, some specific combinations can cause problems

If your problem doesn't seem to be fixed by these steps, make sure that the Phidget is seen '''consistently''' by USB (if it is erratic, try our [[General Troubleshooting|general troubleshooting guide]]). If you are still having problems after using the troubleshooting guide, please [[Contact Information|ask us]]!

==Programming Languages==
Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.

After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language. You can learn more about what is needed to program in a particular language by choosing the language of your preference below. If you need help choosing a language, please look at the [[Software Overview#Language Support |language comparison table]].

We recommend the following languages for OS X:
* [[Language - Applescript|AppleScript]]
* [[Language - C/C++|C/C++]]
* [[Language - C#|C#(Using Mono)]]
* [[Language - Cocoa | Cocoa]]
* [[Language - Flash AS3 | Flash AS3]]
* [[Language - Flex AS3 | Flex AS3]]
* [[Language - LiveCode | LiveCode]]
* [[Language - Java | Java]]
* [[Language - Max/MSP|Max/MSP]]
* [[Language - Python | Python]]
* [[Language - Ruby|Ruby]]

You can also use these languages, but they do not support [[General Phidget Programming#Event Driven Code | event driven code]], and must use [[General Phidget Programming#Logic Code | logic code]] only:

*[[Language - MATLAB|MATLAB]]
*[[Language - Simulink|Simulink]]

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network.

Drivers for the Phidget WebService on OS X are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. If you see the Phidget Preference Pane in System Preferences, then you already have the WebService drivers installed.

There are two ways that you can connect to a Phidget hosted on another computer. The first method is by using the IP address/host name and port of the host computer. The second method makes the use of [http://en.wikipedia.org/wiki/Multicast_DNS mDNS], which allows Phidgets to be found and opened on the network by a server id instead of an IP address/host name. When using a server id, both the client and server will need to be running an implementation of zero configuration networking. The Phidget WebService takes advantage [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] software, which is built-in to OS X. It is a tool, developed by Apple to locate devices such as Phidgets, and printers.

This section helps you install, check, and use the WebService on Windows, but we also have an overview of the [[Phidget WebService]] in general.

===Turning the WebService On and Off===

There are two methods that can be used to turn the WebService on and off. The first method is through the Phidget Preference Pane. In the {{Code|WebService}} tab, you can start or stop the WebService. You can also choose to have the WebService start up automatically upon system boot up by selecting the {{Code|Start Automatically}} checkbox.

[[File:OSX PreferencePane Webservice Stopped.png|link=|alt=OS X PreferencePane WebService]]

The second method of turning the WebService on and off is through command line. After using our installer, the WebService utility is automatically installed in {{Code|/usr/bin/phidget21webservice}}.

You can get command line help with {{Code|phidgetwebservice21}} using the -h option:

<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21 -h
</syntaxhighlight>

<syntaxhighlight lang=text>
'phidgetwebservice21' is a Phidget and Dictionary server from Phidgets Inc. See www.phidgets.com for more information.
Usage: phidgetwebservice21 [OPTION]
All parameters are optional. The default parameters are: port=5001, ServerName=(Computer Name) and no password

Options:
-p Port
-n Server Name
-P Password
-v Debug mode
-h Display this help
</syntaxhighlight>
</div>

Mapping out which command line options to which Phidget Preference Pane option is as follows:

-p: {{Code|Port}} field

-n: {{Code|ServerID}} field

-P: {{Code|Password}} field

-v: Not supported under the Phidget Preference Pane

To find the defaults used by {{Code|phidget21webservice}}, the command line is the fastest way to learn the default server name and IP address of your computer:
*For the default server name, use {{Code|hostname}} on the command line.
*For your IP address, use {{Code|ifconfig -a}} on the command line.
**A line in the return text, under your main internet connection (usually {{Code|eth0}}) will say something like {{Code|inet addr:192.168.3.178}}, which is your IP.

Here are some usage examples:

To start the WebService with default parameters:
<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21
</syntaxhighlight>
</div>

To start the WebService with a server name of {{Code|myServer}}:
<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21-n myServer
</syntaxhighlight>
</div>

To stop the WebService, simply close the command line window or press {{Code|Control}} and {{Code|c}} at the same time in the command line window.

===Using the WebService===

To use a Phidget over the WebService, you'll want to:
* Have two different computers connected to the same network. We will call the computer that has the Phidget directly connected to the USB port the host. The client will be the computer that runs a Phidget application to connect to the Phidget attached to the host. Please note that if you only have a single computer, you can also connect to the Phidget over the WebService. The computer will simply act as both a host and client. This will allow you to bypass the [[General Phidget Programming # Details for Open() | one application per Phidget limitation]].

* Start the WebService on the computer that directly connects to the Phidget
* Run your program on the remote computer that will control the Phidget over the network

The easiest way to test these steps on OS X is to set up the WebService and run the Phidget program on the client. Please follow these steps:

1. On the host, open up the Phidget Preference Pane and traverse to the {{Code|Web Service}} tab.

[[File:OSX PreferencePane Webservice Stopped.png |link=|alt=OS X Preference Pane WebService]]

2. Leave all fields the way they are, and click on {{Code|Start WebService}} to run the WebService.

3. You can determine that the WebService is running by looking at the status on the right side.

[[File:OSX PreferencePane Webservice Running.png|link=|alt=OS X PreferencePane WebService Running]]

4. Ensure that the Phidget is plugged in to the host.

5. On the client's Phidget Preference Pane, open up the {{Code|Bonjour}} tab. You will see the Phidget that is plugged into the host as one of the entries listed. Double click it to open the example application.

[[File:OSX PreferencePane Bonjour.png ‎‎ |link=|alt=OS X PreferencePane Bonjour.png ‎]]

6. The example application will open up, and you will be able to communicate with the Phidget over the WebService.

[[File:OSX PreferencePane Example.png ‎ |link=|alt=OS X PreferencePane Example]]

7. You can confirm that the WebService was indeed behind this exchange by terminating the WebService process while still allowing the remote program to run. On the host's Phidget Preference Pane, traverse to the {{Code|WebService}} tab. Hit {{Code|Stop WebService}} to terminate the WebService.

[[File:OSX PreferencePane Webservice Running.png|link=|alt=OS X PreferencePane WebService Running]]

8. Take a look at the example application on the client. Since the application can no longer connect to the WebService, there is nothing attached.

[[File:OSX PreferencePane Example Stopped.png |link=|alt=OS X PreferencePane Example Stopped]]

===Debugging the WebService===

In addition to enabling [[General Phidget Programming#Logging|logging]] in your Phidget code, you can get additional debugging information from the WebService itself. This additional debugging can only be enabled from the command line approach to start the WebService. Debug information is enabled by specifying the {{Code|-v}} option:

<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21 -v -n "myServer"
</syntaxhighlight>
</div>

The debugging information will be shown as output in the command line console.

==Advanced Uses==

==Appendix==

===Description of Installer files===

Here is the list of files and their description for each file the installer puts onto your system.
===Description of Library files===

This section will explain the files that were placed onto your system as part of the installation process.
* <b>{{Code|Phidget21.framework}}</b> contains the actual Phidget library, which is used at run-time. It is placed into {{Code|/Library/Frameworks}}.
* <b>{{Code|Phidget.kext}}</b> is the kernel extension. It is placed into {{Code|/System/Library/Extensions}}.
* <b>{{Code|libphidget21.jnilib}}</b> is the JNI library for Java. It is placed into {{Code|/Library/Java/Extensions}}.
* <b>{{Code|Phidgets.prefpane}}</b> is the Phidgets Preference Pane. It is placed into {{Code|/Library/PreferencePanes}}.
* <b>{{Code|phidgetwebservice21}}</b> is the Phidget WebService. It is placed into {{Code|/usr/bin}}.
* <b>{{Code|PhidgetsOSA.app}}</b> is the the Phidgets agent for AppleScript. It is placed into {{Code|/Library/ScriptingAdditions}}.

==Common Problems and Solutions==

None, yet.

Language - Delphi

2012-04-20T19:45:43Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:Icon-Delphi.png|64px|alt=|link=]]|'''[http://www.embarcadero.com/products/delphi Embarcadero Delphi]''' is an integrated development environment for console, desktop graphical, web application, and mobile applications.}}
==Support==
Delphi has a complete API for all Phidgets devices, and code samples for AdvancedServo, Servo, PhidgetInterfaceKit, and RFID.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/COM_API_Manual.pdf API Manual]
* [http://www.phidgets.com/downloads/examples/Delphi_2.1.8.20110615.zip Delphi Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General Phidget Programming]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==

The Phidget examples were written using Borland Delphi 2005 and 7, and this tutorial assumes its use.
The ActiveX objects installed with the Phidget libraries are not automatically imported into Delphi, so to begin you will need to manually import them:

#Go to Component >> Import ActiveX Control...
#Select the Phidget Library 2.1 and click install
#In the next popup select the “install into new package” tab
#Give the package a suitable name and description such as “Phidgets”, and then click OK
#Compile and Install the newly created package if not done so automatically.

In Delphi 2005/2006:

#Go to File >> New >> Package - Delphi for Win32. Rename and save the package using File >> Save Project As...
#Import the ActiveX component, go to Component >> Import Component.
#Choose Inport ActiveX Control and click Next
#Select Phidget Library 2.1 and click Next
#Click Next
#Select ‘Add unit to [Package Name] project’ and click Finish.
#Install the ActiveX package you have created by right-mouse-clicking the package name in the Project Manager pane and selecting ‘Install’.
#Delphi should now display a confirmation that the package was installed. Click ok and save the package.
#When you open a new or existing application, you should now see all the Phidget device control objects listed under the ActiveX category.

In newer versions of Delphi:

#Go to Component >> Import Component...
#Choose “Import ActiveX Control” and click Next
#Pick Phidget Library 2.1 from the list and click Next
#Set the palette Page to ActiveX and check the Generate Component Wrappers option
#Choose Install into a new package and click next
#Give the package a name and description such as “Phidgets”, and then click Finish

Once installed, all future projects will be able to use the Phidget ActiveX objects.

===Coding For Your Phidget===

Before you can use the Phidget, you must declare and initialize its ActiveX object.
The simplest method is to place the control from the ActiveX component tab on to your form.
For this tutorial, create a PhidgetInterfaceKit control (PhidgetInterfaceKit1) and then add a text edit field to the form for the purpose of capturing simple output.
The object name for any type of Phidget is listed in the API manual.
Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

Next, we need to tell the program to try and connect to the Phidget through a call to open().
The open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that calling open does not guarantee you can use the Phidget immediately.
We can handle it by either using event driven programming and tracking the AttachEvents and DetachEvents, or by calling waitForAttachment.
WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.

<div class="source"><syntaxhighlight lang=delphi>

procedure TForm1.FormCreate(Sender: TObject);
begin
PhidgetInterfaceKit1.Open(-1);
PhidgetInterfaceKit1.WaitForAttachment(3000);
end;

</syntaxhighlight></div>
The parameters can also be used to open the first Phidget of a type it can find, open based on its serial number, or even open across the network.
The API manual lists all of the available modes that open provides.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This prevents any other instances from retrieving data from the Phidget, including other programs.
The one connection per device limit does not apply when exclusively using the Phidget Webservice.
You can call Close any time outside of the Phidget’s own event handlers to end the connection.

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
This allows the program to execute other tasks until the Phidget fires a new event.

In Delphi, when the event library was installed it added Phidget ActiveX components for each type of Phidget.
These ActiveX components will show up in the toolbox under the ActiveX tab.
The ActiveX object for your Phidget can be added to the form and then hooked to the event handlers you wish to use like any other control.
For a Phidget21COMIPhidgetInterfaceKitEvents control, the event handler looks like the following:

<div class="source"><syntaxhighlight lang=delphi>

procedure TForm1.PhidgetInterfaceKit1SensorChange(ASender: TObject; Index,
SensorValue: Integer);
begin
Edit1.Text := IntToStr(Index) + ': ' + IntToStr(SensorValue);
end;

</syntaxhighlight></div>
With this method, the code inside PhidgetInterfaceKit1SensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the COM API manual for a full list of events and their general usage.

===Working directly with the Phidget===

Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming.
Simply use the CallString such as SensorValue[Index] or OutputState[Index] for PhidgetInterfaceKits.

<div class="source"><syntaxhighlight lang=delphi>

PhidgetInterfaceKit1.OutputState[0] := true;

</syntaxhighlight></div>
===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another PhidgetInterfaceKit ActiveX object to be added to the project.
The new instance can then be set up, opened and used in the same fashion as the previous one.
If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===

The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfacekit, you would place a PhidgetRFID ActiveX object instead of a PhidgetInterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

===Enabling Logging===

Often it’s a good idea to enable logging during development for debugging purposes.
This log, depending on the level set, will record certain events and errors from Phidgets.
In Delphi, this is accomplished by calling EnableLogging(logLevel, filename) on the Phidget object.

<div class="source"><syntaxhighlight lang=delphi>

PhidgetInterfaceKit1.EnableLogging(6, 'testlog.txt');

</syntaxhighlight></div>
Similarly, you can call DisableLogging() at the end of your program to shut it off.
Should you need to contact Phidgets for support, including this log is very helpful for revealing the cause of the problem.
Please see the Programming Manual for a general discussion on Phidget logging and the levels provided.

==Building your Project==
Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Language - Objective C

2012-04-20T19:23:03Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Cocoa.png|64x64px|alt=|link=]]|Cocoa is Apple's native object-oriented application programming interface (API) for the [http://www.apple.com/macosx/mountain-lion/ Mac OS X] [[OS - OS X|operating system]].}}
__TOC__
==Support==
Cocoa has a complete API and code samples for all Phidgets devices.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip API Manual]
* [http://www.phidgets.com/documentation/web/NETDoc/Index.html API Reference]
* [http://www.phidgets.com/downloads/examples/Cocoa_2.1.8.20110630.zip Cocoa Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General Phidget Programming]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==

The Phidget examples were written in Objective-C and Xcode 3.2.4, and this tutorial assumes their use.
Other versions of Xcode should work as well and would be set up in a similar manner.
In Xcode:
* Generate a new Cocoa project with a descriptive name such as PhidgetTest.
* Add the Phidget21 Framework(Groups & Files -> Frameworks -> Other Frameworks).
* Create a new Objective-C class with a descriptive name. For the purpose of this guide, the class name will be PhidgetInterfaceKit.
A header file(.h) as well as an implementation file(.m) will automatically be created.
* Open the header file for editing
* Add a reference to phidget21.h:

<div class="source"><syntaxhighlight lang=objc>

#import <Phidget21/phidget21.h>

</syntaxhighlight></div>

* A text field will be used for the purpose of capturing output. Add a text field outlet in the header file. For example,

<div class="source"><syntaxhighlight lang=objc>

@interface PhidgetInterfaceKit : NSObject{
IBOutlet NSTextField *sensorValueTxt;
}
@end

</syntaxhighlight></div>

* In Groups & Files -> Resources, open up MainMenu.nib to bring up the Interface Builder. Drag a text field from the Library to the Window.
* Now, an instance of the PhidgetInterfaceKit class will need to be created. In the Library, drag an object to the MainMenu.nib Window.
Open up the Identity tab of the Inspector for this object and add the PhidgetInterfaceKit class.
* Connect the PhidgetInterfaceKit class instance to the text field.
The project now has access to Phidgets and we are ready to begin coding.

===Coding For Your Phidget===

A Phidget object will need to be declared. For example, we can declare a PhidgetInterfaceKit in the .m implementation file with:

<div class="source"><syntaxhighlight lang=objc>

CPhidgetInterfaceKitHandle ifkit

</syntaxhighlight></div>

The object name for any type of Phidget is listed in the API manual. Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

Next, the Phidget object needs to be initialized and the program needs to try and connect to the Phidget through a call to open().
Open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately.
We can handle this by using event driven programming and tracking the AttachEvents and DetachEvents, or by calling waitForAttachment.
WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.
For example, we can connect to a PhidgetInterfaceKit in the .m implementation file with:

<div class="source"><syntaxhighlight lang=objc>

@implementation PhidgetInterfaceKit
- (void)awakeFromNib
{
CPhidgetInterfaceKit_create(&ifkit);
CPhidget_open((CPhidgetHandle)ifkit, -1);
}
@end

</syntaxhighlight></div>

The different types of open can be used with parameters to try and get the first device it can find, open based on its serial number, or even open across the network.
The API manual lists all of the available modes that open provides.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This prevents any other instances from retrieving data from the Phidget, including other programs.
The one connection per device limit does not apply when exclusively using the Phidget Webservice.
At the end of your program, don’t forget to call close to free any locks on the Phidget.

<div class="source"><syntaxhighlight lang=objc>

CPhidget_close((CPhidgetHandle)ifkit);
CPhidget_delete((CPhidgetHandle)ifkit);

</syntaxhighlight></div>

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
We can hook an event handler at loading with the following code:

<div class="source"><syntaxhighlight lang=objc>

CPhidgetInterfaceKit_set_OnSensorChange_Handler(ifkit, gotSensorChange, self);

</syntaxhighlight></div>

Next, the callback method needs to be set up before it can be used. For example,

<div class="source"><syntaxhighlight lang=objc>

int gotSensorChange(CPhidgetInterfaceKitHandle phid, void *context, int ind, int val)
{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
[(id)context performSelectorOnMainThread:@selector(SensorChange:)
withObject:[NSArray arrayWithObjects:[NSNumber numberWithInt:ind], [NSNumber
numberWithInt:val], nil] waitUntilDone:NO];
[pool release];
return 0;
}

</syntaxhighlight></div>

Above, the SensorChange method is invoked on the main thread.
Event data is stored in a NSArray, which in turn is sent as a single argument to the SensorChange method.
The NSAutoreleasePool object is created to clean up released objects on the event thread, and is released at the end of the method.

The SensorChange method is defined as follows:

<div class="source"><syntaxhighlight lang=objc>

- (void)SensorChange:(NSArray *)sensorChangeData
{
int sensorIndex, sensorValue;
sensorIndex = [[sensorChangeData objectAtIndex:0] intValue];
sensorValue = [[sensorChangeData objectAtIndex:1] intValue];
[sensorValueTxt setStringValue:[NSString stringWithFormat:@"Sensor: %d, Value:
%d", sensorIndex, sensorValue]];
}

</syntaxhighlight></div>

With this function, the code inside SensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the API manual and the Cocoa examples for a list of events and their usage.

===Working directly with the Phidget===

Some values can be read and sent directly to the Phidget, simply use the C API functions such as CPhidgetInterfaceKit_getSensorValue() for PhidgetInterfaceKits.

<div class="source"><syntaxhighlight lang=objc>

int sensorValue;
CPhidgetInterfaceKit_getSensorValue(ifkit, 0, &sensorValue);
[sensorValueTxt setintValue: sensorValue];

</syntaxhighlight></div>

These functions can be used inside a polling loop as an alternative to event driven programming.

===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another PhidgetInterfaceKit instance to be defined and initialized.
The new instance can then be set up, opened and used in the same process as the previous one.
If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===

The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfacekit, you would declare an RFID object instead of an InterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

==Building your Project==
Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Language - Visual Basic Script

2012-04-20T19:17:46Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Visual Basic Script.png|64x64px|alt=|link=]]|'''VBScript''' ('''V'''isual '''B'''asic '''Script'''ing Edition) is an [http://en.wikipedia.org/wiki/Active_Scripting Active Scripting] language developed by [http://msdn.microsoft.com/en-us/library/t0aew7h6 Microsoft] that is modeled on [[Language_-_Visual_Basic_6.0|Visual Basic]].}}
==Support==
Visual Basic Script has a complete API for all Phidgets devices, and code samples for Encoder, InterfaceKit and RFID.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==

Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/COM_API_Manual.pdf API Manual]
* [http://www.phidgets.com/downloads/examples/VBScript_2.1.8.20110615.zip VBS Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==

You will need the ClassID List from the VBScript examples above to program with Phidgets, and the Phidget Framework to use them.
The Phidget examples were written using Visual Basic Script for Internet Explorer and this tutorial assumes its use.
To begin, load the HTML editor of your choice and create a new document.
Add a table to body of the code for the purpose of displaying simple output.

<div class="source"><syntaxhighlight lang=html4strict>

<html>
<head>
<body>
<form action=”html_interfacekit.htm”>
<table id=”mytable”>
<thead>
<tr><td>Analog Input</td></tr>
</thead>
<tr id=”tr0”><td>0</td> </tr>
<tr id=”tr1”><td>0</td> </tr>
<tr id=”tr2”><td>0</td> </tr>
<tr id=”tr3”><td>0</td> </tr>
<tr id=”tr4”><td>0</td> </tr>
<tr id=”tr5”><td>0</td> </tr>
<tr id=”tr6”><td>0</td> </tr>
<tr id=”tr7”><td>0</td> </tr>
</table>
</form>
</body>
</html>

</syntaxhighlight></div>

===Coding For Your Phidget===

Before you can use the Phidget, you must include its Class ID on object creation in your code.
This will let the browser know which library to try and load for the Phidget definitions.
Each type of Phidget has its ClassID listed inside the ClassID_List.txt document from the VBScript examples.
For example, we can declare and create a PhidgetInterfaceKit for vbscript with:

<div class="source"><syntaxhighlight lang=html4strict>

<object classid="clsid:50484945-4745-5453-3000-000000000003" id="phid"></object>
<script type="text/vbscript">

</script>

</syntaxhighlight></div>

The object name for any type of Phidget is listed in the API manual.
Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

The program can try to connect to the Phidget through an open call.
Open will continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately.
We can account for a connection by using event driven programming and tracking the AttachEvents and DetachEvents, or by calling WaitForAttachment.
WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.

<div class="source"><syntaxhighlight lang=vb>

phid.Open()
phid.WaitForAttachment (3000)

</syntaxhighlight></div>

The different parameters and open calls can be used to open the first Phidget of a type it can find, open based on a serial number, or even open across the network.
The API manual lists all of the available modes that open provides.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This prevents any other instances from retrieving data from the Phidget, including other programs.
The one connection per device limit does not apply when exclusively using the Phidget Webservice.

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
In VBScript, we hook an event handler with the following code:

<div class="source"><syntaxhighlight lang=vb>

Sub phid_OnSensorChange(ByVal Index, ByVal SensorValue)
mytable.rows("str"+CStr(Index)).cells(0).innerText = Cstr(InterfaceKit1.sensorValue(Index))
End Sub

</syntaxhighlight></div>

With this method, the code inside onSensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.

Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the API manual for a full list of events and their usage.

===Working directly with the Phidget===

Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming.
Simply use the instance properties such as phid.SensorChangeTrigger(Index) for PhidgetInterfaceKits.

<div class="source"><syntaxhighlight lang=vb>

phid.SensorChangeTrigger(0) = 1

</syntaxhighlight></div>

===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another PhidgetInterfaceKit instance to be defined and initialized.
The new instance can then be set up, opened and used in the same process as the previous one.

If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===

The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfaceKit, you would use the class ID for a PhidgetRFID instead of a PhidgetInterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

==Building your Project==

Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==

===Issue: Cannot control Phidgets with certain web browsers===
Affected Operating Systems: '''Windows'''

Certain web browsers such as Firefox and Chrome cannot control Phidgets in Visual Basic Script.

Solution: Only Internet Explorer can control Phidgets with Visual Basic Script.

Language - Visual Basic for Applications

2012-04-20T18:57:02Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:Icon-Visual Basic for Applications.png|64x64px|alt=|link=]]|'''Visual Basic for Applications''' ('''VBA''') is an implementation of [http://msdn.microsoft.com/en-ca/office Microsoft]'s event-driven programming language [[Language_-_Visual_Basic_6.0|Visual Basic 6.0]] and its associated integrated development environment (IDE), which are built into most [http://office.microsoft.com Microsoft Office] applications.}}
==Support==
VBA has a complete API for all Phidgets devices, and code samples for Accelerometer, Encoder, InterfaceKit, RFID, TemperatureSensor and Servo.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/COM_API_Manual.pdf API Manual]
* [http://www.phidgets.com/downloads/examples/VBA_2.1.8.20110615.zip VBA Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==

The Phidget examples were written using Microsoft Excel 2000 and this tutorial assumes its use.
Other environments such as Microsoft Office should work provided they support VBA, and each would be set up in a similar manner.

To begin, launch Excel with a new workbook for our project. Launch the VBA editor (Tools | Macro | Visual Basic Editor) and open “ThisWorkbook” in the navigator.

===Coding For Your Phidget===

Before you can use the Phidget, you must include the library in your project.
This can be accomplished from the references screen (Tools | References...) by checking the box beside “Phidget Library 2.1”, or by browsing to the location the framework was installed and choosing the Phidget21COM.dll.

Afterwards, the Phidget object will need to be declared and then initialized inside the workbook item.
For example, we can declare and create a PhidgetInterfaceKit at the top of the code with:

<div class="source"><syntaxhighlight lang=vb>

Public WithEvents phid As PhidgetInterfaceKit
Private Sub Workbook_Open()
Set phid = New PhidgetInterfaceKit
End Sub

</syntaxhighlight></div>

The object name for any type of Phidget is listed in the API manual.
Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

The program can try to connect to the Phidget through an open call.
Open will continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately.
We can account for a connection by using event driven programming and tracking the AttachEvents and DetachEvents, or by calling WaitForAttachment.
WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.

<div class="source"><syntaxhighlight lang=vb>

phid.Open
phid.WaitForAttachment(3000)

</syntaxhighlight></div>

The different parameters and open calls can be used to open the first Phidget of a type it can find, open based on a serial number, or even open across the network.
The API manual lists all of the available modes that open provides.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This prevents any other instances from retrieving data from the Phidget, including other programs.
The one connection per device limit does not apply when exclusively using the Phidget Webservice.

At the end of your program, don’t forget to call close to free any locks on the Phidget.

<div class="source"><syntaxhighlight lang=vb>

Private Sub Workbook_BeforeClose(Cancel As Boolean)
phid.Close
End Sub

</syntaxhighlight></div>

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets. In Visual Basic, we hook an event handler with the following code:

<div class="source"><syntaxhighlight lang=vb>

Private Sub phid_OnSensorChange(ByVal Index As Long, ByVal SensorValue As Long)
Range("A2").Select
ActiveCell.Offset(Index, 0).Value = SensorValue
End Sub

</syntaxhighlight></div>

With this method, the code inside onSensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
You can let the editor generate the procedure declaration for you through the drop down menu at the top of the code window.

Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the API manual for a full list of events and their usage.

===Working directly with the Phidget===

Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming.
Simply use the instance properties such as SensorValue(Index as Long) or OutputState(Index as Long) for PhidgetInterfaceKits.

<div class="source"><syntaxhighlight lang=vb>

phid.OutputState(4) = True

</syntaxhighlight></div>

===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another PhidgetInterfaceKit instance to be defined and initialized.
The new instance can then be set up, opened and used in the same process as the previous one.

If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===

The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfaceKit, you would declare a PhidgetRFID instead of a PhidgetInterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

==Building your Project==
Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Language - Delphi

2012-04-20T17:42:00Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:Icon-Delphi.png|64px|alt=|link=]]|Preamble about the language and its general strengths and weaknesses.
}}
==Support==
Delphi has a complete API for all Phidgets devices, and code samples for AdvancedServo, Servo, PhidgetInterfaceKit, and RFID.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/COM_API_Manual.pdf API Manual]
* [http://www.phidgets.com/downloads/examples/Delphi_2.1.8.20110615.zip Delphi Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General Phidget Programming]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==

The Phidget examples were written using Borland Delphi 2005 and 7, and this tutorial assumes its use.
The ActiveX objects installed with the Phidget libraries are not automatically imported into Delphi, so to begin you will need to manually import them:

#Go to Component >> Import ActiveX Control...
#Select the Phidget Library 2.1 and click install
#In the next popup select the “install into new package” tab
#Give the package a suitable name and description such as “Phidgets”, and then click OK
#Compile and Install the newly created package if not done so automatically.

In Delphi 2005/2006:

#Go to File >> New >> Package - Delphi for Win32. Rename and save the package using File >> Save Project As...
#Import the ActiveX component, go to Component >> Import Component.
#Choose Inport ActiveX Control and click Next
#Select Phidget Library 2.1 and click Next
#Click Next
#Select ‘Add unit to [Package Name] project’ and click Finish.
#Install the ActiveX package you have created by right-mouse-clicking the package name in the Project Manager pane and selecting ‘Install’.
#Delphi should now display a confirmation that the package was installed. Click ok and save the package.
#When you open a new or existing application, you should now see all the Phidget device control objects listed under the ActiveX category.

In newer versions of Delphi:

#Go to Component >> Import Component...
#Choose “Import ActiveX Control” and click Next
#Pick Phidget Library 2.1 from the list and click Next
#Set the palette Page to ActiveX and check the Generate Component Wrappers option
#Choose Install into a new package and click next
#Give the package a name and description such as “Phidgets”, and then click Finish

Once installed, all future projects will be able to use the Phidget ActiveX objects.

===Coding For Your Phidget===

Before you can use the Phidget, you must declare and initialize its ActiveX object.
The simplest method is to place the control from the ActiveX component tab on to your form.
For this tutorial, create a PhidgetInterfaceKit control (PhidgetInterfaceKit1) and then add a text edit field to the form for the purpose of capturing simple output.
The object name for any type of Phidget is listed in the API manual.
Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

Next, we need to tell the program to try and connect to the Phidget through a call to open().
The open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that calling open does not guarantee you can use the Phidget immediately.
We can handle it by either using event driven programming and tracking the AttachEvents and DetachEvents, or by calling waitForAttachment.
WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.

<div class="source"><syntaxhighlight lang=delphi>

procedure TForm1.FormCreate(Sender: TObject);
begin
PhidgetInterfaceKit1.Open(-1);
PhidgetInterfaceKit1.WaitForAttachment(3000);
end;

</syntaxhighlight></div>
The parameters can also be used to open the first Phidget of a type it can find, open based on its serial number, or even open across the network.
The API manual lists all of the available modes that open provides.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This prevents any other instances from retrieving data from the Phidget, including other programs.
The one connection per device limit does not apply when exclusively using the Phidget Webservice.
You can call Close any time outside of the Phidget’s own event handlers to end the connection.

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
This allows the program to execute other tasks until the Phidget fires a new event.

In Delphi, when the event library was installed it added Phidget ActiveX components for each type of Phidget.
These ActiveX components will show up in the toolbox under the ActiveX tab.
The ActiveX object for your Phidget can be added to the form and then hooked to the event handlers you wish to use like any other control.
For a Phidget21COMIPhidgetInterfaceKitEvents control, the event handler looks like the following:

<div class="source"><syntaxhighlight lang=delphi>

procedure TForm1.PhidgetInterfaceKit1SensorChange(ASender: TObject; Index,
SensorValue: Integer);
begin
Edit1.Text := IntToStr(Index) + ': ' + IntToStr(SensorValue);
end;

</syntaxhighlight></div>
With this method, the code inside PhidgetInterfaceKit1SensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the COM API manual for a full list of events and their general usage.

===Working directly with the Phidget===

Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming.
Simply use the CallString such as SensorValue[Index] or OutputState[Index] for PhidgetInterfaceKits.

<div class="source"><syntaxhighlight lang=delphi>

PhidgetInterfaceKit1.OutputState[0] := true;

</syntaxhighlight></div>
===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another PhidgetInterfaceKit ActiveX object to be added to the project.
The new instance can then be set up, opened and used in the same fashion as the previous one.
If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===

The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfacekit, you would place a PhidgetRFID ActiveX object instead of a PhidgetInterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

===Enabling Logging===

Often it’s a good idea to enable logging during development for debugging purposes.
This log, depending on the level set, will record certain events and errors from Phidgets.
In Delphi, this is accomplished by calling EnableLogging(logLevel, filename) on the Phidget object.

<div class="source"><syntaxhighlight lang=delphi>

PhidgetInterfaceKit1.EnableLogging(6, 'testlog.txt');

</syntaxhighlight></div>
Similarly, you can call DisableLogging() at the end of your program to shut it off.
Should you need to contact Phidgets for support, including this log is very helpful for revealing the cause of the problem.
Please see the Programming Manual for a general discussion on Phidget logging and the levels provided.

==Building your Project==
Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Language - Visual Basic Script

2012-04-20T17:40:27Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Visual Basic Script.png|64x64px|alt=|link=]]|Preamble about the language's origin and its main characteristics.}}
==Support==
Visual Basic Script has a complete API for all Phidgets devices, and code samples for Encoder, InterfaceKit and RFID.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==

Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/COM_API_Manual.pdf API Manual]
* [http://www.phidgets.com/downloads/examples/VBScript_2.1.8.20110615.zip VBS Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==

You will need the ClassID List from the VBScript examples above to program with Phidgets, and the Phidget Framework to use them.
The Phidget examples were written using Visual Basic Script for Internet Explorer and this tutorial assumes its use.
To begin, load the HTML editor of your choice and create a new document.
Add a table to body of the code for the purpose of displaying simple output.

<div class="source"><syntaxhighlight lang=html4strict>

<html>
<head>
<body>
<form action=”html_interfacekit.htm”>
<table id=”mytable”>
<thead>
<tr><td>Analog Input</td></tr>
</thead>
<tr id=”tr0”><td>0</td> </tr>
<tr id=”tr1”><td>0</td> </tr>
<tr id=”tr2”><td>0</td> </tr>
<tr id=”tr3”><td>0</td> </tr>
<tr id=”tr4”><td>0</td> </tr>
<tr id=”tr5”><td>0</td> </tr>
<tr id=”tr6”><td>0</td> </tr>
<tr id=”tr7”><td>0</td> </tr>
</table>
</form>
</body>
</html>

</syntaxhighlight></div>

===Coding For Your Phidget===

Before you can use the Phidget, you must include its Class ID on object creation in your code.
This will let the browser know which library to try and load for the Phidget definitions.
Each type of Phidget has its ClassID listed inside the ClassID_List.txt document from the VBScript examples.
For example, we can declare and create a PhidgetInterfaceKit for vbscript with:

<div class="source"><syntaxhighlight lang=html4strict>

<object classid="clsid:50484945-4745-5453-3000-000000000003" id="phid"></object>
<script type="text/vbscript">

</script>

</syntaxhighlight></div>

The object name for any type of Phidget is listed in the API manual.
Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

The program can try to connect to the Phidget through an open call.
Open will continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately.
We can account for a connection by using event driven programming and tracking the AttachEvents and DetachEvents, or by calling WaitForAttachment.
WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.

<div class="source"><syntaxhighlight lang=vb>

phid.Open()
phid.WaitForAttachment (3000)

</syntaxhighlight></div>

The different parameters and open calls can be used to open the first Phidget of a type it can find, open based on a serial number, or even open across the network.
The API manual lists all of the available modes that open provides.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This prevents any other instances from retrieving data from the Phidget, including other programs.
The one connection per device limit does not apply when exclusively using the Phidget Webservice.

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
In VBScript, we hook an event handler with the following code:

<div class="source"><syntaxhighlight lang=vb>

Sub phid_OnSensorChange(ByVal Index, ByVal SensorValue)
mytable.rows("str"+CStr(Index)).cells(0).innerText = Cstr(InterfaceKit1.sensorValue(Index))
End Sub

</syntaxhighlight></div>

With this method, the code inside onSensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.

Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the API manual for a full list of events and their usage.

===Working directly with the Phidget===

Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming.
Simply use the instance properties such as phid.SensorChangeTrigger(Index) for PhidgetInterfaceKits.

<div class="source"><syntaxhighlight lang=vb>

phid.SensorChangeTrigger(0) = 1

</syntaxhighlight></div>

===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another PhidgetInterfaceKit instance to be defined and initialized.
The new instance can then be set up, opened and used in the same process as the previous one.

If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===

The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfaceKit, you would use the class ID for a PhidgetRFID instead of a PhidgetInterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

==Building your Project==

Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==

===Issue: Cannot control Phidgets with certain web browsers===
Affected Operating Systems: '''Windows'''

Certain web browsers such as Firefox and Chrome cannot control Phidgets in Visual Basic Script.

Solution: Only Internet Explorer can control Phidgets with Visual Basic Script.

Language - Visual Basic for Applications

2012-04-20T17:39:18Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:Icon-Visual Basic for Applications.png|64x64px|alt=|link=]]|Preamble about the language's origin and its main characteristics.}}
==Support==
VBA has a complete API for all Phidgets devices, and code samples for Accelerometer, Encoder, InterfaceKit, RFID, TemperatureSensor and Servo.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/COM_API_Manual.pdf API Manual]
* [http://www.phidgets.com/downloads/examples/VBA_2.1.8.20110615.zip VBA Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==

The Phidget examples were written using Microsoft Excel 2000 and this tutorial assumes its use.
Other environments such as Microsoft Office should work provided they support VBA, and each would be set up in a similar manner.

To begin, launch Excel with a new workbook for our project. Launch the VBA editor (Tools | Macro | Visual Basic Editor) and open “ThisWorkbook” in the navigator.

===Coding For Your Phidget===

Before you can use the Phidget, you must include the library in your project.
This can be accomplished from the references screen (Tools | References...) by checking the box beside “Phidget Library 2.1”, or by browsing to the location the framework was installed and choosing the Phidget21COM.dll.

Afterwards, the Phidget object will need to be declared and then initialized inside the workbook item.
For example, we can declare and create a PhidgetInterfaceKit at the top of the code with:

<div class="source"><syntaxhighlight lang=vb>

Public WithEvents phid As PhidgetInterfaceKit
Private Sub Workbook_Open()
Set phid = New PhidgetInterfaceKit
End Sub

</syntaxhighlight></div>

The object name for any type of Phidget is listed in the API manual.
Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

The program can try to connect to the Phidget through an open call.
Open will continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately.
We can account for a connection by using event driven programming and tracking the AttachEvents and DetachEvents, or by calling WaitForAttachment.
WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.

<div class="source"><syntaxhighlight lang=vb>

phid.Open
phid.WaitForAttachment(3000)

</syntaxhighlight></div>

The different parameters and open calls can be used to open the first Phidget of a type it can find, open based on a serial number, or even open across the network.
The API manual lists all of the available modes that open provides.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This prevents any other instances from retrieving data from the Phidget, including other programs.
The one connection per device limit does not apply when exclusively using the Phidget Webservice.

At the end of your program, don’t forget to call close to free any locks on the Phidget.

<div class="source"><syntaxhighlight lang=vb>

Private Sub Workbook_BeforeClose(Cancel As Boolean)
phid.Close
End Sub

</syntaxhighlight></div>

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets. In Visual Basic, we hook an event handler with the following code:

<div class="source"><syntaxhighlight lang=vb>

Private Sub phid_OnSensorChange(ByVal Index As Long, ByVal SensorValue As Long)
Range("A2").Select
ActiveCell.Offset(Index, 0).Value = SensorValue
End Sub

</syntaxhighlight></div>

With this method, the code inside onSensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
You can let the editor generate the procedure declaration for you through the drop down menu at the top of the code window.

Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the API manual for a full list of events and their usage.

===Working directly with the Phidget===

Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming.
Simply use the instance properties such as SensorValue(Index as Long) or OutputState(Index as Long) for PhidgetInterfaceKits.

<div class="source"><syntaxhighlight lang=vb>

phid.OutputState(4) = True

</syntaxhighlight></div>

===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another PhidgetInterfaceKit instance to be defined and initialized.
The new instance can then be set up, opened and used in the same process as the previous one.

If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===

The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfaceKit, you would declare a PhidgetRFID instead of a PhidgetInterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

==Building your Project==
Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Language - REALBasic

2012-04-20T17:38:11Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-REALBasic.png|64x64px|alt=|link=]]|REALBasic is no longer maintained by Phidgets.}}
==Support==
REALBasic has a complete API for all Phidgets devices, but no sample code at this time.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip API Manual]
* [http://www.phidgets.com/documentation/web/cdoc/index.html API Reference]
* We currently do not have any sample code for REALBasic.
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==

Applications using Phidget can be developed in REALbasic through the C API.
This tutorial assumes the use of REALbasic 2009, other recent versions should work as well and would be set up in a similar manner.
Phidgets will not run under REALbasic 2006. Although it’s possible to import Phidgets as ActiveX controls, this is not recommended due to the way REALbasic handles them.
To begin, launch REALbasic and create a new “Desktop Application”.
Then, place an EditField “EditField1” in the form designer for the purpose of capturing some simple output.

===Coding For Your Phidget===

Before you can use the Phidget, you must declare each of the functions from the C library that the program will use.
For example, you can declare at initialization (inside Windows1.Open) some C functions for a PhidgetInterfaceKit with the following syntax:

<div class="source"><syntaxhighlight lang=vb>

Declare Function CPhidget_open lib "phidget21" (phid as Ptr, serialNumber as Integer) as integer
Declare Function CPhidget_waitForAttachment lib "phidget21" (phid as Ptr, milliseconds asInteger) as Integer
Declare Function CPhidgetInterfaceKit_create lib "phidget21" (CPhidgetInterfaceKitHandle as Ptr) as Integer
Declare Function CPhidgetInterfaceKit_set_OnSensorChange_Handler lib "phidget21"(CPhidgetInterfaceKitHandle as Ptr, fptr as Ptr, UserPtr as Ptr) as Integer

</syntaxhighlight></div>

The declaration closely follows the C API with a few minor changes.
Generally, when any type of PhidgetHandle is used, it’s safe to change the type to Ptr.
You will also need to copy the phidget21.dll file from the Phidget Framework directory into your project output directory for these declarations to work.

Afterwards, the Phidget object itself will need to be declared and then initialized.
This can be done by declaring a property on Windows1 named “ifKitHandle” as a Ptr, calling create on an empty block of memory, and then setting the handle to the result.

<div class="source"><syntaxhighlight lang=vb>

Dim tmp As MemoryBlock
Dim result As Integer
tmp = NewMemoryBlock(1000)
Call CPhidgetInterfaceKit_create(tmp)
ifKitHandle = tmp.Ptr(0)

</syntaxhighlight></div>

The object name for any type of Phidget is listed in the API manual.
Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

The program can try to connect to the Phidget through an open call.
Open will continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately.
We can account for a connection by using event driven programming and tracking the AttachEvents and DetachEvents, or by calling WaitForAttachment.
WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.

<div class="source"><syntaxhighlight lang=vb>

result = CPhidget_open(ifKitHandle, -1)
if CPhidget_waitForAttachment(ifKitHandle, 3000)<>0 Then
MsgBox("Can’t find a PhidgetInterfaceKit")
else
'More code goes here
end if

</syntaxhighlight></div>

The different parameters and open calls can be used to open the first Phidget of a type it can find, open based on a serial number, or even open across the network.
The API manual lists all of the available modes that open provides.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This prevents any other instances from retrieving data from the Phidget, including other programs.
The one connection per device limit does not apply when exclusively using the Phidget Webservice.

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
In Real Basic, a few steps will need to be followed to properly hook C events.
Event handler methods with matching definitions must be created inside their own module (Project | Add | Module).

<div class="source"><syntaxhighlight lang=vb>

Function ifKit_OnSensorChange(ByVal phid As Ptr, ByVal userPtr As Ptr, ByVal index
As Integer, ByVal sensorValue As Integer) As Integer
#pragma X86CallingConvention StdCall
Window1.EditField1.text = Str(index) + ":" + Str(sensorValue)
End Function

</syntaxhighlight></div>

In this example, a new module “Module1” was created and given the ifKit_OnSensorChange method.
Note that the handler must have “#pragma X86CallingConvention StdCall” as the first line.
Inside Window1.Open we can then link to the method we wrote with a call to CPhidgetInterfaceKit_set_OnSensorChange_Handler.

<div class="source"><syntaxhighlight lang=vb>

Call CPhidgetInterfaceKit_set_OnSensorChange_Handler(ifKitHandle, AddressOf Module1.ifKit_OnsensorChange, nil)

</syntaxhighlight></div>

With this, the code inside ifKit_onSensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the API manual for a full list of events and their usage.

===Working directly with the Phidget===

Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming.
Simply declare the C function before using calls such as CPhidgetInterfaceKit_getSensorValue for PhidgetInterfaceKits.

<div class="source"><syntaxhighlight lang=vb>

Declare Function CPhidgetInterfaceKit_getSensorValue lib "phidget21" (phid as Ptr, index as Integer, sensorValue as Ptr) as Integerresult = CPhidgetInterfaceKit_getSensorValue(ifKitHandle, 0, tmp)
Dim sensorValue As Integer = tmp.Long(0)
Window1.EditField1.Text = Str(sensorValue)

</syntaxhighlight></div>

===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another instance of a PhidgetInterfaceKit to be defined and initialized.
The new instance can be set up, opened and used in the same process as the previous one.
If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===

The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfaceKit, you would call CPhidgetRFID_create instead of CPhidgetInterfaceKit_create.
The methods and events available would change but they can be used in a similar manner.

==Building your Project==
Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Language - Visual Basic (.NET Compact Framework)

2012-04-20T17:34:44Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Visual Basic Net.png|64x64px|link=|alt=]]|Visual Basic(.NET Compact Framework) is a modern, object-oriented programming language developed by [[http://www.microsoft.com Microsoft]] intended for developing applications for smart devices.}}
__TOC__

==Introduction==

{{LanguageSupport|Visual Basic(.NET Compact Framework)|the complete Phidget API, including events|all Phidget devices.|the .NET Compact Framework. This frameworks is supported on devices with the Windows CE operating system. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]]|}}

==Quick Downloads==
{{QuickDownloads|Visual Basic(.NET Compact Framework)|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip .NET}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip|Phidget Windows CE|(all architectures)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20120216.CAB|Windows CE|Installer(ARMV4I)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20120216.CAB|Windows CE|Installer(x86)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20120216.CAB|Windows CE|Installer(MIPSII)}}
}}
The source code for the Phidget Kernel driver for Windows CE is also provided:
* [http://www.phidgets.com/downloads/libraries/Phidget21CEkernalsource_2.1.8.20120216.zip Kernel Driver Source(all architectures)]

==Getting started with Visual Basic(.NET Compact Framework)==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

To develop applications on Windows CE, you will need a Windows(2000/XP/Vista/7) system in order to perform development on. The drivers can be easily installed onto the Windows CE system by using the installers in the [[#Libraries and Drivers | Libraries and Drivers]] section. You will also need the (.NET Compact Framework Libraries) on your development system to code against.

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
Visual Basic(.NET Compact Framework) programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time.
* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver.
* <b>{{Code|Phidget21CE.NET.dll}}</b> is the .NET(Compact Framework) Phidgets library.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].

If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip files]. Inside the zip file, please use the files that pertain to your architecture. These files should be placed in the {{Code|\Windows}} folder.

===Visual Studio 2005/2008/2010===

=====Use Our Examples=====

We will start by downloading the examples and building an executable for them on the development machine. Visual Studio will be used for development. We will then transfer the executable onto the Windows CE machine to run.

Please start by downloading the [http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip examples] and unpack them into a folder. While these examples were written in Visual Studio 2005 and 2008, Visual Studio 2010 will easily open and upgrade them.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.
[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]

The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} Visual Basic(.NET Compact Framework) example.

Next, build the example project. Right click the {{Code|HelloWorld}} project and select {{Code|Build}} to create an executable.

[[File:VS2008 VBNETCompact Build.PNG|link=|alt=Build]]

Then in Windows Explorer, navigate to the {{Code|project directory\bin\Debug}} folder if you are are targeting a debug configuration. The folder will be {{Code|project directory\bin\Release}} if you are targeting a release configuration. Regardless of whether you are targeting debug or release, you will find an executable named {{Code|HelloWorld.exe}}. Transfer this file onto the Windows CE system.

The only thing left to do is to run the example! Double click on the executable on the Windows CE system to run it.

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices!

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]]. Currently, the only devices we have example code is for the PhidgetInterfaceKit, PhidgetRFID, PhidgetTextLCD. Please ensure that you have set your start up project to be the one that matches your device before compiling.

Once you have the Visual Basic(.NET Compact Framework) examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

On the development computer, when you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget Visual Basic(.NET Compact Framework) libraries. To begin:

1. Generate a new smart device Visual Basic Console Applications project with a descriptive name such as PhidgetTest.

[[File:VS2008 VBNETCompact New Project 1.PNG|link=|alt=New Project]]

[[File:VS2008 VBNETCompact New Project 2.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:VS2008 VBNETCompact Add Reference 1.PNG|link=|alt=Add Reference]]

3. Download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip {{Code|Phidget21CE.NET.dll}}] file. The file is contained in the zip file.

4. Under the .NET tab, select {{Code|Phidget21CE.NET.dll}}.

[[File:VS2008 VBNETCompact Add Reference 2.PNG|link=|alt=Add Reference]]

5. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the Visual Basic(.NET Compact Framework) Phidget functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in Visual Basic|[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

Here, you can find further examples. Coding in Visual Basic(.NET Compact Framework) is very similar to coding in Visual Basic, so you can take a look at our resources on the [[#Language - Visual Basic .NET | section]].

===Example Flow===

{{ExamplePseudocode|In Visual Basic(.NET Compact Framework), you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget .NET library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in Visual Basic(.NET Compact Framework) is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

==Code Snippets==

==Common Problems and Solutions/Workarounds==

==={{ProblemSolution|All Operating Systems|The Phidgets.Events.ErrorEventHandler conflicts with System.IO.ErrorEventHandler.}}===

<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new ErrorEventHandler(spatial_Error);

...
void spatial_Error(object sender, ErrorEventArgs e){
...
}
</syntaxhighlight>
</div>

The above code produces the following errors:

{{Code|'ErrorEventHandler' is an ambiguous reference between 'System.IO.ErrorEventHandler' and 'Phidgets.Events.ErrorEventHandler'}}.

and

{{Code|'ErrorEventArgs' is an ambiguous reference between 'System.IO.ErrorEventArgs' and 'Phidgets.Events.ErrorEventArgs'}}.

The error is due to the {{Code|System.IO}} and {{Code|Phidgets.Events}} namespaces both having a class called {{Code|ErrorEventHandler}}.

To get around this issue, use the fully qualified namespace when referring to the {{Code|ErrorEventHandler}} and {{Code|ErrorEventArgs}} classes:
<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new Phidgets.Events.ErrorEventHandler(spatial_Error);
...

void spatial_Error(object sender, Phidgets.Events.ErrorEventArgs e){
...
}

</syntaxhighlight>
</div>

Language - C Sharp (.NET Compact Framework)

2012-04-20T17:33:38Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-CSharp.png|64x64px|link=|alt=]]|C#(.NET Compact Framework) is a modern, object-oriented programming language developed by [[http://www.microsoft.com Microsoft]] intended for developing applications for smart devices.}}
__TOC__

==Introduction==

{{LanguageSupport|C#(.NET Compact Framework)|the complete Phidget API, including events|all Phidget devices.|the .NET Compact Framework. This frameworks is supported on devices with the Windows CE operating system. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]]|}}

==Quick Downloads==
{{QuickDownloads|C#(.NET Compact Framework)|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip .NET}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip|Phidget Windows CE|(all architectures)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21ARMV4I_2.1.8.20120216.CAB|Windows CE|Installer(ARMV4I)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21x86_2.1.8.20120216.CAB|Windows CE|Installer(x86)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21MIPSII_2.1.8.20120216.CAB|Windows CE|Installer(MIPSII)}}
}}
The source code for the Phidget Kernel driver for Windows CE is also provided:
* [http://www.phidgets.com/downloads/libraries/Phidget21CEkernalsource_2.1.8.20120216.zip Kernel Driver Source(all architectures)]

==Getting started with C#(.NET Compact Framework)==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

To develop applications on Windows CE, you will need a Windows(2000/XP/Vista/7) system in order to perform development on. The drivers can be easily installed onto the Windows CE system by using the installers in the [[#Libraries and Drivers | Libraries and Drivers]] section. You will also need the (.NET Compact Framework Libraries) on your development system to code against.

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
C#(.NET Compact Framework) programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time.
* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver.
* <b>{{Code|Phidget21CE.NET.dll}}</b> is the .NET(Compact Framework) Phidgets library.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].

If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip files]. Inside the zip file, please use the files that pertain to your architecture. These files should be placed in the {{Code|\Windows}} folder.

===Visual Studio 2005/2008/2010===

=====Use Our Examples=====

We will start by downloading the examples and building an executable for them on the development machine. Visual Studio will be used for development. We will then transfer the executable onto the Windows CE machine to run.

Please start by downloading the [http://www.phidgets.com/downloads/examples/CE_2.1.8.20120216.zip examples] and unpack them into a folder. While these examples were written in Visual Studio 2005 and 2008, Visual Studio 2010 will easily open and upgrade them. To load all projects in Visual Studio, go to File → Open → Project, and open {{Code|WindowsCE.NET Examples.sln}} or {{Code|WindowsCE.NET Examples_vs2008.sln}} for Visual Studio 2005 and 2008, respectively.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.
[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]

The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C#(.NET Compact Framework) example.

Start by setting the {{Code|HelloWorld}} project as your start up project.

Next, build the example project. Right click the {{Code|HelloWorld}} project and select {{Code|Build}} to create an executable.

[[File:VS2005 CSharpCompact Build.PNG|link=|alt=Build]]

Then in Windows Explorer, navigate to the {{Code|project directory\bin\Debug}} folder if you are are targeting a debug configuration. The folder will be {{Code|project directory\bin\Release}} if you are targeting a release configuration. Regardless of whether you are targeting debug or release, you will find an executable named {{Code|HelloWorld.exe}}. Transfer this file onto the Windows CE system.

The only thing left to do is to run the example! Double click on the executable on the Windows CE system to run it.

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices!

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]]. Currently, the only devices we have example code is for the PhidgetInterfaceKit, PhidgetRFID, PhidgetTextLCD. Please ensure that you have set your start up project to be the one that matches your device before compiling.

Once you have the C#(.NET Compact Framework) examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

On the development computer, when you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget C#(.NET Compact Framework) libraries. To begin:

1. Generate a new smart device Windows CE C# Console Applications project with a descriptive name such as PhidgetTest.

[[File:VS2005 CSharpCompact New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:VS2005 CSharpCompact Add Reference 1.PNG|link=|alt=Add Reference]]

3. Download the [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip {{Code|Phidget21CE.NET.dll}}] file. The file is contained in the zip file.

4. Under the .NET tab, select {{Code|Phidget21CE.NET.dll}}.

[[File:VS2005 CSharpCompact Add Reference 2.PNG|link=|alt=Add Reference]]

5. Then, in your code, you will need to include the Phidget .NET library:

<div class="source">
<syntaxhighlight lang=csharp>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the C#(.NET Compact Framework) Phidget functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in C#|[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

Here, you can find further examples. Coding in C#(.NET Compact Framework) is very similar to coding in C#, so you can take a look at our resources on the [[#Language - C Sharp | C# section]].

===Example Flow===

{{ExamplePseudocode|In C#(.NET Compact Framework), you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget .NET library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in C#(.NET Compact Framework) is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

==Code Snippets==

==Common Problems and Solutions/Workarounds==

==={{ProblemSolution|All Operating Systems|The Phidgets.Events.ErrorEventHandler conflicts with System.IO.ErrorEventHandler.}}===

<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new ErrorEventHandler(spatial_Error);

...
void spatial_Error(object sender, ErrorEventArgs e){
...
}
</syntaxhighlight>
</div>

The above code produces the following errors:

{{Code|'ErrorEventHandler' is an ambiguous reference between 'System.IO.ErrorEventHandler' and 'Phidgets.Events.ErrorEventHandler'}}.

and

{{Code|'ErrorEventArgs' is an ambiguous reference between 'System.IO.ErrorEventArgs' and 'Phidgets.Events.ErrorEventArgs'}}.

The error is due to the {{Code|System.IO}} and {{Code|Phidgets.Events}} namespaces both having a class called {{Code|ErrorEventHandler}}.

To get around this issue, use the fully qualified namespace when referring to the {{Code|ErrorEventHandler}} and {{Code|ErrorEventArgs}} classes:
<div class="source">
<syntaxhighlight lang=csharp>
using System.IO;
using Phidgets;
using Phidgets.Events;
...
spatial.Error += new Phidgets.Events.ErrorEventHandler(spatial_Error);
...

void spatial_Error(object sender, Phidgets.Events.ErrorEventArgs e){
...
}

</syntaxhighlight>
</div>

Language - Max/MSP

2012-04-20T17:28:21Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-MaxMSP.png|link=|alt=MaxMSP|64x64px]]|Max/MSP, developed by [http://cycling74.com Cycling74] is a visual programming language for creating music and media applications.}}
__TOC__

==Introduction==

{{LanguageSupport|Max/MSP|most of the Phidget API, including events. All the supported functions for Max/MSP will be documented in the {{Code|.help}} files|all Phidget devices.| Windows and OS X|

Only Max/MSP 4.5 or higher is supported.}}

==Quick Downloads==
{{QuickDownloads|Max/MSP|
* [http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip {{Code|.help}} file(Windows - same file as Max/MSP Examples and Libraries)]
* [http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip {{Code|.help}} file(OS X - same file as Max/MSP Examples and Libraries)]|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip|(Windows - same file as Max/MSP Documentation and Libraries)}}
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip|(OS X - same file as Max/MSP Documentation and Libraries)}}|{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip|Max/MSP|(Windows - same file as Max/MSP Documentation and Examples)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip|Max/MSP|(OS X - same file as Max/MSP Documentation and Examples)}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
}}

==Getting started with Max/MSP==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

Instructions are divided up by operating system. Choose:
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#OS X |OS X]]

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
Max/MSP programs on Windows depend on the following files. The installers in the [[#Libraries and Drivers | Quick Downloads]] section put only the {{Code|phidget21.dll}} into your system. You will need to manually put the {{Code|PhidgetXXX.mxe}} onto your system.
* <b><code>phidget21.dll</code></b> contains the actual Phidget library, which is used at run-time. By default, the installer places it in <code>C:\Windows\System32</code>.
* <b><code>PhidgetXXX.mxe</code></b> is the Phidget library for your specific device. XXX denotes the name of your device, Please make sure the <code>.mxe</code> file corresponds with the device you are using. For example, if you are using the PhidgetInterfaceKit, you will need the {{Code|PhidgetInterfaceKit.mxe}}. It is to be placed in the same directory as your Max/MSP application or anywhere in the Max/MSP search path.

If you do not want to use our installer, you can download the {{Code|[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip phidget21.dll]}} and manually install it where you want; refer to our [[OS_-_Windows#Manual_File_Installation|Manual Installation Instructions]].

===Use Our Examples===

Please start by downloading the [http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip Max/MSP Examples and Library] and unpack them into a folder. These examples were written in Max/MSP 4.6, but any version above 4.5 are also supported.

Here, you will find example programs, in {{code | .help}} format for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]].

The only thing left to do is to run the examples! Open the {{code| .help}} file in the Max environment.

Once you have the Max/MSP examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

===Write Your Own Code===

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure the Max/MSP environment to properly link the Phidget Max/MSP libraries. To begin:

Place the {{Code|.mxe}} in the same directory as the patcher, or anywhere in the Max/MSP search path. You can verify the search path locations by navigating to Options → File Preferences.

[[File:MaxMSP Path.PNG|link=|alt=Search Path]]

The best way to start writing your patch is to modify an example, and saving it as a {{Code|.pat}} file.

If you wish to start a new patch. All you need to do is create an object named PhidgetXXX where XXX is the name of your device. For example, the [[Product - 1023 1 - PhidgetRFID | PhidgetRFID device]] will have the {{Code|PhidgetRFID}} object name.
The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

==OS X==

Max/MSP has excellent support on OS X.

The first step in using Max/MSP on Mac is to install the Phidget library. Compile and install them as explained on the [[Device List|getting started guide for your device]]. Then, the [[OS - OS X]] page also describes the different Phidget files, their installed locations, and their roles....

==Follow the Examples==

By following the instructions for your operating system, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

First, let's explain how to operate the example.

[[File:MaxMSP Example.PNG|link=|alt=Example]]

The above screenshot is what shows up when you open the example for the PhidgetInterfaceKit. If you are using a different device, your example patch will be different, but the idea is the same.

For this particular example, the Max object is called {{Code|PhidgetInterfaceKit}}, which is located in the center of the screen. Objects/message boxes are connected to the inputs and outputs of the PhidgetInterfaceKit object. The input objects will either cause a property of the device to change or request for a property to be retrieved. The output objects return the retrieved information. All the supported features of the device are shown in the {{Code|.help}} file.

Try it for yourself! Click on the {{Code | getSerial}} message box to request the Phidget to retrieve the serial number of the device. You should see the last output object of {{Code|route}} changed to the serial number of your device. All devices support the {{Code|getSerial}} object, and is the easiest way to determine if the Phidget libraries are correctly set up, and whether the Max/MSP application is connected to your device.

[[File:MaxMSP getSerial.PNG|link=|alt=getSerial]]

If your example contains the {{Code|read}} message box, click on it. This will return device specific values to the screen.

[[File:MaxMSP read.PNG|link=|alt=Read Data]]

If your example contains the {{Code|start}} message box, you can continuously poll for events. Set the sample rate input for the {{Code|setSampleRate}} object. Then, press the {{Code|start}} message box to start sampling. When a noteworthy event occurs on a Phidget(i.e., when an analog sensor senses a change in the environment), the value will be displayed onto the screen. Press the {{Code|stop}} message box to stop sampling.

For the PhidgetInterfaceKit example, there also a {{Code|setoutput}} message box. Clicking on the check boxes will cause the digital outputs of the PhidgetInterfaceKit device to change. Your example may contain device specific message boxes/objects to click on. See for yourself what they do!

For information regarding calls specific to your device, please see the [[Device List | API for your specific device]]. Please note that some device functionality are not supported in Max/MSP; the {{Code|.help}} example shows the complete list of functionality supported under Max/MSP.

==Code Snippets==

openRemote object

multiple phidgets

==Common Problems and Solutions/Workarounds==

{{ProblemSolution|Crash|When a patch file is closed in the Max/MSP environment, the program crashes}}

If in your Max/MSP environment, you have more patches(of the same Phidget object) than you have of the actual hardware device, the Max/MSP environment may crash. This is due to the fact that a single Phidget Max/MSP object <i>only</i> corresponds to a single Phidget device hardware. For example, your Max/MSP environment may experience unexpected behavior while you have one PhidgetInterfaceKit device connected to the computer, but you have a two seperate patches opened with a single PhidgetInterfaceKit Max object in each one.

Likely Fix: Please ensure that you do not use more patches(of the same Phidget object) than you have of the actual Phidget device.

Language - LiveCode

2012-04-20T17:27:36Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-LiveCode.png|link=|alt=LiveCode|64x64px]]|LiveCode is a high level programming language, developed by [[http://www.runrev.com RunRev]] that draws on English-like syntax for rapid application development.}}
__TOC__

==Introduction==

{{LanguageSupport|LiveCode|only the PhidgetInterfaceKit API, including events|the PhidgetInterfaceKit.|Windows and OS X |

If you wish to use other devices with LiveCode, we have a [[#Extending LiveCode to other Phidgets | guide ]] providing instructions to do so.}}

==Quick Downloads==
{{QuickDownloads|LiveCode|
{{APIQuickDownloads|http://www.phidgets.com/documentation/LiveCode_API_Manual.pdf}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/LiveCode_2.1.8.20111220.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/LiveCodeRequiredWin_2.1.8.20111220.zip|LiveCode Library|(Windows)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/LiveCodeRequiredMac_2.1.8.20111220.zip|LiveCode Library|(OS X)}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
}}

==Getting started with LiveCode==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

Instructions are divided up by operating system. Choose:
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#OS X |OS X]]

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
LiveCode on Windows depend on three files. The installers in the [[#Libraries and Drivers | Quick Downloads]] section put only the {{Code|phidget21.dll}} into your system. You will need to manually put the remaining two files into your system
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. By default, it is placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|phidgets_livecode.dll}}</b> is the Phidget library for LiveCode. It should be placed in the LiveCode User Extensions folder. More information on its usage will be provided in the [[#Use Our Examples | Use Our Examples]] section.
* <b>{{Code|Externals.txt}}</b> lets LiveCode know the name of the Phidget LiveCode library as well as the name of its corresponding {{Code|phidgets_livecode.dll}}. More information on its usage will be provided in the [[#Use Our Examples | Use Our Examples]] section.

If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip {{Code|phidget21.dll}}] and manually install it where you want; refer to our [[OS_-_Windows#Manual_File_Installation|Manual Installation Instructions]].

===Use Our Examples===

Currently, the only device we support and have examples for is the PhidgetInterfaceKit. In particular, the examples were written with the [[Product - 1018 2 - PhidgetInterfaceKit 8/8/8 | PhidgetInterfaceKit 8/8/8]] in mind. If you have a different PhidgetInterfaceKit, you will need to modify the example to meet the number of digital inputs, digital outputs, and analog inputs that your device support.

To run the examples,

1. Download the [http://www.phidgets.com/downloads/libraries/LiveCodeRequiredWin_2.1.8.20120131.zip Phidget LiveCode library] and extract it into a folder. Here, you will find two files inside the {{Code|Windows}} folder: {{Code|phidgets_livecode.dll}} and {{Code|Externals.txt}}.

2. Open up the LiveCode environment.

3. Go to Edit → Preferences.

[[File:LiveCode Preferences.PNG|link=|alt=Preferences]]

4. In the Files & Memory tab, locate the {{Code|User Extensions}} field. This is the path where the Phidget LiveCode library need to be placed.

[[File:LiveCode User Extensions 1.PNG|link=|alt=User Extensions Folder]]

5. Traverse to the User Extensions folder in Windows Explorer. Create a folder named {{Code|Externals}} if it does not already exist. Place {{Code|phidgets_livecode.dll}} and {{Code|Externals.txt}} inside the {{Code|Externals}} folder.

[[File:LiveCode User Extensions 2.PNG|link=|alt=User Extensions Folder]]

6. Download the [http://www.phidgets.com/downloads/examples/LiveCode_2.1.8.20120131.zip examples] and unpack them into a folder. Navigate to the {{Code|LiveCode/InterfaceKit Example}} folder, and open {{Code|InterfaceKit-full.rev}} in LiveCode. These examples were written in LiveCode 4.5, but will also work with other versions.

7. The example will be running in {{Code|Pointer Tool}} mode.

[[File:LiveCode Pointer Tool.PNG|link=|alt=Example in pointer mode]] ?

8. Switch to the {{Code|Browser Tool}} if you want to control GUI elements such as buttons, and scroll bars.

[[File:LiveCode Browse Tool.PNG|link=|alt=Example in browse mode]]

9. Once you have the LiveCode example running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

===Write Your Own Code===

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidgets LiveCode library. To begin:

1. Ensure that the {{Code| phidgets_livecode.dll}} and {{Code| Externals.txt}} are inside the User Extensions folder, as described in the [[#Use Our Examples | Use Our Examples]] section.

2. Generate a new Mainstack.

[[File:LiveCode New MainStack.PNG|link=|alt=New MainStack]]

3. Open up the Application Browser.

[[File:LiveCode Application Browser 1.PNG|link=|alt=Application Browser]]

4. Edit the script of the mainstack, {{Code|Untitled 1}}.

[[File:LiveCode Application Browser 2.PNG|link=|alt=Application Browser]]

5. You will need to tell LiveCode to reference the Phidget LiveCode library. Copy the following into the script of the mainstack:

<div class="source"><syntaxhighlight lang=applescript>
on preOpenStack
if the short name of the owner of the target is the short name of me and \
"phidgets_livecodeExternalWrapper" is not among the lines of the stacksInUse then
set the visible of the templateStack to false
set the name of the templateStack to "phidgets_livecodeExternalWrapper"
set the externals of the templateStack to $EXTERNAL_LIBRARY
create stack
start using stack "phidgets_livecodeExternalWrapper"
end if
end preOpenStack
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

====Creating Standalone Applications====
When you are finished coding, and want to create an executable, you will have to inform LiveCode to package the Phidget LiveCode library along with the executable.

* Place the {{Code|phidgets_livecode.dll}} and {{Code|Externals.txt}} inside the {{Code|Runtime}} folder of your LiveCode User Extensions.

[[File:LiveCode User Extensions 3.PNG|link=|alt=User Extensions Folder]]

* Notice that the files are placed in a hierarchical structure of folders. Please see [http://www.runrev.com RunRev] for more details regarding setting up this hierarchical structure for the {{Code|Runtime}} folder.

* Click on File → Standalone Application Settings.

[[File:LiveCode Standalone Application Settings 1.PNG|link=|alt=Standalone Application Settings]]

* In the {{Code|Script Libraries}} scroll box, please select {{Code|phidgets_livecode}}

[[File:LiveCode Standalone Application Settings 2.PNG|link=|alt=Standalone Application Settings]]

* Then, navigate to the directory of the application you created. Here, you will see a folder named {{Code|Externals}}. Place {{Code|phidgets_livecode.dll}} in this directory.

Now, the application can be used to control Phidgets.

==OS X==

LiveCode has excellent support on OS X.

The first step in using LiveCode on Mac is to install the Phidget libraries. Compile and install them as explained on the [[Device List|getting started guide for your device]]. Then, the [[OS - OS X]] page also describes the different Phidget files, their installed locations, and their roles....

===Libraries===
*[http://www.phidgets.com/downloads/libraries/LiveCodeRequiredMac_2.1.8.20111220.zip Phidget LiveCode Library]

===Description===
LiveCode on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code| libphidget21.so}}</b> contains the actual Phidget library, which is used at run-time. If you used our installer, it's already placed in {{Code|C:\Windows\System32}}. It can be manually installed - check our [[Manual Installation instructions]].
* <b>{{Code|phidgets_livecode.bundle}}</b> is the Phidget library for LiveCode. It should be placed in the LiveCode User Extensions folder. More information will be provided in the [[#Use Our Examples 2 | Use Our Examples]] section.
* <b>{{Code|Externals.txt}}</b> lets LiveCode know the name of the Phidget LiveCode library as well as the name of its corresponding {{Code|phidgets_livecode.dll}}. More information will be provided in the [[#Use Our Examples 2 | Use Our Examples]] section.

===Use Our Examples===

===Write Your Own Code===
====Creating Standalone Applications====

==Follow the Examples==

By following the instructions for your operating system above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the LiveCode Phidget methods:

{{UsingAPhidgetInCodeGeneral|both of which are available in LiveCode|[http://www.phidgets.com/documentation/LiveCode_API_Manual.pdf LiveCode API]}}

===Example Flow===

{{ExamplePseudocode|In LiveCode, you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
|
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/LiveCode_API_Manual.pdf LiveCode API]}}

==Code Snippets==

==Extending LiveCode to other Phidgets==

The Phidgets LiveCode library was developed from a C++ external wrapper and allows the PhidgetInterfaceKit to be programmable in LiveCode. It is possible to extend this external to other Phidgets as well. The goal of this section is to equip the reader with knowledge so that they can understand the relationship between LiveCode and the Phidgets framework. It is intended to provide guidance for readers who wish to extend LiveCode to other Phidgets. This guide uses C++, Microsoft Visual Studio 2005(for Windows XP SP3), XCode 3.2.4(for OS X 10.6.4), LiveCode 4.5 IDE and it is assumed that the reader has a solid understanding of these technologies. It will also help if you are familiar with programming with Phidgets in [[Language - C/C++ | C/C++]]. For your reference, the Visual Studio and XCode project solutions for the Phidget LiveCode library are provided in the [http://www.phidgets.com/downloads/examples/LiveCode_2.1.8.20111220.zip LiveCode examples]

The first step is to download LiveCode Externals Creator SDK from [http://www.runrev.com RunRev]. Run the SDK, select C++ as the language, enter the project name, select the platform and specify the LiveCode installation path. Hit generate to create a skeleton project for the external.

The next step is to setup the environment to allow for access to the Phidget function call.

In Visual Studio, you will need the latest Phidget Windows library and header - these are installed into {{Code|C:\Program Files\Phidgets}} by default if you ran the Phidgets installer. Place the {{Code|phidget21.lib}} and {{Code|phidget21.h}} in the Visual Studio project directory. Be sure to open the properties window, navigate to Configuration Properties → Linker → Input and add {{Code|phidget21.lib}} to the additional dependencies section. Also, include a reference to the library header in the source code.

In XCode, open the newly created {{Code|.xcodeproj}} project into XCode. Add the Phidget framework to the project and include the a reference to the library header in the source code.

Now, we are ready to create external functions. LiveCode will have to acknowledge the existence of any external function. Function declarations are placed inside the {{Code|USER DECLARATIONS}} section of the the code. Here, a call to the function {{Code|phidgetsInterfaceKit_create}} in LiveCode will be mapped to a call to the C++ function,{{Code|phidgetsInterfaceKit_create}}:

<div class="source">

<source lang=cpp>
EXTERNAL_DECLARE_FUNCTION("phidgetsInterfaceKit_create", phidgetsInterfaceKit_create)

</source>

</div>

For example, LiveCode will use the following lines of code to call the external function {{Code|phidgetsInterfaceKit_create}}.
<div class="source">

<source lang=applescript>
local ifKit
get phidgetsInterfaceKit_create("ifKit") --"ifKit" is the name of the variable phid

</source>

</div>

The result of {{Code|get phidgetsInterfaceKit_create("ifKit")}} will be 0 or the error code depending on whether the external function succeeded or failed, respectively.

Now, we implement the {{Code|phidgetsInterfaceKit_create}} C++ function.
<div class="source">

<source lang=cpp>

void phidgetsInterfaceKit_create(char *p_arguments[], int p_argument_count, char **r_result, Bool *r_pass, Bool *r_err)
{
char outcome_str[8];
CPhidgetInterfaceKitHandle ifKit = (CPhidgetInterfaceKitHandle) strtoul(p_arguments[0], NULL, 16);
int outcome=CPhidgetInterfaceKit_create(&ifKit);
if(outcome==0){
char str[90];
int t_success;
// Converts to Hexadecimal format
sprintf(str,"%08x",ifKit);
// Passes back to LiveCode a reference of the InterfaceKit handle
SetVariable(p_arguments[0], str, &t_success);
}
sprintf(outcome_str, "%d", outcome);
*r_result = strdup(outcome_str);
*r_err = False;
*r_pass = False;
return;
}

</source>

</div>

As you can see, this function follows the same format as a typical external function. {{Code|p_arguments[]}} stores the arguments that are passed from the LiveCode function. First, we allocate memory to store a {{Code|CPhidgetInterfaceKitHandle}} and store its address in {{Code|ifKit}}. Next, we call the C function {{Code|CPhidgetInterfaceKit_create}}, create the {{Code|PhidgetInterfaceKit}} handle and return the error code to outcome. If outcome is 0, the address of {{Code|ifKit}} is converted into hexadecimal form. The hexadecimal form is then stored in the LiveCode variable {{Code|ifKit}}, so that LiveCode has a reference to the newly created InterfaceKit handle. Lastly, the result of this external function is stored in {{Code|*r_result}}, which is passed back as the return value for the LiveCode function.

It is also possible to implement Phidgets events with LiveCode. We will implement the {{Code|phidgetsInterfaceKit_set_OnSensorChange_Handler}} function. Again, we declare the existence of the function.
<div class="source">

<source lang=cpp>

EXTERNAL_DECLARE_FUNCTION("phidgetsInterfaceKit_set_OnSensorChange_Handler", phidgetsInterfaceKit_set_OnSensorChange_Handler)

</source>

</div>

In LiveCode, we use the following code to call the external function.
<div class="source">

<source lang=applescript>
get phidgetsInterfaceKit_set_OnSensorChange_Handler(ifKit, "sensorChange")

</source>

</div>

and {{Code|sensorChange}} is the name of the LiveCode command to be called whenever a digital input changes. This command must be in the script of the card that called {{Code|phidgetsInterfaceKit_set_OnSensorChange_Handler}} or its stack. The form of the command is as follow:

<div class="source">

<source lang=applescript>
command sensorChange phid pIndex pValue
...
end sensorChange

</source>

</div>

Now, we implement the {{Code|phidgetsInterfaceKit_set_OnSensorChange_Handler}} C++ function

<div class="source">

<source lang=cpp>

void phidgetsInterfaceKit_set_OnSensorChange_Handler(char *p_arguments[], int p_argument_count, char **r_result, Bool *r_pass, Bool *r_err)
{
CPhidgetInterfaceKitHandle ifKit = (CPhidgetInterfaceKitHandle)strtoul(p_arguments[0], NULL, 16);
char* str=(char *)malloc(90);
str=strdup(p_arguments[1]);
int outcome=CPhidgetInterfaceKit_set_OnSensorChange_Handler((CPhidgetInterfaceKitHandle)ifKit, &SensorChangeHandler, str);
returnOutcome(outcome, r_result, r_pass, r_err);
}
</source>

</div>

and the callback function

<div class="source">

<source lang=cpp>

int __stdcall SensorChangeHandler(CPhidgetInterfaceKitHandle ifKit, void *usrptr, int Index, int Value)
{
int t_success;
char * scmMsg;
scmMsg=NULL;
scmMsg = (char *)malloc(512);
sprintf(scmMsg, "send \"%s %08x, %d, %d\" to current card", (char *)usrptr, ifKit, Index, Value);
SendCardMessage(scmMsg, &t_success);
if (scmMsg != NULL)
free(scmMsg);
return 0
}

</source>

</div>

<b>Note:</b> For OS X, {{Code|__stdcall}} is not needed.

Here, we use {{Code|SendCardMessage}} to run the LiveCode command {{Code|sensorChange}}. The message will be passed to the card that called {{Code|phidgetsInterfaceKit_set_OnSensorChange_Handler}} before passing through the stack in the message hierarchy. Other Phidgets and functions can be extended in a similar manner. The [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Manual] contains calls and events for every type of Phidget.

==Common Problems and Solutions/Workarounds==

Here you can put various frequent problems and our recommended solutions.

Language - Flex AS3

2012-04-20T17:26:44Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Flex_AS3.png|64x64px|link=|alt=]]|Flex AS3 is no longer maintained by Phidgets.}}

==Assessment for use with Phidgets==
Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.

==Support==
Flex AS3 has a complete API and code samples for all Phidgets devices.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

==Restrictions==
In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/Phidget21Flash_doc.zip API Manual]
* [http://www.phidgets.com/documentation/web/flashdoc/index.html API Reference]
* [http://www.phidgets.com/downloads/examples/Flex_2.1.8.20110615.zip Flex AS3 Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General Phidget Programming]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==

The Phidget examples were written using Actionscript 3.0 under Adobe Flex Builder 3 and this tutorial assumes its use.
Other development environments should work provided they support Actionscript 3.0, and each would be set up in a similar manner.
First launch Flex and generate a new project with a descriptive name such as PhidgetTest.
You will then need to add the Phidget Library to your project library path.
This can be done under Project | Properties | Flex Build Path on the Library tab, by clicking the “Add SWC” button and selecting the Phidget21Library.swc from the Flex examples.
As an alternative, you can copy the “com” folder that is located in the Flash AS3 examples into your project source directory and it should work as well.

===Coding For Your Phidget===

Before you can use the Phidget, you must import references from the library to the device in the main body of code. In MXML and Actionscript 3.0:

<div class="source"><syntaxhighlight lang=actionscript>

<?xml version="1.0" encoding="utf-8"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" layout="absolute">
<mx:Script>
<![CDATA[
import com.phidgets.PhidgetInterfaceKit;
import com.phidgets.events.*;
//More code goes here
]]>
</mx:Script>
</mx:Application>

</syntaxhighlight></div>

Afterwards, the Phidget object will need to be declared and then initialized.
For example, a start function is set to execute on initialization, and then an instance of a PhidgetInterfaceKit is declared and then set inside with:

<div class="source"><syntaxhighlight lang=actionscript>

public var phid:com.phidgets.PhidgetInterfaceKit;
public function start():void{
phid = new PhidgetInterfaceKit();
//More code goes here
}

</syntaxhighlight></div>

The object name for any type of Phidget is listed in the API manual. Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

Next, the program needs to try and connect to the Phidget through an open call.
Open will continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately.
We can handle this by using event driven programming and tracking the AttachEvents and DetachEvents, or checking the isAttached property.

<div class="source"><syntaxhighlight lang=actionscript>

phid.open("localhost", 5001);

</syntaxhighlight></div>

The API manual lists all of the available modes that open provides.
In Flash, the parameters can be used to open the first Phidget of a type it can find or based on its serial number.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This means other programs that open the Phidget may end up preventing other instances from retrieving data.
The one connection per device limit does not apply when exclusively using the Phidget WebService, and the Actionscript libraries by extension.

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
In Actionscript 3.0, we hook an event handler with the following code:

<div class="source"><syntaxhighlight lang=actionscript>

phid.addEventListener(PhidgetDataEvent.SENSOR_CHANGE, onSensorChange);

</syntaxhighlight></div>

The onSensorChange method will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
The values from the report can be accessed from the PhidgetDataEvent object.

<div class="source"><syntaxhighlight lang=actionscript>

private function onSensorChange(evt:PhidgetDataEvent):void{
//Insert your code here
}

</syntaxhighlight></div>

Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the API manual for a full list of events and their usage.

===Working directly with the Phidget===

Some values can be directly read and set on the Phidget and used as an alternative to event driven programming.
Simply use the instance properties or call member functions such as getSensorValue(index: int) or setOutputState(index: int, val: Boolean) for PhidgetInterfaceKits.

===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another PhidgetInterfaceKit instance to be defined and initialized.
The new instance can then be set up, opened and used in the same process as the previous one.
If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Flash Security Settings===

During debugging or after publishing the project, you may encounter some difficulties with Flash network security settings either inside or outside of the development environment with Phidgets.
Permissions for your project folder can be added through the settings manager at [http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04a.html here], under “Always trust files in these locations” | “Edit locations...” | “Add location...”.

===Other Phidgets===

The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfacekit, you would declare a RFID object instead of a InterfaceKit object.
The methods and events available would change but they can be accessed in a similar manner.

==Building your Project==
Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Language - Flash AS3

2012-04-20T17:23:35Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Flash AS3.png|64x64px|link=|alt=]]|Flash, developed by [http://www.adobe.com Adobe Systems] is used to build and deploy dynamic multimedia applications to the Internet.}}
__TOC__

==Introduction==

{{LanguageSupport|Flash ActionScript|Phidgets <i>only</i> over the Phidget WebService, and it is unlike the majority of the other programming languages we support where the device can be used without the Phidget WebService. The complete Phidget API, including events are supported|all Phidget devices.|[[#Windows | Windows]] and [[#OS X | OS X]]|

Only ActionScript 3 is supported. Interaction with Phidgets is made possible as the library uses web sockets to communicate with Phidgets over the PhidgetWebService.}}

==Quick Downloads==
{{QuickDownloads|Flash ActionScript|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21Flash_doc.zip ActionScript 3}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/Flash_2.1.8.20120131.zip| (same file as ActionScript Libraries below)}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/examples/Flash_2.1.8.20120131.zip|ActionScript| (same file as Examples above)}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
}}

==Getting started with Flash ActionScript==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

Instructions are divided up by operating system. Choose:
*[[#Windows (2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#OS X |OS X]]
*[[#Linux | Linux]] (including PhidgetSBC)

==Windows (2000/XP/Vista/7)==

===Description of Library===
Flash ActionScript on Windows depend on the following files and folders. The installers in the [[#Libraries and Drivers | Quick Downloads]] section put only the {{Code|phidget21.dll}} and {{Code|PhidgetWebservice21.exe}} into your system. You will need to manually put the {{Code|com}} folder into your system.
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. This needs to be installed on the computer that the Phidget is connected. By default, it is placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|PhidgetWebservice21.exe}}</b> allows for controlling Phidgets remotely across the network. This needs to be installed on the computer that the Phidget is connected.
* <b>{{Code|com}}</b> folder is the Phidget ActionScript library. The computer that is used for Flash development will need this folder. It is to be manually placed in the same directory as your project root.

Unlike the majority of the [[Software_Overview#Language_Support |programming languages]] we support (where applications can directly connect to the Phidgets), Flash can only connect to the Phidgets over the PhidgetWebService. There are potentially three roles that a computer can act as: host, developer, and an end user. It is possible for a single computer to act as more than one of these roles at the same time:

* <b>Host</b>: The computer that the Phidget is attached to, and can broadcast device information to any computer over the network. The {{Code|phidget21.dll}} and {{Code|PhidgetWebservice21.exe}} must be installed on the host. The host must also have the PhidgetWebService started in order for it and other computers to connect to the Phidgets attached to the host.
* <b>Developer</b>: The computer that is used to develop Flash applications. This computer needs the {{Code|com}} folder in the root directory of your project. The {{Code|phidget21.dll}} and {{Code|PhidgetWebservice21.exe}} are only needed if the Phidget is directly attached to the computer.
* <b>End user</b>: The computer that is used to run the compiled flash application (i.e., {{Code|.swf}}).The {{Code|phidget21.dll}} and {{Code|PhidgetWebservice21.exe}} are only needed if the Phidget is directly connected to the computer. If the computer is used for developing Flash applications, then it will need the {{Code|com}} folder in the root directory of your project.

Here is a table summarizing what files/folders are needed for each computer role:

{| style="border:1px solid darkgray;" cellpadding="7px;"
|-style="background: #f0f0f0" align=center
! Computer Role
! {{Code|phidget21.dll}}
! {{Code|Phidget21WebService.dll}}
! {{Code|com}} folder
|-

|Host
|style="background: #5EC155" align=center|[[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center|[[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center|
|-

|Developer
|style="background: #5EC155" align=center|
|style="background: #5EC155" align=center|
|style="background: #5EC155" align=center|[[Image:Checkmark.png|link=]]
|-

|End User
|style="background: #5EC155" align=center|
|style="background: #5EC155" align=center|
|style="background: #5EC155" align=center|
|-

|}

Please see the [[Phidget WebService | Phidget WebService]] section for more information.

If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip {{Code|phidget21.dll}}] and manually install them where you want; refer to our [[OS_-_Windows#Manual_File_Installation | Manual Installation Instructions]].

===Flash Professional===

====Use Our Examples====

This section will assume that the device is plugged into the host computer, and that the development computer has Flash Professional installed.

As the Flash ActionScript library only supports communication with Phidgets through the PhidgetWebService, begin by [[starting the PhidgetWebService]] on the host computer with the default port (5001).

To run the examples on a development computer, download the [http://www.phidgets.com/downloads/examples/Flash_2.1.8.20120131.zip examples] and unpack them into a folder. Here, you will find example programs for all devices. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]].

When you have found your example, open that {{Code|.fla}} file in the Adobe Professional Flash environment. The only thing left to do is to run the examples! Click on Control → Test Movie.

[[File:Flash Test Movie.png|link=|alt=Run]]

Once you have the Flash ActionScript examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

You may also run the examples by navigating to Control → Test Scene. If you are running the examples with Debug → Debug Movie, you will have to change the Flash Global Security Settings in order for the example to run. More information will be provided about the Flash Global Security Settings in the [[#Running Compiled Code | Running Compiled Code]] section.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget ActionScript library. To begin:

1. Place a copy of the [http://www.phidgets.com/downloads/examples/Flash_2.1.8.20120131.zip {{Code|com}}] folder in the root directory of your Flash project.

2. Generate a new ActionScript 3 Flash file.

[[File:Flash New Project.png|link=|alt=New Project]]

3. Then, in your code, you will need to include the Phidget ActionScript library. Navigate to Window → Actions to bring up the Actions window and enter in the following:

<div class="source">
<syntaxhighlight lang=actionscript>
import com.phidgets.*;
import com.phidgets.events.*;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

=====Running Compiled Code=====

Running a compiled {{Code|.swf}} application on an end user computer will prompt the Flash player to display a dialog box mentioning that the application will block all communications with the Internet.

[[File:Flash Player Security Warning.png|link=|alt=Flash Player Security Warning]]

1. Click on the {{Code|Settings}} button to bring up the Flash Global Security Settings Manager in your default web browser. Alternatively, you can access the manager with the following URL: [http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04a.html http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04a.html].

[[File:Flash Global Security Settings 1.png|link=|alt=Flash Global Security Settings]]

2. In the Global Security Settings tab, navigate to {{Code|Edit locations ...}} → {{Code|Add locations}}.

[[File:Flash Global Security Settings 2.png|link=|alt=Browse for File/Folder]]

3. Then, browse and add the application or the folder containing the application.

[[File:Flash Global Security Settings 3.png|link=|alt=Added file to the trusted locations]]

This will allow the Flash Player to allow the application to accept any communication with the Internet.

==OS X==

Flash ActionScript has excellent support on OS X over the PhidgetWebService.

The first step in using Flash ActionScript on Mac is to install...

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This [[#Follow the Examples|teaching]] section has resources for you to learn from the examples and write your own.

Next comes our ActionScript API information, with syntax for all of our functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in C/C++|[http://www.phidgets.com/documentation/Phidget21Flash_doc.zip ActionScript API]}}

===Example Flow===

{{ExamplePseudocode|In flash ActionScript, you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler ()''' and '''DetachHandler ()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize ()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in Flash ActionScript is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|PhidgetSpatial}} object. The examples show how to do this and other API functions.<br><br>
}}

==Code Snippets==
a single Phidget to be opened by multiple applications - something that cannot be done with the regular interface

==Common Problems and Solutions/Workarounds==

Problem: My compiled application is experiencing the following security error upon launching: "SecurityError: Error #2010: Local-with-filesystem SWF files are not permitted to use sockets".

[[File:Socket Runtime Error.png|link=|alt=Socket Error]]

Solution: The symptom of this problem is similar to the one that is discussed in steps 1 - 3 of the [[#Running Compiled Code | Running Compiled Code]] section. Please see that section for a remedy. To access the Flash Global Security Settings Manager, go to [http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04a.html http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04a.html].

Language - Flash AS3

2012-04-20T17:23:18Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Flash AS3.png|64x64px||link=|alt=]]|Flash, developed by [http://www.adobe.com Adobe Systems] is used to build and deploy dynamic multimedia applications to the Internet.}}
__TOC__

==Introduction==

{{LanguageSupport|Flash ActionScript|Phidgets <i>only</i> over the Phidget WebService, and it is unlike the majority of the other programming languages we support where the device can be used without the Phidget WebService. The complete Phidget API, including events are supported|all Phidget devices.|[[#Windows | Windows]] and [[#OS X | OS X]]|

Only ActionScript 3 is supported. Interaction with Phidgets is made possible as the library uses web sockets to communicate with Phidgets over the PhidgetWebService.}}

==Quick Downloads==
{{QuickDownloads|Flash ActionScript|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21Flash_doc.zip ActionScript 3}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/Flash_2.1.8.20120131.zip| (same file as ActionScript Libraries below)}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/examples/Flash_2.1.8.20120131.zip|ActionScript| (same file as Examples above)}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
}}

==Getting started with Flash ActionScript==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

Instructions are divided up by operating system. Choose:
*[[#Windows (2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#OS X |OS X]]
*[[#Linux | Linux]] (including PhidgetSBC)

==Windows (2000/XP/Vista/7)==

===Description of Library===
Flash ActionScript on Windows depend on the following files and folders. The installers in the [[#Libraries and Drivers | Quick Downloads]] section put only the {{Code|phidget21.dll}} and {{Code|PhidgetWebservice21.exe}} into your system. You will need to manually put the {{Code|com}} folder into your system.
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. This needs to be installed on the computer that the Phidget is connected. By default, it is placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|PhidgetWebservice21.exe}}</b> allows for controlling Phidgets remotely across the network. This needs to be installed on the computer that the Phidget is connected.
* <b>{{Code|com}}</b> folder is the Phidget ActionScript library. The computer that is used for Flash development will need this folder. It is to be manually placed in the same directory as your project root.

Unlike the majority of the [[Software_Overview#Language_Support |programming languages]] we support (where applications can directly connect to the Phidgets), Flash can only connect to the Phidgets over the PhidgetWebService. There are potentially three roles that a computer can act as: host, developer, and an end user. It is possible for a single computer to act as more than one of these roles at the same time:

* <b>Host</b>: The computer that the Phidget is attached to, and can broadcast device information to any computer over the network. The {{Code|phidget21.dll}} and {{Code|PhidgetWebservice21.exe}} must be installed on the host. The host must also have the PhidgetWebService started in order for it and other computers to connect to the Phidgets attached to the host.
* <b>Developer</b>: The computer that is used to develop Flash applications. This computer needs the {{Code|com}} folder in the root directory of your project. The {{Code|phidget21.dll}} and {{Code|PhidgetWebservice21.exe}} are only needed if the Phidget is directly attached to the computer.
* <b>End user</b>: The computer that is used to run the compiled flash application (i.e., {{Code|.swf}}).The {{Code|phidget21.dll}} and {{Code|PhidgetWebservice21.exe}} are only needed if the Phidget is directly connected to the computer. If the computer is used for developing Flash applications, then it will need the {{Code|com}} folder in the root directory of your project.

Here is a table summarizing what files/folders are needed for each computer role:

{| style="border:1px solid darkgray;" cellpadding="7px;"
|-style="background: #f0f0f0" align=center
! Computer Role
! {{Code|phidget21.dll}}
! {{Code|Phidget21WebService.dll}}
! {{Code|com}} folder
|-

|Host
|style="background: #5EC155" align=center|[[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center|[[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center|
|-

|Developer
|style="background: #5EC155" align=center|
|style="background: #5EC155" align=center|
|style="background: #5EC155" align=center|[[Image:Checkmark.png|link=]]
|-

|End User
|style="background: #5EC155" align=center|
|style="background: #5EC155" align=center|
|style="background: #5EC155" align=center|
|-

|}

Please see the [[Phidget WebService | Phidget WebService]] section for more information.

If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip {{Code|phidget21.dll}}] and manually install them where you want; refer to our [[OS_-_Windows#Manual_File_Installation | Manual Installation Instructions]].

===Flash Professional===

====Use Our Examples====

This section will assume that the device is plugged into the host computer, and that the development computer has Flash Professional installed.

As the Flash ActionScript library only supports communication with Phidgets through the PhidgetWebService, begin by [[starting the PhidgetWebService]] on the host computer with the default port (5001).

To run the examples on a development computer, download the [http://www.phidgets.com/downloads/examples/Flash_2.1.8.20120131.zip examples] and unpack them into a folder. Here, you will find example programs for all devices. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]].

When you have found your example, open that {{Code|.fla}} file in the Adobe Professional Flash environment. The only thing left to do is to run the examples! Click on Control → Test Movie.

[[File:Flash Test Movie.png|link=|alt=Run]]

Once you have the Flash ActionScript examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

You may also run the examples by navigating to Control → Test Scene. If you are running the examples with Debug → Debug Movie, you will have to change the Flash Global Security Settings in order for the example to run. More information will be provided about the Flash Global Security Settings in the [[#Running Compiled Code | Running Compiled Code]] section.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget ActionScript library. To begin:

1. Place a copy of the [http://www.phidgets.com/downloads/examples/Flash_2.1.8.20120131.zip {{Code|com}}] folder in the root directory of your Flash project.

2. Generate a new ActionScript 3 Flash file.

[[File:Flash New Project.png|link=|alt=New Project]]

3. Then, in your code, you will need to include the Phidget ActionScript library. Navigate to Window → Actions to bring up the Actions window and enter in the following:

<div class="source">
<syntaxhighlight lang=actionscript>
import com.phidgets.*;
import com.phidgets.events.*;
</syntaxhighlight>
</div>

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

=====Running Compiled Code=====

Running a compiled {{Code|.swf}} application on an end user computer will prompt the Flash player to display a dialog box mentioning that the application will block all communications with the Internet.

[[File:Flash Player Security Warning.png|link=|alt=Flash Player Security Warning]]

1. Click on the {{Code|Settings}} button to bring up the Flash Global Security Settings Manager in your default web browser. Alternatively, you can access the manager with the following URL: [http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04a.html http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04a.html].

[[File:Flash Global Security Settings 1.png|link=|alt=Flash Global Security Settings]]

2. In the Global Security Settings tab, navigate to {{Code|Edit locations ...}} → {{Code|Add locations}}.

[[File:Flash Global Security Settings 2.png|link=|alt=Browse for File/Folder]]

3. Then, browse and add the application or the folder containing the application.

[[File:Flash Global Security Settings 3.png|link=|alt=Added file to the trusted locations]]

This will allow the Flash Player to allow the application to accept any communication with the Internet.

==OS X==

Flash ActionScript has excellent support on OS X over the PhidgetWebService.

The first step in using Flash ActionScript on Mac is to install...

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This [[#Follow the Examples|teaching]] section has resources for you to learn from the examples and write your own.

Next comes our ActionScript API information, with syntax for all of our functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in C/C++|[http://www.phidgets.com/documentation/Phidget21Flash_doc.zip ActionScript API]}}

===Example Flow===

{{ExamplePseudocode|In flash ActionScript, you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler ()''' and '''DetachHandler ()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize ()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in Flash ActionScript is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|PhidgetSpatial}} object. The examples show how to do this and other API functions.<br><br>
}}

==Code Snippets==
a single Phidget to be opened by multiple applications - something that cannot be done with the regular interface

==Common Problems and Solutions/Workarounds==

Problem: My compiled application is experiencing the following security error upon launching: "SecurityError: Error #2010: Local-with-filesystem SWF files are not permitted to use sockets".

[[File:Socket Runtime Error.png|link=|alt=Socket Error]]

Solution: The symptom of this problem is similar to the one that is discussed in steps 1 - 3 of the [[#Running Compiled Code | Running Compiled Code]] section. Please see that section for a remedy. To access the Flash Global Security Settings Manager, go to [http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04a.html http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04a.html].

Language - Adobe Director

2012-04-20T17:20:41Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Adobe_Director.png|64x64px|link=|alt=]]|Adobe Director, developed by [http://www.adobe.com Adobe Systems] is a tool used to build interactive and multimedia applications.}}
__TOC__

==Introduction==

{{LanguageSupport|Adobe Director|the complete Phidget API, including events|the PhidgetInterfaceKit devices.|Windows.|}}

==Quick Downloads==

{{QuickDownloads|Adobe Director|
{{APIQuickDownloads|http://www.phidgets.com/documentation/COM_API_Manual.pdf}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/AdobeDirector_2.1.8.20120216.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20120216.zip|COM|}}
{{WindowsQuickDownloads}}
}}

==Getting started with Adobe Director==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

==Windows (2000/XP/Vista/7)==

===Description of Library===
Adobe Director programs on Windows depend on the following. The installers in the [[#Libraries and Drivers | Quick Downloads]] section put only the {{Code|phidget21.dll}} into your system.
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. By default, it is placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|Phidget21COM.dll}}</b> is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. If you installed the Phidget drivers, it will have automatically registered the ActiveX objects into your system. If you are manually installing this file, you must register it through command line by running: {{Code|regsvr32 Phidget21COM.dll}}.

If you do not want to use our installer, you can download both [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20111220.zip files] and manually install them where you want; refer to our [[OS_-_Windows#Manual_File_Installation| Manual Installation Instructions]].

===Adobe Director 11.5===

====Use Our Examples====

1. Download the [http://www.phidgets.com/downloads/examples/AdobeDirector_2.1.8.20120216.zip examples] and unpack them into a folder. These examples were written in Adobe Director 11.5.

2. The easiest way to confirm that your environment is set up properly will be to run the HelloWorld Adobe Director example. In the Adobe Director environment, open up the file named {{Code|HelloWorld.dir}}.

3. To run the example, click on Control → Play.

[[File:AdobeDirector Play.PNG|link=|alt=Play]]

4. This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:

[[File:AdobeDirector HelloWorld Output.PNG|link=|alt=HelloWorld Output]]

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. Currently, the only device we have example code for is the PhidgetInterfaceKit.

Once you have the Adobe Director examples running, we have a teaching section below to help you follow them.

====Write Your Own Code====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget ActiveX object.

1. Create a new movie.

2. Navigate to Insert → Control → ActiveX.

[[File:AdobeDirector Add ActiveX 1.PNG |link=|alt=Add ActiveX Control]]

3. Select the ActiveX control that corresponds to your device. Select {{Code|OK}}.

[[File:AdobeDirector Add ActiveX 2.PNG |link=|alt=Add ActiveX Control]]

4. A window will pop up listing the properties and methods of the ActiveX class. Select {{Code|OK}}.

[[File:AdobeDirector Class ActiveX Properties.PNG |link=|alt=ActiveX Properties]]

5. The ActiveX class will be added to your cast. Create an instance of it by dragging and dropping the cast member onto the stage.

[[File:AdobeDirector ActiveX Cast.PNG ‎|link=|alt=ActiveX Cast]]

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the Adobe Director Phidget functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in Adobe Director|[http://www.phidgets.com/documentation/COM_API_Manual.pdf COM API]}}

===Example Flow===

{{ExamplePseudocode|In Adobe Director, you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''OnAttach()''' and '''OnDetach()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in Adobe Director is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} ActiveX object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/COM_API_Manual.pdf COM API]}}

==Code Snippets==

==Common Problems and Solutions/Workarounds==

==={{ProblemSolution|Windows users in Netherlands|The examples are mislukken}}===

Our examples are unsupported to all users in the country of Netherlands. Sorry! We do not currently know why; a Director version problem is suspected. As we aren't able to run a Netherlands version outside of the Netherlands, this makes the problem very difficult to debug. If you would like to help us work through the example code that we provide and help us figure out why, please contact us.

Language - Simulink

2012-04-20T17:19:55Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Simulink.png|64x64px]]|Preamble about the language's origin and its main characteristics.}}
==Support==
Simulink has a complete API for all Phidgets devices, and code samples for PhidgetInterfaceKit devices.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip API Manual]
* [http://www.phidgets.com/documentation/web/cdoc/index.html API Reference]
* [http://www.phidgets.com/downloads/examples/Simulink_2.1.8.20110615.zip Simulink Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==

Due to the nature of Simulink, some function calls and Phidget classes may not be supported.
These will be discussed later in the tutorial.

Simulink offers several different types of user defined blocks that can interact with MATLAB or C code.
This tutorial will use MATLAB code to demonstrate how user defined functions can be used to interact with Phidgets through the use of MATLAB Fcn, M Level 1 S Functions, and M Level 2 S Function blocks.
As writing C code is beyond the scope of this guide, C S Function blocks will not be discussed.
However, C S Function blocks work similar to M S Function blocks.

MATLAB Fcn blocks are the easiest blocks to use, but have limited features(i.e., only 1 input port).
Level 1 S Functions blocks have more featues, but are more complicated to implement. Level 2 S Functions blocks are the most complex, but benefit in supporting the most features.

This tutorial will assume the reader is familiar with Simulink, Simulink user defined functions and interacting with Phidgets using MATLAB.
For more information about interacting with Phidgets using MATLAB, please see the [[Language - MATLAB#Getting Started|Getting Started Guide for MATLAB]].

===Setting up a Phidgets Project===

The Phidget examples were written using Simulink 6.1/MATLAB 7 in Windows XP.
Other recent versions should work as well and would be set up in a similar manner.
To begin,
* The first step is to set the path for phidget21Matlab.h in MATLAB(File->Set Path). The phidget21Matlab.h can be found in the MATLAB examples.
* Launch MATLAB and enter “simulink” in the MATLAB command window to open up the Simulink Library Browser.
* Create a new model
The project now has access to Phidgets and we are ready to begin coding.

===Connecting to the Phidget===

The Phidget object will need to be declared and initialized.
For example, we can declare and initialize an instance of a PhidgetInterfaceKit inside a M file of a Level 1 S Function block with:

<div class="source"><syntaxhighlight lang=cpp>

global handle;
loadlibrary('phidget21', 'phidget21Matlab.h');
ptr = libpointer('int32Ptr',0);
calllib('phidget21', 'CPhidgetInterfaceKit_create', ptr);
handle = get(ptr, 'Value');
calllib('phidget21', 'CPhidget_open', handle, -1)
calllib('phidget21', 'CPhidget_waitForAttachment', handle, 2500)

</syntaxhighlight></div>

The handle variable is declared as a global, and can be easily accessed by other blocks.
Since blocks repeatedly run until the simulation is completed, the above code will need to be restricted so that it runs only once during a simulation.
It is placed inside the mdlInitializeSizes function.
At the end of the simulation, the Phidget object will need to be closed and deleted.
The folowing lines are added to mdlTerminate.

<div class="source"><syntaxhighlight lang=cpp>

calllib('phidget21', 'CPhidget_close', handle);
calllib('phidget21', 'CPhidget_delete', handle);

</syntaxhighlight></div>

===Working directly with the Phidget===

In this section, a MATLAB Fcn block will be used to set the output states of the digital output ports on a PhidgetInterfaceKit 8/8/8.
The following code is placed inside a M file.
The block’s input is the desired output state.

<div class="source"><syntaxhighlight lang=cpp>

function setOutputStates(outputState)
global handle;
for i = 0:7
if (calllib('phidget21', 'CPhidgetInterfaceKit_setOutputState', handle, i, outputState) == 1)
display('Set output state failed')

end
end

</syntaxhighlight></div>

Note that this handle is the same handle that was created earlier.
Next, a M Level 2 S Function will be used to retrieve sensor values of analog sensor ports and output it to a scope.
The block will contain no inputs and 1 output, with 8 dimensions(1 dimension for each analog sensor of a PhidgetInterfaceKit 8/8/8).
The following code is placed in the Output function in the M file.

<div class="source"><syntaxhighlight lang=cpp>

function Output(block)
dataptr = libpointer('int32Ptr',0);
global handle;
for i = 0:7
if (calllib('phidget21', 'CPhidgetInterfaceKit_getSensorValue', handle, i, dataptr) == 0)
block.OutputPort(1).Data(i+1) = get(dataptr, 'Value');
end
end

</syntaxhighlight></div>

===Event Driven Programming===

MATLAB and Simulink do not support event handling.

===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same model.
Each instance of a Phidget corresponding to a particular handle.
Create more handles to work with more Phidgets. If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===
The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfacekit, you would declare an RFID object instead of an InterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

===Working with Strings===

It is possible for a user to specify a string of characters in the block parameters dialog box of a user defined function such that it is passed into a user defined function.
Please see the PhidgetInterfaceKit_RemoteIP block library in the Simulink examples for details.
Simulink cannot display strings in the GUI, however it is possible to write a C S function that displays strings in the MATLAB console.

===Working in Real Time===

Even though a model may finish simulating before a user has a chance to interact with Phidgets, there are workarounds that can be used to slow down simulation time to allow for user interaction.
One method is to modify the Solver Options(under Simulation->Configuration Parameters->Solver).
Changing the step size and stop time may slow down the simulation. Another method is to implement a user defined function that reduces the simulation speed until the system clock matches the Simulink clock.
The Phidget Simulink example uses the “Real Time Block” to simulate the model in approximate real time.
For more information about the “Real Time Block”, please see

http://www.mathworks.com/support/solutions/en/data/1-15JAW/

To use the “Real Time Block”, place the following files in your MATLAB working directory: slblocks.m, rtc.mdl, waitforreal.m.
These files can be found in the Simulink examples.
Open up the Simulink Library Browser and select “Real Time Clock”.
Place the Real Time Clock block onto your model.

For applications where accurate real time simuation is needed, xPC Target can be used.

Please note that the simulation speed of these methods may differ depending on the CPU speed, complexity of the model, the amount of text being displayed in the MATLAB console, etc....

==Building your Project==
Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Language - MATLAB

2012-04-20T17:16:51Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:Icon-Matlab.png|64x64px]]|MATLAB is a scientific and numerical analysis oriented language, with many graphical libraries and a wide user base.}}
__TOC__

==Introduction==

{{LanguageSupport|MATLAB|the non-[[General Phidget Programming#Event Driven Code|event driven]] part of the Phidget API|AdvancedServo, Encoder, InterfaceKit, Servo and Stepper.|any operating system that can run MATLAB code|}}

If you want to use the events provided by the Phidget library (for, say, collecting sensor data as it changes) then consider using Python as a wrapper. Python has many libraries which can provide MATLAB-like functionality, such as:
* MatplotLib (plotting functions very similar to MATLAB)
* NumPy (array functions similar to MATLAB)
* SciPy (scientific functions similar to MATLAB libraries)

There is also Pytave, which interfaces with Octave, which can read .m files. Using the list of libraries above would '''mimic''' MATLAB abilities in Python. Using Pytave would allow you to open most MATLAB code directly, as long as it works on Octave. In both of these cases, you would use the [[Language - Python | Python Phidget libraries]], and Python as your main Phidget programming language, not MATLAB. Python has excellent [http://python.org/ web documentation], and it is interpreted like MATLAB so there is no need to compile.

We do not support Octave. Phidgets in MATLAB depend on the <code>calllib()</code> function, which Octave does not have. For workarounds, see our [[#Common Problems and Solutions|common problems]] section. Also, the {{Code|calllib}} library uses our C libraries, so programming in MATLAB for Phidgets uses the C API.

==Quick Downloads==
{{QuickDownloads|MATLAB|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21_C_Doc.zip}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/Matlab_2.1.8.20110615.zip MATLAB|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Matlab_2.1.8.20110615.zip|MATLAB (Windows and Mac)|}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
{{LinuxQuickDownloads}}
}}

==Quick Downloads==

Just need the MATLAB drivers, libraries, and examples? Here they are.

* [http://www.phidgets.com/downloads/examples/Matlab_2.1.8.20110615.zip MATLAB Sample Code], including the '''<code>phidget21Matlab.h</code>''' library file, needed for any MATLAB project.

MATLAB depends on the C/C++ libraries, and all MATLAB calls essentially call functions in the C library. So. you need the C/C++ drivers and libraries, and you may also find the C/C++ API reference handy:
*[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Manual Download] or [http://www.phidgets.com/documentation/web/cdoc/index.html (HTML online version)]
*[[General API]] (more help on functions common to all Phidgets)
*[[Device List | Device Specific APIs]] (more help on functions specific to your Phidget)

Libraries and Drivers which MATLAB depends on:
*[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip 32 bit Windows (drivers, with libraries)]
*[http://www.phidgets.com/downloads/libraries/phidget21-x64_2.1.8.20110615.zip 64 bit Windows (drivers, with libraries)]
*[http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20111028.tar.gz General Linux Libraries] ([[OS - Linux | Linux Library Setup Instructions]])
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20111103.dmg General Mac OSX Libraries] ([[OS - Mac OSX | Mac OSX Library Setup Instructions]])

==Getting Started with MATLAB (Windows 2000/XP/Vista/7)==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

===Use Our Examples===

Start by using and modifying existing examples. You can find the MATLAB example code here:

*[http://www.phidgets.com/downloads/examples/Matlab_2.1.8.20111028.zip MATLAB Examples]

If you are using a 64 bit version of Windows, a small modification to the {{Code|phidget21Matlab.h}} will be required to use our examples or writing your own code. Please add the following lines to the beginning of the file:

<div class="source">
<syntaxhighlight lang=c>

#ifndef WIN32
#define __stdcall
#endif

</syntaxhighlight>
</div>

To run the example code, you'll need to unpack the download and find the source code ''for your specific device'' within the example package. The file you need will be named something similar to your device name. Once you have found the file that runs your device, copy that .m source file '''and''' phidget21Matlab.h from the examples folder to your project directory. Then, run the code within MATLAB as you would any .m file. For example, from the MATLAB command line, to run the example that reads the analog input from a Phidget Interface Kit:

<div class="source">
<syntaxhighlight lang=matlab>

run analogin.m

</syntaxhighlight>
</div>

This will allow you to:
{{ExampleCodeReasons}}

If you receive an error regarding that the selected compiler cannot be found.

[[File:MATLAB Win Compiler Error.png|link=|alt=Compile cannot be found]]

You will have to to configure your compiler for MATLAB by entering the following command in the MATLAB command window:
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=matlab>

mex -setup

</source>
</font>
</div>

[[File:MATLAB Win Mex Setup.png|link=|alt=Mex Setup]]

Next, select {{Code|y}} to view all installed compilers.

[[File:MATLAB Win Choose Your Compiler.png|link=|alt=Choose your Compiler]]

Finally, select the compiler you wish MATLAB to use.

[[File:MATLAB Win Mex Setup Output.png|link=|alt=Mex Setup Output]]

===Write Your Own Code===

You can write your MATLAB code the same way you usually do, whether within a text editor or within MATLAB itself. However, to use Phidget calls within your code, you must include a reference to the Phidget library in your main body of code, before any Phidget calls:

<div class="source">
<syntaxhighlight lang=matlab>

function phidgettest(n)
loadlibrary phidget21 phidget21Matlab.h;
% More code goes here
end

</syntaxhighlight>
</div>

Also, before running your code, remember to '''copy phidget21Matlab.h to your project directory'''.

==Getting Started with MATLAB (Mac OS)==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

===Use Our Examples===

Due to different library naming conventions, as well as different compiler support for the behind-the-scenes libraries, you will have to make two small modifications to our MATLAB examples to run them on Mac OS.

Instructions will differ depending on whether you are using a 32 or 64 bit system.

For, <b>32 bit systems</b>, you need to make one change to {{Code|phidget21Matlab.h}}, by adding the following to the top of the file:

<div class="source">
<syntaxhighlight lang=c>

#ifndef WIN32
#define __stdcall
#endif

</syntaxhighlight>
</div>

Save the file and keep it in the same folder where you will run the example.

This change simply defines __stdcall to be nothing. The __stdcall function is not supported on a Mac because it is not supported by the library compiler gcc. Removing the __stdcall definition will simply call the Phidget functions in a raw manner rather than having the stack managed by the function itself.

The next change is to the example {{Code|.m}} source code file you are using. In all of the example code {{Code|.m}} files, there is a line near the very top (line 4 or so) that says:

<div class="source">
<syntaxhighlight lang=matlab>
loadlibrary phidget21 phidget21Matlab.h;
</syntaxhighlight>
</div>

or:

<div class="source">
<syntaxhighlight lang=matlab>
loadlibrary ('phidget21', 'phidget21Matlab.h');
</syntaxhighlight>
</div>

On Mac OS, this needs to be changed to:

<div class="source">
<syntaxhighlight lang=matlab>
loadlibrary /Library/frameworks/Phidget21.framework/Versions/Current/Phidget21 phidget21Matlab.h alias phidget21
</syntaxhighlight>
</div>

The location of {{Code|Phidget21}} should be the actual location of the Phidget libraries on your system. If you just did a default install, the locations as written above should be fine. Otherwise, find the libraries (use a search or locate function from the command line or operating system) and substitute their actual location.

These changes are needed because the Phidget libraries are named differently on Mac OS than they are on Windows. On Windows, the {{Code|loadlibrary}} function looks for a ''phidget21''.dll file and links it to the phidget21 alias used throughout the MATLAB program. This alias linking happens automatically because the library and the alias have the same name, including capitalization.

On Mac OS, however, the library to be linked is the executable {{Code|Phidget21}}. Because it does not have exactly the same name as ''phidget21'' (which is used as the alias in the rest of the {{Code|.m}} code), you have to link it and alias it explicitly.

Without these changes, the errors that appear can be quite strange. They show up as file-not-found errors, ELF-header errors, or simply {{Code|evalin()}} errors, depending on whether you've changed the phidget21Matlab.h file, the path, the file, or none of the above. The file-not-found error looks like this:

<div class="source">
<syntaxhighlight lang=text>
Error in ==> digitalout at 3
loadlibrary phidget21 phidget21Matlab.h;

Error in ==> run at 74
evalin('caller',[script ';']);

Caused by:
Error using ==> loaddefinedlibrary
phidget21.so: cannot open shared object file: No such file or directory
</syntaxhighlight>
</div>

The phidget21Matlab.h file should be either in the current project directory, or in a MATLAB path (type {{Code|path}} in MATLAB to see the current setup). If you prefer to use parentheses and quotations for aliasing (to keep your formatting strict), you can read about the various syntax options for the {{Code|loadlibrary}} function on the [http://www.mathworks.com/help/techdoc/ref/loadlibrary.html MathWorks website].

Once you have made the changes above to both the {{Code|phidget21Matlab.h}} file and the {{Code|*.m}} example file you want to run, running the example you want is easy. Just put the {{Code|*.m}} example and the {{Code|phidget21Matlab.h}} file into your current directory in Matlab, and type the example name.

For instance, to use the {{Code|analogin.m}} example to read analog in data from a Phidget Interface Kit, you can just type it on the MATLAB command line:

<div class="source">
<syntaxhighlight lang=text>
< M A T L A B (R) >
Copyright 1984-2012 The MathWorks, Inc.
R2012a (7.14.0.739) 64-bit (glnxa64)
February 9, 2012

To get started, type one of these: helpwin, helpdesk, or demo.
For product information, visit www.mathworks.com.

>> analogin
</syntaxhighlight>
</div>

For <b>64 bit systems</b>, the {{Code|phidget21Matlab.h}} will differ slightly from the 32 bit version. Download the 64 bit version of {{Code|phidget21Matlab.h}}, and change the following line:
<div class="source">
<syntaxhighlight lang=c>

typedef void* CPhidgetHandle;

</syntaxhighlight>
</div>

with:
<div class="source">
<syntaxhighlight lang=c>

typedef long long CPhidgetHandle;

</syntaxhighlight>
</div>

The next change is to the example {{Code|.m}} source code file you are using. In all of the example code {{Code|.m}} files, there is a line near the very top (line 4 or so) that says:

<div class="source">
<syntaxhighlight lang=matlab>
loadlibrary phidget21 phidget21Matlab.h;
</syntaxhighlight>
</div>

or:

<div class="source">
<syntaxhighlight lang=matlab>
loadlibrary ('phidget21', 'phidget21Matlab.h');
</syntaxhighlight>
</div>

On Mac OS, this needs to be changed to:

<div class="source">
<syntaxhighlight lang=matlab>
loadlibrary /Library/frameworks/Phidget21.framework/Versions/Current/Phidget21 phidget21Matlab.h alias phidget21
</syntaxhighlight>
</div>

The location of {{Code|Phidget21}} should be the actual location of the Phidget libraries on your system. If you just did a default install, the locations as written above should be fine. Otherwise, find the libraries (use a search or locate function from the command line or operating system) and substitute their actual location.

The pointer data type of the PhidgetHandle will also need to be changed. Replace the following:
<div class="source">
<syntaxhighlight lang=c>

ptr = libpointer('int32Ptr',0);

</syntaxhighlight>
</div>

with:

<div class="source">
<syntaxhighlight lang=c>

ptr = libpointer('int64Ptr',0);

</syntaxhighlight>
</div>

The phidget21Matlab.h file should be either in the current project directory, or in a MATLAB path (type {{Code|path}} in MATLAB to see the current setup). If you prefer to use parentheses and quotations for aliasing (to keep your formatting strict), you can read about the various syntax options for the {{Code|loadlibrary}} function on the [http://www.mathworks.com/help/techdoc/ref/loadlibrary.html MathWorks website].

Once you have made the changes above to both the {{Code|phidget21Matlab.h}} file and the {{Code|*.m}} example file you want to run, running the example you want is easy. Just put the {{Code|*.m}} example and the {{Code|phidget21Matlab.h}} file into your current directory in Matlab, and type the example name.

For instance, to use the {{Code|analogin.m}} example to read analog in data from a Phidget Interface Kit, you can just type it on the MATLAB command line:

<div class="source">
<syntaxhighlight lang=text>

>> analogin

</syntaxhighlight>
</div>

===Write Your Own Code===

You can write your MATLAB code the same way you usually do, whether within a text editor or within MATLAB itself. However, to use Phidget calls within your code, you must include a reference to the Phidget library in your main body of code, before any Phidget calls.

On Mac OS:

<div class="source">
<syntaxhighlight lang=matlab>

function phidgettest(n)
loadlibrary /Library/framework/Phidget21.framework/Versions/Current/Phidget21 phidget21Matlab.h alias phidget21
% More code goes here
end

</syntaxhighlight>
</div>

==Getting Started with MATLAB (Linux)==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

===Use our Examples===

====Step 1: Compile the MATLAB Library====

In the [http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20120216.tar.gz Phidget Linux libraries] (not the MATLAB libraries) you have already have compiled the {{Code|phidget21.h}} for running all Phidgets on Linux. There is ''another'' make target in those libraries to make the MATLAB library header file for your Linux system.

To make this MATLAB library:
# Re-download the [http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20120216.tar.gz Phidget Linux libraries] if you have deleted the Phidget Library source code
#* If you re-download, also make the main {{Code|phidget21.h}} Phidget library as described on the [[OS - Linux]] page so the MATLAB library matches
#Then, in the source code directory where you ran {{Code|./configure}}, {{Code|make}}, and {{Code|make install}} for the main libraries, also run:
#:{{Code|make phidget21matlab.h}}

This will generate a file called {{Code|phidget21matlab.h}} which you can rename to {{Code|phidget21Matlab.h}} so that it works with our examples:

<div class="source">
<syntaxhighlight lang=bash>
mv phidget21matlab.h phidget21Matlab.h
</syntaxhighlight>
</div>

Then, if you have an older library, you may have to add one line at the top of {{Code|phidget21Matlab.h}}:

<div class="source">
<syntaxhighlight lang=cpp>
typedef long long __int64;
</syntaxhighlight>
</div>

If you try running the examples as below, and something similar to this is not already in the {{Code|phidget21Matlab.h}} file, MATLAB will give you a series of fairly descriptive errors involving {{Code|__int64}}. So you can also try running the examples and adding this if needed.

And, on '''64-bit Linux systems''' with older libraries, you will need to change the line that says {{Code|typedef long CPhidgetHandle;}} to say either:

<div class="source">
<syntaxhighlight lang=cpp>
typedef long long CPhidgetHandle;
</syntaxhighlight>
</div>

Or:

<div class="source">
<syntaxhighlight lang=cpp>
typedef void* CPhidgetHandle;
</syntaxhighlight>
</div>

....depending on how you want to typecast your Phidget handle within your code (if you are not sure, the first one should work fine).

This changes the pointer type for the Phidget software object to be 64 bits, which is what your 64 bit machine will naturally create.

====Step 2: Modify the Examples====

Download the and unzip the [http://www.phidgets.com/downloads/examples/Matlab_2.1.8.20120216.zip Phidget examples for MATLAB]. Put the {{Code|phidget21Matlab.h}} header file that you just compiled into the unzipped example directory, overwriting the existing Windows/Mac {{Code|phidget21Matlab.h}} file that came with the examples.

The next change is to the example {{Code|.m}} source code file you are using. In all of the example code {{Code|.m}} files, there is a line near the very top (line 4 or so) that says:

<div class="source">
<syntaxhighlight lang=matlab>
loadlibrary phidget21 phidget21Matlab.h;
</syntaxhighlight>
</div>

or:

<div class="source">
<syntaxhighlight lang=matlab>
loadlibrary ('phidget21', 'phidget21Matlab.h');
</syntaxhighlight>
</div>

This needs to be changed to:

<div class="source">
<syntaxhighlight lang=matlab>
loadlibrary /usr/lib/libphidget21.so phidget21Matlab.h alias phidget21
</syntaxhighlight>
</div>

The location of {{Code|libphidget21.so}} should be the actual location of the Phidget libraries on your system. If you just did a default install, the location as written above should be fine. Otherwise, find the libraries (use a search or locate function from the command line or operating system) and substitute the actual location.

These changes are needed because the Phidget libraries are named differently on Linux than they are on Windows. On Windows, the {{Code|loadlibrary}} function looks for a ''phidget21''.dll file and links it to the phidget21 alias used throughout the MATLAB program. This alias linking happens automatically because the library and the alias have the same name, including capitalization.

On Linux, however, the library to be linked is the executable {{Code|libphidget21.so}}. Because it does not have exactly the same name as ''phidget21'' (which is used as the alias in the rest of the {{Code|.m}} code), you have to link it and alias it explicitly.

Without these changes, the errors that appear can be quite strange. They show up as file-not-found errors, ELF-header errors, or simply {{Code|evalin()}} errors, depending on whether you've changed the phidget21Matlab.h file, the path, the file, or none of the above. The file-not-found error looks like this:

<div class="source">
<syntaxhighlight lang=text>
Error in ==> digitalout at 3
loadlibrary phidget21 phidget21Matlab.h;

Error in ==> run at 74
evalin('caller',[script ';']);

Caused by:
Error using ==> loaddefinedlibrary
phidget21.so: cannot open shared object file: No such file or directory
</syntaxhighlight>
</div>

On a '''64-bit Linux''' system, you will need to change the Phidget handle within the example to be a 64 bit pointer, matching the {{Code|phidget21Matlab.h}} file. For example, in the {{Code|analogin.m}} example, the line that says <code>ptr = libpointer('int32Ptr',0);</code> to say:

<div class="source">
<syntaxhighlight lang=matlab>
ptr = libpointer('int64Ptr',0);
</syntaxhighlight>
</div>

====Step 3: Run the Examples====

The compiled and edited {{Code|phidget21Matlab.h}} file should be either in the current project directory, or in a MATLAB path (type {{Code|path}} in MATLAB to see the current setup). If you prefer to use parentheses and quotations for aliasing (to keep your formatting strict), you can read about the various syntax options for the {{Code|loadlibrary}} function on the [http://www.mathworks.com/help/techdoc/ref/loadlibrary.html MathWorks website].

Once you have made the changes above to both the {{Code|phidget21Matlab.h}} file and the {{Code|*.m}} example file you want to run, running the example you want is easy. Just put the {{Code|*.m}} example and the {{Code|phidget21Matlab.h}} file into your current directory in Matlab, and type the example name.

For instance, to use the {{Code|analogin.m}} example to read analog in data from a Phidget Interface Kit, you can just type it on the MATLAB command line:

<div class="source">
<syntaxhighlight lang=text>
< M A T L A B (R) >
Copyright 1984-2012 The MathWorks, Inc.
R2012a (7.14.0.739) 64-bit (glnxa64)
February 9, 2012

To get started, type one of these: helpwin, helpdesk, or demo.
For product information, visit www.mathworks.com.

>> analogin
</syntaxhighlight>
</div>

===Write Your Own Code===

You can write your MATLAB code the same way you usually do, whether within a text editor or within MATLAB itself. However, to use Phidget calls within your code, you must include a reference to the Phidget library in your main body of code, before any Phidget calls.

And on Linux:

<div class="source">
<syntaxhighlight lang=matlab>

function phidgettest(n)
loadlibrary /usr/lib/libphidget21.so phidget21Matlab.h alias phidget21
% More code goes here
end

</syntaxhighlight>
</div>

Also, before running your code, remember to '''copy phidget21Matlab.h to your project directory'''.

==Follow The Examples==

By following the instructions above, you probably now have a working example and want to understand it better so you can change it to do what you want. This section has resources for you to learn from the examples and write your own.

Programming with Phidgets in MATLAB makes extensive use of the '''calllib()''' function to the C/C++ library, so the C/C++ API reference will be helpful:

{{UsingAPhidgetInCodeGeneral|although you can only use the logic code type design in MATLAB|[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API]}}

If you find yourself wanting to use event functions in the API (which are not available in MATLAB), try using Python as described in the [[#Support | support]] section at the top of this page.

===Code Snippets===

Specific calls in MATLAB will differ in syntax from those on the [[General Phidget Programming]] page, but the concepts stay the same.

It may help to have the [[General Phidget Programming]] page and this section open at the same time, because they parallel each other and you can refer to the MATLAB syntax. However, many additional concepts are covered on the General Phidget Programming page on a high level, such as using multiple Phidgets, handling errors, and different styles of programming.

For example, if we were using a [[Product - 1018 - PhidgetInterfaceKit 8/8/8 | Phidget Interface Kit]] as our device, the general calls would look like this:

====Step One: Initialize and Open====

<div class="source">
<syntaxhighlight lang=matlab>

devicePointer = libpointer('int32Ptr',0);
calllib('phidget21', 'CPhidgetInterfaceKit_create', devicePointer);
device = get(devicePointer, 'Value');

</syntaxhighlight>
</div>

The devicePointer is converted to the handle '''device''' as a handle for the Phidget. This example is ''specific to the Interface Kit'' because the call CPhidgetInterfaceKit_create is used. For another device, use the correspondingly named call in the C/C++ API.

The handle '''device''' is then used for all the C function calls where CPhidgetHandle phid is used in the C/C++ API. Every type of Phidget also inherits functionality from the Phidget base class.

Note that open() opens the software object, but not hardware. So, it is not a guarantee you can use the Phidget immediately.

The different types of open can be used with parameters to try and get the first device it can find, open based on its serial number, or even open across the network. The API manual lists all of the available modes that open provides.

====Step Two: Wait for Attachment (plugging in) of the Phidget====

To use the Phidget, it must be plugged in (attached). We can handle this by calling waitForAttachment. This function works for any Phidget. WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded:

<div class="source">
<syntaxhighlight lang=matlab>

calllib('phidget21', 'CPhidget_open', device, -1);
if calllib('phidget21', 'CPhidget_waitForAttachment', device, 2500) == 0
% Insert your code here
end

</syntaxhighlight>
</div>

====Step Three: Do Things with the Phidget====

MATLAB does not support event handling, so all data must be read and sent directly.

The most common thing you might want to do is read data from sensors. For example, in the code below, we might want to read data from a sensor on the [[Product - 1018 - PhidgetInterfaceKit 8/8/8 | Phidget Interface Kit]].

Simply use the C API functions such as CPhidgetInterfaceKit_getSensorValue() or CPhidgetInterfaceKit_setOutState() for Interface Kits. The following reads and displays data from a sensor ten times as quickly as the while loop can execute:

<div class="source">
<syntaxhighlight lang=matlab>

while n<10
dataPointer = libpointer('int32Ptr',0);
calllib('phidget21', 'CPhidgetInterfaceKit_getSensorValue', device, 0, dataPointer)
disp(get(dataPointer, 'Value'));
n=n+1;
end

</syntaxhighlight>
</div>

====Step Four: Close and Delete====

<div class="source">
<syntaxhighlight lang=matlab>

calllib('phidget21', 'CPhidget_close', ikhandle);
calllib('phidget21', 'CPhidget_delete', ikhandle);

</syntaxhighlight>
</div>

At the end of your program, don’t forget to call close to free any locks on the Phidget that the open() call put in place!

The ''complete'' set of functions you have available for all Phidgets can be found in the [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API]. Note, however, MATLAB does not make use of the event functions in the C/C++ API. You can also find more description on any device-specific function either in the [[Device List|Device API]] page for calls available only on your specific Phidget.

==Common Problems and Solutions==
{{ProblemSolution|Octave Problem|The function calls loadlibrary() and callib() are not supported in Octave}}

Likely Fix: As use of Phidgets in MATLAB requires these calls, the best is probably to choose a programming language that is not MATLAB. You can choose [[Software Overview#Language Support|from many languages]] that we support.

However, this may not be possible if, for example, you already have a lot of external code written in MATLAB that you would like to interface your Phidget with. Here are a few suggestions to help you find a way to use your existing MATLAB code:
* Write your overall program in Python. Python natively controls Phidgets, and you can use Pytave to interface between the Python Phidget code and your Octave code.
* If you are using a version of Octave that Pytave does not support, write your program in Python as above. Then, you can try reading your matlab code through R, and using RPy to interface with Python.
* External foreign linking libraries (Swig, FFCall) might be made to work...

{{ProblemSolution|All Operating Systems|You get a warning: The library class 'libphidget21' already exists. Use a classname alias.}}

Note that the {{Code|phidget21}} library is not unloaded at the end of our example {{Code|.m}} files. This is because rapidly unloading the library just after linking it can cause problems in short programs.

So, when you run the program again within the same MATLAB session, you will get this warning. Your code will still work, it is just that running the same code again loads the library again without closing it first.

{{ProblemSolution|OS X|The examples do not run with Rosetta under OS X.}}

The example programs uses the MATLAB {{Code|timer()}} call, which relies on the Java Virtual Machine. Since Rosetta does not support Java, the examples will not operate as expected.

Language - LabVIEW

2012-04-20T17:11:38Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-LabVIEW.png|64x64px|link=|alt=]]|LabVIEW, developed by [http://www.ni.com National Instruments] is dataflow programming language for data processing.}}
__TOC__

==Introduction==

{{LanguageSupport|LabVIEW|the complete Phidget API, including events|all Phidget devices.| Windows. A minimum version of LabVIEW 7.1.1 is required to use the Phidget LabVIEW 32 bit library. For the Phidget LabVIEW 64 bit library, a minimum version of LabVIEW 2009 is required. OS X and Linux are unsupported as Phidgets have not been tested on those systems.|}}

==Quick Downloads==
{{QuickDownloads|LabVIEW|
{{APIQuickDownloads|http://www.phidgets.com/documentation/LabVIEW_Manual.pdf}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/LabVIEWx86_2.1.8.20120216.zip| (32 bit Windows - same file as LabVIEW library)}}
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/LabVIEWx64_2.1.8.20120216.zip| (64 bit Windows - same file as LabVIEW library)}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/examples/LabVIEWx86_2.1.8.20120216.zip|LabVIEW|(32 bit Windows - same file as LabVIEW Examples)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/examples/LabVIEWx64_2.1.8.20120216.zip|LabVIEW|(64 bit Windows - same file as LabVIEW Examples)}}
{{WindowsQuickDownloads}}
}}

==Getting started with LabVIEW==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
LabVIEW programs on Windows depend on the following two items, The installers in the [[#Libraries and Drivers|Quick Downloads]] section put only the {{Code|phidget21.dll}} into your system. You will need to manually put the Phidget LabVIEW library onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. By default, it is placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|Phidgets LabVIEW library}}</b> contains the Phidget library for LabVIEW. You need to place the library into your LabVIEW functions palette. Instructions are explained in the [[#Write Your Own Code | Write Your Own Code]] section.

If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip {{Code|phidget21.dll}}] and manually install it where you want; refer to our [[OS_-_Windows#Manual_File_Installation | Manual Installation Instructions]].

We include instructions for LabVIEW 2011 on [[#Use Our Examples | using our examples]] and [[#Write Your Own Code | writing your own code]].

====Use Our Examples====

To run the examples, you first download the examples found in the [[#Example Code | Quick Downloads]] section and unpack them into a folder. Here, you will find the {{Code|examples}} folder, which contains {{Code|vi}} programs for all the devices. Each {{Code|vi}} example demonstrate the usage of a few of the device's properties. To get a broader understanding of the device, you should take a look at all the {{Code|vi}} examples inside the directory for your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]].

1. Inside the {{Code|examples}} folder, navigate to the directory for your device.

2. Open up any {{Code|.vi}} of your choice in LabVIEW. In this section, the {{Code|Sensor to Output Example.vi}} of the PhidgetInterfaceKit examples will be used.

[[File:LabVIEW Win Front Panel.PNG|link=|alt=Front Panel]]

You will see the front panel of the example. The front panel shows the user interface of the {{code|vi}} program.

3. Next, let us take a look at the block diagram by navigating to {{Code|Window → Show Block Diagram}}.

[[File:LabVIEW Win Block Diagram 1.PNG|link=|alt=Block Diagram]]

The block diagram shows the logic of the application.

[[File:LabVIEW Win Block Diagram 2.PNG|link=|alt=Block Diagram]]

4. The only thing left to do is to run the examples! Navigate to {{Code|Operate → Run}}.

[[File:LabVIEW Win Run 1.PNG|link=|alt=Run]]

5. The application will run.

[[File:LabVIEW Win Run 2.PNG|link=|alt=Run]]

You can determine that your device is connected to your application if you see the indicator for {{Code|attached}} turn green and the correct serial number is displayed. These features are available in most of the example {{Code|vis}} we provide.

6. When you are ready to terminate the application, click on the [[File:LabVIEW Win Stop.PNG|link=|alt=Stop]] button to release the hold on the device. Please keep in mind that the application may not terminate properly if you stop it by clicking on {{Code|Operate → Stop}}.

Once you have the LabVIEW examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

====Write Your Own Code====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to add the Phidget LabVIEW library to your development environment. To begin:

1. Navigate to {{Code|Tools → Advanced → Edit Palette Set}} to modify the functions palette.

[[File:LabVIEW Win Functions Palette 1.PNG|link=|alt=Edit Function Palette]]

2. The functions palette will show up. Right click an empty area, and select {{Code|Insert → Subpalette}}.

[[File:LabVIEW Win Functions Palette 2.PNG|link=|alt=Insert Function Palette]]

3. Next, select {{Code|Link to a directory}}.

[[File:LabVIEW Win Functions Palette 3.PNG|link=|alt=Link to a library]]

4. Make sure you have the Phidget LabVIEW library and examples in the [[#Libraries and Drivers| Quick Downloads]] section downloaded and extracted. After extracting, you will find the {{Code|Phidgets}} folder. In LabVIEW, browse to the {{Code|Phidgets}} folder, and select {{Code|Current Folder}}.

[[File:LabVIEW Win Functions Palette 4.PNG|link=|alt=Select Phidgets library]]

This will load the Phidget LabVIEW library into the functions palette. You can find all the functions that pertain to Phidgets inside the {{Code|Phidgets}} palette.

[[File:LabVIEW Win Functions Palette 5.PNG|link=|alt=Phidgets LabVIEW Library]]

5. Click on {{Code|Save Changes}} in the {{Code|Edit Controls and Functions Palette Set}} window.

[[File:LabVIEW Win Functions Palette 6.PNG|link=|alt=Save Function Palette]]

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next comes our API information, with syntax for all of our functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in LabVIEW|[http://www.phidgets.com/documentation/LabVIEW_Manual.pdf API Manual]}}

==Common Problems and Solutions/Workarounds==

{{KnownIssues|Phidgets do not always work cleanly in Labview. Sometimes they do not appear, sometimes they work veeerrryyy slowly. No known fixes yet, hopefully soon.}}

Language - AutoIt

2012-04-20T17:10:20Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Autoit.png|64x64px]]|Preamble about the language's origin and its main characteristics.}}
==Support==
AutoIt has a complete API for all Phidgets devices, but no sample code at this time.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]]

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/COM_API_Manual.pdf API Manual]
* At this time, we do not have sample code available for AutoIt.
* You can find a high level discussion about programming with Phidgets in general on the [[General Phidget Programming]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==

Applications using Phidgets can be developed in AutoIt v3 through the COM API and this tutorial assumes its use.
The Phidget framework will register the necessary .dlls for you. To begin, create a new AutoIt script file and open it with your preferred editor.
Then, create a simple user interface to work with and then place an input control for the purpose of capturing some simple output.

<div class="source"><syntaxhighlight lang=autoit>

#include <GUIConstantsEx.au3>
GUICreate("Phidget Test")
$InputControl = GUICtrlCreateInput("", 20, 40, 160)
GUISetState(@SW_SHOW)
;Phidget initialization code goes here
Do
$msg = GUIGetMsg()
Until $msg = $GUI_EVENT_CLOSE
;Phidget Event Handlers go here

</syntaxhighlight></div>

===Coding For Your Phidget===

Before you can use the Phidget, you must create the object from the Phidget21COM library at initialization.
This can be accomplished through a call to ObjCreate. For example, we can declare and create a PhidgetInterfaceKit with:

<div class="source"><syntaxhighlight lang=autoit>

$oPhid1 = ObjCreate("Phidget21COM.PhidgetInterfacekit")

</syntaxhighlight></div>

The object name for any type of Phidget is listed in the API manual.
Every type of Phidget also shares some functionality from the base Phidget class.

===Connecting to the Phidget===

The program can try to connect to the Phidget through a call to open.
Open will continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately.
We can account for a connection by using event driven programming and tracking the AttachEvents and DetachEvents, or by calling WaitForAttachment.
WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.

<div class="source"><syntaxhighlight lang=autoit>

$oPhid1.Open()
$oPhid1.WaitForAttachment(3000)
If NOT $oPhid1.IsAttached Then
MsgBox(0, "Error", "Phidget Device not attached")
Exit
EndIf

</syntaxhighlight></div>

The different parameters and open calls can be used to open the first Phidget of a type it can find, open based on a serial number, or even open across the network.
The API manual lists all of the available modes that open provides.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This prevents any other instances from retrieving data from the Phidget, including other programs.
The one connection per device limit does not apply when exclusively using the Phidget Webservice.

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
This allows the program to execute other tasks until the Phidget generates a new event.
In AutoIt, you enable event handlers for a Phidget at initialization with the following line:

<div class="source"><syntaxhighlight lang=autoit>

$oPhidEvents = ObjEvent($oPhid1, "phid1_")

</syntaxhighlight></div>

AutoIt will use the phidl1_ prefix we declared when looking for the handler to execute.
You can define the handler functions for events such as OnSensorChange or Attached elsewhere in your code:

<div class="source"><syntaxhighlight lang=autoit>

Func phid1_OnSensorChange($Index, $SensorValue)
GUICtrlSetData($InputControl, $SensorValue)
EndFunc

</syntaxhighlight></div>

With this method, the code inside phid1_OnSensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the API manual for a full list of events and their usage.

===Working directly with the Phidget===

Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming.
Simply use the instance properties such as SensorValue(Index as Long) or OutputState(Index as Long) for PhidgetInterfaceKits.

<div class="source"><syntaxhighlight lang=autoit>

$oPhid1.OutputState(0) = "true"

</syntaxhighlight></div>

Note that when setting booleans on the Phidget, it must be encapsulated in quotes.
Alternatively, you can usually use the integer value 0 for false and 1 for true.

===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another PhidgetInterfaceKit object to be defined and initialized.
The new object can then be set up, opened and used in the same process as the previous one.
If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===

The design given in this document can also be followed for almost all Phidgets. For example, if you
were using a PhidgetRFID instead of an PhidgetInterfacekit, you would declare a PhidgetRFID object
instead of a PhidgetInterfaceKit. The methods and events available would change but they can be
accessed in a similar manner.

==Building your Project==
Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Language - Applescript

2012-04-20T17:08:19Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Applescript.png|64x64px]]|Applescript is a scripting language for Mac OSX designed primarily for interfacing between applications.}}
==Support==
Applescript has a complete API and sample code for all Phidgets devices.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* API Manual (Link to API download)
* API Reference (Link to online API reference (if applicable))
* Example Programs written in this language
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

==Getting Started==
The Phidget examples were written using AppleScript 2.1.2 under AppleScript Editor 2.3, and this tutorial assumes their use. Other versions and development environments should work as well and would be set up in a similar manner.

*First, open the AppleScript editor to create a new script.
*Coding with Phidgets is made possible by the interaction of Apple Events between AppleScript and • the PhidgetsOSA application. Type the following to interact with PhidgetsOSA:

<div class="source"><syntaxhighlight lang=applescript>

tell application "PhidgetsOSA"
end tell

</syntaxhighlight></div>

The project now has access to Phidgets and we are ready to begin coding. For the rest of this document, unless otherwise stated, it will be assumed that all code will be typed inside this tell block.

===Coding For Your Phidget===
A Phidget object will need to be declared. For example, we can declare a PhidgetInterfaceKit:

<div class="source"><syntaxhighlight lang=applescript>

set ifkit to make new phidget interfacekit

</syntaxhighlight></div>

The object name for any type of Phidget is listed in the PhidgetsOSA dictionary. Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

Next, the Phidget object needs to be initialized and the program needs to try and connect to the Phidget through a call to open.
Open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately.
We can handle this by using event driven programming and tracking the Attach Events and Detach Events, or by specifying the wait parameter.
The wait parameter will block for a certain amount of time until a connection is made to the Phidget. For example, we can connect to a PhidgetInterfaceKit with:

<div class="source"><syntaxhighlight lang=applescript>

tell ifkit to open

</syntaxhighlight></div>

The different types of open can be used with parameters to try and get the first device it can find, open based on its serial number, or even open across the network.
For more information on connecting across a network, please see the "Working with Phidget WebService" guide on the programming section at www.phidgets.com.
The PhidgetsOSA dictionary lists all of the available modes that open provides.
Examples of the usage of different types of open are listed below:

We can tell the ifkit to block for 5000ms until a connection has been made to the PhidgetInterfaceKit with:

<div class="source"><syntaxhighlight lang=applescript>

tell ifkit to open wait 1000 --wait for 5000ms

</syntaxhighlight></div>

We can also connect to a PhidgetInterfaceKit over the WebService with a serial number of 99999 on a server with an IP Address of 192.168.3.180 and a port that is opened on 5001 with:

<div class="source"><syntaxhighlight lang=applescript>

tell ifkit to open serial number 99999 server address "192.168.3.180" server port 5001

</syntaxhighlight></div>
It is also possible to connect using the server id. For example, we can connect to a PhidgetInterfaceKit on a password protected server with:

<div class="source"><syntaxhighlight lang=applescript>

tell ifkit to open server id "TestMac" password "pw"

</syntaxhighlight></div>

At the end of your script, don’t forget to call close to free any locks on the Phidget.

<div class="source"><syntaxhighlight lang=applescript>

tell ifkit to close
delete ifkit

</syntaxhighlight></div>

Phidgets can also be freed from the [[#PhidgetsOSA Menu Bar|PhidgetsOSA Menu Bar]].

===Event Driven Programming===
We recommend the use of event driven programming when working with Phidgets.
We can hook an event handler at loading with the following code:

<div class="source"><syntaxhighlight lang=applescript>

tell ifkit to make new interfacekit sensor change handler with properties {script file:thisScript}

</syntaxhighlight></div>

And after the tell block at end of the script, the callback method is defined as follows:

<div class="source"><syntaxhighlight lang=applescript>

using terms from application "PhidgetsOSA"
on interfacekit sensor changed ind to val on ifkit
log "Sensor Index: " & ind & ", Sensor Value: " & val
end interfacekit sensor changed
end using terms from

</syntaxhighlight></div>

With this function, the code inside the interfacekit sensor changed handler will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the PhidgetsOSA dictionary and the AppleScript examples for a list of events and their usage.

Please keep in mind that events are triggered from the PhidgetsOSA application and not from AppleScript. Thus, the AppleScript editor won't be able to receive replies when the script runs. In addition, any changes you make to the event code must be saved in order for the changes to take effect.

===Working directly with the Phidget===
Some values can be read and sent directly to the Phidget.
For example, sensor values from the PhidgetInterfaceKit can be read with:

<div class="source"><syntaxhighlight lang=applescript>

log "The first sensor has a value of: " & first interfacekit sensor's value

</syntaxhighlight></div>

These functions can be used inside a polling loop as an alternative to event driven programming.

===Using the same Phidget in more than one Application===
One important thing to remember is that when working with Phidgets, a call to open will reserve the device until closed. This prevents any other instances from retrieving data from the Phidget, including other programs.
If your goal is to use the same Phidget among multiple AppleScripts and/or other applications, there are two approaches.
:1. Implement logic in the script that will use the same Phidget object if the script detects that a Phidget of the same type has already been initialized.
For example,

<div class="source"><syntaxhighlight lang=applescript>

if first phidget interfacekit exists then
set ifkit to the first phidget interfacekit
else
set ifkit to make the phidget interfacekit
open ifkit
end if

</syntaxhighlight></div>

:2. The one connection per device limit does not apply when exclusively using the open Phidget Webservice. For more information, please see the "Connecting to the Phidgets" section of this document.

===Working with multiple Phidgets===
Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another InterfaceKit instance to be defined and initialized.
The new instance can then be set up, opened and used in the same process as the previous one.
If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

===Other Phidgets===
The design given in this document can also be followed for almost all Phidgets.
For example, if you were using a PhidgetRFID instead of an PhidgetInterfacekit, you would declare an RFID object instead of an InterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

===PhidgetsOSA Menu Bar===
[[Image:applescript_bar.jpg]]

The PhidgetsOSA menu bar appears whenever AppleScript accesses the PhidgetsOSA application.
The menu bar is used to monitor the status of any accessed Phidgets.

Additionally, it can be used to free the lock on a Phidget or quit the PhidgetsOSA application.

==Building your Project==
Describe the different ways a project could be built using this language.

==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Language - Android Java

2012-04-20T16:42:18Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:Icon-Android.png‎|64x64px|link=|alt=]]|Android Java is the main language used to program for the [[OS - Android|Android OS]].}}
__TOC__

==Introduction==

{{LanguageSupport|Android|nearly the complete Phidget API, including events, and only excepting a few open() calls outlined later|the Phidget Interface Kit and two Hello World examples.|Eclipse on Windows, Mac OS, and Linux|}}

==Quick Downloads==
{{QuickDownloads|Android|
{{APIQuickDownloads|http://www.phidgets.com/documentation/JavaDoc.zip}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/android-examples_2.1.8.20120216.tar.gz|(and Phidget Android Library)}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/examples/android-examples_2.1.8.20120216.tar.gz||(Phidget21.jar included in Examples)}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
{{LinuxQuickDownloads}}
}}

==Getting Started with Android Java (Eclipse)==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

As Android development is primarily done on Eclipse, and Eclipse is relatively platform-independent, we provide instructions for Eclipse rather than by operating system.

For basic differences on installing and setting up Eclipse on your development system, you can try the [[OS - Android|Android Operating System]] page. However, your best bet for information about general use of Eclipse on your development operating system (Windows, Mac, or Linux) will be the [http://www.eclipse.org/documentation/ Eclipse support page] or the Internet at large.

Phidgets can run directly plugged in to Android devices with a USB port and system 3.1 or later.

Otherwise, Android can control a Phidget remotely over a network, by using the [[Phidget WebService]]

Hence, we split instructions up by Android OS version number.

===Android Under 3.1 (and/or no USB Port)===

These types of phones and tablets can use Phidgets only remotely over a network using the [[OS - Android#WebService|Phidget WebService]].

====Use Our Examples====

Download and unpack the [http://www.phidgets.com/downloads/examples/android-examples_2.1.8.20120216.tar.gz Phidget Examples for Android]. There are two Hello World examples: {{Code|HelloWorldRemote}} (the one you want), and {{Code|HelloWorld}} (for tablets with a USB port).

Import the {{Code|HelloWorldRemote}} example into Eclipse:
* File → Import... → General → Existing Projects Into Workspace → (Next)
* Select {{Code|HelloWorldRemote}} root directory → Select all files → Finish

Next, you '''must change''' the IP address within the example code to the IP address of the computer directly connected to the Phidget you are trying to control. This happens on the line that says something like:
<div class="source">
<syntaxhighlight lang=java>
device.open("192.168.3.133", 5001);
</syntaxhighlight>
</div>

Also, note that the HelloWorldRemote example was written for Android 2.1. If needed, you can change this in:
(Right Click on Project) → Properties → Resource (on left) → Android

To run the example: Right-click on project in Package Explorer (To open the Package Explorer, use Window → Show View → Package Explorer)

Select Run As... → Android Application

This will bring up the Android Virtual Device manager window. If your Android hardware is plugged in to your debugging computer, you will see the hardware as an option on which to run the example. You should run it directly on your Android device, unless you are comfortable setting up the emulator to run on your local network.

After the {{Code|HelloWorldRemote}} application starts running on your Android device:
# Make sure the Phidget WebService is running on the computer with the IP address you put into the code
#*For directions on how to set up and run the webservice on a remote computer, refer to the page [[Software Overview#Operating System Support|for that operating system]]
# Plug a Phidget into that computer

And on your Android device, depending on which Phidget you plug in, you should see something like:

[[Image:android_helloworld_remotehello.png|700px|alt=|link=]]

And when you unplug that Phidget from the remote computer, you should see something like this on your Android device:

[[Image:android_helloworld_remotegoodbye.png|700px|alt=|link=]]

If you have the specific Phidget for the other included Android examples (i.e. the InterfaceKit), you can run the other examples in the same way.

To envision the system in the background, you can refer to the WebService section on the [[OS - Android]] page.

====Write Your Own Code====

To write your own code from scratch, start with an Android project in Eclipse (File → New → Android Project). Then....

=====Step One: Link the Phidget Libraries to your Project=====

When you download and unzip the [http://www.phidgets.com/downloads/examples/android-examples_2.1.8.20120216.tar.gz Phidget Examples for Android], each project folder will (in addition to the project files themselves) contain three things:
# A libs/ folder (containing an armabi/ folder and a single file called libphidget21.so)
# A jar file containing the general Phidget java library (phidget21.jar)
# A jar file for directly driving USB devices from a USB port on the Android device (PhidgetsUSB.jar)

Copy the {{Code|libs}} folder, the {{Code|PhidgetsUSB.jar}} file, and the {{Code|phidget21.jar}} file to your project folder.

To install libraries to run a Phidget '''remotely''' over a network using the WebService:
# Add the libs/ folder to your project
#* To add the libs/ folder in Eclipse, simply place it in the root folder of your project
# Add the phidget21.jar file to your project
#* In Eclipse use the top-bar menu: Project → Properties → Java Build Path → Libraries (tab) → Add JAR

=====Step Two: Give your Program Permission to use the Internet=====

Add the following to your <code>AndroidManifest.xml</code> file:

<div class="source"><syntaxhighlight lang=xml>
<uses-permission android:name="android.permission.INTERNET"></uses-permission>
</syntaxhighlight></div>

=====Step Three: Include the Phidget Libraries in your Source=====

Then, in your code, include an {{Code|import}} reference to the library. In Android Java:

<div class="source"><syntaxhighlight lang=java>
// This contains all of the devices and the exceptions
import com.phidgets.*;

// This contains all of the event listeners
import com.phidgets.event.*;
</syntaxhighlight></div>

Then you are ready to begin coding!

===Android 3.1+ with USB Port===

If your tablet has a USB host port and is running Android 3.1 or later, you can plug Phidgets directly into it.

====Use Our Examples====

Download and unpack the [http://www.phidgets.com/downloads/examples/android-examples_2.1.8.20120216.tar.gz Phidget Examples for Android]. There are two Hello World examples: {{Code|HelloWorld}} (the one you want), and {{Code|HelloWorldRemote}} (for controlling Phidgets over the WebService).

Import the {{Code|HelloWorld}} example into Eclipse:
* File → Import... → General → Existing Projects Into Workspace → (Next)
* Select {{Code|HelloWorldRemote}} root directory → Select all files → Finish

Note that the HelloWorld example was written for Android 3.1. If needed, you can change this in:
(Right Click on Project) → Properties → Resource (on left) → Android

To run the example: Right-click on project in Package Explorer (To open the Package Explorer, use Window → Show View → Package Explorer)

Select Run As... → Android Application

This will bring up the Android Virtual Device manager window. If your Android hardware is plugged in to your debugging computer, you will see the hardware as an option on which to run the example. You should run it directly on your Android device, unless you are comfortable setting up the emulator to use your development computer's USB hub.

After the {{Code|HelloWorld}} application starts running on your Android device, plug a Phidget into your Android tablet's USB port!

Since the USB device requires special permission, the first thing you will probably see is a request from the Phidget example to use the USB port:

[[Image:android_helloworld_usb_permissions.png|500px|alt=|link=]]

And on your Android device, depending on which Phidget you plug in, you should see something like:

[[Image:android_helloworld_hello.png|700px|alt=|link=]]

And when you unplug that Phidget from the remote computer, you should see something like this on your Android device:

[[Image:android_helloworld_goodbye.png|700px|alt=|link=]]

If you have the specific Phidget for the other included Android examples (i.e. the InterfaceKit), you can run the other examples in the same way.

If you are having trouble running the examples, a method to debug the Android USB port is on the [[OS - Android]] page, under the Hardware section.

====Write Your Own Code====

To write your own code from scratch, start with an Android project in Eclipse (File → New → Android Project). Then....

=====Step One: Link the Phidget Libraries to your Project=====

When you download and unzip the [http://www.phidgets.com/downloads/examples/android-examples_2.1.8.20120216.tar.gz Phidget Examples for Android], each project folder will (in addition to the project files themselves) contain three things:
# A libs/ folder (containing an armabi/ folder and a single file called libphidget21.so)
# A jar file containing the general Phidget java library (phidget21.jar)
# A jar file for directly driving USB devices from a USB port on the Android device (PhidgetsUSB.jar)

Copy the {{Code|libs}} folder, the {{Code|PhidgetsUSB.jar}} file, and the {{Code|phidget21.jar}} file to your project folder.

To install libraries to run a Phidget '''remotely''' over a network using the WebService:
# Add the libs/ folder to your project
#* To add the libs/ folder in Eclipse, simply place it in the root folder of your project
# Add the phidget21.jar file to your project
# Also add the PhidgetsUSB.jar file to your project
#* In Eclipse, to add jar files use the top-bar menu: Project → Properties → Java Build Path → Libraries (tab) → Add JAR

=====Step Two: Give your Program Permission to use USB=====

Add the following to your <code>AndroidManifest.xml</code> file:

<div class="source"><syntaxhighlight lang=xml>
<uses-feature android:name="android.hardware.usb.host" />
</syntaxhighlight></div>

=====Step Three: Include the Phidget Libraries in your Source=====

Then, in your code, include an {{Code|import}} reference to the library. In Android Java:

<div class="source"><syntaxhighlight lang=java>
// This contains all of the devices and the exceptions
import com.phidgets.*;

// This contains all of the event listeners
import com.phidgets.event.*;
</syntaxhighlight></div>

Then you are ready to begin coding!

==Follow the Examples==

By following the instructions above, you probably now have a working example and want to understand it better so you can change it to do what you want. This section has resources for you to learn from the examples and write your own.

Programming with Phidgets in MATLAB makes extensive use of the mainstream Java Phidgets library, so the Java API reference will be helpful:

{{UsingAPhidgetInCodeGeneral|although you can only use the event code in Android|[http://www.phidgets.com/documentation/JavaDoc.zip Java API]}}

===API Support===

Most of the Java API is supported in Android. However, only some of the available open calls are supported:

When using a Phidget over a network, you can open the remote Phidget using one of the supported Java API calls:
<div class="source"><syntaxhighlight lang=java>
void open(int serial, java.lang.String ipAddress, int port)
void open(int serial, java.lang.String ipAddress, int port, java.lang.String password)
void openAny(java.lang.String ipAddress, int port)
void openAny(java.lang.String ipAddress, int port, java.lang.String password)
void openLabel(java.lang.String label, java.lang.String ipAddress, int port)
void openLabel(java.lang.String label, java.lang.String ipAddress, int port, java.lang.String password)
</syntaxhighlight></div>

When using a Phidget when it is directly plugged in to an Android 3.1 or later tablet, you can use one of these supported Java API calls:
<div class="source"><syntaxhighlight lang=java>
void open(int serial)
void openAny()
void openLabel(java.lang.String label)
</syntaxhighlight></div>

This leaves these Java API calls, which are '''unsupported''' on Android:
<div class="source"><syntaxhighlight lang=java>
void open(int serial, java.lang.String serverID)
void open(int serial, java.lang.String serverID, java.lang.String password)
void openAny(java.lang.String serverID)
void openAny(java.lang.String serverID, java.lang.String password)
void openLabel(java.lang.String label, java.lang.String serverID)
void openLabel(java.lang.String label, java.lang.String serverID,
java.lang.String password)
</syntaxhighlight></div>

===Code Snippets===

Specific calls in Android Java will differ in syntax from those on the [[General Phidget Programming]] page, but the concepts stay the same.

It may help to have the [[General Phidget Programming]] page and this section open at the same time, because they parallel each other and you can refer to the Android Java syntax. However, many additional concepts are covered on the General Phidget Programming page on a high level, such as using multiple Phidgets, handling errors, and different styles of programming.

For example, if we were using a [[Product - 1018 - PhidgetInterfaceKit 8/8/8 | Phidget Interface Kit]] as our device, the general calls would look like this:

====Step One: Initialize and Open====

For opening a remote Phidget over the network using the WebService:

<div class="source"><syntaxhighlight lang=java>
InterfaceKitPhidget device;
device = new InterfaceKitPhidget();

// Open first detected Interface Kit, remotely with IP address and port
device.open("192.168.3.33", 5001);
</syntaxhighlight></div>

For opening a Phidget directly attached to the tablet's USB port:

<div class="source"><syntaxhighlight lang=java>
InterfaceKitPhidget device;
com.phidgets.usb.Manager.Initialize(this);
device = new InterfaceKitPhidget();

// Open locally, with Phidget in tablet USB port
ik.open("192.168.3.33", 5001);
</syntaxhighlight></div>

The direct open call prevents any other instances from retrieving data from the Phidget, including other programs.
The one connection per device limit does not apply when exclusively using the Phidget WebService.

Both open calls will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately. We can handle this by using event driven programming and tracking the AttachEvents and DetachEvents....

====Step Two: Wait for Attachment (plugging in) of the Phidget====

To use the Phidget, it must be plugged in and a software event caught (i.e. attached).

Android Java is '''only''' event-driven, so you cannot use {{Code|waitForAttachment()}} without hanging and being relatively unsafe with your threads. Instead, you should define an event handler function that you can then synchronize and tie in with the attachment event itself.

First, let's write our handler:

<div class="source"><syntaxhighlight lang=java>
class AttachEventHandler implements Runnable {
Phidget device;
TextView eventOutput;

public AttachEventHandler(Phidget device, TextView eventOutput) {
this.device = device;
this.eventOutput = eventOutput; }

public void run() {
try {
// The actual useful thing our handler does
eventOutput.setText("Hello " + device.getDeviceName() + ", Serial " + Integer.toString(device.getSerialNumber()));
} catch (PhidgetException e) { e.printStackTrace(); }

// Notify whoever called us (and is waiting) that we're done
synchronized(this) { this.notify(); }
}
}
</syntaxhighlight></div>

This may seem complex, but really it is just:
# A class wrapper so we can work independently once we get permission from the main thread, and
# A way to call back to the {{Code|synchronized()}} call to let them know we're done and stay thread safe

Now that we have our 'handler' we can hook it in as an event function to trigger on device attachment:

<div class="source"><syntaxhighlight lang=java>
device.addAttachListener(new AttachListener() {
public void attached(final AttachEvent attachEvent) {
AttachEventHandler handler = new AttachEventHandler(attachEvent.getSource(), eventOutput);

// This is synchronised in case more than one device is attached before one completes attaching
synchronized(handler) {

runOnUiThread(handler);
try { handler.wait(); } catch (InterruptedException e) { e.printStackTrace(); }
}
}
});
</syntaxhighlight></div>

====Step Three: Do Things with the Phidget====

Again, because Android is event driven, use buttons (or timers) to schedule events if you want to poll the device at a certain interval or user specification. Otherwise, simply set the sensitivity and/or data rate (depending on your device type) and catch events as they come in using the handler structure above.

====Step Four: Close and Delete====

At the end of your program, don’t forget to call close to free any locks on the Phidget.

We can put the close() call for Phidgets in Android within an overridden version of the onDestroy() Android application function. Within it, we simply close the device. For Phidgets directly attached to a USB Android tablet, you should also call Uninitialize():

<div class="source"><syntaxhighlight lang=java>
@Override
protected void onDestroy() {
super.onDestroy();
try { device.close(); } catch (PhidgetException e) { e.printStackTrace(); }
// Uninitialize should only be called for directly connected Phidgets
com.phidgets.usb.Manager.Uninitialize();
}
</syntaxhighlight></div>

The ''complete'' set of functions you have available for all Phidgets can be found in the [http://www.phidgets.com/documentation/JavaDoc.zip Java API]. You can also find more description on any device-specific function either in the [[Device List|Device API]] page for calls available only on your specific Phidget.

==Common Problems and Solutions/Workarounds==

This section contains some Android Java and Eclipse-specific common problems. For more answers about using Phidgets, visit our forums, FAQ, or contact us.

{{ProblemSolution|Eclipse Error|Unable to get view server protocol version from device emulator}}

Likely Fix: Project → Clean... → Clean All (If that does not work, clean again and restart Eclipse)

{{ProblemSolution|Eclipse Error|Android requires compiler compliance level 5.0 or 6.0. Found 'X.Y' instead}}

Likely Fix: This may happen when running the examples. The javac and java version on the example do not match those on your computer.
* Find the version of java and javac on your computer (for example, <code>java -version</code> on the command line)
* In Eclipse, open the Package Explorer (Window → Show View → Package Explorer)
* Find the project, right-click and select Properties
* In Properties → Java Compiler → (Checkbox) Enable Project Specific Settings → Set Compiler Compliance Level = Java Version → Apply
* When told this requires rebuild, say Rebuild Now

Language - iOS

2012-04-20T16:41:28Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-iOS.png|64x64px|alt=|link=]]|applications are built using the Cocoa Touch framework and the Objective C programming language, both developed by [http://www.apple.com Apple].}}
__TOC__

==Introduction==

{{LanguageSupport|iOS|nearly the complete Phidget API, including events. As iOS devices do not have USB ports, Phidgets can only be remotely controlled over a network, by using the [[Phidget WebService]]|the Phidget InterfaceKit, Hello World examples and a Skeleton starter project.|Xcode on OS X.|}}

==Quick Downloads==
{{QuickDownloads|iOS|
* [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C API]|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip|(same file as iOS libraries)}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip|iOS|(same file as iOS examples)}}
{{MacQuickDownloads}}
}}

==Getting Started with Cocoa Touch==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
* Make sure your libraries are properly linked
* Go from source code to a test application as quickly as possible

As iOS development is primarily done on Xcode, we provide instructions for Xcode, specifically version 4.0.

====Use Our Examples====

Start by ensuring that the WebService is running on the computer that the Phidget is connected to. This computer needs to have an USB port and can be an OS X system or any other [[Software Overview#Operating System Support|operating systems]] we support. For directions on how to set up and run the WebService , refer to the page [[Software Overview#Operating System Support|for that operating system]]

Then on the the OS X system that will be used for developing iOS applications, download and unpack the [http://www.phidgets.com/downloads/examples/android-examples_2.1.8.20120216.tar.gz Phidget Examples for iOS]. The easiest way to confirm that your environment is set up properly will be to compile and run the HelloWorld iOS example.
Start by opening the HelloWorld.xcodeproj in Xcode.

Next, select your target destination that you want the application be ran on: an iOS device or simulator. For the purpose of this section, we will be using the simulator.

[[Image:IOS Xcode Destination.png||alt=|link=]]

To run the example, click on the {{Code|Run}} button.

[[Image:IOS Xcode Run.png||alt=|link=]]

This program will detect for Phidgets that are attached/detached on the host computer. Go ahead, and attach or detach your devices! Here is an example output:

[[Image:IOS Webservice Example HelloWorld Output.png||alt=|link=]]

After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your specific device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started Guide for your Device]]. Currently, the only device we provide example code for is the PhidgetInterfaceKit.

Once you have the iOS examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget iOS library. To begin:

1. Generate a new iOS Windows-based application project with a descriptive name such as PhidgetTest.

[[File:IOS NewProject 1.png|link=|alt=New Project]]

[[File:IOS NewProject 2.png|link=|alt=New Project]]

A {{Code|.xcodeproj}} project file will be created.

2. Set up the Provisioning Profiles and Code Signing settings, if necessary.

3. Download the [http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip Phidget iOS library] and extract it.

4. Inside, you will find the {{Code|iphoneos}} and the {{Code|iphonesimulator}} folders. Move the two folders as well as the {{Code|phidget21.h}} into the same directory as the newly created {{Code|.xcodeproj}} file.

5. In Xcode, open up the Project Settings → Build Settings.

6. In Linking → Other Linker Flags, follow these steps for both the Debug, and Release sections:

Select {{Code|Any iOS Simulator SDK}} and enter: {{Code|$(SRCROOT)/iphonesimulator/libPhidget21.a}}.

Select {{Code|Any iOS SDK}} and enter: {{Code|$(SRCROOT)/iphoneos/libPhidget21.a}}.

[[File:IOS Add Library.png|link=|alt=Add Library]]

7. In Search Paths → Header Search Paths, enter: {{Code|$(SRCROOT)}}.

[[File:IOS Add Header.png|link=|alt=Add Header]]

8. In the header file, add a reference to {{Code|phidget21.h}}:
<div class="source">
<syntaxhighlight lang=objc>
#import "phidget21.h"
</syntaxhighlight>
</div>

The project now has access to Phidgets and we are ready to begin coding.

Please note that the Phidget iPhone library also contains a sample skeleton xCode project for iOS. This project already contains project settings similar to those discussed above and it lets you quickly start on Phidgets development.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions above, you probably now have a working example and want to understand it better so you can change it to do what you want. This section has resources for you to learn from the examples and write your own.

Your main reference for writing iOS applications will be our C API information, with syntax for all of our functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in iOS|[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C API]}}

===API Support===

Most of the C API is supported in iOS, with the exception of the local open calls. This is because there are no USB ports on iOS devices, so only the remote open calls can be used.

The following open calls are unsupported:
<div class="source"><syntaxhighlight lang=objc>
int CPhidget_open(CPhidgetHandle phid, int serialNumber)
int CPhidget_openLabel(CPhidgetHandle phid, const char * label)
</syntaxhighlight></div>
===Code Snippets===

Specific calls in iOS will differ in syntax from those on the [[General Phidget Programming]] page, but the concepts stay the same.

It may help to have the [[General Phidget Programming]] page and this section open at the same time, because they parallel each other and you can refer to the Cocoa Touch syntax, as described on this page. However, many additional concepts are covered on the General Phidget Programming page on a high level, such as using multiple Phidgets, handling errors, and different styles of programming.

For example, if we were using a [[Product - 1018 - PhidgetInterfaceKit 8/8/8 | Phidget Interface Kit]] as our device, the general calls would look like this:

====Step One: Initialize and Open====

For opening a remote Phidget over the network using the WebService:

<div class="source"><syntaxhighlight lang=objc>
CPhidgetInterfaceKitHandle device;

// Open first detected Interface Kit, remotely with IP address and port
CPhidget_openRemoteIP((CPhidgetHandle)device, -1, "192.168.3.33", 5001, NULL);
</syntaxhighlight></div>

Since the WebService is used to connect to the Phidget, the one connection per device limit does not apply.

The open calls will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately. We can handle this by using event driven programming and tracking the attach events and detach events.

====Step Two: Wait for Attachment (plugging in) of the Phidget====

To use the Phidget, it must be plugged in (attached). We can handle this simply by calling {{Code|CPhidget_waitForAttachment}}. This function works for any Phidget. {{Code|CPhidget_waitForAttachment}} will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded:

<div class="source">
<syntaxhighlight lang=objc>
int serialNum;
CPhidget_waitForAttachment(10000);
CPhidget_getSerialNumber((CPhidgetHandle)device, &serialNum);
NSLog("%d attached!", serialNum);
</syntaxhighlight>
</div>

Sometimes, it makes more sense to handle the attachment via an event. This would be in instances where the Phidget is being plugged and unplugged, and you want to handle these incidents. Or, when you want to use event-driven programming because you have a GUI-driven program. In these cases, an event-driven code snippet to handle the attachment might look something like this.

First, you hook an event handler with the following code:
<div class="source">
<syntaxhighlight lang=objc>
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
...
CPhidgetManager_set_OnAttach_Handler(manager, gotAttach, self);
...
}
</syntaxhighlight>
</div>

Next, the callback method needs to be set up:
<div class="source">
<syntaxhighlight lang=objc>
// ========== Event Handling Setup Functions ==========
int gotAttach(CPhidgetHandle phid, void *context) {
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

//invokes the DeviceAttach event method on the main thread and block the main thread until after the DeviceAttach method finishes
//A bad access exception may occur if you set waitUntilDone to No
[(id)context performSelectorOnMainThread:@selector(DeviceAttach:)
withObject:[NSValue valueWithPointer:phid]
waitUntilDone:YES];
[pool release];
return 0;
}
</syntaxhighlight>
</div>

Above, the {{Code|DeviceAttach}} method is invoked on the main thread. The {{Code|NSAutoreleasePool}} object is created to clean up released objects on the event thread, and is released at the end of the method. The {{Code|DeviceAttach}} method is defined as follows:

<div class="source">
<syntaxhighlight lang=objc>
// ========== Event Handling Functions ==========
- (void)DeviceAttach:(NSValue *)phid
{
int phidgetSerial;
const char * phidgetName;

CPhidget_getSerialNumber((CPhidgetHandle)[phid pointerValue], &phidgetSerial);
CPhidget_getDeviceName((CPhidgetHandle)[phid pointerValue], &phidgetName);

outputField.text = [NSString stringWithFormat:@"%@Hello Device %@, Serial Number: %d\n\n", outputField.text, [NSString stringWithCString:phidgetName encoding:NSASCIIStringEncoding], phidgetSerial];
}
</syntaxhighlight>
</div>

With this function, the code inside {{Code|DeviceAttach}} will get executed every time the PhidgetInterfaceKit is attaches to the computer. Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets. Please refer to the API manual and the iOS examples for a list of events and their usage.

====Step Three: Do Things with the Phidget====

You can read data and interact with your Phidget both by polling it for its current state (or to set a state), or by catching events that trigger when the data changes.

For our [[Product - 1018 - PhidgetInterfaceKit 8/8/8 | PhidgetInterfaceKit]], the polling method of getting the current sensor state and setting an output state looks something like this:

<div class="source">
<syntaxhighlight lang=objc>

# Get a data point from Analog Port 0
int sensorValue;
CPhidgetInterfaceKit_getSensorValue(device, 0, &sensorValue);
[sensorValueTxt setintValue: sensorValue];

# Set digital output port 0 to be on
CPhidgetInterfaceKit_setOutputState(device, 0, 1);

</syntaxhighlight>
</div>

====Step Four: Close and Delete====

At the end of your program, don’t forget to call {{Code|CPhidget_close()}} and {{Code|CPhidget_delete()}} to free any locks on the Phidget that the {{Code|CPhidget_open()}} call put in place!

<div class="source">
<syntaxhighlight lang=objc>
CPhidget_close((CPhidgetHandle)ifkit);
CPhidget_delete((CPhidgetHandle)ifkit);
</syntaxhighlight>
</div>

The ''complete'' set of functions you have available for all Phidgets can be found in the [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C API]. You can also find more description on any device-specific function either in the [[Device List|Device API]] page for calls available only on your specific Phidget.

==Common Problems and Solutions/Workarounds==

Language - Visual Basic .NET

2012-04-20T16:40:07Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Visual Basic Net.png|64x64px|link=|alt=]]|Visual Basic .NET, developed by [http://www.microsoft.com Microsoft] is a modern object oriented programming language and the successor to [[Language - Visual Basic 6.0 | Visual Basic 6.0]].}}
__TOC__

==Introduction==

{{LanguageSupport|Visual Basic .NET|the complete Phidget API, including events|all Phidget devices.|the .NET or Mono framework. Both of the frameworks are supported on Windows. For Linux and OS X, only the Mono framework can be used. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]], [[#Visual Studio 2003 | Visual Studio 2003]], [[#MonoDevelop | MonoDevelop]] and the [[#Mono | Mono command line compilers]]|}}

==Quick Downloads==
{{QuickDownloads|Visual Basic .NET|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip .NET}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/VBNET_2.1.8.20120216.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip|.NET Framework Files|}}
{{WindowsQuickDownloads}}
}}

==Getting started with Visual Basic .NET==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

Instructions are divided up by operating system. Choose:
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#OS X |OS X]]
*[[#Linux | Linux]] (including PhidgetSBC)

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
Visual Basic .NET programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. By default, it is placed in {{Code|C:\Windows\System32}}.
You will also need one of the following two files, depending on the .NET framework version you are targeting:
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidget library for .NET framework <i><b>2.0</b></i> or higher. Your compiler has to know where this file is. By default, it is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidget library for .NET framework <i><b>1.1</b></i>. Your compiler has to know where this file is. By default, is is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
You can optionally install the following files:
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio/MonoDevelop. This documentation is also visible in the Object Browser in Visual Studio. By default, it is placed into {{Code|C:\Program Files\Phidgets}}.
* <b>{{Code|Policy.2.1.Phidget21.NET.dll}}</b> is the policy assembly for {{Code|Phidget21.NET.dll}}. Our installer places this file in the Global Assembly Cache(GAC) directory. It directs any programs compiled against version 2.1.0 or higher of {{Code|Phidget21.NET.dll}} to use the most recent installed version.

If you do not want to use our installer, you can download the five [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20111220.zip files].

Running the examples and writing your own code can be fairly environment-specific, so we include instructions for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]], [[#Visual Studio 2003 | Visual Studio 2003]], [[#MonoDevelop | MonoDevelop]] and the [[#Mono | Mono command line compiler]].

===Visual Studio 2005/2008/2010===

Microsoft makes free versions of Visual Studio available known as Express Editions. The Express editions are suitable for most applications, but are limited in features for more complex applications. Please see [http://www.microsoft.com/visualstudio Microsoft Visual Studio] for more information.

=====Use Our Examples=====

Please start by downloading the [http://www.phidgets.com/downloads/examples/VBNET_2.1.8.20120131.zip examples] and unpack them into a folder. While these examples were written in Visual Studio 2005 and Visual Studio 2008, Visual Studio 2010 will easily open and upgrade them with the Visual Studio Conversion Wizard.

[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]

To load all projects in Visual Studio, go to File → Open → Project, and open {{Code|AllExamples/AllExamples.sln}} or {{Code|AllExamples/AllExamples_vs2008.sln}} for Visual Studio 2005 and 2008, respectively.

This will load all of the examples available for Visual Basic .NET, and then you can set your main project to be the one that matches your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]].

The only thing left to do is to run the examples! Click on Debug → Start Debugging. Please note that the projects, by default try to find the {{Code|Phidget21.NET.dll}} in {{Code|C:\Program Files\Phidgets}}. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the type Phidget is not defined, please re-add the reference to {{Code|Phidget21.NET.dll}}. Please see the [[#Write Your Own Code | Write Your Own Code ]] section for details.

[[File:VBNET VS2005 Run.PNG|link=|alt=Run]]

Once you have the Visual Basic .NET examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget .NET library. To begin:

1. Generate a new Visual Basic .NET Console Application project with a descriptive name such as PhidgetTest.

[[File:VBNET VS2005 New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:VBNET VS2005 Add Reference 1.PNG|link=|alt=Add Reference]]

3. Under the .NET tab, select {{Code|Phidget21.NET.dll}}.
If you used our installer, these files are installed in {{Code|C:\Program Files\Phidgets}}, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.

[[File:VBNET VS2005 Add Reference 2.PNG|link=|alt=Add Reference]]

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.

===Visual Studio 2003===

=====Use Our Examples=====

As the Visual Basic .NET examples were written in Visual Studio 2005 and 2008, Visual Studio 2003 is not able to open the examples. Furthermore, it will be difficult to import the examples into your Visual Studio 2003 project as you will need to recreate the GUI components. Fortunately, taking a look at the source code will give you valuable programming insight. We have a [[#Follow the Examples|teaching ]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget .NET library.

1. Generate a new Visual Basic Console Application project with a descriptive name such as PhidgetTest.

[[File:VBNET VS2003 New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:VBNET VS2003 Add Reference 1.PNG|link=|alt=Add Reference]]

3. Under the .NET tab, select {{Code|Phidget21.NET1.1.dll}}.
If you used our installer, these files are installed in {{Code|C:\Program Files\Phidgets}}, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.

[[File:VBNET VS2003 Add Reference 2.PNG|link=|alt=Add Reference]]

The project now has access to the Phidget21 function calls and you are ready to begin coding.

The [[#Follow the Examples|teaching ]] section also has further resources for programming your Phidget.

===Mono===

This section will provide instructions on how to compile using the {{Code|vbnc}} compiler.

=====Use Our Examples=====

We do not have Visual Basic .NET examples for the Mono framework. Fortunately, you can take a look at the source code for our [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Visual Studio 2005 and 2008 examples] for valuable programming insight. We have a [[#Follow the Examples|teaching ]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your compiler to properly link the Phidget .NET library.

Place the {{Code|Phidget21.NET.dll}} in the same directory as your source code.
To compile and build an executable, run:
<div class="source">
<syntaxhighlight lang=bash>
vbnc /out:example.exe /r:Phidget21.NET.dll Example.vb
</syntaxhighlight>
</div>

Afterwards, you will have an executable named {{Code|example.exe}} that you can run. Type the following to run the program:
<div class="source">
<syntaxhighlight lang=bash>
mono example.exe
</syntaxhighlight>
</div>

The [[#Follow the Examples|teaching]] section also has further resources for programming your Phidget.

===MonoDevelop===

=====Use Our Examples=====

Download the [http://www.phidgets.com/downloads/examples/VBNET_2.1.8.20120131.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. These examples were written in Visual Studio 2005 and 2008, but are also compatible with MonoDevelop. Please note that the examples are only designed to be ran under the .NET framework. The examples are not compatible with the Mono framework. Despite this, if you are using the Mono framework, you can take a look at the source code for our [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Visual Studio examples] for valuable programming insight. We have a [[#Follow the Examples|teaching ]] section below to help you follow them.

The rest of this section will explain the steps needed to run our examples under the .NET framework. To load all projects in MonoDevelop, go to File → Open, and open {{Code|AllExamples/AllExamples.sln}}

This will load all of the examples available for Visual Basic .NET, and then you can set your main project to be the one that matches your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]].

[[File:VBNET Win MonoDevelop Startup Project.PNG|link=|alt=Start Up Project]]

The only thing left to do is to run the examples! Right click the project, and click on {{Code|Run With}} and select the Microsoft .NET framework. Please note that the projects, by default try to find the {{Code|Phidget21.NET.dll}} in the {{Code|C\Program Files\Phidgets}}. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the Phidget is not defined, please re-add the reference to {{Code|Phidget21.NET.dll}}. Please see the [[#Write Your Own Code 4 | Write Your Own Code]] section for details.

[[File:VBNET Win MonoDevelop Run.PNG|link=|alt=Run]]

Once you have the Visual Basic .NET examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget .NET library. To begin:

1. Create a new Visual Basic .NET console project with a descriptive name such as PhidgetTest.

[[File:VBNET Win MonoDevelop New Project.PNG|link=|alt=New Project]]

2. Add a reference to the Phidget .NET library.

[[File:VBNET Win MonoDevelop Add Reference 1.PNG|link=|alt=Add Reference]]

3. Select {{Code|Phidget21.NET.dll}}. If you used our installer, by default, this file is placed in {{Code|C:\Program Files\Phidgets}}. If it is in another location, please change the path to the file's location accordingly.

[[File:VBNET Win MonoDevelop Add Reference 2.PNG|link=|alt=Add Reference]]

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

==OS X==

Visual Basic .NET has excellent support on OS X through the Mono framework.

The first step in using Visual Basic .NET on Mac is to install the Phidget libraries. Compile and install them as explained on the [[Device List|getting started guide for your device]]. Then, the [[OS - OS X]] page also describes the different Phidget files, their installed locations, and their roles....

==Linux==

Visual Basic .NET has support on Linux through the Mono framework.

The first step in using Visual Basic .NET on Linux is to install the Phidget libraries. Compile and install them as explained on the main [[OS - Linux | Linux page]]. That Linux page also describes the different Phidget files, their installed locations, and their roles.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the Phidget .NET functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in .NET|[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

===Example Flow===

{{ExamplePseudocode|In Visual Basic .NET, you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in Visual Basic .NET is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}

==Code Snippets==

==Common Problems and Solutions/Workarounds==

Here you can put various frequent problems and our recommended solutions.

Language - Visual Basic 6.0

2012-04-20T16:39:03Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Visual Basic.png|64x64px|link=|alt=]]|Visual Basic 6.0, developed by [http://www.microsoft.com Microsoft] is a high level programming language that uses the COM programming model.}}
__TOC__

==Introduction==

{{LanguageSupport|Visual Basic 6.0|the complete Phidget API, including events|all Phidget devices.| the Microsoft Visual Basic 6 IDE|}}

==Quick Downloads==
{{QuickDownloads|Visual Basic 6.0|
{{APIQuickDownloads|http://www.phidgets.com/documentation/COM_API_Manual.pdf COM}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/VB6_2.1.8.20120131.zip|}}|
{{WindowsQuickDownloads}}
}}

==Getting started with Visual Basic 6.0==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

==Windows (2000/XP/Vista/7)==

===Description of Library Files===
Visual Basic 6.0 programs on Windows depend on two files, which the installers in [[#Libraries and Drivers|Quick Downloads]] put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. By default, it is placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|Phidget21COM.dll}}</b> is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. Your compiler has to know where this file is, by default our installer places this file into {{Code|C:\Program Files\Phidgets}}, so you can either point your compiler to that location, or copy and link to it in a directory for your project workspace. If you are manually installing this file, you must register it through command line by running: {{Code|regsvr32 Phidget21COM.dll}}.

If you do not want to use our installer, you can download both [http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip files] and manually install them where you want; refer to our [[OS_-_Windows#Manual_File_Installation | Manual Installation Instructions]].

We include instructions on [[#Use Our Examples | using our examples]] and [[#Write Your Own Code | writing your own code]] for the Microsoft Visual Basic 6.0 IDE.

====Visual Basic 6.0====

=====Use Our Examples=====

To run the examples, you first download the [http://www.phidgets.com/downloads/examples/VB6_2.1.8.20120131.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]].

1. Open up the {{Code|.vbp}} project into the Visual Basic IDE.

2. Next, navigate to Project → Components to ensure that your project has access to the Phidget ActiveX objects

[[File:VB6 Components.PNG|link=|alt=Components]]

3. The Components menu will show up. Ensure that the Phidget COM library is selected. If it is not, then browse for {{Code|Phidget21COM.dll}} and add it. By default, it is placed in {{Code|C:\Program Files\Phidgets}}. Accept the changes.

[[File:VB6 Library.PNG|link=|alt=Library]]

4. Navigate to Project → References and ensure that the Phidget COM library is selected.

[[File:VB6 References.PNG|link=|alt=References]]

5. The only thing left to do is to run the examples! Click on Run → Start.

[[File:VB6 Run.PNG|link=|alt=Run]]

Once you have the Visual Basic 6.0 examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

=====Write Your Own Code=====

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget COM library. To begin:

1. Generate a new Standard EXE project.

[[File:VB6 New Project.PNG|link=|alt=New Project]]

2. Next, navigate to Project → Components to add the Phidget ActiveX objects into your project.

[[File:VB6 Components.PNG|link=|alt=Components]]

3. The Components menu will show up. Browse for {{Code|Phidget21COM.dll}} and add it. By default, it is placed in {{Code|C:\Program Files\Phidgets}}. Accept the changes.

[[File:VB6 Library.PNG|link=|alt=Library]]

4. Navigate to Project → References and ensure that the Phidget COM library is selected.

[[File:VB6 References.PNG|link=|alt=References]]

5. Navigate to Project → Project1 Properties, select the {{Code|Make}} tab and ensure that the {{Code|Remove information about unused ActiveX Controls}} checkbox is unchecked.

[[File:VB6 Unused ActiveX Controls.PNG|link=|alt=Unused ActiveX Controls]]

6. Then, you will need to declare and initialize the Phidget ActiveX object for your device.

The simplest method is to place the Phidget ActiveX object from the toolbox directly onto your form. If the toolbox is not present on your screen, navigate to View → Toolbox to show the toolbar. Next, find the ActiveX object for your device in the toolbox, and double click it to add it to the form.

[[File:VB6 Toolbox ActiveX.PNG|link=|alt=Accessing Phidget ActiveX objects from the toolbox]]

Alternatively, you can dynamically create the Phidget ActiveX object in code. For example, for an PhidgetInterfaceKit, you would type:

<div class="source">
<syntaxhighlight lang=vb>
Dim WithEvents PhidgetInterfaceKit As PhidgetInterfaceKit

Private Sub Form_Load()
...
Set PhidgetInterfaceKit = Controls.Add("Phidget21COM.PhidgetInterfaceKit", "PhidgetInterfaceKit")
...
End Sub
</syntaxhighlight>
</div>

The object name for each type of Phidget is listed in the [http://www.phidgets.com/documentation/COM_API_Manual.pdf COM API Manual]. Please see the [http://www.phidgets.com/downloads/examples/VB6_2.1.8.20120131.zip examples] on how to add a reference to your particular Phidget.

The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next comes our API information, with syntax for all of our functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in Visual Basic 6.0|[http://www.phidgets.com/documentation/COM_API_Manual.pdf COM API Manual]}}

===Example Flow===

{{ExamplePseudocode|In Visual Basic 6.0, you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget library below in the Main Code section. This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in Visual Basic 6.0 is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a PhidgetSpatial object. The examples show how to do this and other API functions|
[http://www.phidgets.com/documentation/COM_API_Manual.pdf COM API Manual]}}

==Common Problems and Solutions/Workarounds==
{{ProblemSolution|Windows|My application does not compile when a function contains more than one parameter.}}

In Visual Basic 6.0, the common way to handle multiple parameters is to not enclose the parameters with brackets. For example, instead of:
<div class="source">
<syntaxhighlight lang=vb>
Object.getProperty(Parameter1, Parameter2)
</syntaxhighlight>
</div>

You should write:
<div class="source">
<syntaxhighlight lang=vb>
Object.getProperty Parameter1, Parameter2
</syntaxhighlight>
</div>

If you wish, you can run the function with the parameters enclosed in brackets if you explicitly use the {{Code|Call}} keyword when running the function. For example:

<div class="source">
<syntaxhighlight lang=vb>
Call Object.getProperty(Parameter1, Parameter2)
</syntaxhighlight>
</div>