Phidgets 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 - 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

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 - 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 - macOS

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 - macOS

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 - macOS

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 - Max

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 - 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 - 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 - Visual Basic

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 - Python

2012-04-20T16:36:48Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Python.png|64x64px|link=|alt=Python]]|Python is an object oriented programming language developed by the [http://www.python.org/psf/summary/ Python Software Foundation], is powerful and easy to learn.}}
__TOC__

==Introduction==

{{LanguageSupport|Python|the complete Phidget API, including events|all Phidget devices.|Windows, OS X and Linux. We provide instructions on how to set up your environment for [[#Command line | command line]], [[#IDLE | IDLE]], and [[#Eclipse with PyDev | Eclipse with PyDev]]|

Only Python 2.5 or higher is supported.}}

==Quick Downloads==

{{QuickDownloads|Python|
{{APIQuickDownloads|http://www.phidgets.com/documentation/PythonDoc.zip}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/Python_2.1.8.20120131.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/PhidgetsPython_2.1.8.20120131.zip|Python|}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
{{LinuxQuickDownloads}}
}}

==Getting started with Python==

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===
Python 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. You will need to manually put the Phidget Python Module 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|Phidget Python Module}}</b> is the Phidget library for Python.
* <b>{{Code|setup.py}}</b> is used to install the Phidget module into the standard location for third party Python modules. On typical Python environments, this setup will install the Phidget Python module in the {{Code|site-packages}} directory.

If you do not want to use our installer, you can download the [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20111220.zip {{Code|phidget21.dll}}].

The first thing you will have to do is to [[#Installing the Phidget Python Module |install the {{Code|Phidget Python Module}}]].
Afterwards, Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each environment below.

===Installing the Phidget Python Module===

Please start by downloading [http://www.phidgets.com/downloads/libraries/PhidgetsPython_2.1.8.20120131.zip Phidget Python Module]. After extracting the file, open up a command line terminal, traverse to the directory containing {{Code|setup.py}} and enter the following to install the Phidget Python module into the Python environment.

<div class="source">
<syntaxhighlight lang=bash>
python setup.py install
</syntaxhighlight>
</div>

===Command Line===

====Use Our Examples====
Please ensure that the Phidget Python Module is [[#Installing the Phidget Python Module | installed]] onto your system.

Next, download the [http://www.phidgets.com/downloads/examples/Python_2.1.8.20120131.zip examples] and unpack them into a folder. While these examples were written in Python 3.0, they are also compatible with Python 2.5(with a [[#All Operating Systems: The examples produces an error while running in a Python 2.5 environment. | minor modification]]). 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]].

Now, open up a command line prompt and navigate to the directory of the example folder.

Next, enter the following to run the example:

<div class="source">
<syntaxhighlight lang=bash>
python example.py
</syntaxhighlight>
</div>

Once you have the Python 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 Phidgets Python libraries. Please see the [[#Use Our Examples| Use Our Examples ]] section for instructions.

Then, in your code, you will need to reference to the Phidget Python library.

<div class="source">
<syntaxhighlight lang=python>
from Phidgets.PhidgetException import *
from Phidgets.Events.Events import *
</syntaxhighlight>
</div>

Then, you will also have to add a reference to your particular Phidget. For example, you would include the following line for a PhidgetInterfaceKit:
<div class="source">
<syntaxhighlight lang=python>
from Phidgets.Devices.InterfaceKit import *
</syntaxhighlight>
</div>

Please see the [http://www.phidgets.com/downloads/examples/Python_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.

===IDLE===

====Use Our Examples====

Please ensure that the Phidget Python Module is [[#Installing the Phidget Python Module | installed]] onto your system.

Next, download the [http://www.phidgets.com/downloads/examples/Python_2.1.8.20120131.zip examples] and unpack them into a folder. While these examples were written in Python 3.0, they are also compatible with Python 2.5(with a [[#All Operating Systems: The examples produces an error while running in a Python 2.5 environment. | minor modification]]). 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]]. Now, open the example in the IDLE editor.

The only thing left to do is to run the examples! Click on Run → Run Module.

[[File:Python IDLE Run.PNG|link=|alt=Run?]]

Once you have the Python 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 Python library. Please see the [[#Use Our Examples 2| Use Our Examples ]] section for instructions.

Then, in your code, you will need to reference to the Phidget Python library.

<div class="source">
<syntaxhighlight lang=python>
from Phidgets.PhidgetException import *
from Phidgets.Events.Events import *
</syntaxhighlight>
</div>

Then, you will also have to add a reference to your particular Phidget. For example, you would include the following line for a PhidgetInterfaceKit:
<div class="source">
<syntaxhighlight lang=python>
from Phidgets.Devices.InterfaceKit import *
</syntaxhighlight>
</div>

Please see the [http://www.phidgets.com/downloads/examples/Python_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.

===Eclipse with PyDev===

====Use Our Examples====

1. Please ensure that the Phidget Python Module is [[#Installing the Phidget Python Module | installed]] onto your system.

2. Next, download the [http://www.phidgets.com/downloads/examples/Python_2.1.8.20120131.zip examples] and unpack them into a folder. While these examples were written in Python 3.0, they are also compatible with Python 2.5(with a [[#All Operating Systems: The examples produces an error while running in a Python 2.5 environment. | minor modification]]). 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]]. You will need this example source code to be imported into your project later on.

3. Next, a new project will need to be created. Generate a new PyDev project with a descriptive name such as PhidgetTest.

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

4. To import the example program into your project, right click the Project and select {{Code|Import}}.

[[File:Python PyDev Import File 1.PNG|link=|alt=Import File]]

5. On the next screen, select {{Code|File System}} and proceed to the next screen.

[[File:Python PyDev Import File 2.PNG|link=|alt=Import File]]

6. Browse to the directory where you extracted the examples into, and select the example you wish to open.

[[File:Python PyDev Import File 3.PNG|link=|alt=Import File]]

7. The only thing left to do is to run the examples! Click on Run → Run.

[[File:Python PyDev Run.PNG|link=|alt=Run?]]

Once you have the Python 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 Python library. Please see the [[#Use Our Examples 3 | Use Our Examples ]] section for instructions.

Then, in your code, you will need to include a reference to the Phidget Python library.

<div class="source">
<syntaxhighlight lang=python>
from Phidgets.PhidgetException import *
from Phidgets.Events.Events import *
</syntaxhighlight>
</div>

You will also have to add a reference to your particular Phidget. For example, you would include the following line for a PhidgetInterfaceKit:
<div class="source">
<syntaxhighlight lang=python>
from Phidgets.Devices.InterfaceKit import *
</syntaxhighlight>
</div>

Please see the [http://www.phidgets.com/downloads/examples/Python_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.

==OS X==

Python has excellent support on OS X.

The first step in using Python 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==

Python has excellent support on Linux.

The first step in using Python on Linux is to install the Phidget libraries. These are the core Phidget libraries, written in C, which when compiled become part of the programming libraries available to your system. Download, compile, and install from the links and instructions on the main [[OS - Linux | Linux page]]. That Linux page also describes the different Phidget files, their installed locations, and their roles.

The next step is to install the Phidget Python module. Download it here:
* [http://www.phidgets.com/downloads/libraries/PhidgetsPython_2.1.8.20120216.zip Phidget Python Module]

Then, unpack the module and enter the root of the newly unzipped directory. There will be a script in the base directory called {{Code|setup.py}}. This is used the same way as most other distributed Python modules - from a command line type:

<div class="source">
<syntaxhighlight lang=bash>
python setup.py install
</syntaxhighlight>
</div>

This will build the module and install the built python module files into your {{Code|site-packages}} directory.

===Use Our Examples===

First, download the examples:
*[http://www.phidgets.com/downloads/examples/Python_2.1.8.20120216.zip Phidget Python Examples]

Unpack them, and enter the root directory. You will find examples specific to each Phidget device, as well as a {{Code|HelloWorld.py}} example. The {{Code|HelloWorld.py}} code is probably the easiest example to run as it will work with any Phidget device. Or you can use the example specific to your Phidget. In that case, find the source file that is 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]].

The Phidget examples were written in Python 3.0 and this tutorial assumes its use. However, they should still be compatible with Python 2.6. To run the examples using Python 2.5, you will need to modify the example code in the exception handling to read “except RuntimeError, e:”, instead of “except RuntimeError as e:”.

If needed, make those changes to the {{Code|HelloWorld.py}} example or the one for your Phidget.

Then, if you have not set up [[OS_-_Linux#Setting_udev_Rules|your udev rules for USB access]], you will need to run the Python example as '''root''':

<div class="source">
<syntaxhighlight lang=bash>
sudo python HelloWorld.py
</syntaxhighlight>
</div>

===Write Your Own Code===

When writing your code from scratch, you start it as you would any Python code on Linux, such as within a text editor like Emacs, Vi, Gedit, or Kate. In your '''{{Code|.py}}''' source code file, you must include a reference to the Phidget module:

<div class="source">
<syntaxhighlight lang=python>
from Phidgets.PhidgetException import *
from Phidgets.Events.Events import *
</syntaxhighlight>
</div>

In addition, you should include the module functions for your specific device. In the case of the Interface Kit, this would be:

<div class="source">
<syntaxhighlight lang=python>
from Phidgets.Devices.InterfaceKit import *
</syntaxhighlight>
</div>

For other devices, it would be the software object you found when running the examples above. Then, you would run your Python code the same way as the examples.

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 Python examples and which has resources such as the API reference.

==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 Python code will be our Python API information, with syntax for all of our functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in Python|[http://www.phidgets.com/documentation/PythonDoc.zip Python API]}}

===Example Flow===

{{ExamplePseudocode|In Python, you can name these '''event''' functions whatever you like. You will then pass their function names 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 Python 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/PythonDoc.zip Python API]}}

===Code Snippets===

Specific calls in Python 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 Python 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=python>
# Create
try:
device = InterfaceKit()
except RuntimeError as e:
print("Runtime Error: %s" % e.message)

# Open
try:
device.openPhidget()
except PhidgetException as e:
print (“Phidget Exception %i: %s” % (e.code, e.detail))
exit(1)
</syntaxhighlight>
</div>

The variable {{Code|device}} is now a handle for the Phidget. This example is ''specific to the Interface Kit'' because the call InterfaceKit() is used. For another device, use the correspondingly named call in the Python API.

The handle '''device''' is then used for all the Python function calls using the Phidget for its device-specific functions - in this case, Interface Kit specific functions. 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.

Also note that you can catch exceptions thrown by the Phidget library as we did above when using the openPhidget() call. In other words, this should probably be present around most of your Phidget calls, especially when you are learning how to use the Phidget and debugging your code:

<div class="source">
<syntaxhighlight lang=python>
try:
# Your code goes here
except PhidgetException as e:
print (“Phidget Exception %i: %s” % (e.code, e.detail))
exit(1)
</syntaxhighlight>
</div>

====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 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=python>
device.waitForAttach(10000)
print ("%d attached!" % (device.getSerialNum()))
</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:

<div class="source">
<syntaxhighlight lang=python>
def AttachHandler(event):
attachedDevice = event.device
serialNumber = attachedDevice.getSerialNum()
deviceName = attachedDevice.getDeviceName()
print("Hello to Device " + str(deviceName) + ", Serial Number: " + str(serialNumber))

# Insert code for -creating- device here....

try:
device.setOnAttachHandler(AttachHandler)
except PhidgetException as e:
# Insert code for handling any exceptions
# A common exception will occur if you do not create the device properly above

# Insert code for -opening- device here....
</syntaxhighlight>
</div>

====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 | Phidget Interface Kit]], the polling method of getting the current sensor state and setting an output state looks something like this:

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

# Get a data point from Analog Port 0
device.getSensorValue(0)

# Set digital output port 0 to be on
device.setOutputState(0, 1)

</syntaxhighlight>
</div>

To catch data changes via events, you would use something like this:

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

def sensorChanged(e):
print (“Sensor %i: %i” % (e.index, e.value))
return 0

# Insert code to create an Interface Kit called 'device'

# Hook our function above into the device object
device.setOnSensorChangeHandler(sensorChanged)

# Insert code to open 'device'

</syntaxhighlight>
</div>

====Step Four: Close and Delete====

At the end of your program, don’t forget to call closePhidget() to free any locks on the Phidget that the openPhidget() call put in place!

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

device.closePhidget()

</syntaxhighlight>
</div>

The ''complete'' set of functions you have available for all Phidgets can be found in the [http://www.phidgets.com/documentation/PythonDoc.zip Python 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==

==={{ProblemSolution|OS X|My application hangs when using multiple devices in a single Python application.}}===

A call to {{Code|open}} may hang indefinitely if multiple devices are being programmed in a single Python application. To circumvent this, allow the application to delay a short period between {{Code|open}} calls. For most environments, a 1.25 millisecond delay is enough. For example:
<div class="source">
<syntaxhighlight lang=python>
import time
...
interface_kit.openPhidget(94695)
time.sleep(0.00125)
rfid.openPhidget(33502)
</syntaxhighlight>
</div>

==={{ProblemSolution|All Operating Systems|The examples produce an error while running in a Python 2.5 environment.}}===

Running the examples produces an error similar to the following:
<div class="source">
<syntaxhighlight lang=python>
InterfaceKit-simple.py:33: Warning: 'as' will become a reserved keyword in Python 2.6
File "InterfaceKit-simple.py", line 33
except RuntimeError as e:
SyntaxError: invalid syntax
</syntaxhighlight>
</div>

To run the example code in Python 2.5, all the lines containing:
<div class="source">
<syntaxhighlight lang=python>
except RuntimeError as e:
</syntaxhighlight>
</div>
will need to be replaced with:
<div class="source">
<syntaxhighlight lang=python>
except Runtime, e:
</syntaxhighlight>
</div>

Language - Java

2012-04-20T16:35:49Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-Java.png|64x64px|link=|alt=Java]]|Java is a modern, object-oriented programming language maintained by Oracle.}}
__TOC__

==Introduction==

{{LanguageSupport|Java|the complete Phidget API, including events|all Phidget devices.|the {{Code|javac}} command line compiler as well as in integrated development environments(IDEs) such as [[#NetBeans | NetBeans]] and [[#Eclipse | Eclipse]]|}}

==Quick Downloads==

{{QuickDownloads|Java|
{{APIQuickDownloads|http://www.phidgets.com/documentation/JavaDoc.zip}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20111220.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/phidget21jar_2.1.8.20111220.zip|Java|(phidget21.jar)}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
{{LinuxQuickDownloads}}
}}

==Getting started with Java==

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===
Java programs on Windows depend on two files, which the installers in the [[#Libraries and Drivers | Quick Downloads]] section 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|phidget21.jar}}</b> is the Phidget Java library for JDK <i><b>1.4.2</b></i> or higher. Your compiler has to know where this file is. By default, it is placed 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. For more information, please see the section for your specific compiler/environment.

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}}] as well as the [http://www.phidgets.com/downloads/libraries/phidget21jar_2.1.8.20120131.zip {{Code|phidget21.jar}}] and manually install them where you want; refer to our [[OS_-_Windows#Manual_File_Installation|Manual Installation Instructions]].

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

You can program Phidgets with Java in command line with the {{Code|javac}} compiler as well as in IDEs such as NetBeans and Eclipse.

===Javac (Command Line)===

====Use Our Examples====

Download the [http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20111220.zip example] 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 are intended for the [[#NetBeans | NetBeans IDE]].

Ensure that the {{Code|phidget21.jar}} is in the same directory as the source code.

To compile in Windows command prompt:
<div class="source">
<syntaxhighlight lang=bash>
javac -classpath .;phidget21.jar example.java
</syntaxhighlight>
</div>

This will create Java bytecode in the form of {{Code|.class}} files. Type the following to run the program:
<div class="source">
<syntaxhighlight lang=bash>
java -classpath .;phidget21.jar example
</syntaxhighlight>
</div>

If you wish, you can compile the project as a {{Code|.jar}} so there are fewer files to maintain. The [[http://www.oracle.com/java Java SDK]] provides the {{Code|jar}} utility which packages all the {{Code|.class}} files into a single {{Code|.jar}} file.
To begin, you will have to provide a Manifest file to indicate the program entry point. With your favourite text editor, create a new file with the following content:
<div class="source">
<syntaxhighlight lang=text>
Manifest-Version: 1.0
Class-Path: phidget21.jar
Main-Class: example
</syntaxhighlight>
<br/>
</div>
Ensure that the file ends in a single new line or a carriage return character.
Save the file as {{Code|example.mf}} and place it in the same directory as the other {{Code|.class}} files.
Next, create the .{{Code|jar}} with:
<div class="source">
<syntaxhighlight lang=bash>
jar -cfm example.jar example.mf *.class
</syntaxhighlight>
</div>
Afterwards, you can run the {{Code|.jar}} with:
<div class="source">
<syntaxhighlight lang=bash>
java -jar example.jar
</syntaxhighlight>
</div>
Once you have the Java 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 Java library. Please see the [[#Use Our Examples| previous]] section for instructions.

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

<div class="source">
<syntaxhighlight lang=java>
import com.phidgets.*;
import com.phidgets.event.*;
</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.

===NetBeans===

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

You first download the [http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20111220.zip examples], unpack them into a folder, and then find the source code for your device. The source file will be named the same as the software object 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]]. The full examples were written in NetBeans, so the rest of this section will use these examples. To use the simple examples, you will have to import the source code into a new NetBeans project.

[[File:Java NetBeans Open Project.PNG|link=|alt=Open Project]]

The only thing left to do is to run the examples! Click on Run → Run Project. The project, by default tries to find the {{Code|phidget21.jar}} in {{Code|..\..\lib}}.

[[File:Java NetBeans Run.PNG|link=|alt=Run]]

Once you have the Java 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 Java library. To begin:

1. Create a new Java application project with a descriptive name such as PhidgetTest.

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

2. Add a reference to the Phidget Java library. In the projects pane, right click {{Code|Libraries}} and add the {{Code|jar}}.

[[File:Java NetBeans Add Jar.PNG|link=|alt=Add Jar]]

3. Find and select {{Code|phidget21.jar}}.

[[File:Java NetBeans Add Jar 2.PNG|link=|alt=Add Jar]]

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

<div class="source">
<syntaxhighlight lang=java>
import com.phidgets.*;
import com.phidgets.event.*;
</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.

===Eclipse===

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

1. Download the [http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20111220.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 use the simple examples. The full examples were written in NetBeans, and are not compatible with Eclipse. The rest of this guide will assume that the simple examples are used. The example source code will be copied into your Eclipse project later on. Keep note of the file name of the example as a Java class will be created with the same name.

2. Generate a new Java project with a descriptive name such as PhidgetTest. Click next.

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

3. On the next screen, go to the libraries panel and add an external {{Code|jar}}.

[[File:Java Eclipse Add Jar 1.PNG|link=|alt=Add Jar]]

4. Find and select {{Code|phidget21.jar}}.

[[File:Java Eclipse Add Jar 2.PNG|link=|alt=Add Jar]]

5. Add a new Java class to the project.

[[File:Java Eclipse New Class.PNG|link=|alt=New Class]]

6. Name this class with the same name as the simple example's name.

[[File:Java Eclipse New Class 2.PNG|link=|alt=New Class]]

7. Copy and paste the example source code over to the class you created.

[[File:Java Eclipse Source.PNG|link=|alt=Source Code]]

8. The only thing left to do is to run the examples!

[[File:Java Eclipse Run.PNG|link=|alt=Run]]

Once you have the Java 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 Java library. Please see the [[#Use Our Examples 3| Use Our Examples]] section for instructions.

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

<div class="source">
<syntaxhighlight lang=java>
import com.phidgets.*;
import com.phidgets.event.*;
</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.

==Mac OS==

{{ContentNeeded|This section needs to be filled in}}

Java has excellent support on OS X through the Java Compiler.

The first step in using Java 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....

===Use Our Examples===

The command to compile in a OS X and Linux terminal are slightly different. Rather than prefixing {{Code|phidget21.jar}} with a semi-colon( {{Code|;}} ), a colon( {{Code|:}} ) is used:

<div class="source">
<syntaxhighlight lang=bash>
javac -classpath .:phidget21.jar example.java
</syntaxhighlight>
</div>

Then, to run the program:

<div class="source">
<syntaxhighlight lang=bash>
java -classpath .:phidget21.jar example
</syntaxhighlight>
</div>

Perhaps refer to the Windows section of Eclipse and Netbeans for further information?

===Write Your Own Code===

==Linux==

Java has excellent support on Linux - there is an established implementation of the Java compiler and interpreter, and several Integrated Development Environments (IDEs) including NetBeans and Eclipse.

The first step in using Java on Linux is to install the base Phidget libraries. Compile and install them as explained on the main [[OS - Linux | Linux page]]. That Linux page also describes the different basic Phidget library files, their installed locations, and their roles.

You will also need the [http://www.phidgets.com/downloads/libraries/phidget21jar_2.1.8.20120131.zip Phidget Java Libraries (phidget21.jar)].

Once downloaded, the {{Code|phidget21.jar}} library file does not get 'installed' (i.e. do not run {{Code| java -jar phidget21.jar}}). Rather, the library file gets put into the path of whatever program you write, and you will link it via both the java compiler and the java interpreter. We walk you through this below.

We have two different types of Phidget examples in Java:
*Simple examples, to be run on the command line, and
*Full examples, to be run in NetBeans

Both are contained within the [http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20120131.zip Phidget Java example download package].

===Description of Library Files===

The Phidget Java libraries depend on the C libraries being installed as explained on the main [[OS - Linux | Linux page]]. If you browse around within the phidget21.jar archive, you will find Java class files (too many to reasonably list here) that have names related to the devices they provide an API for.

These Java class files use the functions available in the ''dynamic'' Phidget21 C-language library on Linux. Dynamic libraries end with {{Code|.so}}, and so the C library that the Phidget Java class files use is {{Code|/usr/lib/libphidget21.so}}.

===Javac (Command Line)===

====Use Our Examples====

Linux gets somewhat complicated in that two Java compilers exist: {{Code|openjdk}} and {{Code|gcj}}. Furthermore, a given IDE can ''usually'' use either compiler. That being said, we only offer support here for openJDK and IDEs running openJDK.

To find out which type of compiler your computer has, use the {{Code|-version}} option on the command line. You can use the same option for your runtime environment (interpreter):

<div class="source">
<syntaxhighlight lang=text>
$> java -version
java version "1.6.0_23"
OpenJDK Runtime Environment (IcedTea6 1.11pre) (6b23~pre11-0ubuntu1.11.10.1)
OpenJDK 64-Bit Server VM (build 20.0-b11, mixed mode)

$> javac -version
javac 1.6.0_23
</syntaxhighlight>
</div>

The good news is that you can have both {{Code|openjdk}} and {{Code|gcj}} on your machine, co-habitating happily. There can be only one linked java and javac in {{Code|/usr/bin/}} however, and so this will correspond to whichever java compiler and interpreter you installed last.

If you do not have {{Code|openjdk}} installed already (this is the default Java installation for most Linux machines, so you will probably know), and you choose to install it for Phidget purposes, it is important is that the {{Code|java}} version be greater than the {{Code|javac}} version. Otherwise, your runtime environment will consider the stuff your compiler produces to be newfangled nonsense. So when installing Java from a repository, you should install both the jdk and the jre. These are, unfortunately, usually separate packages in a repository (e.g. {{Code|openjdk-7-jre}} and {{Code|openjdk-7-jdk}}).

The simple examples in Java are meant to be compiled and run on the command line. The example package includes a {{Code|Makefile}} so you can either make all of the examples at once, with:

<div class="source">
<syntaxhighlight lang=bash>
make all
</syntaxhighlight>
</div>

...Or you can make them individually. You should pick out the example with the name that corresponds to the family of your Phidget hardware. If you're not sure what the family (software object) is, you can find out on the product API [[Device List|for your device]]. Once you've identified the right example - say, {{Code|HelloWorld.java}}, which will work with any Phidget - compile it on the command line with:

<div class="source">
<syntaxhighlight lang=bash>
javac -classpath .:phidget21.jar HelloWorld.java
</syntaxhighlight>
</div>

To run the example on a Linux machine [[OS - Linux#Setting udev Rules| without your udev USB rules set]], you will need to run the Java example as root:

<div class="source">
<syntaxhighlight lang=bash>
sudo java -classpath .:phidget21.jar HelloWorld
</syntaxhighlight>
</div>

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

You'll note that the Phidget Java library file {{Code|phidget21.jar}} needs to be explicitly linked at both points in the compile and run process. Alternatively, you can make a jar file which includes the Phidget Java library. This process takes two steps, the first of which is creating a text file called {{Code|MyProgram.mf}}, where {{Code|MyProgram}} is replaced by the name of your main class in both the filename and the text below:

<div class="source">
<syntaxhighlight lang=text>
Manifest-Version: 1.0
Class-Path: phidget21.jar
Main-Class: MyProgram

</syntaxhighlight>
</div>

'''Note:''' The manifest file should end with a carriage return. So, there should be an extra line at the bottom of the file.

After creating the manifest file, you can use the {{Code|jar}} function to create one self-contained file with your classes and the correct classpath.

<div class="source">
<syntaxhighlight lang=bash>
jar –cfm MyProgram.jar MyProgram.mf *.class
</syntaxhighlight>
</div>

If porting this for an external system, such as one that your customer would be running, the Phidget library would need to be compiled and distributed along with the {{Code|.jar}}. Although we do not directly support this, if you are interested in how to construct this, we provide both a distribution example and information on cross-compiling:
* The [[Language - Android Java | Android Java]] libraries have an ARM-compiled {{Code|libphidget21.so}} file included, as an example of distributing a compiled libphidget21.so with the jar file
* The [[OS - Linux#Cross-Compiling with a Custom Toolchain|Linux page]] has more detail for compiling the Phidget C Libraries for an external target.

===NetBeans===

We offer in-depth tutorials on using our examples in NetBeans and Eclipse in the [[#NetBeans|Windows NetBeans]] and [[#Eclipse|Windows Eclipse]] sections.

As our full examples are written with NetBeans, but NetBeans is not part of the standard Linux package repository, we offer installation instructions here before referring to the Windows sections.

====Installation====

Although Eclipse is standard in the Debian/Ubuntu package repository, NetBeans is no longer standard. What is more, Netbeans does not install by default into a folder within your path. As our Phidget full Java examples are written using NetBeans, we provide basic installation instructions here so you can actually run them.

To install NetBeans:

1. Download the install script from website: [http://netbeans.org/downloads/ http://netbeans.org/downloads/]<br>
2. Change the permissions of the downloaded file to be executable. Usually, this is something like:
:{{Code|chmod +x netbeans-7.1-ml-javase-linux.sh}}<br>
3. Run the downloaded file as a script. (This will result in a GUI interaction that walks you through installation.)<br>
4. To find the location where the NetBeans installation occurred, run:<br>
:{{Code|updatedb}}
:{{Code|locate netbeans | grep bin}}<br>
5. Usually, the location of the binary is {{Code|/usr/local/netbeans-7.1/bin/netbeans}}, where 7.1 is the installed version.

====Use Our Examples====

Once you have NetBeans installed, running our examples will be very similar to the process described in the [[#NetBeans|Windows NetBeans]] 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 Java library. Please see the [[#NetBeans| Windows NetBeans]] section for instructions if you are unfamiliar with NetBeans.

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

<div class="source">
<syntaxhighlight lang=java>
import com.phidgets.*;
import com.phidgets.event.*;
</syntaxhighlight>
</div>

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

The [[#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 Phidgets Java methods:

{{UsingAPhidgetInCodeGeneral|both of which are available in Java|[http://www.phidgets.com/documentation/JavaDoc.zip Java API]}}

===Example Flow===

{{ExamplePseudocode|In Java, 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. Some 'get data' functions are also specific to each device.
|Creating a Phidget software object in Java - when you are not using the Manager - is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|SpatialPhidget}} object. The device-specific examples show how to do this and other API functions.<br><br>
The software object provides device specific methods which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/JavaDoc.zip Java API]}}

==Common Problems and Solutions/Workarounds==

None yet.

Language - C

2012-04-20T16:35:08Z

Djrudiak:

[[Category:Language]]
{{OSLang|[[File:icon-C++.png|link=|alt=C/C++|64x64px]]|C++ is a general purpose, cross-platform programming language with a vast user base.}}
__TOC__

==Introduction==

{{LanguageSupport|C/C++|the complete Phidget API, including events|all Phidget devices.|Windows 2000/XP/Vista/7(environments include [[#Visual Studio | Visual Studio]], [[#Borland | Borland]], [[#Cygwin/MinGW | Cygwin, and MinGW]]), [[#Windows CE | Windows CE]], [[#OS X | OS X]], and [[#Linux | Linux]]|}}

==Quick Downloads==
{{QuickDownloads|C/C++|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21_C_Doc.zip}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/VCpp_2.1.8.20110615.zip Visual Studio 2005/2008/2010|}}
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20110615.tar.gz Generic|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/phidget21bcc_2.1.8.20110615.zip|Borland(Windows)|}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
{{LinuxQuickDownloads}}
}}

==Getting started with C/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/C++ programs on Windows depend on three 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|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts {{Code|phidget21.lib}} 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. {{Code|phidget21.lib}} is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler for details. Please note that we provide versions of the {{Code|phidget21.lib}} that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets}}; The 32 bit version of {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets\x86}}.
* <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. By default, our installer puts {{Code|phidget21.h}} 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 do not want to use our installer, you can download all three [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]].

Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]], [[#Visual Studio 2003 | Visual Studio 2003]], [[#Visual Studio C++ 6.0 | Visual Studio 6]], [[#Borland| Borland]], [[#Cygwin/MinGW | Cygwin/MinGW]], and [[#Dev C++ | Dev C++]].

===Visual Studio===

C++/CLI (which used to be called Managed C++) is very different from mainstream C/C++. If you must use C++/CLI, consider calling the Phidget .NET library, instead of the C API normally used from C/C++. We have no documentation for using C++/CLI.

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.

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

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

To run the examples, you first download the [http://www.phidgets.com/downloads/examples/VCpp_2.1.8.20110615.zip examples] and unpack them into a folder. To load all projects in Visual Studio, go to File → Open → Project → Solution, and open {{Code|Visual Studio Phidgets Examples.sln}} in the {{Code|VCpp}} folder of the examples.

Since the examples were written in Visual Studio 2005, if you are opening the examples in Visual Studio 2008/2010, you will need to go through the Visual Studio Conversion Wizard to open and convert the 2005 project.

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

This will load all of the examples available for C/C++. 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.

[[File:VS2005 StartUp Project.PNG|link=|alt=Start Up Project]]

To run the example, click on Debug → Start Debugging. Please note that the projects, by default try to find the {{Code|phidget21.h}} and {{Code|phidget21.lib}} in the {{Code|$(SystemDrive)\Program Files\Phidgets}}. If you have these files installed in another location, please change the path to the file's location accordingly. Please see the [[#Write Your Own Code | Write Your Own Code]] section for details.

[[File: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: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/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 C/C++ library. To begin:

1. Generate a new Visual C++: Win32 Console Application project with a descriptive name such as PhidgetTest.

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

2. Next, select Console Application.

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

3. Open the project properties window.

4. Navigate to Configuration Properties → C/C++.

5. Add {{Code|"C:\Program Files\Phidgets"}} to the additional directories field. This step will find the {{Code|phidget21.h}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.

[[File:VS2005 Header.PNG|link=|alt=Header File]]

6. Navigate to Configuration Properties → Linker → Input.

7. Edit the additional dependencies and add {{Code|"C:\Program Files\Phidgets\phidget21.lib"}}. This step will find the {{Code|phidget21.lib}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.

[[File:VS2005 Library.PNG|link=|alt=Library File]]

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

Then, in your code, you will need to include the Phidget C/C++ library:

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

#include <phidget21.h>

</syntaxhighlight>
</div>

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. Start by downloading the [http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz examples]. You can import these examples into a Visual Studio 2003 C++ project. Afterwards, unpack them into a folder. Here, you can find example programs for all the devices. You will need this example source code to be copied into your C++ project later on. The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example.

2. A new project will need to be created. Generate a new Visual C++ empty project(.NET) with a descriptive name such as HelloWorld.

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

3. Create a new C++ file by adding a new item to the source files folder.

[[File:VS2003 New File.PNG|link=|alt=New File]]

[[File:VS2003 New File 2.PNG|link=|alt=New File]]

4. An empty C++ file will pop up. Please copy and paste the contents of the {{Code|HelloWorld.c}} program into here.

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

5. Next, the project setting needs to be set up. Open the project properties window.

6. Navigate to Configuration Properties → C/C++.

7. Add {{Code|"C:\Program Files\Phidgets"}} to the additional include directories field. This step will find the {{Code|phidget21.h}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.

[[File:VS2003 Header.PNG|link=|alt=Header File]]

8. Navigate to Configuration Properties → Linker → Input.

9. Add {{Code|"C:\Program Files\Phidgets\phidget21.lib"}} to the additional dependencies field. This step will find the {{Code|phidget21.lib}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.

[[File:VS2003 Library.PNG|link=|alt=Library File]]

10. Now, you can run the example. Click on Debug → Start Without Debugging.

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

11. 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:VS2003 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]].

Once you have the C/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 C/C++ 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 C/C++ library:

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

#include <phidget21.h>

</syntaxhighlight>
</div>

====Visual Studio C++ 6.0====

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

1. Download the [http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20110615.tar.gz examples] and unpack them into a folder. Here, you can find example programs for all the devices. You will need this example source code to be copied into your C++ project later on. The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example.

2. Next, a new project will need to be created. Generate a new Win32 Console Application project with a descriptive name such as HelloWorld.

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

3. Create an empty project.

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

4. Next, the project settings needs to be set up. Navigate to Project → Settings → C/C++ → Preprocessor.

5. Add {{Code|C:\Program Files\Phidgets}} to the additional include directories field. This step will find the {{Code|phidget21.h}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.

[[File:VS6 Header.PNG|link=|alt=Header File]]

6. Navigate to Project → Settings → Link → Input → Additional library Path.

7. Add {{Code|phidget21.lib}} to the object/library modules field.

8. Add {{Code|C:\Program Files\Phidgets}} to the additional library path. This step will find the {{Code|phidget21.lib}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.

[[File:VS6 Library.PNG|link=|alt=Library File]]

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

To import the example program into your project, please:

9. Create a new C++ file by navigating to File → New → Files → C++ Source File and enter a descriptive name such as HelloWorld.

[[File:VS6 New File.PNG|link=|alt=New File]]

10. An empty C++ file will pop up. Please copy and paste the contents of the {{Code|HelloWorld.c}} program here.

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

11. Now, you can run the example. Click on Build → Execute.

[[File:VS6 Run.PNG|link=|alt=Run]]

12. 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:VS6 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]].

Once you have the C/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 C/C++ library. Please see the [[#Use Our Examples 3 | Use Our Examples]] section for instructions.

In your '''{{Code|.c}}''' source code file, you must include a reference to the library header:

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

#include <phidget21.h>

</syntaxhighlight>
</div>

Then, you would compile your completed C/C++ code the same way as shown in the [[#Use Our Examples 3 | Use Our Examples]] section.

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/C++ examples and which has resources such as the API reference.

===Borland===

====Use Our Examples====

In addition to running one of the two [[#Libraries and Drivers:| Windows Installers]] above (which you probably already have if you worked through the ''Getting Started'' page [[Device List | for your device]]), you will need the [http://www.phidgets.com/downloads/libraries/phidget21bcc_2.1.8.20110615.zip Borland C++ Libraries]. {{Code|phidget21bcc.lib}} is typically placed in {{Code|C:\Program Files\Phidgets}}, but you are free to place it in any directory you wish.

After installing the Phidget C/C++ library, you're ready to download the [http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz examples] and run the examples.

Afterwards, unpack the examples. The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example. Locate the {{Code|HelloWorld.c}} file and type the following to compile the file and link the Phidget C/C++ library:

To compile, link the Phidget C/C++ library and build a binary executable, enter the following in a command line prompt in the directory with {{Code|HelloWorld.c}}:
<div class="source">
<syntaxhighlight lang=bash>
bcc32 -eHelloWorld -I"C:\Program Files\Phidgets" -L"C:\Program Files\Phidgets" phidget21bcc.lib HelloWorld.c
</syntaxhighlight>
</div>

It is assumed that {{Code|phidget21bcc.lib}} and {{Code|phidget21.h}} are placed in {{Code|C:\Program Files\Phidgets}}. If the files are placed in another location, please adjust the paths to both of the file's location accordingly.

In this case, {{Code|HelloWorld.c}} would be the '''.c''' file specific to your device. After using {{Code|bcc32}}, you will have an executable named {{Code|HelloWorld}} that you can 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:Borland 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]].

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

When writing your code from scratch, you start it as you would any C/C++ code with Borland. In your '''{{Code|.c}}''' source code file, you must include a reference to the library header:

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

#include <phidget21.h>

</syntaxhighlight>
</div>

Then, you would compile your completed C/C++ code the same way as the examples [[#Use Our Examples 4 |above]].

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/C++ examples and which has resources such as the API reference.

===GCC on Windows===

====Cygwin/MinGW====

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

Download the [http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz examples] and unpack them into a folder. Afterwards, unpack the examples. The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example. Locate the {{Code|HelloWorld.c}} file and type the following to compile the file and link the Phidget C/C++ library in a command line prompt:

<b>Cygwin</b>

<div class="source">
<syntaxhighlight lang=bash>
gcc example.c -o HelloWorld -I"/cygdrive/c/Program Files/Phidgets" -L"/cygdrive/c/Program Files/Phidgets" -lphidget21
</syntaxhighlight>
</div>

<b>MinGW</b>
<div class="source">
<syntaxhighlight lang=bash>
gcc example.c -o HelloWorld -I"C:\Program Files\Phidgets" -L"C:\Program Files\Phidgets" -lphidget21
</syntaxhighlight>
</div>

After using gcc, you will have an executable named {{Code|HelloWorld}} that you can run.
It is assumed that {{Code|phidget21.h}} and {{Code|phidget21.lib}} are placed in {{Code|C:\Program Files\Phidgets}}. If the files are placed in another location, please adjust the paths to the file's location accordingly.

After using {{Code|gcc}}, you will have an executable named {{Code|HelloWorld}} that you can 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:C MinGW 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]].

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

When writing your code from scratch, you start it as you would any C/C++ code with Cygwin/MinGW in your favourite text editor. In your '''{{Code|.c}}''' source code file, you must include a reference to the library header:

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

#include <phidget21.h>

</syntaxhighlight>
</div>

Then, you would compile your completed C/C++ code the same way as shown in the [[#Use Our Examples 5| Use Our Examples]] section above.

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/C++ examples and which has resources such as the API reference.

===Dev C++===

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

1. Download the [http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz 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]]. You will need this example source code to be copied into your Dev C++ project later on. The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example.

2. In order to control Phidgets with Dev C++, we will use the {{Code|reimp}} tool to convert the {{Code|phidget21.lib}} to a format that Dev C++ accepts. Download the [http://www.phidgets.com reimp tool].

3. Open up command line and traverse to the directory containing the reimp tool. Type the following command to create {{Code|libphidget21.a}}.
<div class="source">
<syntaxhighlight lang=bash>
reimp.exe "C:\Program Files\Phidgets\phidget21.lib"
</syntaxhighlight>
</div>
The command above assumes that the {{Code|phidget21.lib}} is in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly. Please note that the 64 bit version of {{Code|phidget21.lib}} is not supported on Dev C/C++. Please use the 32 bit version of {{Code|phidget21.lib}}.

4. Place {{Code|libphidget21.a}} in {{Code|<Dev-Cpp Install Directory>/lib}}.

5. Next, a new project will need to be created. Generate a new console application with a descriptive name such as PhidgetTest. Please select C as the project type.

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

6. Next, the project settings needs to be set up. Navigate to Project Options → Directories → Include Directories.

7. Add a new path to {{Code|C:\Program Files\Phidgets}}. This step will find the {{Code|phidget21.h}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.

[[File:DevC Header.PNG|link=|alt=Header File]]

8. Navigate to Project Options → Parameters → Linker.

9. Add {{Code|-lphidget21}} to the field. This step will find the {{Code|libphidget21.a}} file in {{Code|<Dev-Cpp Install Directory>/lib}}.

[[File:DevC Library.PNG|link=|alt=Library File]]

10. To import the {{Code|HelloWorld}} program into your project, please open up {{Code|main.c}} in the editor.

11. An empty C file will pop up. Please copy and paste the contents of the example program.

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

12. Now, you can run the example. Click on Execute → Compile & Run.

[[File:DevC Run.PNG|link=|alt=Run]]

13. 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:DevC 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]].

Once you have the C/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 C/C++ library. Please see the [[#Use Our Examples 6 | Use Our Examples]] section for instructions.

In your '''{{Code|.c}}''' source code file, you must include a reference to the library header:

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

#include <phidget21.h>

</syntaxhighlight>
</div>

Then, you would compile your completed C/C++ code the same way as the [[#Use Our Examples 6 | examples]] above.

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/C++ examples and which has resources such as the API reference.

==OS X==

C/C++ has excellent support on OS X through the gcc compiler.

The first step in using C/C++ on Mac is to install the Phidget C/C++ 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.

{{ContentNeeded|The information we say that we say on the OS - OS X page (i.e. the different files, locations, and roles) should actually be added there}}

===Use Our Examples===

After installing the Phidget C/C++ library for OS X as above, you're ready to download the [http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz examples]. Afterwards, unzip the file. To run the example code, you'll need to find the source code ''for your specific device''. Then, compile the code under your platform and run it.

The examples assume that the compiled libraries have been set up properly. To set them up on OS X, follow the ''Getting Started'' page for [[Device List | your specific device]]

To compile, link the Phidget C/c++ library, and build an executable binary on OS X, do (for example, depending on the Headers location):

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

gcc example.c -o example -framework Phidget21 -I/Library/Frameworks/Phidget21.framework/Headers
</syntaxhighlight>
</div>

After using gcc, you will have an executable named {{Code|example}} that you can run.

===Write Your Own Code===

When writing your code from scratch, you must include a reference to the library header:

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

#include <phidget21.h>

</syntaxhighlight>
</div>

Then, you would compile your completed C/C++ code the same way as shown in the [[#Use Our Examples 7|Use Our Example]] section above.

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/C++ examples. Even more help and references are provided from there.

==Linux==

C/C++ has support on Linux through the gcc compiler.

The first step in using C/C++ 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.

===Use Our Examples===

After installing the Phidget libraries for Linux as above, you're ready to download and run the examples:
*[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz Generic C/C++ Examples]

To run the example code, you'll need to download and unpack the examples, and then 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]]. Then, compile the code under your platform and run it. When compiling, you need to link to the Phidget library.

To compile, link the Phidget libraries and build a binary executable on Linux, do the following in a terminal in the directory with {{Code|example.c}}:

<div class="source">
<syntaxhighlight lang=bash>
gcc example.c -o example -lphidget21
</syntaxhighlight>
</div>

In this case, {{Code|example.c}} would be the '''.c''' file specific to your device. After using gcc, you will have an executable named {{Code|example}} that you can run.

On Linux, if you have not set up [[OS_-_Linux#Setting_udev_Rules | your udev rules for USB access]], you will need to run the program '''as root''':

<div class="source">
<syntaxhighlight lang=bash>
sudo ./example
</syntaxhighlight>
</div>

===Write Your Own Code===

When writing your code from scratch, you start it as you would any C/C++ code on Linux, such as within a text editor like Emacs, Vi, Gedit, or Kate. In your '''{{Code|.c}}''' source code file, you must include a reference to the library header:

<div class="source">
<syntaxhighlight lang=cpp>
#include <phidget21.h>
</syntaxhighlight>
</div>

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

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/C++ examples and which has resources such as the API reference.

==Windows CE==

===Description of Library Files===
C/C++ programs on Windows CE depend on the following files, which the Windows CE installer puts onto your system:
* <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]]. It can be placed anywhere on the system.
* <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}}.

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

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

Currently, we have no example code for C/C++ on Windows CE. However, set up is very much the same as what it would be with [[#Visual Studio 2005/2008/2010 |Visual Studio 2005/2008/2010]] in Windows. The {{Code|phidget21.h}} and {{Code|phidget21.lib}} can be downloaded [http://www.phidgets.com/downloads/libraries/Phidget21-wincedevel_2.1.8.20120216.zip here].

=====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 C/C++ library. To begin:

1. Generate a new Visual C++: Win32 Smart Device project with a descriptive name such as PhidgetTest.

[[File:WinCE VS C NewProject 1.PNG|link=|alt=New Project]]

2. Select {{Code|Next}}.

[[File:WinCE VS C NewProject 2.PNG|link=|alt=New Project]]

3. Select the SDK(s) that you want to code against and elect {{Code|Next}}.

[[File:WinCE VS C NewProject 3.PNG|link=|alt=SDKs]]

4. Create a console application and select {{Code|Next}}.

[[File:WinCE VS C NewProject 4.PNG|link=|alt=Create Console Application]]

3. Open the project properties window.

4. Navigate to Configuration Properties → C/C++.

5. Add {{Code|"C:\Program Files\Phidgets"}} to the additional directories field. This step will find the {{Code|phidget21.h}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.

[[File:VS2005 Header.PNG|link=|alt=Header File]]

6. Navigate to Configuration Properties → Linker → Input.

7. Edit the additional dependencies and add {{Code|"C:\Program Files\Phidgets\phidget21.lib"}}. This step will find the {{Code|phidget21.lib}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.

[[File:VS2005 Library.PNG|link=|alt=Library File]]

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

Then, in your code, you will need to include the Phidget C/C++ library:

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

#include <phidget21.h>

</syntaxhighlight>
</div>

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.

Your main reference for writing C code will be our C/C++ API information, with syntax for all of our functions:

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

===Example Flow===

{{ExamplePseudocode|In C/C++, 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 C is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating an object with the {{Code|CPhidgetSpatialHandle}} type, and then initializing it using the {{Code|CPhidgetSpatial_create function}}. The examples show how to do this and other API functions.<br><br>
Other C calls follow a similar syntax - {{Code|CPhidgetXXX_function}}, where XXX is the name of your device, and function is an action available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API]}}

==Common Problems and Solutions/Workarounds==

===Issue: I am using a non US-English version of Windows, and the Visual C/C++ examples run into a linker error===
Affected Operating Systems: '''Windows'''

The example projects, by default finds the {{Code|phidget21.h}} and {{Code|phidget21.lib}} in ${SystemDrive}\Program Files\Phidgets. If you are using a non US-English version of Windows, the Phidget drivers may be installed into a different location. To resolve, you will have to modify the paths to these two files. For instructions, please see your environment/compiler section.

Language - C Sharp

2012-04-20T16:32:48Z

Djrudiak:

[[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, 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.

==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 - iOS

2012-04-20T16:30:44Z

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 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 - Android

2012-04-20T16:29:40Z

Djrudiak:

[[Category:OS]]
{{OSLang|[[File:Icon-Android.png‎|64x64px|link=]]|Android is a mobile OS commonly used on smartphones and tablet computers.}}
__TOC__

Tablets with a USB port and Android version 3.1 or greater can control Phidgets directly plugged in to them. Earlier Android versions (tested down to 2.1) can control Phidgets over a network using the [[#WebService|WebService]]. We do not currently support Android devices acting as a [[Phidget WebService]] server, but if you are looking for a compact and cheaper-than-a-tablet 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]].

Android code is developed on an external platform anyway (i.e. Windows, Mac OS, or Linux), and so getting your Phidget to work locally on that platform first will help you distinguish any issues from network ones later.

Near the end of the Windows, Mac OS, or Linux setup process, we direct you to choose a language. At that point, please remember to return here to this Android Java page.

Alternately, you can first try using [[Language - Java|mainstream Java]] to control the Phidget on your host computer and become familiar with it. On the mainstream Java page, we provide example code - including code that works on the Android development platform of Eclipse - to test your Phidget directly from your development computer.

===Installing===

The 'installation' of the Phidget Android libraries is simply linking and distributing the libraries with your code. As the most common platform to do this (on Windows, Mac, and Linux) is through Eclipse, we provide brief instructions on how to get and install Eclipse so you can more easily follow along with our already-linked examples later.

====Eclipse (Android Java Development Platform)====

Development for your Android OS Phidget application can occur on Linux, Mac OSX, or Windows.

To install Eclipse, you will need the following:

# The JDK and Java on your development system
#*See the [[Language - Java|mainstream Java]] page for details on Java for Windows, Mac, and Linux
# Eclipse (a Java Integrated Development Environment) on your development system
#*[http://www.eclipse.org/downloads/ http://www.eclipse.org/downloads/] (for Windows or MacOS)
#*<code>sudo apt-get install eclipse</code> (for Linux)
#*For 64-bit Linux, you will need the <code>ia32-libs</code> package as well for Android development, try:
#*:{{Code|sudo apt-get install ia32-libs}}

====Android SDK (and ADT Eclipse Plugin)====

After installing Java and Eclipse, you can install the Android Software Developer's Toolkit (SDK) and the Android plugin for Eclipse (ADT).

# Download and install the Android SDK package for your development system:
#*See the download instructions link at [http://developer.android.com/sdk/ http://developer.android.com/sdk/]
#*Google's instructions for installing are here: [http://developer.android.com/sdk/installing.html http://developer.android.com/sdk/installing.html]
# Download and install the ADT Eclipse Plugin for Android
#*Follow the instructions at [http://developer.android.com/sdk/eclipse-adt.html http://developer.android.com/sdk/eclipse-adt.html]

To check that the JDK, the Android SDK, and Eclipse have all been configured correctly, use the Google HelloAndroid example:

[http://developer.android.com/resources/tutorials/hello-world.html http://developer.android.com/resources/tutorials/hello-world.html]

Once you have confirmed that the Android SDK has been correctly installed, you are ready to begin developing applications with Phidgets.

=====Android SDK and ADT on Linux=====

After downloading and unpacking the Android SDK package (the link is [[#Android SDK (and ADT Eclipse Plugin)|just above]]), run the Android SDK manager. If {{Code|android-sdk-linux}} is the unpacked directory that was downloaded, try:
:{{Code|android-sdk-linux/tools/android}}

This will give you the option to download the Android versions you want to support. Running the SDK from within Eclipse ({{Code|Window}} → {{Code|Android SDK}}) will let you add those Android versions to Eclipse, for emulating them before downloading to an Android device and using with Phidgets.

Then, to add Android support to your compilation process in Eclipse, make sure {{Code|adb}} is in your path (e.g. by adding it to {{Code|/etc/environment}}).

====Phidget Libraries====

The libraries from the [http://www.phidgets.com/downloads/examples/android-examples_2.1.8.20120216.tar.gz Phidget Android examples] (not our mainstream Java examples, despite the same name) are the libraries for including with your Android code.

When you download and unzip the examples, each project (in addition to the source files, resources, and so on) contain three things:

# A libs/ folder
# 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)

Feel free to browse around within these jar files to get a sense of what will be going on the Android OS side. We describe how to link and use these library files later on the [[Language - Android Java#Write Your Own Code | Write your own Android code]] section of the Android Java 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 Android system.

===Checking===

When you run a Phidgets Android example, you transfer and link the libraries and code all at the same time. This should 'just work' 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 Android device and run them. Detailed instructions for this (including choosing the right {{Code|HelloWorld}} project to run) are on the [[Language - Android Java]] 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 [[#Remote Phidget|hardware of the host computer]] if your Android device is controlling the Phidget over the WebService. Or, you should check the hardware of your [[#Directly Connected Phidget|Android device]] if the Phidget is directly connected to the tablet's USB port.

=====Remote Phidget=====

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 [[Software Overview#Operating System Support|page specific to the operating system]]

=====Directly Connected Phidget=====

To check whether a Phidget is correctly connecting in your Android hardware (even if our examples do not work), you can use the kernel logs on your Android tablet in a similar way as you would on [[OS - Linux|Linux]].

You need to access the logs from your debugging computer - e.g. the computer where you have installed Google's development plugins as described above. Plug a USB Phidget into your Android device. Then, as soon as possible, from a command line on that computer, use the ADB (Android Debugging Bridge) program to access the program {{Code|dmesg}} on your Android device:

<div class="source">
<syntaxhighlight lang=bash>
adb shell dmesg
</syntaxhighlight>
</div>

This will print out the entirety of the kernel logs on your Android device. Even if you have been running your device for only a little while, this could be thousands of lines of output. If you plugged the Phidget in and then ran {{Code|dmesg}} right away, the kernel detection of the Phidget should be almost at the bottom of the logs. If you are on Linux or Mac OS, you can mitigate the length of this output using {{Code|tail -n 50}} or so. If you are on Windows, you may consider using a command redirection operator like {{Code|>}} to write to a file and then view the last 50 or so lines.

Near the end of the output you will find something like this for a successful registration of a Phidget in the Android kernel:

<div class="source">
<syntaxhighlight lang=text>
<6>[ 3282.554249] usb 1-1.2: new full speed USB device using tegra-ehci and address 5
<6>[ 3282.612359] usb 1-1.2: New USB device found, idVendor=06c2, idProduct=0032
<6>[ 3282.612418] usb 1-1.2: New USB device strings: Mfr=1, Product=2, SerialNumber=3
<6>[ 3282.612466] usb 1-1.2: Product: PhidgetTemperatureSensor
<6>[ 3282.612504] usb 1-1.2: Manufacturer: Phidgets Inc.
<6>[ 3282.612540] usb 1-1.2: SerialNumber: 287638
<4>[ 3282.612576] device: '1-1.2': device_add
<4>[ 3282.615639] device: '1-1.2:1.0': device_add
<4>[ 3282.618632] device: '0003:06C2:0032.0003': device_add
<3>[ 3282.631412] generic-usb 0003:06C2:0032.0003: claimed by neither input, hiddev nor hidraw
</syntaxhighlight>
</div>

If the kernel log Phidget attachment does '''not''' appear, make sure that other devices that are supposed to work with your tablet (USB data keys, keyboards, etc. - the list depending entirely on which tablet) do indeed work. Not having the Phidget appear in your kernel logs indicates there is a problem with your USB hardware on your Android device.

Note that in order to consider a port on your tablet to be compatible with Phidgets it must be able to '''host''' USB devices. Simply finding and using a USB cable to connect the Phidget to the power charging port on your phone or tablet is not enough! A host USB port should either say so explicitly, or at least act like a 'normal' USB port such as ones you would find on your PC, and be able to use many common USB devices like memory sticks.

If the kernel log attachment does appear, but your code doesn't run, the problem is probably with your code. Work through the [[Language - Android Java]] page to make sure you have all the libraries, jar files, and permissions set and linked properly to use your Phidget.

====Troubleshooting====

If the examples '''do not''' work but USB '''does''' work (i.e. your remote computer or Android 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 that USB port in software
* You have properly set either android.permission.INTERNET or android.hardware.usb.host in your AndroidManifest.xml file (as described on the [[Language - Android Java]] page)
* You have copied and linked the Phidget jar libraries and libs/ folder into your project (as described on the [[Language - Android Java]] page)
* The Phidget libraries are the latest version (visit the [[#Getting Started (Libraries and Drivers)| getting started section]] to download them)
* If using the Phidget over the webservice, make sure the webservice drivers and the Android libraries are both the latest version
* If directly connecting to your Android device, the port you are using is a real USB host port (not a reduced-function power charging port)
* 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==

Android OS programs are written in [[Language - Android Java|Android Java]] using the Android SDK and the Phidgets library. You can read on within this page to learn how to use Android with the WebService, or you can jump ahead right now to the [[Language - Android Java|Android Java]] page and start writing code!

Note that Android Java is NOT the same as mainstream Java. Any Java programs you have will probably need significant modification before they run on Android, including our [[Language - Java|mainstream Java]] Phidget Examples.

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network.<br>This section helps you use the WebService on Android, but we also have an overview of the [[Phidget WebService]] in general.

Currently, Android devices cannot ''host'' the WebService, but they can use data streaming from another computer over the WebService.

===Setting Up the WebService===

Using an Android device, your network-controlled Phidget system will probably look something like this:

[[Image:Webservice general pctoandroid.png|600px|link=|alt=]]

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 the [http://www.phidgets.com/downloads/examples/android-examples_2.1.8.20120216.tar.gzAndroid Examples].
* Edit the IP address and port in the {{Code|HelloWorldRemote}} example to match the IP address of the host computer (5001 is the default port)
* Transfer the example {{Code|HelloWorldRemote}} to your Android Device
* Run the example on your Android device, making sure it is also connected to the local network
** In Eclipse, right-click on project in Package Explorer (To open the Package Explorer, use Window → Show View → Package Explorer)
** Select Run As... → Android Application

3. Plug a Phidget into the host computer

===Using the WebService===

After performing the steps above, you will be using the WebService already. Plugging in the Phidget to the host computer will probably give you a screen like this:

[[Image:android_helloworld_remotehello.png|700px|alt=|link=]]

(The Phidget you actually plugged in will show up, be it a TemperatureSensor or something else)

And when you unplug that Phidget from the remote host computer, you should see something like this on your Android device:

[[Image:android_helloworld_remotegoodbye.png|700px|alt=|link=]]

===Debugging the WebService===

As currently an Android 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==

None yet, feel free to [[Contact Information|suggest some]]!

==Common Problems and Solutions==

None yet.

OS - Phidget SBC

2012-04-20T16:28:44Z

Djrudiak:

[[Category:OS]]
{{OSLang|[[File:icon-Linux.png|64x64px|link=OS - Linux]]|On the Single Board Computer (SBC), Phidgets can be either plugged directly into one of the USB ports or run over a network using the [[#WebService | WebService]].}}
__TOC__

==Getting Started (Libraries and Drivers)==

The Single Board Computer (SBC) is a unique Phidget. It is a computer with a Linux operating system. It can compile code, save files, manage background jobs, host information over the web, and more.

'''If this is your first time''' using the Phidget SBC, you will want to start with the [[1072 0 - Getting Started | Getting Started Guide for the SBC]]. After that, here we will get you started on topics beyond those in the getting started guide, including how to write Phidget code to run on the SBC. You '''do not need this page''' if you are simply using the SBC to broadcast data from Phidgets over the network - it does that automatically. We describe how to verify and use this in the [[1072 0 - Getting Started | Getting Started Guide]].

This page will show you how to:
* Install the ability to write and develop code on the SBC itself
* Use the command line for basic coding tasks
* Troubleshoot the SBC's network
It will also give additional specifications, which are useful for doing more advanced things with the SBC hardware and software.

Before reading this page, you should have done the following via the Getting Started Guide:
* Set up networking on your SBC, via either Ethernet or wireless
* Set up an admin password
* Learned the IP address or link local address of the SBC
We will use this information in setting up the libraries and drivers to use the SBC for writing and running code.

Conceivably, you could simply use the SBC like any Linux computer, and do all of your development and compiling of Phidget code on the SBC itself. In practice this gets complicated as the SBC does not have a keyboard or screen. So usually, you will want to develop your code an external computer and copy files and settings over to the SBC via a network. This makes this Getting Started section unique, in that we show you how to set up both computers:
* Your [[#Getting Started - External Computer | External Development Computer]], usually your main desktop or laptop which will transfer files and settings to and from the SBC
* The [[#Getting Started - The SBC (Debian Linux) | SBC]] itself, which needs programming language libraries to use Phidgets.

===Getting Started - External Computer===

You have two ways to connect to the SBC from an external computer: via the [[#SBC Web Interface|SBC Web Interface]] and over the more powerful but complex [[#SSH | Secure Shell (SSH)]].

====SBC Web Interface====

You have already worked extensively with the web interface in the [[1072 0 - Getting Started | Getting Started Guide for the SBC]]. This was the tool within a web browser which was opened either via the Phidget control panel on Windows, or by simply entering the IP or link local address into an internet browser. It allowed you to set the password, set up internet connectivity, and so on.

This section doesn't have more information on the interface; rather, it simply serves as a reminder that you have the web interface as an available tool. Examples, including screenshots, are placed where appropriate in this document. The web interface will probably stay your initial go-to way to connect to the SBC, especially for tasks that benefit from graphical interaction, like setting up wireless or using the webcam.

====SSH====

The most flexible way to transfer files and commands to and from the SBC is via a program called '''ssh'''. The ssh program provides command line text access over a network into the SBC. Using it, you can run programs and give the SBC commands. The ssh program has a companion program called '''scp''' which can copy files back and forth. For Linux users, this will be familiar territory. If you are using Windows or Mac OS, and are unfamiliar with ssh, you can think of it like the command line or a Mac terminal, but with a remote connection to a different computer.

Before connecting over ssh, you will need:
* The '''IP address''' (such as 168.254.3.0) or '''link local address''' (such as phidgetsbc.local) of the SBC
* The '''admin password''' for the SBC
Both of these items can be found by following the steps in the [[1072 0 - Getting Started | Getting Started Guide for the SBC]].

You will also need to enable SSH on the SBC side. This can be done through the [[#SBC Web Interface| Web Interface]], under {{Code|Network → Settings}}, by changing the ''SSH Server'' radio button to ''Enabled'' and saving your changes:

[[File:sbc_turn_on_ssh.png|link=|alt=]]

=====SSH on Windows=====

The ssh program is not installed on Windows by default. But, there are a variety of SSH programs available for free. One simple and commonly used program is [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html PuTTY], and it has the advantage that the executable doesn't need to install, it just runs.

With PuTTY, when you first run the program it will ask you what to connect to. Enter the IP address or link local address of the SBC, and then click the SSH radio button right below the address, which will change the port to 22. Then click open, and you'll have an ssh connection to the SBC open in a terminal. It will prompt you for a user name ({{Code|root}}) and password (the admin password).

To copy files back and forth, there is an SCP component to PuTTY, called PSCP, which is available from the same [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html PuTTY download page]. Use of PSCP will be similar with the address, username, and password, except that you will be transferring files instead of sending commands.

=====SSH on Linux and Mac OS=====

Linux and Mac OS already have ssh installed by default. To run ssh simply open a terminal...
* {{Code|Ctrl-Alt-T}} on Linux
* {{Code|Applications → Utilities → Terminal}} on Mac OS
...and type:

<div class="source">
<syntaxhighlight lang=bash>
ssh root@phidgetsbc.local
</syntaxhighlight>
</div>

If you have re-named your SBC, include that name instead of the {{Code|phidgetsbc.local}} link address. Or, you can use the SBC's IP address, e.g. something like {{Code|ssh root@168.254.3.0}}

To copy files back and forth, the command follows the form of: {{Code|scp from to}}

So, to copy a file {{Code|/root/data.txt}} from the SBC to your local machine, type:

<div class="source">
<syntaxhighlight lang=bash>
scp root@phidgetsbc.local:/root/data.txt .
</syntaxhighlight>
</div>

Note the use of the dot '''.''' to indicate that scp should put the file in the current local directory. If you're not sure what folder the terminal is operating in type {{Code|pwd}} to print the working directory. Terminals usually start by default in your home folder.

===Getting Started - The SBC (Debian Linux)===

The SBC runs Linux, which is a full operating system. It is stripped down compared to a full desktop release of Linux, but you can compile code on it, run programs, schedule tasks, create and manage files, run a web server, and much, much more.

At this point you have connected to the SBC via the [[#SBC Web Interface|web interface]], and probably also through [[#SSH|SSH]]. This section will help you install libraries and drivers that you probably want - i.e. support for C, Java, and Python. After this section, you'll be well into the depths of using the SBC as a computer, and so you'll probably want to keep the [[#Using SBC Linux|Using SBC Linux section]] open for reference while you work if you are not already familiar with Linux.

The SBC comes with the following Phidget functionality installed:
* The Phidget C libraries {{Code|libphidget21.so}}
* The Phidget [[#WebService | WebService]]
(If you are simply curious what these are and how they get installed, we describe the process on the [[OS - Linux | general Linux page]].)

But to compile C programs, or run Java programs, or use Python, you will need to install these languages onto the SBC.

Before installing anything on the SBC, however, (even via a button on the web interface) make sure that the ''Include full Debian Package Repository'' option is checked in the web interface under {{Code|System → Packages}}.

====Installing C/C++ and Java====

The simplest way to install C/C++ and Java on the SBC is via the web interface. There is a button under {{Code|System → Packages}} to install C support (including {{Code|gcc}}) and another button to install Java support:

[[File:sbc_packages_web.png|link-|alt=]]

Now you're ready to begin programming. We have programming pages for both [[Language - C/C++|C/C++]] and for [[Language - Java|Java]]. Remember that if you're unfamiliar with Linux, we have help on using files and running programs automatically in the [[#Using SBC Linux|Using SBC Linux section]].

If you want to avoid using the [[#SSH|SSH]] interface on the SBC entirely, and you want to write your program in Java and run it continuously from boot (which is the only option if you want to avoid [[#SSH|SSH]]), we have a [[#Program in Java with the Web Interface|very in-depth section]] on that topic.

====Installing Python====

Installing Python has two steps. First, you'll need to install the basic ability to run python, and then you'll need to install the Phidget Python module. Both steps (and both options) require that you issue the relevant commands through an [[#SSH|SSH terminal]].

=====Basic Python=====

The base Python functionality can be downloaded and installed in one step with [[#apt|apt]] (i.e. in a terminal, type):

<div class="source">
<syntaxhighlight lang=bash>
apt-get install python
</syntaxhighlight>
</div>

This will give you Python, and now you just have to install the Phidget Python module to gain Phidget functionality.

=====Install Phidget Python Method 1: Use a USB Key=====

Copy the [http://www.phidgets.com/downloads/libraries/PhidgetsPython_2.1.8.20120216.zip Python Libraries] onto a USB key. Unpack the zip file into a folder on the USB key. Insert the key into the SBC.

You will have to figure out where the USB key (and the Phidget Python library folder) is now located. We describe how in the general [[#Using USB Data Keys | Using USB Data Keys]] section.

After you know the place where the USB key is mounted, in a terminal go to that directory (e.g. type {{Code|cd /media/usb0/}}), enter the unpacked Phidget Python Library folder, and run:

<div class="source">
<syntaxhighlight lang=bash>
python setup.py install
</syntaxhighlight>
</div>

Now, you're ready to begin writing Python code for the SBC. For more help on writing and using Python with Phidgets, we have an whole [[Language - Python | page on that topic]]. Remember that if you're unfamiliar with Linux, we have help on using files and running programs automatically in the [[#Using SBC Linux|Using SBC Linux section]].

=====Install Phidget Python Method 2: Use the Internet=====

Rather than using a USB key to transfer the file, the SBC can download it directly from the internet. You will need {{Code|wget}} and {{Code|unzip}} installed, both of which are small:

<div class="source">
<syntaxhighlight lang=bash>
apt-get install wget
apt-get install unzip
</syntaxhighlight>
</div>

Copy the web link address for the [http://www.phidgets.com/downloads/libraries/PhidgetsPython_2.1.8.20120216.zip Python Libraries].

In an SSH terminal to the SBC, type: {{Code|wget http://www.python_library_link}} where instead of http://www.python_library_link you insert the link you just copied. Copying into a terminal can usually be done via the right-click menu.

This will download the Phidget python libraries to the folder you ran the {{Code|wget}} command in. Unzip the downloaded file using the command {{Code|unzip file}}, where file is the filename from {{Code|wget}}. Or try typing {{Code|ls}} to list the names of a file in the directory, which should include the unzipped folder. Enter the unzipped folder (e.g. use {{Code|cd}} to change directory), and install the Phidget Python libraries:

<div class="source">
<syntaxhighlight lang=bash>
python setup.py install
</syntaxhighlight>
</div>

Now, you're ready to begin writing Python code for the SBC. For more help on writing and using Python with Phidgets, we have a whole [[Language - Python | page on that topic]]. Remember that if you're unfamiliar with Linux, we have help on using files and running programs automatically in the [[#Using SBC Linux|Using SBC Linux section]].

====Installing Other Languages====

You may also be able to program on the SBC using [[Language - Ruby|Ruby]] and [[Language - C Sharp|C# under Mono]], though we do not offer in-depth support for these languages on the SBC. The installation procedures should more or less follow that of [[#Installing Python|installing python]] on the SBC, except you will be installing Ruby or Mono. Performing package searches using [[#apt|apt cache search]] can help you find the relevant software.

For C#, as of 2012 the {{Code|mono-complete}} package is broken on the Debian Squeeze repository. Rather, you have to install the Mono runtime and Mono compiler separately.

To install the runtime package (and its dependencies), use [[#apt|apt]]:

<div class="source">
<syntaxhighlight lang=bash>
apt-get install mono-runtime
</syntaxhighlight>
</div>

Then, to install the C# compiler:

<div class="source">
<syntaxhighlight lang=bash>
apt-get install mono-gmcs
</syntaxhighlight>
</div>

The assembly mscorlib.dll was not found or could not be loaded.
It should have been installed in the `/usr/lib/mono/1.0/mscorlib.dll' directory.

Using apt-get install mono-complete to get a sense of the package tree structure.

apt-get install libmono-corlib1.0-cil

apt-get install libmono-system1.0-cil

gmcs Code.cs -r:Phidget21.NET.dll

mono Code.exe

==Using SBC Linux==

Now that you've set up communication with the SBC, and installed whichever programming language support you need, you're probably ready for a short tour of useful tools on the SBC's version of Linux.

First, you will by default be running on the SBC as '''root''', which is the super-user. For Linux users, this probably makes you nervous because you know you can overwrite important system files without the system asking for additional permission. As a Windows or Mac OS user - although you may usually run your computer as an administrator - your familiar system usually prompts you to confirm before you do anything really dangerous, and this will '''not''' happen on the SBC as the root user.

Next, there is no installed help on the SBC. Help on Linux is usually called 'man pages' which is short for 'the manual pages'. On a full Linux system, usually if you need help with any command you can type, for example, {{Code|man ls}} and it will give you help with the program [[#ls|ls]]. But these help pages take up significant space, and they are widely available online. So, if you need more help with a certain command, you can always type {{Code|man command}} into your favourite search engine.

Finally, the SBC has no windowing system. For Linux users, this means no X-windows (Gnome, KDE, etc). And as a Windows or Mac user, you can think of it as running all of your programs and commands to run your computer through the terminal or DOS prompt command line. The SBC provides all of the functionality of an operating system (e.g. process scheduling, file management, etc) but without any graphical interface. The only exception is the [[#SBC Web Interface|web interface]], which gives graphical access to a limited part of what the SBC can do.

===Some Useful Commands===

If you are doing more with the SBC than simply running pre-written programs [[#Writing a Phidget Program|in Java to run continuously from boot]], you will be interacting with the SBC's Linux operating system over the command line by using [[#SSH|SSH]]. This section discusses useful programs already installed on the SBC, and how to run them on the command line.

====ls====

The '''ls''' program lists the contents of a directory.

It will show both files and folders, but not files that start with a "." (these are hidden files on Linux).
*If you also want to show hidden files, use {{Code|ls -a}}
*If you want more information, such as size and date modified, use {{Code|ls -l}}
*Commands can be combined, like {{Code|ls -al}}

====cd====

The '''cd''' program changes to a new directory.

For example, {{Code|cd /root}} changes into the directory at the base of the file tree called ''root''.

Note:
* Linux uses forward slashes
* The base of all directories is "/" (not "C:\")
* The tilde symbol (~) is short for your home directory (i.e. when you are root, this is short for "/root")
* The double dot ".." means move one directory higher (for example from {{Code|/root/data/}} to {{Code|/root/}})

====pwd====

The '''pwd''' program prints the current directory you are working in. ('P'rint 'W'orking 'D'irectory)

For example:
:{{Code|root@phidgetsbc:~# pwd}}
:{{Code|/root}}

====cp, mv, and rm====

These programs are copy ('''cp'''), move ('''mv'''), and remove ('''rm''').

Copy copies a file from one location and pastes it to another.

For example, if you have a file {{Code|data.txt}}, typing {{Code|cp data.txt data_backup.txt}} will put a copy of the file {{Code|data.txt}} into {{Code|data_backup.txt}}

Move moves a file (this is also useful for renaming files) to a new destination.

For example, if you have a file {{Code|data.txt}}, typing {{Code|mv data.txt data_backup.txt}} will put the contents of {{Code|data.txt}} into {{Code|data_backup.txt}}, and then will remove {{Code|data.txt}}.

Remove deletes a file.

For example, typing {{Code|rm data.txt}} will delete {{Code|data.txt}}.

Note that '''rm''' is final. Once you remove a file using {{Code|rm}}, it is gone forever. There is no recycle bin, no temporary trash, nothing other than backups you may have personally created in the past!

Directories can only be removed with {{Code|rmdir}}, and then only if they are empty. If you want to remove a directory and all the files in it, use {{Code|rm -rf directory}} but be '''very, very careful''' with this command. Trying to remove everything within a directory (e.g. {{Code|rm -rf *}}) is one of the most dangerous commands you can run on a Linux system, as running it from the wrong directory will result in Linux happily removing everything under that directory -- which could be your entire filesystem.

====find====

The '''find''' program does what it says - it finds things.

Unfortunately for the casual user, the find program is very flexible and powerful, and thus not especially intuitive to use. But, here are some examples:

{| style="border:1px solid darkgray;" cellpadding="15px;"
|-
! SSH Command
! What it Does
! Example
|-
| {{Code|find folder -name file.txt}}
| Looks for all files in a folder (/ for root - or all - folders) with a certain name (* for wildcard)
| {{Code|find / -name *.jpg}}
|-
| {{Code|find folder -mtime +X}}
| Looks for all files in a folder modified less than X days ago
| {{Code|find /root -mtime +30}}
|}

====grep====

The '''grep''' program takes text input and searches for a term.

For example, if you type {{Code|mount}} to view what devices are mounted (e.g. loaded) on your SBC, you will see:

<div class="source">
<syntaxhighlight lang=text>
root@phidgetsbc:~# mount
tmpfs on /lib/init/rw type tmpfs (rw,nosuid,mode=0755)
proc on /proc type proc (rw,noexec,nosuid,nodev)
sysfs on /sys type sysfs (rw,noexec,nosuid,nodev)
udev on /dev type tmpfs (rw,mode=0755)
tmpfs on /dev/shm type tmpfs (rw,nosuid,nodev)
devpts on /dev/pts type devpts (rw,noexec,nosuid,gid=5,mode=620)
rootfs on / type rootfs (rw)
procbususb on /proc/bus/usb type usbfs (rw)
/dev/sda1 on /media/usb0 type vfat (rw,noexec,nodev,sync,noatime,nodiratime)
</syntaxhighlight>
</div>

This may be a lot of information you don't need. If you are only interested in a USB key attachment (as described in the [[#Using USB Data Keys|Using USB Data Keys]] section), you can use grep to filter that one response:

<div class="source">
<syntaxhighlight lang=text>
root@phidgetsbc:~# mount | grep sda1
/dev/sda1 on /media/usb0 type vfat (rw,noexec,nodev,sync,noatime,nodiratime)
</syntaxhighlight>
</div>

====nano====

The '''nano''' program is a small text editor that you can use within an SSH terminal.

Nano can be surprisingly useful for writing short lengths of code right on the SBC, so there is no need to transfer files and keep track of different file versions on different computers.

Nano has all keyboard commands which are listed at the bottom of the screen at all times as a reminder (Ctrl-O to save, Ctrl-X to exit, these expand with a larger terminal window). And, nano provides what is called 'syntax highlighting', which colours reserved keywords, comments, strings, and so on as appropriate to the programming language you are using. Nano detects the programming language via the extension of the file ({{Code|.java}} for Java, {{Code|.c}} for C/C++, and {{Code|.py}} for Python).

Typing {{Code|nano test.py}} on an SSH command line and then entering a few lines of Python into the new empty file results in:

[[File:sbc_nano_python.png|link=|alt=]]

====apt====

The '''apt''' program allows you to install, uninstall, upgrade, and search software available for the SBC.
For a non-Linux user, the apt framework may be daunting at first, but it actually allows you to keep your system up to date and install and manage software quickly, easily, and for free.

'''Note:''' Before installing anything on the SBC, make sure that the ''Include full Debian Package Repository'' option is checked in the web interface under {{Code|System → Packages}}.

{| style="border:1px solid darkgray;" cellpadding="15px;"
|-
! SSH Command
! What it Does
! Example
|-
| {{Code|apt-cache search term}}
| Looks for all programs (packages) that have {{Code|term}} in the title or description
| {{Code|apt-cache search opencv}}
|-
| {{Code|apt-cache show package}}
| Shows a lot of data about {{Code|package}} including size, version, etc
| {{Code|apt-cache show unzip}}
|-
| {{Code|apt-get update}}
| Gets the most recent listing of available software
| {{Code|apt-get update}} (No options)
|-
| {{Code|apt-get install program}}
| Installs {{Code|program}} from the internet
| {{Code|apt-get install python}}
|-
|}

====mount====

The program {{Code|mount}} shows you all of the mounted devices on your SBC.

For example:

<div class="source">
<syntaxhighlight lang="text">
root@phidgetsbc:~# mount
tmpfs on /lib/init/rw type tmpfs (rw,nosuid,mode=0755)
proc on /proc type proc (rw,noexec,nosuid,nodev)
sysfs on /sys type sysfs (rw,noexec,nosuid,nodev)
udev on /dev type tmpfs (rw,mode=0755)
tmpfs on /dev/shm type tmpfs (rw,nosuid,nodev)
devpts on /dev/pts type devpts (rw,noexec,nosuid,gid=5,mode=620)
rootfs on / type rootfs (rw)
procbususb on /proc/bus/usb type usbfs (rw)
/dev/sda1 on /media/usb0 type vfat (rw,noexec,nodev,sync,noatime,nodiratime)
</syntaxhighlight>
</div>

For the non-Linux user, the concept of a device may be quite strange. To give a short summary, everything on Linux that you can read or write is a file. Webcams are files (i.e. you can 'read' photos from them), USB keys are files, and each filesystem (tmp storage, the kernel portion, the main filesystem) are also themselves files. These files specify what and how something can be written. These are not necessarily linear, for example, you can see above that the USB key ({{Code|/media/usb0}} is mounted ''within'' the root file system {{Code|rootfs}} which is /.

So mount gives you an idea of what devices have been 'mounted' for reading or writing, and how you can read and write to them. More information on mount (and its various forms, like {{Code|umount}}) is available widely around the Internet.

====which====

The program {{Code|which}} tells you if and where a program is installed.

For example, on a default SBC, typing {{Code|which python}} will return no results. But after successfully [[#Installing Python | installing python]], it will return {{Code|/usr/bin/python}} as the location of the python program/binary/executable.

===Some Useful Commands to Install===

These are other programs you may find useful on the command line. Although they are not on the SBC by default, these and other programs can usually be installed simply by using [[#apt|apt-get install]], with the exception of gcc. For example, {{Code|apt-get install wget}} will download and install [[#wget|wget]].

'''Note:''' This section and the section on [[#Some Useful Commands|pre-installed commands]] can hardly cover all of the complexities and power of the Linux operating system. There are many excellent tutorials online, and between them and using [[#apt|apt]] to find and install programs you should be able to learn a lot and perform any number of complex useful tasks.

====gcc====

The '''gcc''' program is the C compiler for Linux.

If you are an experienced C/C++ user on Mac or Linux, or if you've already read our [[Language - C/C++ | C Language page]], you might think you need to install gcc via {{Code|apt-get}} to compile C code. However, gcc is not in the package repository for the SBC, so {{Code|apt-get install gcc}} will fail. Rather, to install gcc, you can do it via the web interface, as described in the [[#Installing C/C++ and Java|Installing C/C++ and Java]] section.

After installing it via the SBC web interface, you can use {{Code|gcc}} normally.

====less====

The '''less''' program displays the contents of a text or source code file. When displaying the file, {{Code|less}} allows you to scroll up and down to read it.

This is useful if you are writing your sensor readings to a data file, and you want to read the data file while it is being written by your main code. If your data file is called {{Code|data.txt}}, you can type {{Code|less data.txt}} and see the lines in the file, and what they are.

The {{Code|less}} program output can also be piped into another program. For example, you can use {{Code|less}} and the word search program {{Code|grep}} to find lines within a file with a search term. For instance, if you have a C source code file {{Code|Program.c}} on the SBC, and you want to see all the lines in {{Code|Program.c}} that contain a variable name {{Code|var}}, you can type:
:<code>less Program.c | grep var</code>

====wget====

The '''wget''' program allows you to get an online file (over http) and download it to the SBC.

For example, to get the source file (HTML) from the Phidgets home page, you can type:

<div class="source">
<syntaxhighlight lang=bash>
wget http://www.phidgets.com
</syntaxhighlight>
</div>

This is most useful for downloading libraries, drivers, or anything (zip, tar, etc) you need from the web which is not available by [[#apt|using apt]].

===Writing a Phidget Program===

We provide two ways to write and upload a Phidget Program:
# The [[#SBC Web Interface|web interface]]:
#* This is useful for simple projects written in Java that you want to start only at boot
#* You can also use C projects, but they must be compiled off the SBC for an ARM processor
# Over [[#SSH|SSH]], which will allow you to write or transfer source code directly to and from the SBC
#* This is useful for all other projects, such as:
#** Projects that run at scheduled times (e.g. once per minute)
#** Projects that use languages other than Java or ARM-compiled C
Note that you can still run an [[#SSH|SSH]] project at boot, you just have to write and install a startup script. This is a bit complex, but we do have an example that starts the program {{Code|phidgetwebservice21}} [[OS - Linux#As A Service|at boot using a script]].

Once you know which method you'd like to use, you can continue on to learn how to [[#Program in Java with the Web Interface|Program in Java with the Web Interface]], or how to [[#Program with SSH|Program with SSH]] using Java, C, or Python. If you are actually typing in source code on the SBC, you'll find our [[#Developing Code on the SBC|developing code on the SBC section]] useful.

====Program in Java with the Web Interface====

To show how to write, compile, and install Java programs on the SBC, we'll use the [[Language - Java|Java Hello World]] example code. You can download the HelloWorld example by downloading the whole [http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20120216.zip Java example package]. Make sure you have [[#Installing C/C++ and Java|Java installed on the SBC]].

Here's how to get the HelloWorld code running on the SBC. On your external computer:

1. Download the SBC version of the Phidget Java libraries ({{Code|phidget21.jar}}). You can download this from the [[#SBC Web Interface|web interface]], on the page under {{Code|Projects → Projects}}, under the '''Notes''' section.

2. Place the SBC version of {{Code|phidget21.jar}} into a directory on your external computer. This will be your working directory that you will use to compile the Java files.

3. Also copy the {{Code|HelloWorld.java}} file into that working directory.

4. Compile the {{Code|HelloWorld.java}} file from within that working directory. From the command line prompt on Windows, this will be:
<div class="source">
<syntaxhighlight lang=bash>
javac -classpath .;phidget21.jar HelloWorld.java
</syntaxhighlight>
</div>
In a terminal on Linux or Mac OS, this will be:
<div class="source">
<syntaxhighlight lang=bash>
javac -classpath .:phidget21.jar HelloWorld.java
</syntaxhighlight>
</div>

5. You should now have three compiled class files: {{Code|HelloWorld.class}}, {{Code|HelloWorld$1.class}}, and {{Code|HelloWorld$2.class}}. You don't need to try and run them, and if you do you may encounter an error because the SBC {{Code|phidget21.jar}} may be slightly different than the Phidget support you have installed on your external computer.

Now we move onto the SBC:

6. Create a new project on the SBC, in the web interface under {{Code|Projects → Projects}}. Call it HelloWorld:

[[File:sbc_create_project.png|link=|alt=]]

7. On the next screen, you will be prompted to upload your files. We will upload the three Java class files, and then click the {{Code|Start}} button:

[[File:sbc_web_run_project.png|link=|alt=]]

8. You'll note that as it runs, there are two links below the {{Code|Stop}} button: One called {{Code|stdout}}, which is ''Standard Output'', and one called {{Code|stderr}}, which is ''Standard Error''. Usually, when you run a program on the command line, you see both standard out and standard error at the same time - i.e. you get all program output right there in your terminal or command prompt. But when running a program in the background, Linux splits the output up into normal output and error output as this is very useful for debugging (i.e. you can check if standard error is empty).

Here, however, if you're not sure whether the program will run correctly, you should first check {{Code|stderr}} to see if any errors were generated, and then check {{Code|stdout}} to see if the output looks as expected.

To write your own Java program, follow the same process but use your own source code instead of the {{Code|HelloWorld.java}} example.

Now that you have a running program, we offer additional help on [[#Via the Web Interface|running a program automatically using the web interface]].

====Program with SSH====

Similarly to starting a program via the [[#Program in Java with the Web Interface|web interface]], we use the Phidget Java {{Code|HelloWorld}} example here.

Make sure you have [[#Installing C/C++ and Java|Java installed on the SBC]]. To compile and run the {{Code|HelloWorld}} example:

1. Open an [[#SSH|SSH terminal]] to the SBC

2. Download the [http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20120216.zip Phidget Java Examples] to the SBC, using [[#wget|wget]] (you may need to install {{Code|wget}} using [[#apt|apt]].)

3. Unpack the examples using [[#unzip|unzip]] (you may need to install {{Code|unzip}} using [[#apt|apt]].)

4. The location of {{Code|phidget21.jar}} on the SBC is {{Code|/usr/share/java/phidget21.jar}}. Within the unzipped example directory, compile the {{Code|HelloWorld.java}} example:

<div class="source">
<syntaxhighlight lang=bash>
javac -classpath .:/usr/share/java/phidget21.jar HelloWorld.java
</syntaxhighlight>
</div>

5. To run the {{Code|HelloWorld}} program, use:

<div class="source">
<syntaxhighlight lang=bash>
java -classpath .:/usr/share/java/phidget21.jar HelloWorld
</syntaxhighlight>
</div>

Now that you have a running program, you'll probably want to learn to [[#Running a Program Automatically|run this Java program automatically]].

'''Permissions Note:''' If you're used to using Linux with Phidgets already, you'll probably notice that you don't need to switch into root using {{Code|sudo}} on the SBC in order to run programs. This is because you already are running as root, not because the [[OS - Linux#Setting udev Rules|udev rules are set up]]. So if you set up another user, or [[#Via Cron|run a cron job]] as anything other than root or system, you'll need to add permission for the Phidget program to run in your [[OS - Linux#Setting udev Rules|udev rules]].

====Developing Code on the SBC====

When you're not just using pre-written source code, and you're writing code actually on the SBC itself, you'll probably want to use [[#nano|nano]]. Other terminal editors on the SBC include {{Code|vi}} which is already installed, and {{Code|emacs}}, which you can install using [[#apt|apt]]. Both {{Code|vi}} and {{Code|emacs}} are much more efficient for the experienced user, but they contain modes and keyboard shortcuts that can seem strange or almost hindering to the casual user.

Regardless of which editor you choose to use, some of your keyboard habits may not transfer well. For example, in the Linux command line, the command {{Code|Ctrl-C}} means ''stop the currently running program'', (i.e. your open editor) not copy. Within most SSH terminals, you can copy and paste using the right-mouse button, and on some terminals (and all native Linux terminals) you can copy by simply highlighting text, and you can paste it using the middle (scroll) mouse button. On the other hand, if you write a program that hangs on the command line, {{Code|Ctrl-C}} can actually be useful to terminate it.

Also {{Code|Ctrl-Z}} does not mean ''undo'', rather it means ''run the current program in the background''. This is useful because running a program in an SSH terminal simply hangs your SSH input until the program is done. So typing {{Code|Ctrl-Z}} while the program is running frees up the command line for more input. But if you accidentally hit {{Code|Ctrl-Z}} while running an editor like [[#nano|nano]], the editor will immediately exit to the command line. Don't worry though, it will not stop or lose your work. You can bring it back up by using the {{Code|fg}} (e.g. 'foreground') command, like {{Code|fg nano}}, and this will automatically bring your nano process back to the front.

===Running a Program Automatically===

For testing your program, you will certainly want to run it via [[#SSH|SSH]] or via the {{Code|Start}} button on the project page on the web interface until you are quite sure it runs well. However, eventually you will probably want the program to run without your input, either [[#Via the Web Interface|continuously, and starting at boot]], or via a task scheduled to [[#Via Cron|run to completion at certain times]].

Both have their advantages and disadvantages. Usually, you would want to use the continuous, from-boot methods for event driven code that has to handle a wide variety of user input that could occur at any time. You would want to use the scheduled method when the SBC needs to perform a repeated task (e.g. reading sensor data) again and again. The main difference is:
* With the continuous (boot) method you can have any Phidgets (including sensors, LEDs, input switches, etc) attached and giving events to your code all the time, and
* With the scheduled (cron) method you have much less of a chance to run into long-term memory management and instability problems with any code you write, because your program runs for only a short time before exiting and getting cleaned up.

====Via the Web Interface====

To use this method, you must have created the program you want to run as [[#Program in Java with the Web Interface | a Java or ARM-compiled C project in the web interface]]. If you would like to use another language, or another way of uploading your project, but you still want to start at boot and run continuously, you will need to use a [[#Via a Boot Script|boot script]].

In the web interface, go to the {{Code|Projects}} tab, and click on the project you would like to run. Near the bottom of the project page (the one with the {{Code|Start}} and {{Code|Stop}} buttons at the top), there will be a section called {{Code|Startup Settings}}. You can see a screenshot of the whole project page, including these settings, in the [[#Program in Java with the Web Interface | web interface project section]].

Select the {{Code|Enabled}} radio button. The other defaults should be fine, unless you specifically know otherwise:
* For ''Boot Order'', lower numbers boot first. Booting later means more programs are available for use, booting earlier means other programs can use your program.
* ''Run as a daemon'' starts the program as a daemon, which is a program that runs in the background. Unless you have ''explicitly'' written your program as a daemon, leave this checked. (If you don't know what a daemon is, don't worry, you haven't written one, so leave it checked.) ''Un''checking this when your program is a normal program will cause the SBC to hang while booting.
* The ''Executable or Class'' name should be automatically sensed to be your main Java class
* ''Arguments'' are any command line arguments you need, just as you would type them into the command line

'''Note:''' Your program must be very, very stable to run properly via the web interface. Imagine your program running continuously for days, or months on end. Any memory leaks, over time, will render your program (and the SBC) unusable until a reboot. Counts or other variables that increase within your program and never reset may create a segmentation fault eventually.

If, for stability purposes, you want your program to start, run for a little while, and then exit so that the SBC operating system can clean up the memory each time, you'll probably want to use [[#Via Cron|Cron]] to run your program instead.

====Via Cron====

Cron can automatically schedule programs - known as 'jobs', or 'cron jobs' - at most once per minute. Less often than that, it is very flexible, allowing you to run it on certain months, weekdays, hours, etc. Cron simply reads a special file (your {{Code|crontab}}) and runs whatever programs are listed, with whatever timing they are listed with. The cron program runs all the time in the background, making it what is known as a Linux ''daemon'', but the programs it starts as jobs run only as long as they naturally would, and then they exit.

If you need your program to run more often than once per minute, have the program schedule itself while still running. For example, to run every five seconds, run a fast loop, and sleep for five seconds. Do this twenty times and exit. Then schedule this once per minute using cron, and your program will in essence run every five seconds.

Setting up a cron job simply entails editing your {{Code|crontab}} file.

First, you'll probably want to specify your default editor to be [[#nano|nano]]. Otherwise it will default to {{Code|vi}} and you'll have to figure out {{Code|vi}} in order to add lines to your crontab:

<div class="source">
<syntaxhighlight lang=bash>
export EDITOR=nano
</syntaxhighlight>
</div>

Then, to edit your crontab file, simply type:

<div class="source">
<syntaxhighlight lang=bash>
crontab -e
</syntaxhighlight>
</div>

Each line of the crontab file is one scheduled job. Lines that start with a hash "#" are comments and are ignored. There is an example line in the crontab, and a reminder line at the very end. Essentially, each line should contain:

<div class="source">
<syntaxhighlight lang=text>
minute hour dayOfMonth month dayOfWeek command
</syntaxhighlight>
</div>

Where:
*{{Code|command}} is the program you want to run (with absolute path, and arguments)
** For example, {{Code|./myprogram argument1}} won't work, but {{Code|/root/code/myprogram argument1}} will
* Each time argument is either a number, a list of numbers separated by commas, or an asterisk
** For example, * * * * * means every minute for all days and months, 0,30 * * * * means every thirty minutes (i.e. at the top of the hour and at 30 minutes in) for all days and months

If you already have jobs scheduled, you'll see them in the file that comes up. You can edit, add, or delete.

After you save, you'll see a little message back in the terminal that says the new crontab file was installed, and it is now scheduled! Cron always starts every boot, and so if you have edited and installed your crontab as above, the scheduling of your program will start properly even after a reboot of the SBC. However, if you are having strange scheduling problems, you may want to familiarize yourself with the [[#Software Details|software details]] of how the SBC as a whole determines the current date and time.

=====My Cron Job Doesn't Work!=====

It is actually very common for a script or program to work on the command line but then ''not'' work as a cron job. The most common reason for this, by far, is that you specify ''relative'' paths in your program to access files rather than ''absolute'' paths. For example:
* {{Code|code/project.c}} is a relative path (bad for cron)
* {{Code|/root/code/project.c}} is an absolute path (good for cron)
The cron jobs are ''not'' executed from your home directory, or your code directory, so they will not be using the same location you may be using to test your code. So always use absolute paths.

Another common reason is you may be using environment variables or other settings that are true in a terminal but are ''not'' true by default in the raw system. You can end up taking many things for granted in a shell, for example the shortcut "~" means home directory in a shell, but not by default in the raw system. The things that get loaded for a shell (but which are not present in the raw system) are:
* The settings loaded by {{Code|/etc/profile}}
* Any settings in {{Code|~/.bashrc}}, which is nothing by default on the SBC

On a full Linux operating system, you would use the logs written to by cron to find the error output and debug it. On the SBC, however, cron does not write logs (otherwise, these logs would eat up the SBC memory very quickly even for routine jobs). For short-term debugging, you can write output from your program to a file, and read that file afterwards to figure out what your program is doing.

====Via a Boot Script====

If you want to run your program constantly and for it to start at boot like the [[#Via the Web Interface|web interface would do]], you can install your program into the boot order using a script. This is a somewhat involved process, and you should be familiar with shell programming in Linux. For this process, we only offer a [[OS - Linux#As A Service|similar example]] which installs and runs the program {{Code|phidgetwebservice21}} within the boot sequence.

===Using USB Data Keys===

After plugging the USB key in, it won't just appear on your desktop, so to speak, so you'll need to figure out where you can read and write to it within the SSH directory structure.

The web interface program can help with this. After you plug a USB key in, it will show up under {{Code|Status → System}}. Or, the USB key and all other attached devices can be seen at {{Code|Status → USB}}:

[[File:sbc_mounted_devices.png|link=|alt=]]

In the screenshot above, you can see that the USB key is located in {{Code|/media/usb0}}.

Alternately, you can use the SSH command {{Code|mount}}, and the searching program {{Code|grep}} which will filter the response of {{Code|mount}} and only return the lines with your search term ({{Code|usb}}):

<div class="source">
<syntaxhighlight lang=bash>
root@phidgetsbc:~# mount | grep usb
/dev/sda1 on /media/usb0 type vfat (rw,noexec,nodev,sync,noatime,nodiratime)
</syntaxhighlight>
</div>

In this case, the USB key can be written to and read from using the {{Code|/media/usb0}} directory. Copying a file to {{Code|/media/usb0}} will copy a file to the USB key. The same goes for removing, renaming, opening files within your program, etc.

'''Note:''' Mount points like {{Code|/media/usb0}} should not be hard-coded into any of your programs. (See the [[#Common Problems and Solutions | Common Problems and Solutions]] section for more information.) If you need to obtain the mount point for a freshly mounted USB key within your code, have your code obtain the mount tables and search on the ''device'' (e.g. {{Code|/dev/sda1}} or {{Code|/dev/sdb1}}) and obtain the corresponding mounted {{Code|/media/usbN}} location, where N is a number 0-9.

===Saving and Retrieving Data===

This section covers getting data on and off of the SBC. There are two main methods of simply moving data on and off the SBC - via a [[#Via a USB Key|USB key]], and via [[#Over the Network (SCP)|copy over the network]] - and a third method for moving and installing data when it concerns [[#Backing Up Your Data|backing up lower level system data]].

====Via a USB Key====

After plugging in a USB data key, first you need to [[#Using USB Data Keys | find out the location]] where that data key was mounted.

Let's say the location of the USB key is {{Code|/media/usb0/}}, and we want to copy the file {{Code|data.txt}} to the USB key. Your SSH session might look something like this, using [[#ls|ls]] and [[#mount|mount]]:

<div class="source">
<syntaxhighlight lang=bash>
root@phidgetsbc:~# ls
data.txt
root@phidgetsbc:~# mount
tmpfs on /lib/init/rw type tmpfs (rw,nosuid,mode=0755)
proc on /proc type proc (rw,noexec,nosuid,nodev)
sysfs on /sys type sysfs (rw,noexec,nosuid,nodev)
udev on /dev type tmpfs (rw,mode=0755)
tmpfs on /dev/shm type tmpfs (rw,nosuid,nodev)
devpts on /dev/pts type devpts (rw,noexec,nosuid,gid=5,mode=620)
rootfs on / type rootfs (rw)
procbususb on /proc/bus/usb type usbfs (rw)
/dev/sda1 on /media/usb0 type vfat (rw,noexec,nodev,sync,noatime,nodiratime)
root@phidgetsbc:~# cp data.txt /media/usb0/
</syntaxhighlight>
</div>

The '''cp''' program copies data from a source to a destination. The syntax is {{Code|cp from to}}, where here we are copying from {{Code|data.txt}} to {{Code|/media/usb0/}}.

'''Caution:''' Even if there is no USB key mounted at {{Code|/media/usb0/}}, this use of {{Code|cp}} will still work ''with no errors''! This is because there is still a file called {{Code|/media/usb0/}}, there is just no USB key file system ''mounted'' to that point. So be sure to run [[#mount|mount]] or use some other method of determining that there is, in fact, a USB data key attached and where it is mounted to.

====Over the Network (SCP)====

SCP is a command line program already installed on Linux and Mac OS, and downloadable for free on Windows. We discuss it and give examples in the [[#SSH|SSH]] section, but remember it here when you're trying to get data on and off of the SBC. With SSH or a terminal already open, you'll probably find it to be much faster and easier than dealing with a USB key.

====Backing Up Your Data====

For the web interface, you can save and restore all web interface settings under the {{Code|System → Backup & Restore}} tab.

To save the settings of what packages are installed for later re-installation, you can type:

<div class="source">
<syntaxhighlight lang=bash>
dpkg --get-selections > installedPrograms.txt
</syntaxhighlight>
</div>

Then save the file {{Code|installedPrograms.txt}} externally. If you have to completely wipe the SBC, you can just reinstall the whole list by moving the {{Code|installedPrograms.txt}} file back onto the SBC, and then typing:

<div class="source">
<syntaxhighlight lang=bash>
dpkg –set-selections < installedPrograms.txt
apt-get dselect-upgrade
</syntaxhighlight>
</div>

Also remember to externally save:
* Your {{Code|~/.bashrc}} settings file if you've changed it
* Your {{Code|crontab}} file if [[#Via Cron|you've edited it]]
* Any data files or code you've created

It is important to save these settings often, and at points where you know the system is running well. It may be tempting to create a backup right before you [[#Recovery System|wipe the SBC and start from scratch]], but often the reason you are having problems then is some setting or change, and backing these up and reinstalling them will only reinstall the problem.

To truly back the files up, you must copy them to an external computer or location using either a [[#Via a USB Key|USB Key]] or [[#Over the Network (SCP) | over the network]]. Then they can be copied back if needed later.

If you are looking to restore data on an SBC that will not boot properly, you'll want to be in the [[#Partial Recovery|partial recovery]] portion of our Troubleshooting section.

==Troubleshooting==

The SBC can be quite tricky to debug, because it is a complex and flexible computer. Common problems and solutions include:
* You can't find the SBC on the network at all - refer to the [[#Initial Internet Setup|Initial Internet Setup]] section
* You have changed some setting or file such that the SBC doesn't run anymore, or doesn't run as expected - refer to the [[#Recovery|Recovery]] section

If you are having trouble using Phidgets on the SBC, you should go through the [[OS - Linux#Troubleshooting | Troubleshooting section on the general Linux page]]. Some of the problems on the Linux page (such as library problems) are easier to fix by simply working through the [[#Recovery|Recovery]] section when they occur on the SBC.

Namely, it often helps to simply perform a [[#Factory Reset|factory reset]] on the SBC (save your files and installed program list first, as [[#Backing Up Your Data|described here]]). Sometimes you change a file or setting within the operating system when you are trying to get something up and running, and this unintentionally affects other programs too. Performing a factory reset starts you with a clean slate.

If your problem doesn't seem to be fixed by these steps, or the information within this guide, please [[Contact Information|ask us]]!

===Initial Internet Setup===

To set up the SBC, you almost always need a ''wired'' Ethernet connection with DHCP (Dynamic Host Configuration Protocol), and without a firewall. This connection should be to a ''router'', not directly plugged in to your computer.

Even if you do not have this type of a connection at home, these types of connections are very common at both offices and universities. On a Windows or Mac OS computer, you can bring up the Phidget Control Panel as described in the SBC's [[1072 0 - Getting Started|Getting Started Page]]. Failing this, or on a Linux computer, we discuss some alternate setup methods in this section. Keep in mind that without a wired, open DHCP connection these setup methods can be difficult and fickle.

====No Wired-Only Connection====

Sometimes it can work to plug the SBC, using Ethernet, directly into an Ethernet port on your home wireless router. Do not plug it directly into your computer! (Although in some instances, a direct connection can be made to work on Linux, see the [[#No DHCP|No DHCP]] section below)

This direct-router method is a very picky process, however, and can fail because:
* Some home and office routers place a firewall between wireless connections (clients) and wired connections (the local area network)
* Some home and office routers do not by default allow both Ethernet DHCP and wireless DHCP.
* Some routers and DHCP hubs only provide access to an internet connection, and do not provide local area network inter-connections (this is common on mobile device tethering hubs)

Routers are quite complex, and even with admin privileges it can be a painstaking process to find all the right firewall settings to turn off in order to allow two computers on the network to talk to one another, rather than just connect to the internet. This is why university or office networks are often ideal for the purpose of setting up the SBC, because these institutions depend on computers on a local network being able to talk together. University libraries in particular can be a good source of wired DHCP connection ports.

Covering all of the different router configuration possibilities here, and how to change them to make the SBC work, is essentially impossible. If you try using the SBC at home or at work, the SBC does not work on the first try when plugged directly into the router via Ethernet, and you want to make that connection work rather than seeking out an alternate for the initial setup, you should find documentation specific to your router (usually available online) and properly configure it.

The good news is that if you can find an Ethernet DHCP connection ''just once'' for a short time, you can use that connection to configure the SBC to work on your home wireless network. During that initial connection, you can enable wireless and set up as many wireless DHCP connections (with passwords) that you need. Once wireless is enabled and set up, you can take the SBC home to your wireless router and the SBC will automatically seek out and connect to its remembered networks as they appear. At that point, you can also use wireless like a normal internet, web interface, and SSH connection.

====No Link Local Addressing====

If you have a wired DHCP connection, no firewall, and no link local addressing (e.g. bonjour or avahi is not installed) then you will need access to the DHCP router logs. From the router logs, you should see the connection (or attempted connection) by the SBC within the logs. From that log entry, you should either be able to determine the IP address for the SBC, or see what happens when the router blocks access. The IP address can be used in place of the link local address for both the web interface and for SSH.

====No DHCP====

The SBC will first try to use DHCP, but then it will revert to responding to a link local address under bonjour and avahi. If you are depending on this, please wait '''at least three minutes''' after the SBC boots for the SBC to fail in obtaining a DHCP connection and properly revert to link local addressing.

If you have a static IP setup, and want to use link local addressing rather than accessing the router logs, this should usually work by default on Windows and Mac OS (e.g. type the address such as {{Code|phidgetsbc.local}} into a web browser). If it doesn't work automatically, there is not much you can do and you should seek out a wired DHCP connection elsewhere.

On Linux, it also should work by default, but you have the additional option of explicitly adding routes that look within the default network settings for the SBC. From a terminal (as root), type:
* {{Code|route add -net 169.254.0.0 netmask 255.255.0.0 dev eth0 metric 99}}
* {{Code|route add default dev eth0 metric 99}}
You can also compile and use the {{Code|phidgetsbclist.c}} example (use the provided Makefile, don't use gcc) in the [http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20120216.tar.gz Phidget Linux Libraries] package, under the {{Code|examples}} folder. This will allow you to see if the SBC is detected on the network at all. Note that to use this option you must have the Phidget Libraries and the Phidget WebService installed on your Linux computer - in-depth instructions to do this are on the [[OS - Linux|main Linux page]].

===Recovery System===

You can either boot the SBC into recovery mode and attempt to recover files and settings, or you can completely wipe the SBC by performing a factory reset. If the LEDs do not turn on normally (red on constantly, green on at first start, then off, then on when fully booted) then you'll want to read the [[#Hardware Issues|hardware issues]] section.

====Partial Recovery====

The recovery system can be entered in two ways:
# From the {{Code|System → Backup & Restore}} web interface page.
# By holding down the reset button for 20+ seconds - until the green light has switched from flashing slowly to flashing quickly.

The recovery system runs an [[#SSH|SSH]] server where the username and password both are {{Code|root}}.

If the main filesystem has been damaged/misconfigured in such a way that it won’t boot, you may be able to fix the issue or recover important files before running a full factory reset. From an SSH connection to the recovery system, you can mount the main root filesystem with the following commands (assuming it’s not damaged):

<div class="source">
<syntaxhighlight lang=bash>
ubiattach /dev/ubi_ctrl -m 6
mount -t ubifs /dev/ubi0_0 /mnt
</syntaxhighlight>
</div>

====Factory Reset====

This restores the kernel and root filesystem from backup, overwriting any changes that may have been made and ''completely wiping the system'' to the state that it got shipped in. (You can save your files and installed program list first, as [[#Backing Up Your Data|described here]].) This can be enacted one of two ways.
# Use the reset button:
##Enter the recovery mode by holding down the reset button for 20+ seconds as above (until fast flashing)
##Wait for a full boot (i.e. you can see it on the Phidget control panel, or can SSH with username and password as {{Code|root}})
##Hold down the reset button again, but this time for only 10 seconds (until slow flashing)
##Wait for the SBC to fully reset and reboot (at least three minutes) - the LED will turn off and on again when this occurs
##*Note that after a factory reboot the SSH server will be disabled
##*Also note that after a factory reboot the SBC creates new SSH keys, and reverts to the {{Code|phidgetsbc.local}} address
# Via the web interface, under {{Code|System → Backup & Restore → Go button}}, where you can follow the instructions

====Hardware Issues====

The LEDs are an indicator of the hardware working properly. The normal boot process is:
* Red LED: Turns on from moment of power being applied.
* Green LED: Turns on momentarily when power applied, then turns off momentarily, then turns on and stays on when booted.

If the green status LED never turns on (or fails to turn on the second time), the boot process is failing somewhere. This could be due to:
* A damaged OS - Try performing a [[#Factory Reset|Factory Reset]]
* If this fails, it is likely hardware damage (very difficult to diagnose, please [[Contact Information|contact us]])

If neither LED turns on, hardware damage is even more likely. Unless the path to the red LED is the one thing that has been damaged, the device is likely not receiving and using power.
* Try performing a [[#Factory Reset|Factory Reset]], and if that does not work please [[Contact Information|contact us]]

=====USB Issues=====

On the Phidget SBC2, there is a hardware issue that is unrelated to the LEDs. It is a USB problem, and manifests in many ways:
* Strange behaviour when some devices but not others are plugged in to the SBC
* Strange behaviour with combinations of devices
* Failure (or intermittent failure) to see Phidgets on the USB hub, or USB keys on the hub

This problem is fixable, either on your own or by sending your SBC back to Phidgets. For an in-depth solution, see the [[SBC2_USB_Hub_Fix | SBC2 Hub Fix Page]].

===Updating Your SBC===

If you've owned your SBC for a while and want to update your packages, you can run:

<div class="source">
<syntaxhighlight lang=bash>
apt-get update
apt-get upgrade
</syntaxhighlight>
</div>

...to ''update'' your software source list and then ''upgrade'' to the latest version of all installed software. If you are used to Mac OS or Windows, note that this does not just update the non-kernel parts of the operating system, it updates every additional piece of software you have installed.

To update the SBC software itself (e.g. the kernel), it is easiest to use the web interface, under {{Code|System → Backup & Restore → Go button}}, to enter a page that will give you the option to update. You will need to have an update file on a USB key inserted into the SBC, of type:
* UBI Image (system_ubi.img), or
* Kernel image (uImage), or
* Phidget Upgrade package containing both UBI and Kernel images (phidgetsbc*.bin)

These are either obtained from the Phidgets website, or are a custom kernel / filesystem that you can create yourself, if you are experienced.

The reason why this information is in troubleshooting is that you should certainly [[#Backing Up Your Data|back up your system]] before trying this. And, it is quite rare to need to upgrade the kernel or filesystem on the SBC, so something serious should be going on before you attempt it. Try using the [[#Recovery System|recovery system]] first.

==Programming Languages==

Now that you have the basic libraries installed, you can pick your language and begin programming!

If you are not using the [[#WebService | webservice]] to control a Phidget over a network, your next step will be to delve into the use of your specific language. Each page has its own set of specific libraries, code examples, and setup instructions.

On SBC Linux, we recommend the following languages:

*[[Language - C/C++|C/C++]]
*[[Language - Java | Java]]
*[[Language - Python | Python]]

These languages may also run on the SBC, but we do not yet directly offer SBC support for them:
* [[Language - Ruby|Ruby]]
* [[Language - C Sharp|C#]] (using Mono)

You can probably figure out how to install and use them by a combination of the language pages linked above, and the section on [[#Installing Other Languages|installing other languages on the SBC]].

==WebService==

The SBC comes with the [[Phidget WebService]] installed, and the SBC automatically starts the WebService at boot.

To practice using the WebService, and to learn more about it, we have hands-on examples on the [[OS - Linux|general Linux page]], starting in the [[OS - Linux#Using the WebService|using the WebService section]].

==Advanced Uses==

===Using a Different Wireless Adapter===

The support for the wireless adaptor that Phidgets sells is written into the SBC kernel. Hence, we do not support using other adaptors.

However, Linux is very flexible, and it is possible (though not easy) to write a custom kernel for the SBC and add support for a new wireless adaptor. We can't help you with this, but we do provide some basic guidelines for [[#Custom Kernel and Filesystem|building your own kernel]].

===Using a Different Webcam===

In addition to the webcam that Phidgets sells, you have the option to use many different webcams with the SBC. There is a [http://www.ideasonboard.org/uvc/#devices long list] of compatible webcams.

The common thread for these webcams is that they use UVC - the USB Video Class - drivers for Linux. You can then use [[#mount|mount]] to find out what video device your webcam is mounted under.

===Taking Pictures With the Webcam===

Probably the most straightforward way to use a webcam for pictures rather than video is to use the {{Code|opencv}} library. You can get it by:

<div class="source">
<syntaxhighlight lang=bash>
apt-get install libcv2.1
</syntaxhighlight>
</div>

If there is no {{Code|libcv2.1}} package, you can perform {{Code|apt-cache search libcv}} to find the current version.

The opencv libraries can also be used within Python, by installing the link between them:

<div class="source">
<syntaxhighlight lang=bash>
apt-get install python-opencv
</syntaxhighlight>
</div>

Then taking pictures from within code becomes quite simple. For example, in Python, taking and saving an image is four lines:

<div class="source">
<syntaxhighlight lang=bash>
#! /usr/bin/python

import cv

# The webcam is located at /dev/video0
# OpenCV only needs the number after video
webcam = cv.CaptureFromCAM(0)

frame = cv.QueryFrame(webcam)

cv.SaveImage("image.jpg", frame)
</syntaxhighlight>
</div>

For the complete OpenCV documentation, see [http://opencv.willowgarage.com/documentation/index.html The OpenCV Reference], and specifically the section on [http://opencv.willowgarage.com/documentation/reading_and_writing_images_and_video.html Reading and Writing Images].

===Checking System Logs===

The SBC maintains two logs: a kernel log and a system log.

The kernel log is for low-level occurrences, such as devices attaching and leaving the USB hub, recording what drivers are being used, and so on.

The system log (syslog) is for normal chatter from the operating system. Any program with the right permissions can use it (though you need to know the method to write to it, information all around the Internet can help) and it contains everything from the Ethernet going up and down, to webserver requests, and so on. If you don't run many programs or services on the SBC, the syslog will essentially be a mirror of the kernel log, because the kernel is the only thing talking.

You can check these logs by using the web interface in the {{Code|System → Logs}} tab.

Or you can perform more powerful filtering and displaying via an SSH terminal. For example, {{Code|dmesg}} is the command to display the kernel log, and {{Code|tail}} prints the last ten lines of input. So, if you are trying to see if you can get a device to be detected on USB, you can run <code>dmesg | tail</code> to print the latest ten lines of kernel log data.

The actual locations of the log files (for filtering and reading) are:
* {{Code|/var/log/syslog}}
* {{Code|/var/log/dmesg}}
But don't edit them directly! Always follow the advice and procedures around the Internet on how to properly log items to syslog.

===Custom Kernel and Filesystem===

You can compile your own kernel and flash it to the board. It is left up to the user to configure an appropriate cross-compiler for kernel development. You may also be able to compile a new kernel on-board.

Compiling a new, custom kernel is somewhat hard. If the SBC is your first experience with Linux, writing a custom kernel will be very difficult, and more probably impossible. We might be able to offer additional suggestions to people who have extensive experience in Linux already, but ultimately you're on your own here.

You may be able to write a custom kernel right on the SBC, but the easiest way is to develop the kernel on an external computer. And the easiest way to develop on an external computer is for that computer to also be Linux. On your external Linux system, you will need a cross-compiling toolchain for the ARM processor, which we briefly describe on the [[OS - Linux#Cross-Compiling with a Custom Toolchain | main Linux page]].

Also on your external computer, you can download the [http://www.phidgets.com/downloads/libraries/phidgetsbc2-kerneldev_1.0.1.20120106.tar.gz SBC Kernel Development Package] from the Phidgets website. This kernel development kit has a brief README file which describes how to obtain the proper kernel and patch, configure, customize, and build it.

After making your new kernel, you should have a uImage and modules target for your Makefile. At this point you can transfer your kernel files onto the SBC, make their targets, and transfer them into the nand memory. This involves erasing the old kernel, flashing the new kernel, installing the new kernel modules, and rebooting. From the SBC, in the kernel directory:

<div class="source">
<syntaxhighlight lang=bash>
make uImage; make modules
flash-eraseall /dev/mtd3
nandwrite -p /dev/mtd3 arch/arm/boot/uImage
make modules-install
reboot
</syntaxhighlight>
</div>

Custom kernels can also be flashed from the [[#Recovery System | Recovery System]].

If you need to create a root filesystem image, the filesystem type is UBIFS, and the commands to create it are:

<div class="source">
<syntaxhighlight lang=bash>
mkfs.ubifs -m 2KiB -e 126KiB -c 4050 -r $ROOTFS/ system_ubifs.img
ubinize -o system_ubi.img -m 2KiB -p 128KiB -s 512 ubinize.cfg
</syntaxhighlight>
</div>

Where {{Code|ubinize.cfg}} contains:

<div class="source">
<syntaxhighlight lang=bash>
# Section header
[rootfs]
# Volume mode (other option is static)
mode=ubi
# Source image
image=system_ubifs.img
# Volume ID in UBI image
vol_id=0
# Volume size
vol_size=64128KiB
# Allow for dynamic resize
vol_type=dynamic
# Volume name
vol_name=rootfs
# Autoresize volume at first mount
vol_flags=autoresize
</syntaxhighlight>
</div>

You then flash ‘system_ubi.img’ (not ‘system_ubifs.img’) from the recovery system.

Again, like the custom kernel creation, the need to create a custom root filesystem is essentially non-existent except for those advanced users who already know they need it... and furthermore, you are almost entirely on your own.

==Software Details==

For even more advanced uses of the SBC, it may help to know the gritty details of the SBC software system.

;Operating System
:Debian/GNU Linux
:Kernel 2.6.X or higher (generally kept up to date with latest releases, use {{Code|uname -r}} to check the kernel version)

;Main Filesystem (rootfs)
:UBIFS (a raw flash type of file system)
:Mounted in a 460 MB Nand partition (in Read/Write mode)

;Kernel
:uImage format
:Has its own 3MiB partition on bare Nand

;Web Interface Scripts and Configuration Data
:Located in {{Code|/etc/webif}}
:Modifying these scripts can be done; however, it is very easy to enter invalid data that could cause the system to behave unexpectedly or not boot.

;User Applications uploaded through Web Interface
:Located in {{Code|/usr/userapps}}

;Webcam Device Location
:{{Code|/dev/video0}}
:Numbers increase with more webcams

;Date and Time
:Set using ntp (network time protocol) at boot
:The ntp daemon continues to run in the background and will periodically update the clock
:The network keeps the SBC very close to real time
:Also there is a real-time clock with battery backup which will preserve date/time across reboots, power removal
:The real-time clock is synced to system time during reboot/shutdown
:If power is unplugged suddenly, and the network not restored, the real-time clock may not have the correct time

;Wireless Networking System
:Wireless adapter support for the wireless adapter that Phidgets sells is written into the kernel
:It supports WEP and WPA
:It is best configured through the configuration interface.

;Nand Layout
:The board contains 512MiB on Nand. This nand is split into 7 partitions as follows:
:0: u-boot size: 256K Read Only
:1: u-boot_env size: 128K Read Only
:2: recovery_kernel size: 2M Read Only
:3: kernel size: 3M Writable
:4: flashfs size: ~3.625M Read Only
:5: recovery_fs size: ~ 43M Read Only
:6: rootfs size: ~ 460M Writable
: The final size of flashfs/recovery_fs/rootfs depends on the image size at production, and on the number/location of bad blocks in the NAND.
: '''Note''': U-Boot and recovery kernel and filesystem cannot be written from Linux - this is a safety measure.

;Boot Loader
:U-Boot is used for setting up the processor and booting Linux, and is only accessible via a serial connection.
:Normal users will not need to use or modify it.
:Be very careful when modifying the u-boot partition. If it is damaged or overwritten, it is difficult to fix.
:When using U-Boot, a prompt will appear via serial shortly after power on.
:The environment variables will help you determine how to boot Linux on the SBC
:You can also refer to the [http://www.denx.de/wiki/DULG/Manual U-Boot documentation]

;Boot Process
:From power on...
:1. Processor loads first 4 bytes from NAND into Steppingstone and runs it.
:2. Steppingstone sets up RAM, copies u-boot from NAND into RAM and runs U-Boot.
:3. U-Boot initializes the processor, sets GPIO state, etc., copies the linux kernel into RAM, sets up the kernel command line arguments, checks that the kernel image is valid, and boots it.
:4. Linux boots, bringing up USB, Networking, NAND, etc. and then mounts the rootfs NAND partition on /.
:5. init gets run as the parents of all processes, as uses the /etc/inittab script to bring up the system. This includes mounting other filesystems, settings the hostname, and running the scripts in /etc/init.d, among other things.
:6. inittab then turns the green LED on.
:7. inittab then sets up a getty on the first serial port, ready for interfacing using the debug board.

==Hardware Details==

Dan, please don't read this section....it is just a collection of ideas until the Application Guides get written.

Application guides for:
* Hooking up batteries and managing wires
* Different cases
* Making Phidgets field-replaceable

==Common Problems and Solutions==

{{ProblemSolution|USB Memory Key mounting|Sometimes USB Memory Keys mount at more than one location}}

When you insert a memory key, the SBC will load it as a device (e.g. {{Code|/dev/sda1}}) and it will also ''mount'' the key for reading and writing within the {{Code|/media/}} directory. The {{Code|/media/}} directory version will be called something like {{Code|usb0}}.
At times, an inserted memory key will get mounted in more than one location. You can observe if this occurs by checking the currently mounted devices with the command {{Code|mount}}:

<div class="source">
<syntaxhighlight lang="text">
root@phidgetsbc:~# mount
tmpfs on /lib/init/rw type tmpfs (rw,nosuid,mode=0755)
proc on /proc type proc (rw,noexec,nosuid,nodev)
sysfs on /sys type sysfs (rw,noexec,nosuid,nodev)
udev on /dev type tmpfs (rw,mode=0755)
tmpfs on /dev/shm type tmpfs (rw,nosuid,nodev)
devpts on /dev/pts type devpts (rw,noexec,nosuid,gid=5,mode=620)
rootfs on / type rootfs (rw)
procbususb on /proc/bus/usb type usbfs (rw)
/dev/sda1 on /media/usb0 type vfat (rw,noexec,nodev,sync,noatime,nodiratime)
/dev/sda1 on /media/usb1 type vfat (rw,noexec,nodev,sync,noatime,nodiratime)
</syntaxhighlight>
</div>

You will note that the same device ({{Code|/dev/sda1}}) is now mounted at ''both'' {{Code|/media/usb0}} and {{Code|/media/usb1}}. To fix this problem as it occurs, you can use {{Code|umount}} (notice there is no letter 'n') to unmount the second instance:

<div class="source">
<syntaxhighlight lang="text">
root@phidgetsbc:~# umount /media/usb1
</syntaxhighlight>
</div>

In practice, this should not be a problem, because writing to or reading from either {{Code|usb0}} or {{Code|usb1}} will have the same effect on the memory key. However, if you hard-code a media location into your program (i.e. expecting {{Code|/media/usb0}} to be the first USB key you insert and {{Code|/media/usb1}} to be the second key) your program will sometimes work and sometimes fail.

To get around this within code, find the mount point for each device as it appears. The devices, such as {{Code|/dev/sda1}} will always refer to the actual memory key. But, they cannot be written to directly without being mounted, so you will have to parse the mount table (what is returned from {{Code|mount}}) within your code to find the device and its corresponding mount point.

This is a problem with the standard embedded Debian automount program, and we have no known fix.

{{ProblemSolution|Perl Locale Errors on SSH|No Locales Installed}}

By default, no locales are installed on the SBC. If you use [[#apt|apt]] a lot to install and manage your software on the SBC, you will get messages like this:

<div class="source">
<syntaxhighlight lang="text">
perl: warning: Setting locale failed.
perl: warning: Please check that your locale settings:
LANGUAGE = (unset),
LC_ALL = (unset),
LANG = "en_CA.UTF-8"
are supported and installed on your system.
perl: warning: Falling back to the standard locale ("C").
locale: Cannot set LC_CTYPE to default locale: No such file or directory
locale: Cannot set LC_MESSAGES to default locale: No such file or directory
locale: Cannot set LC_ALL to default locale: No such file or directory
</syntaxhighlight>
</div>

To squelch these messages, you should install and reconfigure your locale like this:

<div class="source">
<syntaxhighlight lang="bash">
apt-get install locales
dpkg-reconfigure locales
</syntaxhighlight>
</div>

The last command will show you a long list from which you should pick your location, by language. For example, en_CA is english_Canada. Here in Calgary, we use en_CA.UTF-8 and so for the first question we would input locale "114" and for the second (system) question we would input {{Code|en_CA}} for the locale.

This might give you a locale undefined error, in which case you can generate the locale (for us, again, it is en_CA):

<div class="source">
<syntaxhighlight lang="bash">
locale-gen en_CA
</syntaxhighlight>
</div>

OS - Linux

2012-04-20T16:27:50Z

Djrudiak:

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

You need kernel '''version 2.6''' (released in 2003) or later.

==Getting Started (Libraries and Drivers)==

Linux has complete support for all Phidgets and their software APIs; the only thing it lacks when compared to Windows and Mac OSX is a graphical user interface. We walk you through all steps for download, installation, checking, and starting to write code below.

If you are already a pro, and just want the downloads:
*[http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20110615.tar.gz Phidget Libraries for Linux]
*[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz Phidget Generic C Examples]
*[http://www.phidgets.com/downloads/libraries/phidgetwebservice_2.1.8.20120123.tar.gz Phidget WebService Libraries for Linux]

===Installing===

To install the libraries, follow these steps:

#Download {{Code|libusb-0.1}} and its development libraries
#*Try {{Code|apt-cache search libusb}} in a terminal to find current packages
#*Or install [http://www.libusb.org/ from source], which includes the libusb development libraries by default
#Unpack and install the [http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20110615.tar.gz Phidget Libraries]
#*From the main unpacked libraries directory, run:
#*:{{Code|./configure}}
#*:{{Code|make}}
#*:{{Code|sudo make install}}
#*This will compile phidget21.h and place the library into your gcc path

'''Note:''' Although these libraries are written in C, the additional libraries for Python, Java, and most other Phidget-supported languages depend on them.

===Checking===

To confirm the libraries were installed and work correctly, you can check both the hardware and software sides 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====

To confirm that the libraries were installed correctly and can be used in code, you can use the [http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz Phidget Generic C Examples].

The easiest way to confirm correct installation will be to compile and run the {{Code|HelloWorld}} C example, included in the examples download. This does not involve writing any C code, but it does involve compiling the example and running it, which is a quick process as we show below. If you feel more comfortable running the {{Code|HelloWorld}} example for your specific language, you can skip below and pick your language, but keep in mind that any problems could be with the C library installation and not necessarily with your language.

To compile and run the basic C example for checking your installation:

1. Unpack the Phidget Generic C Examples<br>
2. Open a terminal (often Ctrl-Alt-T) and go to the directory where the examples are unpacked<br>
3. Compile the {{Code|HelloWorld.c}} example:<br>
<div class="source">
<syntaxhighlight lang=bash>

gcc HelloWorld.c -o HelloWorld -lphidget21

</syntaxhighlight>
</div>
4. Run the {{Code|HelloWorld}} example:<br>
<div class="source">
<syntaxhighlight lang=bash>

sudo ./HelloWorld

</syntaxhighlight>
</div>
(The sudo is needed for USB access for now, see the [[#Setting udev Rules|Setting udev Rules]] section for how to change this)

The {{Code|-lphidget21}} will look in the standard library location for your Linux distribution (usually {{Code|/usr/lib/}}) for the Phidget 21 library file. Generally, libraries to be linked on Linux through {{Code|gcc}} have a naming convention. For example, {{Code|-lphidget21}} looks for the binary files '''{{Code|libphidget21.a}}''' and '''{{Code|libphidget21.so}}''' in the library location. These files are automatically put in the library location during the {{Code|make install}} step of [[#Installing | installing the libraries]].

The HelloWorld program will simply print out basic information for any device you plug in, and print a message upon unplugging the device. For example, starting the program, plugging in an Interface Kit Phidget, unplugging the Interface Kit, and pressing Enter displays:

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

$ sudo ./HelloWorld

Opening...
Press Enter to end

Hello to Device Phidget InterfaceKit 8/8/8, Serial Number: 37299
Goodbye Device Phidget InterfaceKit 8/8/8, Serial Number: 37299

Closing...

</syntaxhighlight>
</div>

====Hardware====

If the out-of-the-box examples do not work, make sure the Phidget is seen by your USB interface. To check this, you can use the kernel log reader {{Code|dmesg}}. Pipe the output of {{Code|dmesg}} into the utility {{Code|tail}} to read the last ten lines of the log:

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

$> dmesg | tail
....(9 lines)....
[24344.013638] usb 2-1.2: new low speed USB device number 5 using ehci_hcd

</syntaxhighlight>
</div>

The number between the [ ] is the system time in seconds since the last boot up, so you can tell whether the event was recent or not. (This will also tell you the interrupt type of Phidget that is registered by the USB interface, see the [[#Common Problems and Solutions | common problems section below]] for more information on what this means.)

The Phidget should both connect and disconnect properly, so unplugging it should result in an additional line at the tail:

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

$> dmesg | tail
....(8 lines)....
[24344.013638] usb 2-1.2: new low speed USB device number 5 using ehci_hcd
[25094.809328] usb 2-1.2: USB disconnect, device number 5

</syntaxhighlight>
</div>

If you don't see similar lines to these at the tail of your kernel log, 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 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:
* No other programs, drivers, or processes are using that USB port in software
* You are running the example program as root (or your udev rules have been set properly)
* You are using libusb 0.1 (not 1.0 or later)
* You have compiled versions of libphidget21.a and libphidget21.so in your system library location (usually {{Code|/usr/lib}})
* The Phidget libraries are the latest version (visit the [[#Getting Started (Libraries and Drivers)| getting started section]] to download them)
* Your Linux kernel version is 2.6 or later (type {{Code|uname -r}} in a terminal to get your kernel version)
* 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==

Now that you have the basic libraries installed, you can pick your language and begin programming!

If you are not using the [[#WebService | webservice]] (discussed below) to control a Phidget over a network, your next step will be to delve into the use of your specific language. Each page has its own set of specific libraries, code examples, and setup instructions.

On Linux, we recommend the following languages:

*[[Language - C/C++|C/C++]]
*[[Language - Java | Java]]
*[[Language - Python | Python]]
*[[Language - Ruby | Ruby]]
*[[Language - C Sharp | C#]] (Using [[Language - C Sharp#Mono|Mono]])
*[[Language - Flash AS3 | Flash AS3]]

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.<br>This section helps you install, check, and use the WebService on Linux, but we also have an overview of the [[Phidget WebService]] in general.

===Installing the WebService===

To install the webservice, you must first have the [[#Installing|Phidget libraries installed]]. Then, follow these steps:

#Download '''avahi''' and its development libraries (mdnsresponder/bonjour is also an option, see the [[#WebService with mDNSResponder|webservice with mDNSResponder]] section)
#*Try {{Code|apt-cache search avahi}} in a terminal to find current packages
#*Often, this is installed in a default system, you may already have it
#Unpack and install the [http://www.phidgets.com/downloads/libraries/phidgetwebservice_2.1.8.20111028.tar.gz Phidgets WebService] source code tarball for Linux
#*From the unpacked WebService source code directory, run:
#*:{{Code|./configure}}
#*:{{Code|make}}
#*:{{Code|sudo make install}}
#*This will compile the executable {{Code|phidgetwebservice21}} and place it into {{Code|/usr/bin/phidgetwebservice21}}

====WebService with BSD====

For '''BSD''', the webservice has been found to work (BSD 8+) but requires a special configuration at the {{Code|./configure}} step:

<div class="source">
<syntaxhighlight lang=bash>
./configure LIBS=/usr/lib/libphidget21.so CFLAGS=-pthread
</syntaxhighlight>
</div>

Then {{Code|make}} and {{Code|sudo make install}} are the same.
<br>
The {{Code|LIBS}} argument may not be necessary, but sometimes BSD has trouble finding the library install location. The {{Code|CFLAGS}} argument is needed because BSD needs explicit linking for using threads.

====WebService with mDNSResponder====

To use '''mdnsresponder''' instead of avahi, change the configure script to be:

<div class="source">
<syntaxhighlight lang=bash>
./configure --enable-zeroconf=bonjour
</syntaxhighlight>
</div>

(To see all options, use {{Code|./configure --help}} like you would any configure script)

===Setting Up the WebService===

To set up and use the webservice, it helps to have [[#Setting udev Rules|set your udev rules]]. Otherwise, you must run the webservice as root.

You can get command line help with {{Code|phidgetwebservice21}} by using the {{Code|-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>

You will see this help regardless of whether the webservice was correctly hooked in to avahi. In fact, you will see it even if you explicitly disabled mDNS in the {{Code|./configure}} step at compile:

<div class="source">
<syntaxhighlight lang=bash>
./configure --disable-zeroconf
</syntaxhighlight>
</div>

(To see all options, use {{Code|./configure --help}} like you would any configure script)

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.

Using a server name to connect would not be an option without avahi or some other mDNS service; in this case you would only have the option to use an IP address.

===Using the WebService===

To use a Phidget over the webservice, you'll want to:
* Obtain code you can use to open a Phidget remotely
* 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 Linux is simply to set up the webservice and run the Phidget program on the same computer, using the loopback interface. Later, you can replace one of the two ends with a different computer and/or operating system.

To quickly create code to run remotely, in our examples we include commented out lines with openRemote() function calls of different types. In the C example for your device, find the line that says:

{{Code|CPhidget_open((CPhidgetHandle) device, -1)}}

and change it to be:

<div class="source">
<syntaxhighlight lang=bash>
int serial_number = 37299
CPhidget_openRemoteIP ((CPhidgetHandle) device, serial_number, "127.0.0.1", 5001, NULL)
</syntaxhighlight>
</div>

Except that you should replace '''37299''' with the serial number of your Phidget, which you can obtain from either the Phidget board itself, or from when you [[#Checking|ran the HelloWorld example code]]. 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. The NULL is used to not specify a password.

Save the changed example under a different filename. In the walkthrough here, we are using the {{Code|InterfaceKit.c}} example, and we rename it to be {{Code|InterfaceKitRemote.c}}

Compile your new C file. In our {{Code|InterfaceKitRemote.c}} case, this would be by:

<div class="source">
<syntaxhighlight lang=bash>
gcc InterfaceKitRemote.c -o InterfaceKitRemote -lphidget21
</syntaxhighlight>
</div>

1. Start two terminals to run this test, usually opened via Ctrl-Alt-T. Your [[#Setting udev Rules|udev rules]] need to be set up or you should use sudo for every command. First, start the webservice in Terminal #1:

[[Image:Linux_ws_start.png]]

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

2. Start the InterfaceKitRemote program that you just compiled which will open the remote Phidget. In this case, it is {{Code|InterfaceKitRemote}}:

[[Image:Linux_ws_step2.png]]

3. Now, plug in the Phidget! The {{Code|phidget21webservice}} program captures the attach and other events and sends them out over the network (in the background in Terminal #1) and the Phidget software objected opened with openRemote in Terminal #2 receives them:

[[Image:Linux_ws_step3.png]]

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:

[[Image:Linux_ws_step4.png]]

===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 is enabled via a re-compile of the webservice. From the webservice source code directory, do:

<div class="source">
<syntaxhighlight lang=bash>
make clean

./configure --enable-debug

make

sudo make install
</syntaxhighlight>
</div>

If you suspect multicast DNS (mDNS) may be the problem, you can:
* Try compiling the webservice with mDNSResponder, as described in [[#Installing the WebService|Installing the WebService]], or
* Try compiling the webservice completely without mDNS, as described in [[#Setting Up the WebService|Setting Up the WebService]]

==Advanced Uses==

===Setting udev Rules===

If you don't want to be using {{Code|sudo}} to run Phidget programs (including the webservice) forever, you will want to create a {{Code|udev}} rule to allow yourself access to the Phidget when you are not root.

Udev has an easy way to set the owner and permissions of the USB interface of the Phidget - it finds all devices that match a given set of rules, and applies new traits to them. But you need to give udev something to match in order to apply the new settings. Here, we will tell udev to match the vendor code for Phidgets, Inc. You can get the vendor code in hex by using {{Code|lsusb}}:

<div class="source">
<syntaxhighlight lang=bash>
$> lsusb
....Information about other devices...
Bus 002 Device 013: ID 06c2:0045 Phidgets Inc. (formerly GLAB) PhidgetInterface Kit 8-8-8
</syntaxhighlight>
</div>

The two numbers separated by a colon are the codes for '''vendor:product'''. Since we want to set up the rule so that all Phidgets, no matter what product, can be used without root privileges, we use the vendor code, which is '''06c2'''.

The rules for udev are kept in files in {{Code|/etc/udev/rules.d/}} and are traditionally grouped into order of running (10 runs before 20, 30, etc) and device type (cd, network, etc). There should be one or more files in there already - if this is your first time editing udev rules take a look at them to see the syntax to use:
* Commas separate each pair with == or =
* One rule on each line, no line breaks
* Quotes around the value to be matched or changed
* Comments can be added on lines starting with #

Strictly speaking, the files run in lexical order (i.e. the order they're listed when you use {{Code|ls}}). A device can match many rules, and all will apply (if possible). If conflicting rules are found, the first rule found is followed.

To make sure the Phidget udev rules are found first, we can create a file {{Code|10-persistent-usb.rules}} (all udev rule files need to end with {{Code|.rules}}) and add one line to it:

<div class="source">
<syntaxhighlight lang=bash>
SUBSYSTEM=="usb", ATTRS{idVendor}=="06c2", MODE="0666", OWNER="user"
</syntaxhighlight>
</div>

Make sure to replace {{Code|user}} with your user name. You probably recognize the '''06c2''' from the vendor discussion above. We have added the match on {{Code|SUBSYSTEM}} to search first within usb (within a possibly big database). The {{Code|MODE}} sets read and write privileges for everyone to the device, and {{Code|OWNER}} sets the owner to be you.

Save the {{Code|10-persistent-usb.rules}} in {{Code|/etc/udev/rules.d/}} and then change its permissions so it can be read by all:

<div class="source">
<syntaxhighlight lang=bash>
sudo chmod a+r /etc/udev/rules.d/10-persistent-usb.rules
</syntaxhighlight>
</div>

The udev rule is now set, and it just has to get read in. The reading of the rules is goverened by a daemon, {{Code|udevd}}, which you can manage via the program {{Code|udevadm}}. The {{Code|udevadm}} man page is quite extensive for all sorts of uses of {{Code|udevadm}} while you are testing this or other udev rules. To re-read and implement the rules without having to reset the daemon or reset the computer, you can use:

<div class="source">
<syntaxhighlight lang=bash>
sudo udevadm control --reload-rules
</syntaxhighlight>
</div>

Finally, if you performed all of these steps with the Phidget plugged in to your computer, you will need to unplug and plug the Phidget back in before trying to use usb access without root privileges.

===Starting the WebService at Boot===

If you are tired of starting the webservice on the command line all the time, you can have the webservice start when your system starts, every time.

====User Space====

If you are running a standard Linux machine with an X-server (Unity, KDE) the easiest way to do this is to have the Phidget WebService start when your x server starts.

In this case, the webservice will be running in user space, so your [[#Setting udev Rules|udev rules need to be set up]] for the your user permissions to be able to access the USB ports using libusb.

Within the X-windowing system, there is usually some sort of {{Code|System → Settings/Preferences → Startup}} that you can choose to add programs that start when a user session starts. On Ubuntu you can use Unity to find programs listing "startup" in their names to accomplish the same thing. This will eventually lead you to a graphical tool like this to simply add the {{Code|/usr/bin/phidgetwebservice21}} program:

[[Image:linux_ws_boot.png|400px]]

====As A Service====

You would want to set the boot start of {{Code|phidgetwebservice21}} to be a service if you are running a server, or a headless machine. It is handy any time you need the webservice to be started as a booted, respawning service with a presence in different run levels and for all users.

A service is essentially a program that hangs out in the background, waiting to be used by some incoming task. When the service is needed, the service forks a program to handle that need. Most services that run on your Linux computer already have the ability to fork themselves.

The webservice, however, is just a binary on Linux - {{Code|phidgetwebservice21}} - and so we need a program that handles the forking for us. For this, we use the {{Code|start-stop-daemon}} program to spawn a standalone process for us, or kill it, based on our service-like start, stop, and restart commands.

To do this, we need:
# A script that tells the boot process how to start and handle the webservice (i.e. by using {{Code|start-stop-daemon}})
# A link from that script to the boot list
# An initialization file for the script

First, the script. We will walk through Debian here, both because it is such a common distribution and because it is the distribution that our [[SBC|Single Board Computer]] runs. But {{Code|init}} is surprisingly diverse on Linux, including everything from a different boot order, to different initialization programs and structure, and even different runlevels.

On Debian (including Ubuntu), the initialization script covers:
* Runlevels that the service should be present on
* Dependencies of the service
* Name of the service and other informative data
* The location of the PIDFILE, which stores the process ID (pid) for later dealing with a spawned instance
* Any configuration file locations
* What to do when the service is given instructions to '''start''', '''stop''', or '''reload'''.

The Debian script we use to start the webservice on the [[SBC|Single Board Computer]]:

<div class="source">
<syntaxhighlight line start="1" lang=bash>

#!/bin/sh

### BEGIN INIT INFO
# Provides: phidgetwebservice
# Required-Start: $network $remote_fs
# Required-Stop: $network $remote_fs
# Should-Start: avahi
# Should-Stop: avahi
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Phidget WebService
# Description: Phidget WebService for controlling Phidgets over the network.
### END INIT INFO

DESC="Phidget WebService"
NAME=phidgetwebservice
BIN=phidgetwebservice21
DAEMON=/usr/bin/$BIN
PIDFILE=/var/run/$NAME.pid
CFG=/etc/default/$NAME

# Gracefully exit if the package has been removed.
test -x $DAEMON || exit 0

# load config
pws_port="5001"
pws_serverid=""
pws_password=""
[ -f $CFG ] && . $CFG

start() {
[ -z "$pws_port" ] || OPTIONS="-p $pws_port "
[ -z "$pws_password" ] || OPTIONS="$OPTIONS-P $pws_password "

if [ -z "$pws_serverid" ]; then
OPTIONS="$OPTIONS -n $( hostname )"
else
OPTIONS="$OPTIONS -n $pws_serverid"
fi

echo -n "Starting $DESC: "
start-stop-daemon -S -b -q -p $PIDFILE -m -x $DAEMON -- $OPTIONS && echo "OK" || echo "ALREADY RUNNING"
}

stop() {
echo -n "Stopping $DESC: "
start-stop-daemon -K -q -p $PIDFILE -x $DAEMON && echo "OK" || echo "NOT RUNNING"
}

case "$1" in
start)
start
;;
stop)
stop
;;
restart|force-reload)
stop
sleep 1
start
;;
*)
echo "Usage: $0 {start|stop|restart}"
esac

exit 0
</syntaxhighlight>
</div>

Save the script into a file called {{Code|phidgetwebservice}}, and use {{Code|chmod 755}} to make it executable.

Also on Debian, startup service scripts should go in {{Code|/etc/init.d}}, and then put within the appropriate runlevel-numbered folder - by symbolic link. There is a handy tool to do this for you, called {{Code|insserv}}:

<div class="source">
<syntaxhighlight lang=bash>
sudo insserv -d phidgetwebservice
</syntaxhighlight>
</div>

The {{Code|insserv}} program is the program that makes use of the {{Code|### BEGIN INIT INFO...### END INIT INFO}} that appears at the top of the {{Code|phidgetwebservice}} script. Use {{Code|man insserv}} for more information. The {{Code|insserv}} tool handles the mess of finding the right runlevel folders (i.e. the {{Code|rc.d}} numbered folders) and making the appropriate links. You can see what links would be updated by running {{Code|insserv}} with the {{Code|-n}} option, for a dry run.

'''Note:''' When you run {{Code|insserv}}, all of the dependencies for the boot order are re-written. This means that all of the initialization scripts in {{Code|/etc/init.d}} are re-examined. So, you'll probably get a lot of output when you run the command.

Then, you can check that {{Code|phidgetwebservice}} is on the service list with:

<div class="source">
<syntaxhighlight lang=bash>
service --status-all
</syntaxhighlight>
</div>

And you can start it right now without rebooting like this:

[[Image:linux_system_service_start.png]]

The {{Code|service}} command has many options to start and stop services like the phidgetwebservice, try {{Code|man service}} for more information.

At this point, you can follow the client instructions on [[#Using the WebService|using the webservice]] to create a loopback test for the new webservice service that should now be running.

The final piece, for future configuration changes, is that the {{Code|/etc/init.d}} script looks for the file {{Code|/etc/default/phidgetwebservice}} upon starting up. The file is expected to contain the port, server ID, and password for the server side of the webservice. These are also set in the {{Code|phidgetwebservice}} script in {{Code|init.d}}, as you can see from reading the code above, but if you want to change them a lot, you can edit the configuration file rather than changing the {{Code|phidgetwebservice}} script and re-installing by {{Code|insserv}} every time. The configuration file in {{Code|/etc/default/}} should contain the same syntax as that used in the script source above:

<div class="source">
<syntaxhighlight lang=bash>
pws_port="5001"
pws_serverid=""
pws_password=""
</syntaxhighlight>
</div>

===Cross-Compiling with a Custom Toolchain===

This would allow you to have the Phidget libraries compiled to include in code for an embedded device. When developing for an embedded device, you will often write code for it on your 'normal' computer, and then build the code to binary with a different target than the processor in your computer. Many microcontrollers do not have the ability to run a full operating system, and hence cannot compile code natively.

The collection of tools used to create binary code for a separate system is called a ''toolchain''. Compiling the Phidget libraries specifically for an embedded system, and placing them into the path for writing code on top of the libraries is like adding another link in this chain.

You can use the typical {{Code|./configure}} setup for custom build targets:

<div class="source">
<syntaxhighlight lang=bash>
./configure --prefix=toolchain_location --build=this_system --host=target_system
</syntaxhighlight>
</div>

For the Phidget libraries, the {{Code|./configure}} tool works this way as well. You'd use this in the [[#Installing|install the libraries section]] setup. For example, let's say you're building the libraries to develop code for the [[SBC|Phidget Single Board Computer (SBC)]] as a target. Your system is a standard Linux system (i686-pc-linux-gnu) and the target system for the [[SBC]] is {{Code|arm-linux-gnueabi}}. For this target, you'll need the base of the GNU embedded Debian chain:

<div class="source">
<syntaxhighlight lang=bash>
sudo apt-get install gcc-arm-linux-gnueabi
</syntaxhighlight>
</div>

Then, download the Phidget libraries [[#Getting Started (Libraries and Drivers)|above]] and unpack them into a folder {{Code|phidget_libraries}}. If {{Code|/usr/arm-linux-gnueabi}} is the location of your ARM toolchain (downloaded above in {{Code|gcc-arm-linux-gnueabi}}), type:

<div class="source">
<syntaxhighlight lang=bash>
~/phidget_libraries $> ./configure --prefix=/usr/arm-linux-gnueabi --build=i686-pc-linux-gnu --host=arm-linux-gnueabi
</syntaxhighlight>
</div>

==Common Problems and Solutions==

{{ProblemSolution|Low Speed Phidgets (Max of 8)|Linux will only schedule one low-speed interrupt transfer per millisecond.}}

You can find out the type of your Phidget by attaching it and then running <code><font size=3>dmesg | tail</font></code>, which will display the type of Phidget from your kernel logs, as described above in the [[#Hardware|hardware section]]. The practical consequence of this is if your system has many low speed Phidgets attached, they will each be throttled down. Low speed Phidgets require an interrupt transfer as often as every 8 milliseconds. A Linux system could only have up to 8 of these Phidgets attached.

{{ProblemSolution|Sample Overrun Error|The data read from a program, or the first packet on the WebService, can give a sample overrun error (EEPHIDGET_OVERRUN).}}

Linux only polls data from the analog inputs on Phidgets when you ask it to. So there is some delay between when you open the device and when it actually attaches when data from those inputs are accumulating...and overrunning the buffer. This is simply in the nature of how Linux polls USB - we recommend catching (but ignoring) this one-time initial error.

OS - macOS

2012-04-20T16:26:50Z

Djrudiak:

[[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 side 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.

OS - Windows

2012-04-20T15:17:24Z

Djrudiak: /* Phidget Control Panel */

[[Category:OS]]
{{OSLang|[[File:icon-Windows.png|64x64px|link=OS - Windows]]|Windows, 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 2000 or newer''', on both 32 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 [[File:Ph.jpg]] icon in your task bar and know how to use it, then you've already followed the guide and are ready to learn more about the control panel, the Phidget WebService, and more - all specific to Windows.

If you are already a pro, and just want the drivers:

*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20111028.exe 32 Bit]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20111028.exe 64 Bit]

For special cases where you want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section.
*[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)
*[http://www.phidgets.com/Drivers_Info.html#windows Software License]

===Installing===

The Phidget installer requires that your system has .NET framework 2.0 or higher. The .NET framework can be downloaded from [http://www.microsoft.com/net Microsoft]. If you do not have the .NET framework 2.0 or later installed, you can still use Phidgets. However, you won't be able to use the installer, and will have to manually install the Phidget libraries. Please see the [[#Advanced Uses | Advanced Uses]] section.

To install the libraries, follow these steps:

1. Download one of the Phidget installer for your system, depending on whether your system is 32 or 64-bit.
*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20120216.exe 32-bit]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20120216.exe 64-bit]

2. Open up the installer, and proceed through the wizard.

[[File:Windows Install.PNG|link=|alt=Windows Install]]

Please note that by default, the installer places the [[#Description of Installer files | Phidget libraries]] in {{Code|C:\Program Files\Phidgets}}.

3. 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.

Next, the Phidget Control Panel will be discussed.

====Phidget Control Panel====

The Phidget Control Panel 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, you should see the [[File:Ph.jpg]] icon in the taskbar. Double click on it to bring up the Phidget Control Panel. If the icon does not appear, just find and open the Phidget Control Panel from the start menu.

[[File:Windows ControlPanel General.PNG|link=|alt=Windows Control Panel General]]

The general tab shows the list of Phidgets currently physically attached to the computer. You can also view the currently installed Phidget library version, as well as having the checkbox option to choose whether the Phidget Control Panel is to be started up automatically once Windows boots up. You can double click on a Phidget device in the Phidget Control Panel to open up an example program for the device.

[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel 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 Control Panel 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 Control Panel can still be running) when you are running your own applications.

The next tab is the {{Code|WebService}} tab, which allows you to control Phidgets over a network. There are four sub-tabs. The first sub-tab is the {{Code|Setup}} tab.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]

Here, you can start and stop the WebService. Details are provided in the [[#WebService | WebService]] section. You can also determine whether the Phidget WebService is currently running. There is also a check box that you can select to turn on verbose output, which will display useful troubleshooting information for the WebService.

The next sub-tab is the {{Code|Output}} tab, which provides useful debugging information while you are using the WebService. This tab will only show up if the verbose output option is selected in the previous tab.

[[File:Windows ControlPanel WebService Output.PNG|link=|alt=Windows Control Panel WebService Output]]

The {{Code|Dictionary}} sub-tab comes next; it lists all the key-value pairs that gets created when the WebService runs. More information is provided in the [[General Phidget Programming#Using the Dictionary|Dictionary]] section of the [[General Phidget Programming|General Phidget Programming]] page.

[[File:Windows ControlPanel WebService Dictionary.PNG|link=|alt=Windows Control WebService Dictionary]]

The {{Code|Bonjour}} sub-tab gives a list of all currently attached Phidgets that are connected to the WebService. This tab will only appear if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system. 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:Windows ControlPanel WebService Bonjour.PNG|link=|alt=Windows Control Panel WebService Bonjour]]

The last tab is the {{Code|PhidgetSBC}} tab, which displays the complete list of any PhidgetSBCs connected to the network. This tab will be enabled if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system.

[[File:Windows ControlPanel WebService PhidgetSBC.PNG|link=|alt=Windows Control Panel WebService 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 side component is working by seeing if a Phidget device is listed in the {{Code|General}} tab of the Phidget Control Panel.

[[File:Windows_ControlPanel_General.PNG|link=|alt=Windows Control Panel 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 Windows Device Manager.
On Windows XP, you can access the Device Manager by accessing the start menu, right clicking on {{Code|Computer}} and selecting {{Code|Properties}}. Next, select {{Code|Advanced System Settings}} to open up a new Window. Here, open up the {{Code|Hardware}} tab and select {{Code|Device Manager}}. The Device Manager window will open.

[[File:Windows7 DeviceManager.PNG|link=|alt=Windows Device Manager]]

Under the {{Code|Human Interface Devices}} heading, you can view whether your computer detects that the Phidget is connected through the USB if it is in the list. There should be a {{Code|HID-compliant device}} and a {{Code|USB Input Device}} entry for every Phidget that is attached to the computer. Please note that there is currently no way of directly determining which entry belongs to which Phidget. A simple way of verifying which entry belongs to which Phidget is to simply connect or disconnect the Phidget from the USB port of the computer. The list will automatically refresh to show the updated list of all connected USB devices.

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 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 2000 or newer.
* The Phidget Control Panel requires that you have .NET framework 2.0 or newer.
* No other programs, drivers, or processes are using that USB port in software. Some drivers or software will sometimes mistakenly claim Phidget devices when waiting on some hardware to be connected. Please see the section: [[Communication Protocols#Issue: Some third party software prevents communications with Phidgets|third party software prevents communications with Phidgets]] for more information.
* 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]].

On Windows, we recommend the following languages:

*[[Language - C Sharp|C#]]
*[[Language - C/C++|C/C++]]
*[[Language - Flash AS3|Flash AS3]]
*[[Language - Java|Java]]
*[[Language - LabVIEW|LabView]]
*[[Language - Max/MSP|Max/MSP]]
*[[Language - Python|Python]]
*[[Language - Visual Basic .NET|Visual Basic .NET]]
*[[Language - Visual Basic 6.0|Visual Basic 6.0]]

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]]

The following languages are also supported, but due to a lack of demand, the full API is not implemented. Please refer to the specific language for more information on what features are unsupported.
*[[Language - Adobe Director|Adobe Director]]
*[[Language - AutoIt|AutoIt]]
*[[Language - Delphi|Delphi]]
*[[Language - LiveCode|LiveCode]]
*[[Language - Visual Basic for Applications|Visual Basic for Applications]]
*[[Language - Visual Basic Script|Visual Basic Script]]

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network. For more information, please see the [[Phidget WebService|Phidget WebService]] page.

Drivers for the Phidget WebService on Windows are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. If you have a [[File:Ph.jpg]] icon in your taskbar, 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 the [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] software. It is a tool, developed by Apple to locate devices such as Phidgets, and printers. You will have to install Bonjour onto your system to use the second method.

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 Control Panel. In the {{Code|WebService}} tab, you can start, restart or stop the WebService. You can also choose to have the WebService start up automatically upon Windows boot up by selecting {{Code|Automatic}} as the {{Code|Startup Type}}. By leaving the {{Code|Startup Type}} as {{Code|Manual}}, you will have to manually turn the WebService on everytime you wish to use it.

[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup]]

The second method of turning the WebService on and off is through command line. If you used our installer, the WebService utility is automatically installed in {{Code|C:\Program Files\Phidgets\PhidgetWebservice21.exe}}. Otherwise, if you wish to manually install the {{Code|PhidgetWebservice21.exe}}, you can place it anywhere on your system, and navigate to it in command line.

You can get command line help with {{Code|PhidgetWebservice21.exe}} using the {{Code|-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 Control Panel option is as follows:

-p: {{Code|Port}} field

-n: {{Code|ServerID}} field

-P: {{Code|Password}} field

-v: {{Code|Enable verbose output}} checkbox

To find the host name and IP address of your computer, open up the command line prompt.
*For the default server name, type {{Code|hostname}}.
*For your IP address, type {{Code|ipconfig -all}}.
**A line in the return text, will say something like {{Code|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|C:\Program Files\Phidgets}}).

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

To start the WebService with a server name of {{Code|myServer}}:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe -n myServer
</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:
* 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 Windows is [http://www.apple.com/support/downloads/bonjourforwindows.html download] and install Bonjour onto both the host and client. Next, we will set up the WebService and run the Phidget program on the client. Please follow these steps:

1. On the host, open up the Phidget Control Panel and traverse to the {{Code|Setup}} tab of the {{Code|WebService}} section.

[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup Stopped]]

2. Leave all fields the way they are, and click on {{Code|Start}} to run the WebService.

3. You can determine that the WebService is running by looking at the WebService status at the bottom of the window.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]

4. Ensure that the Phidget is plugged in to the host.

5. On the client's Phidget Control Panel, open up the {{Code|Bonjour}} tab in the {{Code|WebService}} section. 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:Windows ControlPanel WebService Bonjour Running.PNG|link=|alt=Windows Control Panel WebService Bonjour]]

6. The example application will open up, and you will be able to communicate with the Phidget over the WebService.

[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel 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 Control Panel, traverse to the {{Code|Setup}} tab of the {{Code|WebService}} section. Hit {{Code|Stop}} to terminate the WebService.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]

8. Take a look at the example application on the client. Since the application can no longer connect to the WebService, the attached state of the Phidget is false.

[[File:Windows ControlPanel WebService Example Disconnected.PNG|link=|alt=Windows Control Panel WebService Example while WebService 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 be enabled from the {{Code|Enable verbose output}} checkbox in the Phidget Control Panel.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]

The debugging information is shown in the {{Code|Output}} tab.

[[File:Windows ControlPanel WebService Output Running.PNG|link=|alt=Windows Control Panel WebService Output Running]]

If you are using 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.exe -v -n "myServer"
</syntaxhighlight>
</div>

The debugging information is shown command line output. This will prove useful when debugging WebService problems.

==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. This section will describe the purpose of the most important files file and cover how to manually install and distribute the libraries with your code. You can get the files [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20110615.zip here].

====Description of Library files====

* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts {{Code|phidget21.lib}} 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. {{Code|phidget21.lib}} is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler for details. Please note that we provide versions of the {{Code|phidget21.lib}} that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets}}; The 32 bit version of {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets\x86}}.
* <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. By default, our installer puts {{Code|phidget21.h}} 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.
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidgets library for .NET framework 2.0 or greater. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidgets library for .NET framework 1.1. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21COM.dll}}</b> is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. This libraries is used by the [[Language - Adobe Director|AdobeDirector]], [[Language - AutoIt|AutoIT]], [[Language - Delphi|Delphi]], [[Language - Visual Basic 6.0|Visual Basic 6.0]], [[Language - Visual Basic for Applications|Visual Basic for Applications]], [[Language - Visual Basic Script|Visual Basic Script]].

=====Special Cases of Library Install=====

Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|C:\WINDOWS\system32}} 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.

===Windows in a Virtual Machine===

Phidgets can also be used inside a virtual machine. Instructions for VMWare and VirtualBox are provided below. Virtual PC is not supported as USB Phidgets requires a virtual platform that supports HID USB Devices and since Virtual PC does not support HID USB devices, Phidgets may not be used.

As always, please ensure that you have the latest Phidget [[#Getting Started (Libraries and Drivers) | drivers]] installed on the virtual machine and that you are using the latest version of your virtual software.

<b>VMWare:</b>

To enable USB Phidgets, select Virtual Machine -> Removable Devices -> and select the Phidget Input Device -> Connect.

<b>VirtualBox</b>

To enable USB Phidgets, VirtualBox Guest Additions(Devices -> Install Guest Additions) may need to be installed. Afterwards, click on Devices -> USB Devices and select the Phidget device to enable. The state should go from Busy to Captured. VirtualBox may bring up a new hardware wizard in the host operating system, which has to be installed. Please note that Phidgets with USB hubs(i.e, [[Product - 1019 1 - PhidgetInterfaceKit 8/8/8 w/6 Port Hub|1019]]), are undetectable; Fortunately, Phidgets that are attached to such Phidgets are detectable.

==Common Problems and Solutions==

===Issue: A corrupt installation fails on uninstall or repair===
Affected Operating Systems: '''Windows'''

Solution: If the normal uninstall fails, or for whatever reason, you can choose to remove the Phidget drivers manually.
Please perform the following:
# Shut down any programs using the Phidget libraries, including the WebService and the Phidget Control Panel.
# Delete {{Code|C:\Program Files\Phidgets\}}
# Remove the Phidgets key from the Registry {{Code|[-HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services PhidgetWebService21]}}.

In most cases this is enough to get the installer working again. If you need to remove all traces of the Phidgets libraries manually, perform the following additional steps:

# Unregister the COM library: {{Code|regsvr32 /u "C:\Program Files\Phidgets\Phidget21COM.dll"}}.
# Remove {{Code|Phidget21.NET}} and {{Code|Policy.2.1.Phidget21.NET}} from {{Code|C:\Windows\Assembly\}}.
# Delete {{Code|C:\Documents and Settings\All Users\Application Data\Phidgets}} if you are using WindowsXP or {{Code|C:\Users\All Users\Phidgets}} if you are using Windows Vista.
# Delete {{Code|C:\Windows\system32\phidget21.dll}}.
# Delete Phidgets from the start menu.
# Search for and remove keys mentioning Phidgets from the registry in the following locations:
:* {{Code|[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\]}}
:* {{Code|[HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Products\]}}
:* {{Code|[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders\Phidgets Inc]}}
:* {{Code|[HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run\Phidget21Manager]}}
:* {{Code|[HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Assemblies\Global\]}}

:7. Reboot

'''NOTE:''' You can go through the registry and purge any other keys mentioning Phidgets if you still have problems, but at this point you should be able to reinstall under most cases. There will also be keys relating to the installer, the .NET library and the COM library, but they should not interfere with anything.

===Issue: Event data is sporadic/slow/clumped over the WebService===
Affected Operating Systems: '''Windows'''

Windows implements 200ms delayed ACKs for network traffic. When traffic is one-way only - as it is with event data, the data will all arrive in clumps every 200ms because of delayed ACKs.

This can be a great drawback for applications which rely on low latency event data over the network. (source: http://support.microsoft.com/kb/214397)

This delayed ACK behavior can be disabled in windows to decrease event latency as documented here: http://support.microsoft.com/kb/328890

In the future, the Phidgets library may implement this differently, but so far we have been unable to match the performance achieved by disabling delayed ACK.

==Appendix==

===Description of Installer files===

Here is the list of files and their description for each file the installer puts onto your system.
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is also placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].
* <b>{{Code|PhidgetWindowsService21.exe}}</b> is a Windows service that controls {{Code|PhidgetWebService21.exe}}.
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts {{Code|phidget21.lib}} 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. {{Code|phidget21.lib}} is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler for details. Please note that we provide versions of the {{Code|phidget21.lib}} that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets}}; The 32 bit version of {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets\x86}}.
* <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. By default, our installer puts {{Code|phidget21.h}} 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.
* <b>{{Code|phidget21.jar}}</b> is an archive containing the Phidgets library, used by the [[Language - Java | Java]] programming language.
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidgets library for .NET framework 2.0 or greater. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidgets library for .NET framework 1.1. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio.
* <b>{{Code|Phidget21COM.dll}}</b> is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. This libraries is used by the [[Language - Adobe Director|AdobeDirector]], [[Language - AutoIt|AutoIT]], [[Language - Delphi|Delphi]], [[Language - Visual Basic 6.0|Visual Basic 6.0]], [[Language - Visual Basic for Applications|Visual Basic for Applications]], [[Language - Visual Basic Script|Visual Basic Script]].
* <b>{{Code|Phidget21Manager.exe}}</b> is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.
* <b>{{Code|Examples}} folder</b> contain example applications that allows you to quickly see if your Phidget is properly configured.
* <b>{{Code|x86 folder}} folder</b> contain the 32 bit versions of {{Code|phidget21.dll}}, {{Code|phidget21.lib}}, {{Code|Phidget21COM.dll}}. These folder will only appear on 64 bit installations and is useful if you want to code against the 32 bit libraries.

OS - Windows

2012-04-20T15:14:52Z

Djrudiak: /* Phidget Control Panel */

[[Category:OS]]
{{OSLang|[[File:icon-Windows.png|64x64px|link=OS - Windows]]|Windows, 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 2000 or newer''', on both 32 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 [[File:Ph.jpg]] icon in your task bar and know how to use it, then you've already followed the guide and are ready to learn more about the control panel, the Phidget WebService, and more - all specific to Windows.

If you are already a pro, and just want the drivers:

*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20111028.exe 32 Bit]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20111028.exe 64 Bit]

For special cases where you want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section.
*[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)
*[http://www.phidgets.com/Drivers_Info.html#windows Software License]

===Installing===

The Phidget installer requires that your system has .NET framework 2.0 or higher. The .NET framework can be downloaded from [http://www.microsoft.com/net Microsoft]. If you do not have the .NET framework 2.0 or later installed, you can still use Phidgets. However, you won't be able to use the installer, and will have to manually install the Phidget libraries. Please see the [[#Advanced Uses | Advanced Uses]] section.

To install the libraries, follow these steps:

1. Download one of the Phidget installer for your system, depending on whether your system is 32 or 64-bit.
*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20120216.exe 32-bit]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20120216.exe 64-bit]

2. Open up the installer, and proceed through the wizard.

[[File:Windows Install.PNG|link=|alt=Windows Install]]

Please note that by default, the installer places the [[#Description of Installer files | Phidget libraries]] in {{Code|C:\Program Files\Phidgets}}.

3. 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.

Next, the Phidget Control Panel will be discussed.

====Phidget Control Panel====

The Phidget Control Panel 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, you should see the [[File:Ph.jpg]] icon in the taskbar. Double click on it to bring up the Phidget Control Panel. If the icon does not appear, just find and open the Phidget Control Panel from the start menu.

[[File:Windows ControlPanel General.PNG|link=|alt=Windows Control Panel General]]

The general tab shows the list of Phidgets currently physically attached to the computer. You can also view the currently installed Phidget library version, as well as having the checkbox option to choose whether the Phidget Control Panel is to be started up automatically once Windows boots up. You can double click on a Phidget device in the Phidget Control Panel to open up an example program for the device.

[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel 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 Control Panel 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 Control Panel can still be running) when you are running your own applications.

The next tab is the {{Code|WebService}} tab, which allows you to control Phidgets over a network. There are four sub-tabs. The first sub-tab is the {{Code|Setup}} tab.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]

Here, you can start and stop the WebService. Details are provided in the [[#WebService | WebService]] section. You can also determine whether the Phidget WebService is currently running. There is also a check box that you can select to turn on verbose output, which will display useful troubleshooting information for the WebService.

The next sub-tab is the {{Code|Output}} tab, which provides useful debugging information while you are using the WebService. This tab will only show up if the verbose output option is selected in the previous tab.

[[File:Windows ControlPanel WebService Output.PNG|link=|alt=Windows Control Panel WebService Output]]

The {{Code|Dictionary}} sub-tab comes next; it lists all the key-value pairs that gets created when the WebService runs. More information is provided in the [[General Phidget Programming#Using the Dictionary|Dictionary]] section of the [[General Phidget Programming|General Phidget Programming]] page.

[[File:Windows ControlPanel WebService Dictionary.PNG|link=|alt=Windows Control WebService Dictionary]]

The {{Code|Bonjour}} sub-tab gives a list of all currently attached Phidgets that are connected to the WebService. This tab will only appear if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system. 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:Windows ControlPanel WebService Bonjour.PNG|link=|alt=Windows Control Panel WebService Bonjour]]

The last tab is the {{Code|PhidgetSBC}} tab, which displays the complete list of PhidgetSBCs connected to the network. This tab will be enabled if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system.

[[File:Windows ControlPanel WebService PhidgetSBC.PNG|link=|alt=Windows Control Panel WebService 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 side component is working by seeing if a Phidget device is listed in the {{Code|General}} tab of the Phidget Control Panel.

[[File:Windows_ControlPanel_General.PNG|link=|alt=Windows Control Panel 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 Windows Device Manager.
On Windows XP, you can access the Device Manager by accessing the start menu, right clicking on {{Code|Computer}} and selecting {{Code|Properties}}. Next, select {{Code|Advanced System Settings}} to open up a new Window. Here, open up the {{Code|Hardware}} tab and select {{Code|Device Manager}}. The Device Manager window will open.

[[File:Windows7 DeviceManager.PNG|link=|alt=Windows Device Manager]]

Under the {{Code|Human Interface Devices}} heading, you can view whether your computer detects that the Phidget is connected through the USB if it is in the list. There should be a {{Code|HID-compliant device}} and a {{Code|USB Input Device}} entry for every Phidget that is attached to the computer. Please note that there is currently no way of directly determining which entry belongs to which Phidget. A simple way of verifying which entry belongs to which Phidget is to simply connect or disconnect the Phidget from the USB port of the computer. The list will automatically refresh to show the updated list of all connected USB devices.

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 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 2000 or newer.
* The Phidget Control Panel requires that you have .NET framework 2.0 or newer.
* No other programs, drivers, or processes are using that USB port in software. Some drivers or software will sometimes mistakenly claim Phidget devices when waiting on some hardware to be connected. Please see the section: [[Communication Protocols#Issue: Some third party software prevents communications with Phidgets|third party software prevents communications with Phidgets]] for more information.
* 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]].

On Windows, we recommend the following languages:

*[[Language - C Sharp|C#]]
*[[Language - C/C++|C/C++]]
*[[Language - Flash AS3|Flash AS3]]
*[[Language - Java|Java]]
*[[Language - LabVIEW|LabView]]
*[[Language - Max/MSP|Max/MSP]]
*[[Language - Python|Python]]
*[[Language - Visual Basic .NET|Visual Basic .NET]]
*[[Language - Visual Basic 6.0|Visual Basic 6.0]]

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]]

The following languages are also supported, but due to a lack of demand, the full API is not implemented. Please refer to the specific language for more information on what features are unsupported.
*[[Language - Adobe Director|Adobe Director]]
*[[Language - AutoIt|AutoIt]]
*[[Language - Delphi|Delphi]]
*[[Language - LiveCode|LiveCode]]
*[[Language - Visual Basic for Applications|Visual Basic for Applications]]
*[[Language - Visual Basic Script|Visual Basic Script]]

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network. For more information, please see the [[Phidget WebService|Phidget WebService]] page.

Drivers for the Phidget WebService on Windows are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. If you have a [[File:Ph.jpg]] icon in your taskbar, 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 the [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] software. It is a tool, developed by Apple to locate devices such as Phidgets, and printers. You will have to install Bonjour onto your system to use the second method.

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 Control Panel. In the {{Code|WebService}} tab, you can start, restart or stop the WebService. You can also choose to have the WebService start up automatically upon Windows boot up by selecting {{Code|Automatic}} as the {{Code|Startup Type}}. By leaving the {{Code|Startup Type}} as {{Code|Manual}}, you will have to manually turn the WebService on everytime you wish to use it.

[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup]]

The second method of turning the WebService on and off is through command line. If you used our installer, the WebService utility is automatically installed in {{Code|C:\Program Files\Phidgets\PhidgetWebservice21.exe}}. Otherwise, if you wish to manually install the {{Code|PhidgetWebservice21.exe}}, you can place it anywhere on your system, and navigate to it in command line.

You can get command line help with {{Code|PhidgetWebservice21.exe}} using the {{Code|-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 Control Panel option is as follows:

-p: {{Code|Port}} field

-n: {{Code|ServerID}} field

-P: {{Code|Password}} field

-v: {{Code|Enable verbose output}} checkbox

To find the host name and IP address of your computer, open up the command line prompt.
*For the default server name, type {{Code|hostname}}.
*For your IP address, type {{Code|ipconfig -all}}.
**A line in the return text, will say something like {{Code|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|C:\Program Files\Phidgets}}).

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

To start the WebService with a server name of {{Code|myServer}}:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe -n myServer
</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:
* 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 Windows is [http://www.apple.com/support/downloads/bonjourforwindows.html download] and install Bonjour onto both the host and client. Next, we will set up the WebService and run the Phidget program on the client. Please follow these steps:

1. On the host, open up the Phidget Control Panel and traverse to the {{Code|Setup}} tab of the {{Code|WebService}} section.

[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup Stopped]]

2. Leave all fields the way they are, and click on {{Code|Start}} to run the WebService.

3. You can determine that the WebService is running by looking at the WebService status at the bottom of the window.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]

4. Ensure that the Phidget is plugged in to the host.

5. On the client's Phidget Control Panel, open up the {{Code|Bonjour}} tab in the {{Code|WebService}} section. 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:Windows ControlPanel WebService Bonjour Running.PNG|link=|alt=Windows Control Panel WebService Bonjour]]

6. The example application will open up, and you will be able to communicate with the Phidget over the WebService.

[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel 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 Control Panel, traverse to the {{Code|Setup}} tab of the {{Code|WebService}} section. Hit {{Code|Stop}} to terminate the WebService.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]

8. Take a look at the example application on the client. Since the application can no longer connect to the WebService, the attached state of the Phidget is false.

[[File:Windows ControlPanel WebService Example Disconnected.PNG|link=|alt=Windows Control Panel WebService Example while WebService 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 be enabled from the {{Code|Enable verbose output}} checkbox in the Phidget Control Panel.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]

The debugging information is shown in the {{Code|Output}} tab.

[[File:Windows ControlPanel WebService Output Running.PNG|link=|alt=Windows Control Panel WebService Output Running]]

If you are using 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.exe -v -n "myServer"
</syntaxhighlight>
</div>

The debugging information is shown command line output. This will prove useful when debugging WebService problems.

==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. This section will describe the purpose of the most important files file and cover how to manually install and distribute the libraries with your code. You can get the files [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20110615.zip here].

====Description of Library files====

* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts {{Code|phidget21.lib}} 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. {{Code|phidget21.lib}} is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler for details. Please note that we provide versions of the {{Code|phidget21.lib}} that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets}}; The 32 bit version of {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets\x86}}.
* <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. By default, our installer puts {{Code|phidget21.h}} 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.
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidgets library for .NET framework 2.0 or greater. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidgets library for .NET framework 1.1. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21COM.dll}}</b> is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. This libraries is used by the [[Language - Adobe Director|AdobeDirector]], [[Language - AutoIt|AutoIT]], [[Language - Delphi|Delphi]], [[Language - Visual Basic 6.0|Visual Basic 6.0]], [[Language - Visual Basic for Applications|Visual Basic for Applications]], [[Language - Visual Basic Script|Visual Basic Script]].

=====Special Cases of Library Install=====

Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|C:\WINDOWS\system32}} 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.

===Windows in a Virtual Machine===

Phidgets can also be used inside a virtual machine. Instructions for VMWare and VirtualBox are provided below. Virtual PC is not supported as USB Phidgets requires a virtual platform that supports HID USB Devices and since Virtual PC does not support HID USB devices, Phidgets may not be used.

As always, please ensure that you have the latest Phidget [[#Getting Started (Libraries and Drivers) | drivers]] installed on the virtual machine and that you are using the latest version of your virtual software.

<b>VMWare:</b>

To enable USB Phidgets, select Virtual Machine -> Removable Devices -> and select the Phidget Input Device -> Connect.

<b>VirtualBox</b>

To enable USB Phidgets, VirtualBox Guest Additions(Devices -> Install Guest Additions) may need to be installed. Afterwards, click on Devices -> USB Devices and select the Phidget device to enable. The state should go from Busy to Captured. VirtualBox may bring up a new hardware wizard in the host operating system, which has to be installed. Please note that Phidgets with USB hubs(i.e, [[Product - 1019 1 - PhidgetInterfaceKit 8/8/8 w/6 Port Hub|1019]]), are undetectable; Fortunately, Phidgets that are attached to such Phidgets are detectable.

==Common Problems and Solutions==

===Issue: A corrupt installation fails on uninstall or repair===
Affected Operating Systems: '''Windows'''

Solution: If the normal uninstall fails, or for whatever reason, you can choose to remove the Phidget drivers manually.
Please perform the following:
# Shut down any programs using the Phidget libraries, including the WebService and the Phidget Control Panel.
# Delete {{Code|C:\Program Files\Phidgets\}}
# Remove the Phidgets key from the Registry {{Code|[-HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services PhidgetWebService21]}}.

In most cases this is enough to get the installer working again. If you need to remove all traces of the Phidgets libraries manually, perform the following additional steps:

# Unregister the COM library: {{Code|regsvr32 /u "C:\Program Files\Phidgets\Phidget21COM.dll"}}.
# Remove {{Code|Phidget21.NET}} and {{Code|Policy.2.1.Phidget21.NET}} from {{Code|C:\Windows\Assembly\}}.
# Delete {{Code|C:\Documents and Settings\All Users\Application Data\Phidgets}} if you are using WindowsXP or {{Code|C:\Users\All Users\Phidgets}} if you are using Windows Vista.
# Delete {{Code|C:\Windows\system32\phidget21.dll}}.
# Delete Phidgets from the start menu.
# Search for and remove keys mentioning Phidgets from the registry in the following locations:
:* {{Code|[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\]}}
:* {{Code|[HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Products\]}}
:* {{Code|[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders\Phidgets Inc]}}
:* {{Code|[HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run\Phidget21Manager]}}
:* {{Code|[HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Assemblies\Global\]}}

:7. Reboot

'''NOTE:''' You can go through the registry and purge any other keys mentioning Phidgets if you still have problems, but at this point you should be able to reinstall under most cases. There will also be keys relating to the installer, the .NET library and the COM library, but they should not interfere with anything.

===Issue: Event data is sporadic/slow/clumped over the WebService===
Affected Operating Systems: '''Windows'''

Windows implements 200ms delayed ACKs for network traffic. When traffic is one-way only - as it is with event data, the data will all arrive in clumps every 200ms because of delayed ACKs.

This can be a great drawback for applications which rely on low latency event data over the network. (source: http://support.microsoft.com/kb/214397)

This delayed ACK behavior can be disabled in windows to decrease event latency as documented here: http://support.microsoft.com/kb/328890

In the future, the Phidgets library may implement this differently, but so far we have been unable to match the performance achieved by disabling delayed ACK.

==Appendix==

===Description of Installer files===

Here is the list of files and their description for each file the installer puts onto your system.
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is also placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].
* <b>{{Code|PhidgetWindowsService21.exe}}</b> is a Windows service that controls {{Code|PhidgetWebService21.exe}}.
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts {{Code|phidget21.lib}} 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. {{Code|phidget21.lib}} is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler for details. Please note that we provide versions of the {{Code|phidget21.lib}} that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets}}; The 32 bit version of {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets\x86}}.
* <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. By default, our installer puts {{Code|phidget21.h}} 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.
* <b>{{Code|phidget21.jar}}</b> is an archive containing the Phidgets library, used by the [[Language - Java | Java]] programming language.
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidgets library for .NET framework 2.0 or greater. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidgets library for .NET framework 1.1. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio.
* <b>{{Code|Phidget21COM.dll}}</b> is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. This libraries is used by the [[Language - Adobe Director|AdobeDirector]], [[Language - AutoIt|AutoIT]], [[Language - Delphi|Delphi]], [[Language - Visual Basic 6.0|Visual Basic 6.0]], [[Language - Visual Basic for Applications|Visual Basic for Applications]], [[Language - Visual Basic Script|Visual Basic Script]].
* <b>{{Code|Phidget21Manager.exe}}</b> is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.
* <b>{{Code|Examples}} folder</b> contain example applications that allows you to quickly see if your Phidget is properly configured.
* <b>{{Code|x86 folder}} folder</b> contain the 32 bit versions of {{Code|phidget21.dll}}, {{Code|phidget21.lib}}, {{Code|Phidget21COM.dll}}. These folder will only appear on 64 bit installations and is useful if you want to code against the 32 bit libraries.

OS - Windows

2012-04-20T15:13:28Z

Djrudiak:

[[Category:OS]]
{{OSLang|[[File:icon-Windows.png|64x64px|link=OS - Windows]]|Windows, 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 2000 or newer''', on both 32 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 [[File:Ph.jpg]] icon in your task bar and know how to use it, then you've already followed the guide and are ready to learn more about the control panel, the Phidget WebService, and more - all specific to Windows.

If you are already a pro, and just want the drivers:

*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20111028.exe 32 Bit]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20111028.exe 64 Bit]

For special cases where you want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section.
*[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)
*[http://www.phidgets.com/Drivers_Info.html#windows Software License]

===Installing===

The Phidget installer requires that your system has .NET framework 2.0 or higher. The .NET framework can be downloaded from [http://www.microsoft.com/net Microsoft]. If you do not have the .NET framework 2.0 or later installed, you can still use Phidgets. However, you won't be able to use the installer, and will have to manually install the Phidget libraries. Please see the [[#Advanced Uses | Advanced Uses]] section.

To install the libraries, follow these steps:

1. Download one of the Phidget installer for your system, depending on whether your system is 32 or 64-bit.
*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20120216.exe 32-bit]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20120216.exe 64-bit]

2. Open up the installer, and proceed through the wizard.

[[File:Windows Install.PNG|link=|alt=Windows Install]]

Please note that by default, the installer places the [[#Description of Installer files | Phidget libraries]] in {{Code|C:\Program Files\Phidgets}}.

3. 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.

Next, the Phidget Control Panel will be discussed.

====Phidget Control Panel====

The Phidget Control Panel is a tool to quickly determine whether your system is able to communicate Phidgets, and also act as a debugging tool.

Once the Phidget libraries are installed using the installer, you should see the [[File:Ph.jpg]] icon in the taskbar. Double click on it to bring up the Phidget Control Panel. If the icon does not appear, just find and open the Phidget Control Panel from the start menu.

[[File:Windows ControlPanel General.PNG|link=|alt=Windows Control Panel General]]

The general tab shows the list of Phidgets currently physically attached to the computer. You can also view the currently installed Phidget library version, as well as having the checkbox option to choose whether the Phidget Control Panel is to be started up automatically once Windows boots up. You can double click on a Phidget device in the Phidget Control Panel to open up an example program for the device.

[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel 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 Control Panel 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 Control Panel can still be running) when you are running your own applications.

The next tab is the {{Code|WebService}} tab, which allows you to control Phidgets over a network. There are four sub-tabs. The first sub-tab is the {{Code|Setup}} tab.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]

Here, you can start and stop the WebService. Details are provided in the [[#WebService | WebService]] section. You can also determine whether the Phidget WebService is currently running. There is also a check box that you can select to turn on verbose output, which will display useful troubleshooting information for the WebService.

The next sub-tab is the {{Code|Output}} tab, which provides useful debugging information while you are using the WebService. This tab will only show up if the verbose output option is selected in the previous tab.

[[File:Windows ControlPanel WebService Output.PNG|link=|alt=Windows Control Panel WebService Output]]

The {{Code|Dictionary}} sub-tab comes next; it lists all the key-value pairs that gets created when the WebService runs. More information is provided in the [[General Phidget Programming#Using the Dictionary|Dictionary]] section of the [[General Phidget Programming|General Phidget Programming]] page.

[[File:Windows ControlPanel WebService Dictionary.PNG|link=|alt=Windows Control WebService Dictionary]]

The {{Code|Bonjour}} sub-tab gives a list of all currently attached Phidgets that are connected to the WebService. This tab will only appear if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system. 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:Windows ControlPanel WebService Bonjour.PNG|link=|alt=Windows Control Panel WebService Bonjour]]

The last tab is the {{Code|PhidgetSBC}} tab, which displays the complete list of PhidgetSBCs connected to the network. This tab will be enabled if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system.

[[File:Windows ControlPanel WebService PhidgetSBC.PNG|link=|alt=Windows Control Panel WebService 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 side component is working by seeing if a Phidget device is listed in the {{Code|General}} tab of the Phidget Control Panel.

[[File:Windows_ControlPanel_General.PNG|link=|alt=Windows Control Panel 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 Windows Device Manager.
On Windows XP, you can access the Device Manager by accessing the start menu, right clicking on {{Code|Computer}} and selecting {{Code|Properties}}. Next, select {{Code|Advanced System Settings}} to open up a new Window. Here, open up the {{Code|Hardware}} tab and select {{Code|Device Manager}}. The Device Manager window will open.

[[File:Windows7 DeviceManager.PNG|link=|alt=Windows Device Manager]]

Under the {{Code|Human Interface Devices}} heading, you can view whether your computer detects that the Phidget is connected through the USB if it is in the list. There should be a {{Code|HID-compliant device}} and a {{Code|USB Input Device}} entry for every Phidget that is attached to the computer. Please note that there is currently no way of directly determining which entry belongs to which Phidget. A simple way of verifying which entry belongs to which Phidget is to simply connect or disconnect the Phidget from the USB port of the computer. The list will automatically refresh to show the updated list of all connected USB devices.

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 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 2000 or newer.
* The Phidget Control Panel requires that you have .NET framework 2.0 or newer.
* No other programs, drivers, or processes are using that USB port in software. Some drivers or software will sometimes mistakenly claim Phidget devices when waiting on some hardware to be connected. Please see the section: [[Communication Protocols#Issue: Some third party software prevents communications with Phidgets|third party software prevents communications with Phidgets]] for more information.
* 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]].

On Windows, we recommend the following languages:

*[[Language - C Sharp|C#]]
*[[Language - C/C++|C/C++]]
*[[Language - Flash AS3|Flash AS3]]
*[[Language - Java|Java]]
*[[Language - LabVIEW|LabView]]
*[[Language - Max/MSP|Max/MSP]]
*[[Language - Python|Python]]
*[[Language - Visual Basic .NET|Visual Basic .NET]]
*[[Language - Visual Basic 6.0|Visual Basic 6.0]]

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]]

The following languages are also supported, but due to a lack of demand, the full API is not implemented. Please refer to the specific language for more information on what features are unsupported.
*[[Language - Adobe Director|Adobe Director]]
*[[Language - AutoIt|AutoIt]]
*[[Language - Delphi|Delphi]]
*[[Language - LiveCode|LiveCode]]
*[[Language - Visual Basic for Applications|Visual Basic for Applications]]
*[[Language - Visual Basic Script|Visual Basic Script]]

==WebService==

The Phidget WebService allows you to remotely control a Phidget over a network. For more information, please see the [[Phidget WebService|Phidget WebService]] page.

Drivers for the Phidget WebService on Windows are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. If you have a [[File:Ph.jpg]] icon in your taskbar, 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 the [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] software. It is a tool, developed by Apple to locate devices such as Phidgets, and printers. You will have to install Bonjour onto your system to use the second method.

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 Control Panel. In the {{Code|WebService}} tab, you can start, restart or stop the WebService. You can also choose to have the WebService start up automatically upon Windows boot up by selecting {{Code|Automatic}} as the {{Code|Startup Type}}. By leaving the {{Code|Startup Type}} as {{Code|Manual}}, you will have to manually turn the WebService on everytime you wish to use it.

[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup]]

The second method of turning the WebService on and off is through command line. If you used our installer, the WebService utility is automatically installed in {{Code|C:\Program Files\Phidgets\PhidgetWebservice21.exe}}. Otherwise, if you wish to manually install the {{Code|PhidgetWebservice21.exe}}, you can place it anywhere on your system, and navigate to it in command line.

You can get command line help with {{Code|PhidgetWebservice21.exe}} using the {{Code|-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 Control Panel option is as follows:

-p: {{Code|Port}} field

-n: {{Code|ServerID}} field

-P: {{Code|Password}} field

-v: {{Code|Enable verbose output}} checkbox

To find the host name and IP address of your computer, open up the command line prompt.
*For the default server name, type {{Code|hostname}}.
*For your IP address, type {{Code|ipconfig -all}}.
**A line in the return text, will say something like {{Code|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|C:\Program Files\Phidgets}}).

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

To start the WebService with a server name of {{Code|myServer}}:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe -n myServer
</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:
* 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 Windows is [http://www.apple.com/support/downloads/bonjourforwindows.html download] and install Bonjour onto both the host and client. Next, we will set up the WebService and run the Phidget program on the client. Please follow these steps:

1. On the host, open up the Phidget Control Panel and traverse to the {{Code|Setup}} tab of the {{Code|WebService}} section.

[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup Stopped]]

2. Leave all fields the way they are, and click on {{Code|Start}} to run the WebService.

3. You can determine that the WebService is running by looking at the WebService status at the bottom of the window.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]

4. Ensure that the Phidget is plugged in to the host.

5. On the client's Phidget Control Panel, open up the {{Code|Bonjour}} tab in the {{Code|WebService}} section. 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:Windows ControlPanel WebService Bonjour Running.PNG|link=|alt=Windows Control Panel WebService Bonjour]]

6. The example application will open up, and you will be able to communicate with the Phidget over the WebService.

[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel 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 Control Panel, traverse to the {{Code|Setup}} tab of the {{Code|WebService}} section. Hit {{Code|Stop}} to terminate the WebService.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]

8. Take a look at the example application on the client. Since the application can no longer connect to the WebService, the attached state of the Phidget is false.

[[File:Windows ControlPanel WebService Example Disconnected.PNG|link=|alt=Windows Control Panel WebService Example while WebService 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 be enabled from the {{Code|Enable verbose output}} checkbox in the Phidget Control Panel.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]

The debugging information is shown in the {{Code|Output}} tab.

[[File:Windows ControlPanel WebService Output Running.PNG|link=|alt=Windows Control Panel WebService Output Running]]

If you are using 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.exe -v -n "myServer"
</syntaxhighlight>
</div>

The debugging information is shown command line output. This will prove useful when debugging WebService problems.

==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. This section will describe the purpose of the most important files file and cover how to manually install and distribute the libraries with your code. You can get the files [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20110615.zip here].

====Description of Library files====

* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts {{Code|phidget21.lib}} 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. {{Code|phidget21.lib}} is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler for details. Please note that we provide versions of the {{Code|phidget21.lib}} that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets}}; The 32 bit version of {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets\x86}}.
* <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. By default, our installer puts {{Code|phidget21.h}} 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.
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidgets library for .NET framework 2.0 or greater. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidgets library for .NET framework 1.1. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21COM.dll}}</b> is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. This libraries is used by the [[Language - Adobe Director|AdobeDirector]], [[Language - AutoIt|AutoIT]], [[Language - Delphi|Delphi]], [[Language - Visual Basic 6.0|Visual Basic 6.0]], [[Language - Visual Basic for Applications|Visual Basic for Applications]], [[Language - Visual Basic Script|Visual Basic Script]].

=====Special Cases of Library Install=====

Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|C:\WINDOWS\system32}} 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.

===Windows in a Virtual Machine===

Phidgets can also be used inside a virtual machine. Instructions for VMWare and VirtualBox are provided below. Virtual PC is not supported as USB Phidgets requires a virtual platform that supports HID USB Devices and since Virtual PC does not support HID USB devices, Phidgets may not be used.

As always, please ensure that you have the latest Phidget [[#Getting Started (Libraries and Drivers) | drivers]] installed on the virtual machine and that you are using the latest version of your virtual software.

<b>VMWare:</b>

To enable USB Phidgets, select Virtual Machine -> Removable Devices -> and select the Phidget Input Device -> Connect.

<b>VirtualBox</b>

To enable USB Phidgets, VirtualBox Guest Additions(Devices -> Install Guest Additions) may need to be installed. Afterwards, click on Devices -> USB Devices and select the Phidget device to enable. The state should go from Busy to Captured. VirtualBox may bring up a new hardware wizard in the host operating system, which has to be installed. Please note that Phidgets with USB hubs(i.e, [[Product - 1019 1 - PhidgetInterfaceKit 8/8/8 w/6 Port Hub|1019]]), are undetectable; Fortunately, Phidgets that are attached to such Phidgets are detectable.

==Common Problems and Solutions==

===Issue: A corrupt installation fails on uninstall or repair===
Affected Operating Systems: '''Windows'''

Solution: If the normal uninstall fails, or for whatever reason, you can choose to remove the Phidget drivers manually.
Please perform the following:
# Shut down any programs using the Phidget libraries, including the WebService and the Phidget Control Panel.
# Delete {{Code|C:\Program Files\Phidgets\}}
# Remove the Phidgets key from the Registry {{Code|[-HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services PhidgetWebService21]}}.

In most cases this is enough to get the installer working again. If you need to remove all traces of the Phidgets libraries manually, perform the following additional steps:

# Unregister the COM library: {{Code|regsvr32 /u "C:\Program Files\Phidgets\Phidget21COM.dll"}}.
# Remove {{Code|Phidget21.NET}} and {{Code|Policy.2.1.Phidget21.NET}} from {{Code|C:\Windows\Assembly\}}.
# Delete {{Code|C:\Documents and Settings\All Users\Application Data\Phidgets}} if you are using WindowsXP or {{Code|C:\Users\All Users\Phidgets}} if you are using Windows Vista.
# Delete {{Code|C:\Windows\system32\phidget21.dll}}.
# Delete Phidgets from the start menu.
# Search for and remove keys mentioning Phidgets from the registry in the following locations:
:* {{Code|[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\]}}
:* {{Code|[HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Products\]}}
:* {{Code|[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders\Phidgets Inc]}}
:* {{Code|[HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run\Phidget21Manager]}}
:* {{Code|[HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Assemblies\Global\]}}

:7. Reboot

'''NOTE:''' You can go through the registry and purge any other keys mentioning Phidgets if you still have problems, but at this point you should be able to reinstall under most cases. There will also be keys relating to the installer, the .NET library and the COM library, but they should not interfere with anything.

===Issue: Event data is sporadic/slow/clumped over the WebService===
Affected Operating Systems: '''Windows'''

Windows implements 200ms delayed ACKs for network traffic. When traffic is one-way only - as it is with event data, the data will all arrive in clumps every 200ms because of delayed ACKs.

This can be a great drawback for applications which rely on low latency event data over the network. (source: http://support.microsoft.com/kb/214397)

This delayed ACK behavior can be disabled in windows to decrease event latency as documented here: http://support.microsoft.com/kb/328890

In the future, the Phidgets library may implement this differently, but so far we have been unable to match the performance achieved by disabling delayed ACK.

==Appendix==

===Description of Installer files===

Here is the list of files and their description for each file the installer puts onto your system.
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is also placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].
* <b>{{Code|PhidgetWindowsService21.exe}}</b> is a Windows service that controls {{Code|PhidgetWebService21.exe}}.
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts {{Code|phidget21.lib}} 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. {{Code|phidget21.lib}} is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler for details. Please note that we provide versions of the {{Code|phidget21.lib}} that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets}}; The 32 bit version of {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets\x86}}.
* <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. By default, our installer puts {{Code|phidget21.h}} 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.
* <b>{{Code|phidget21.jar}}</b> is an archive containing the Phidgets library, used by the [[Language - Java | Java]] programming language.
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidgets library for .NET framework 2.0 or greater. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidgets library for .NET framework 1.1. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio.
* <b>{{Code|Phidget21COM.dll}}</b> is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. This libraries is used by the [[Language - Adobe Director|AdobeDirector]], [[Language - AutoIt|AutoIT]], [[Language - Delphi|Delphi]], [[Language - Visual Basic 6.0|Visual Basic 6.0]], [[Language - Visual Basic for Applications|Visual Basic for Applications]], [[Language - Visual Basic Script|Visual Basic Script]].
* <b>{{Code|Phidget21Manager.exe}}</b> is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.
* <b>{{Code|Examples}} folder</b> contain example applications that allows you to quickly see if your Phidget is properly configured.
* <b>{{Code|x86 folder}} folder</b> contain the 32 bit versions of {{Code|phidget21.dll}}, {{Code|phidget21.lib}}, {{Code|Phidget21COM.dll}}. These folder will only appear on 64 bit installations and is useful if you want to code against the 32 bit libraries.

Template:OSLang

2012-04-20T15:10:34Z

Djrudiak: Created page with "{| |- |{{{1}}}||{{{2}}} |}"

{|
|-
|{{{1}}}||{{{2}}}
|}

Main Page

2012-04-13T21:29:22Z

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=4&up_dat=27&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]

OS - Windows

2012-04-13T17:48:16Z

Djrudiak: /* Issue: Event data is sporadic/slow/clumped over the webservice */

[[Category:OS]]
[[File:icon-Windows.png|64x64px|link=OS - Windows]]On Windows, 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 2000 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]]. If you already have the [[File:Ph.jpg]] icon in your task bar and know how to use it, then you've already followed the guide and are ready to learn more about the control panel, the Phidget WebService, and more - all specific to Windows.

If you are already a pro, and just want the drivers:

*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20111028.exe 32 Bit]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20111028.exe 64 Bit]

For special cases where you want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section.
*[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)
*[http://www.phidgets.com/Drivers_Info.html#windows Software License]

===Installing===

The Phidget installer requires that your system has .NET framework 2.0 or higher. The .NET framework can be downloaded from [http://www.microsoft.com/net Microsoft]. If you do not have the .NET framework 2.0 or later installed, you can still use Phidgets. However, you won't be able to use the installer, and will have to manually install the Phidget libraries. Please see the [[#Advanced Uses | Advanced Uses]] section.

To install the libraries, follow these steps:

1. Download one of the Phidget installer for your system, depending on whether your system is 32 or 64-bit.
*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20120216.exe 32-bit]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20120216.exe 64-bit]

2. Open up the installer, and proceed through the wizard.

[[File:Windows Install.PNG|link=|alt=Windows Install]]

Please note that by default, the installer places the [[#Description of Library files | Phidget libraries]] in {{Code|C:\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 the Phidget Control Panel will be discussed.

====Phidget Control Panel====

The Phidget Control Panel is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.

Once the Phidget libraries are installed using the installer, you should see the [[File:Ph.jpg]] icon in the taskbar. Double click on it to bring up the Phidget Control Panel. If the icon does not appear, just find and open the the Phidget Control Panel from the start menu.

[[File:Windows ControlPanel General.PNG|link=|alt=Windows Control Panel General]]

The general tab shows the list of Phidgets currently physically attached to the computer. You can also view the currently installed Phidget library version, as well as having the option to choose whether the Phidget Control Panel is to be started up automatically once Windows boots up. You can double click on a Phidget device to open up an example program for the device.

[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel 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 Control Panel, 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 Control Panel can still be running) when you are running your own applications.

The next tab is the {{Code|WebService}} tab, which allows you to control Phidgets over a network. There are four sub-tabs. The first sub-tab is the {{Code|Setup}} tab.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]

Here, you can start and stop the WebService. Details are provided in the [[#WebService | WebService]] section. You can also determine whether the Phidget WebService is currently running. There is also a check box that you can select to turn on verbose output, which will display useful troubleshooting information for the WebService.

The next sub-tab is the {{Code|Output}} tab, which provides useful debugging information while you are using the WebService. This tab will only show up if the verbose output option is selected in the previous tab.

[[File:Windows ControlPanel WebService Output.PNG|link=|alt=Windows Control Panel WebService Output]]

The {{Code|Dictionary}} sub-tab comes next; it lists all the key-value pairs that gets created when the WebService runs. More information is provided in the [[General Phidget Programming#Using the Dictionary|Dictionary]] section of the [[General Phidget Programming|General Phidget Programming]] page.

[[File:Windows ControlPanel WebService Dictionary.PNG|link=|alt=Windows Control WebService Dictionary]]

The {{Code|Bonjour}} sub-tab gives a list of all currently attached Phidgets that are connected to the WebService. This tab will only appear if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system. You can also double click on the Phidget to connect to it over the network using one or more computers, and still use the Phidget on the computer it is directly connected to.

[[File:Windows ControlPanel WebService Bonjour.PNG|link=|alt=Windows Control Panel WebService Bonjour]]

The last tab is the {{Code|PhidgetSBC}} tab, which displays the complete list of PhidgetSBCs connected to the network. You can double click on the PhidgetSBC to bring up the PhidgetSBC Adminstration Console. This tab will be enabled if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system.

[[File:Windows ControlPanel WebService PhidgetSBC.PNG|link=|alt=Windows Control Panel WebService PhidgetSBC]]

===Checking===

To confirm the libraries were installed and work correctly, you can check both the hardware and software sides 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 side is working by seeing if the Phidget device is listed in the {{Code|General}} tab of the Phidget Control Panel.

[[File:Windows_ControlPanel_General.PNG|link=|alt=Windows Control Panel General]]

The above screenshot shows that a PhidgetRFID and a PhidgetInterfaceKit are attached to the computer. If the Phidget is plugged into a USB port and 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 Windows Device Manager.
On Windows XP, you can access the Device Manager by right clicking on {{Code|My Computer}}, and selecting {{Code|Device Manager}} under the {{Code|Hardware}} tab. The Device Manager window will open.

[[File:WindowsXP DeviceManager.PNG|link=|alt=Windows Device Manager]]

Under the {{Code|Human Interface Devices}} heading, you can view whether your computer detects that the Phidget is connected through the USB if it is in the list. There should be a {{Code|HID-compliant device}} and a {{Code|USB Human Interface Device}} entry for every Phidget that is attached to the computer. Please note that there is currently no way of directly determining which entry belongs to which Phidget. A simple way of verifying which entry belongs to which Phidget is to simply connect or disconnect the Phidget from the USB port of the computer. The list will automatically refresh to show the updated list of all connected USB devices.

If you don't see the 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 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 2000 or newer.
* The Phidget Control Panel require that you have .NET framework 2.0 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)
* Some drivers or software will sometimes mistakenly claim Phidget devices when waiting on some hardware to be connected. Please see the section: [[Communication Protocols#Issue: Some third party software prevents communications with Phidgets|third party software prevents communications with Phidgets]] for more information.

* 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==

After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language.

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, we recommend the following languages:

*[[Language - C Sharp|C#]]
*[[Language - C/C++|C/C++]]
*[[Language - Flash AS3|Flash AS3]]
*[[Language - Java|Java]]
*[[Language - LabVIEW|LabView]]
*[[Language - Max/MSP|Max/MSP]]
*[[Language - Python|Python]]
*[[Language - Ruby|Ruby]]
*[[Language - Visual Basic .NET|Visual Basic .NET]]
*[[Language - Visual Basic 6.0|Visual Basic 6.0]]

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]]

The following languages are also supported, but to to a lack of demand, they full API is not implemented. Please refer to the specific language for more information on what features are unsupported.
*[[Language - Delphi|Delphi]]
*[[Language - Visual Basic for Applications|Visual Basic for Applications]]
*[[Language - Visual Basic Script|Visual Basic Script]]
*[[Language - LiveCode|LiveCode]]
*[[Language - Adobe Director|Adobe Director]]
*[[Language - AutoIt|AutoIt]]

==WebService==

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

Drivers for the Phidget WebService on Windows are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. If you have a [[File:Ph.jpg]] icon in your taskbar, you already have the WebService drivers installed.

You can connect to a Phidget hosted on another computer if you know the IP address of the host computer. Phidgets optionally supports the use of mDNS, which allows Phidgets to be found and opened on the network by a server id instead of an IP address and port. 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. It is a tool, developed by Apple to locate devices such as Phidgets, and printers. It allows you to connect to a Phidget over the WebService while specifying the server id. Alternatively, an IP address and port can be supplied to connect to a Phidget over the WebService. If you do not have Bonjour installed on your system, you will have to use the second method to connect to a Phidget.

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 Control Panel. In the {{Code|WebService}} tab, you can start, restart or stop the WebService. You can also choose to have the WebService start up automatically upon Windows boot up by selecting {{Code|Automatic}} as the {{Code|Startup Type}}. By leaving the {{Code|Startup Type}} as {{Code|Manual}}, you will have to manually turn the WebService on everytime you wish to use it.

[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup]]

The second method of turning the WebService on and off is through command line. If you used our installer, the WebService utility is automatically installed in {{Code|C:\Program Files\Phidgets\PhidgetWebservice21.exe}}.

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>

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, type {{Code|hostname}} in the command line.
*For your IP address, type {{Code|ipconfig -all}} in the command line.
**A line in the return text, will say something like {{Code|192.168.2.198}}, which is your IP.

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

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

To start the WebService with a server name of {{Code|myServer}}:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe -n myServer
</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:
* 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.

* 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 is [http://www.apple.com/support/downloads/bonjourforwindows.html download] and install Bonjour onto both the host and client. Next, we will set up the WebService and run the Phidget program on the client. Please follow these steps:

1. On the host, open up the Phidget Control Panel and traverse to the {{Code|Setup}} tab of the {{Code|WebService}} section.

[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup Stopped]]

2. Leave all fields the way it is, and click on {{Code|Start}} to run the WebService.

3. You can determine that the WebService is running by looking at the WebService status at the bottom of the window.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]

4. Ensure that the Phidget is plugged in to the host.

5. On the client's Phidget Control Panel, open up the {{Code|Bonjour}} tab in the {{Code|WebService}} section. 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:Windows ControlPanel WebService Bonjour Running.PNG|link=|alt=Windows Control Panel WebService Bonjour]]

6. The example application will open up, and you will be able to interact with the Phidget over the WebService.

[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel Example]]

7. You can confirm that the WebService was indeed behind this exchange by killing the WebService process while still allowing the remote program to run. On the host's Phidget Control Panel, traverse to the {{Code|Setup}} tab of the {{Code|WebService}} section. Hit {{Code|Stop}} to terminate the WebService.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]

8. Take a look at the example application on the client. Since the application can no longer connect to the WebService, the attached state of the Phidget is false.

[[File:Windows ControlPanel WebService Example Disconnected.PNG|link=|alt=Windows Control Panel WebService Example while WebService 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 be enabled from the {{Code|Enable verbose output}} checkbox in the Phidget Control Panel.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]

The debugging information is shown in the {{Code|Output}} tab.

[[File:Windows ControlPanel WebService Output Running.PNG|link=|alt=Windows Control Panel WebService Output Running]]

If you are using 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.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. This section will describe the purpose of each individual file and cover how to manually install and distribute the libraries with your code.

====Description of Library files====

* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is also placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebservce]].
* <b>{{Code|PhidgetWindowsService21.exe}}</b> is a Windows service that controls {{Code|PhidgetWebService21.exe}}.
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts {{Code|phidget21.lib}} 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. {{Code|phidget21.lib}} is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler for details. Please note that we provide versions of the {{Code|phidget21.lib}} that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets}}; The 32 bit version of {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets\x86}}.
* <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. By default, our installer puts {{Code|phidget21.h}} 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.
* <b>{{Code|phidget21.jar}}</b> is an archive containing the Phidgets library, used by the [[Language - Java | Java]] programming language.
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidgets library for .NET framework 2.0 or greater. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidgets library for .NET framework 1.1. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio.
* <b>{{Code|Phidget21COM.dll}}</b> is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. This libraries is used by the [[Language - Adobe Director|AdobeDirector]], [[Language - AutoIt|AutoIT]], [[Language - Delphi|Delphi]], [[Language - Visual Basic 6.0|Visual Basic 6.0]], [[Language - Visual Basic for Applications|Visual Basic for Applications]], [[Language - Visual Basic Script|Visual Basic Script]].
* <b>{{Code|Phidget21Manager.exe}}</b> is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.
* <b>{{Code|Examples}} folder</b> contain example applications that allows you to quickly see if your Phidget is properly configured.
* <b>{{Code|x86 folder}} folder</b> contain the 32 bit versions of {{Code|phidget21.dll}}, {{Code|phidget21.lib}}, {{Code|Phidget21COM.dll}}. These folder will only appear on 64 bit installations and is useful if you want to code against the 32 bit libraries.

====Special Cases of Library Install====

Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|C:\WINDOWS\system32}} 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)

PhidgetWebService21.exe is also provided in the link above.

===Windows in a Virtual Machine===

Phidgets can also be used inside a virtual machine. Instructions for VMWare and VirtualBox are provided. Virtual PC is not supported as USB Phidgets requires a virtual platform that supports HID USB Devices. Since Virtual PC does not support HID USB devices, Phidgets may not be used.

As always, please ensure that you have the latest Phidget [[#Getting Started (Libraries and Drivers) | drivers]] installed on the virtual machine and that you are using the latest version of your virtual software.

<b>VMWare:</b>

To enable USB Phidgets, select Virtual Machine -> Removable Devices -> and select the Phidget Input Device -> Connect.

<b>VirtualBox</b>

To enable USB Phidgets, VirtualBox Guest Additions(Devices -> Install Guest Additions) may need to be installed. Afterwards, click on Devices -> USB Devices and select the Phidget device to enable. The state should go from Busy to Captured. VirtualBox may bring up a new hardware wizard in the host operating system, which has to be installed. Please note that Phidgets with USB hubs(i.e, [[Product - 1019 1 - PhidgetInterfaceKit 8/8/8 w/6 Port Hub|1019]]), are undetectable; Fortunately, Phidgets that are attached to such Phidgets are detectable.

==Common Problems and Solutions==

===Issue: A corrupt installation fails on uninstall or repair===
Affected Operating Systems: '''Windows'''

Solution: If the normal uninstall fails, or for whatever reason, you can choose to remove the Phidgets framework manually.
Please perform the following:
# Shut down any programs using the Phidget libraries, including the webservice and the Phidget Control Panel.
# Delete C:\Program Files\Phidgets\
# Remove the Phidgets key from the Registry [-HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services PhidgetWebService21].

In most cases this is enough to get the installer working again. If you need to remove all traces of
the Phidgets libraries manually, perform the following additional steps:

# Unregister the COM library: regsvr32 /u “C:\Program Files\Phidgets\Phidget21COM.dll”
# Remove Phidget21.NET and Policy.2.1.Phidget21.NET from C:\Windows\Assembly\
# Delete ‘C:\Documents and Settings\All Users\Application Data\Phidgets’ (WindowsXP) or ‘C:\Users\All Users\Phidgets’ (Vista).
# Delete C:\Windows\system32\phidget21.dll
# Delete Phidgets from the start menu
# Search for and remove keys mentioning Phidgets from the registry in the following locations:
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\]
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Products\]
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders\Phidgets Inc]
:* [HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run\Phidget21Manager]
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Assemblies\Global\]

:9. Reboot

'''NOTE:''' You can go through the registry and purge any other keys mentioning Phidgets if you still
have problems, but at this point you should be able to reinstall under most cases. There will also be
keys relating to the installer, the .NET library and the COM library, but they should not interfere with
anything.

===Issue: Event data is sporadic/slow/clumped over the webservice===
Affected Operating Systems: '''Windows'''

Windows implements 200ms delayed ACKs for network traffic. When traffic is one-way only - as it is with event data, the data will all arrive in clumps every 200ms because of delayed ACKs.

This can be a great drawback for application which rely on low latency event data over the network. (source: http://support.microsoft.com/kb/214397)

This delayed ACK behavior can be disabled in windows to decrease event latency as documented here: http://support.microsoft.com/kb/328890

In the future, the Phidgets library may implement this differently, but so far we have been unable to match the performance achieved by disabling delayed ACK.

OS - Windows

2012-04-05T16:34:24Z

Djrudiak: /* Issue: Event data is sporadic/slow/clumped over the webservice */

[[Category:OS]]
[[File:icon-Windows.png|64x64px|link=OS - Windows]]On Windows, 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 2000 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]]. If you already have the [[File:Ph.jpg]] icon in your task bar and know how to use it, then you've already followed the guide and are ready to learn more about the control panel, the Phidget Webservice, and more - all specific to Windows.

If you are already a pro, and just want the drivers:

*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20111028.exe 32 Bit]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20111028.exe 64 Bit]

For special cases where you want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section.
*[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)
*[http://www.phidgets.com/Drivers_Info.html#windows Software License]

===Installing===

The Phidget installer requires that your system has .NET framework 2.0 or higher. The .NET framework can be downloaded from [http://www.microsoft.com/net Microsoft]. If you do not have the .NET framework 2.0 or later installed, you can still use Phidgets. However, you won't be able to use the installer, and will have to manually install the Phidget libraries. Please see the [[#Advanced Uses | Advanced Uses]] section.

To install the libraries, follow these steps:

1. Download one of the Phidget installer for your system, depending on whether your system is 32 or 64-bit.
*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20120216.exe 32-bit]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20120216.exe 64-bit]

2. Open up the installer, and proceed through the wizard.

[[File:Windows Install.PNG|link=|alt=Windows Install]]

Please note that by default, the installer places the [[#Description of Library files | Phidget libraries]] in {{Code|C:\Program Files\Phidgets}}.

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

Proceed onto to the [[#Phidget Control Panel | next]] section where the Phidget Control Panel will be discussed.

====Phidget Control Panel====

The Phidget Control Panel is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.

Once the Phidget libraries are installed using the installer, you should see the [[File:Ph.jpg]] icon in the taskbar. Double click on it to bring up the Phidget Control Panel. If the icon does not appear, just find and open the the Phidget Control Panel from the start menu.

[[File:Windows ControlPanel General.PNG|link=|alt=Windows Control Panel General]]

The general tab shows the list of Phidgets currently physically attached to the computer. You can also view the currently installed Phidget library version, as well as having the option to choose whether the Phidget Control Panel is to be started up automatically once Windows boots up. You can double click on a Phidget device to open up an example program for the device.

[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel 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 Control Panel, 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 Control Panel can still be running) when you are running your own applications.

The next tab is the {{Code|WebService}} tab, which allows you to control Phidgets over a network. There are four sub-tabs. The first sub-tab is the {{Code|Setup}} tab.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]

Here, you can start and stop the Webservice. Details are provided in the [[#Webservice | Webservice]] section. You can also determine whether the Phidget Webservice is currently running. There is also a check box that you can select to turn on verbose output, which will display useful troubleshooting information for the Webservice.

The next sub-tab is the {{Code|Output}} tab, which provides useful debugging information while you are using the Webservice. This tab will only show up if the verbose output option is selected in the previous tab.

[[File:Windows ControlPanel WebService Output.PNG|link=|alt=Windows Control Panel WebService Output]]

The {{Code|Dictionary}} sub-tab comes next; it lists all the key-value pairs that gets created when the Webservice runs. More information is provided in the [[General Phidget Programming#Using the Dictionary|Dictionary]] section of the [[General Phidget Programming|General Phidget Programming]] page.

[[File:Windows ControlPanel WebService Dictionary.PNG|link=|alt=Windows Control WebService Dictionary]]

The {{Code|Bonjour}} sub-tab gives a list of all currently attached Phidgets that are connected to the Webservice. This tab will only appear if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system. You can also double click on the Phidget to connect to it over the network using one or more computers, and still use the Phidget on the computer it is directly connected to.

[[File:Windows ControlPanel WebService Bonjour.PNG|link=|alt=Windows Control Panel WebService Bonjour]]

The last tab is the {{Code|PhidgetSBC}} tab, which displays the complete list of PhidgetSBCs connected to the network. You can double click on the PhidgetSBC to bring up the PhidgetSBC Adminstration Console. This tab will be enabled if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system.

[[File:Windows ControlPanel WebService PhidgetSBC.PNG|link=|alt=Windows Control Panel WebService PhidgetSBC]]

===Checking===

To confirm the libraries were installed and work correctly, you can check both the hardware and software sides 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 side is working by seeing if the Phidget device is listed in the {{Code|General}} tab of the Phidget Control Panel.

[[File:Windows_ControlPanel_General.PNG|link=|alt=Windows Control Panel General]]

The above screenshot shows that a PhidgetRFID and a PhidgetInterfaceKit are attached to the computer. If the Phidget is plugged into a USB port and 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 Windows Device Manager.
On Windows XP, you can access the Device Manager by right clicking on {{Code|My Computer}}, and selecting {{Code|Device Manager}} under the {{Code|Hardware}} tab. The Device Manager window will open.

[[File:WindowsXP DeviceManager.PNG|link=|alt=Windows Device Manager]]

Under the {{Code|Human Interface Devices}} heading, you can view whether your computer detects that the Phidget is connected through the USB if it is in the list. There should be a {{Code|HID-compliant device}} and a {{Code|USB Human Interface Device}} entry for every Phidget that is attached to the computer. Please note that there is currently no way of directly determining which entry belongs to which Phidget. A simple way of verifying which entry belongs to which Phidget is to simply connect or disconnect the Phidget from the USB port of the computer. The list will automatically refresh to show the updated list of all connected USB devices.

If you don't see the 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 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 2000 or newer.
* The Phidget Control Panel require that you have .NET framework 2.0 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)
* Some drivers or software will sometimes mistakenly claim Phidget devices when waiting on some hardware to be connected. Please see the section: [[Communication Protocols#Issue: Some third party software prevents communications with Phidgets|third party software prevents communications with Phidgets]] for more information.

* 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==

After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language.

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, we recommend the following languages:

*[[Language - C Sharp|C#]]
*[[Language - C/C++|C/C++]]
*[[Language - Flash AS3|Flash AS3]]
*[[Language - Java|Java]]
*[[Language - LabVIEW|LabView]]
*[[Language - Max/MSP|Max/MSP]]
*[[Language - Python|Python]]
*[[Language - Ruby|Ruby]]
*[[Language - Visual Basic .NET|Visual Basic .NET]]
*[[Language - Visual Basic 6.0|Visual Basic 6.0]]

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]]

The following languages are also supported, but to to a lack of demand, they full API is not implemented. Please refer to the specific language for more information on what features are unsupported.
*[[Language - Delphi|Delphi]]
*[[Language - Visual Basic for Applications|Visual Basic for Applications]]
*[[Language - Visual Basic Script|Visual Basic Script]]
*[[Language - LiveCode|LiveCode]]
*[[Language - Adobe Director|Adobe Director]]
*[[Language - AutoIt|AutoIt]]

==Webservice==

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

Drivers for the Phidget Webservice on Windows are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. If you have a [[File:Ph.jpg]] icon in your taskbar, you already have the Webservice drivers installed.

You can connect to a Phidget hosted on another computer if you know the IP address of the host computer. Phidgets optionally supports the use of mDNS, which allows Phidgets to be found and opened on the network by a server id instead of an IP address and port. 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. It is a tool, developed by Apple to locate devices such as Phidgets, and printers. It allows you to connect to a Phidget over the Webservice while specifying the server id. Alternatively, an IP address and port can be supplied to connect to a Phidget over the Webservice. If you do not have Bonjour installed on your system, you will have to use the second method to connect to a Phidget.

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 Control Panel. In the {{Code|Webservice}} tab, you can start, restart or stop the Webservice. You can also choose to have the Webservice start up automatically upon Windows boot up by selecting {{Code|Automatic}} as the {{Code|Startup Type}}. By leaving the {{Code|Startup Type}} as {{Code|Manual}}, you will have to manually turn the Webservice on everytime you wish to use it.

[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup]]

The second method of turning the Webservice on and off is through command line. If you used our installer, the Webservice utility is automatically installed in {{Code|C:\Program Files\Phidgets\PhidgetWebservice21.exe}}.

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>

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, type {{Code|hostname}} in the command line.
*For your IP address, type {{Code|ipconfig -all}} in the command line.
**A line in the return text, will say something like {{Code|192.168.2.198}}, which is your IP.

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

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

To start the Webservice with a server name of {{Code|myServer}}:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe -n myServer
</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:
* 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.

* 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 is [http://www.apple.com/support/downloads/bonjourforwindows.html download] and install Bonjour onto both the host and client. Next, we will set up the Webservice and run the Phidget program on the client. Please follow these steps:

1. On the host, open up the Phidget Control Panel and traverse to the {{Code|Setup}} tab of the {{Code|WebService}} section.

[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup Stopped]]

2. Leave all fields the way it is, and click on {{Code|Start}} to run the Webservice.

3. You can determine that the Webservice is running by looking at the WebService status at the bottom of the window.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]

4. Ensure that the Phidget is plugged in to the host.

5. On the client's Phidget Control Panel, open up the {{Code|Bonjour}} tab in the {{Code|Webservice}} section. 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:Windows ControlPanel WebService Bonjour Running.PNG|link=|alt=Windows Control Panel WebService Bonjour]]

6. The example application will open up, and you will be able to interact with the Phidget over the Webservice.

[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel Example]]

7. You can confirm that the Webservice was indeed behind this exchange by killing the Webservice process while still allowing the remote program to run. On the host's Phidget Control Panel, traverse to the {{Code|Setup}} tab of the {{Code|Webservice}} section. Hit {{Code|Stop}} to terminate the Webservice.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]

8. Take a look at the example application on the client. Since the application can no longer connect to the Webservice, the attached state of the Phidget is false.

[[File:Windows ControlPanel WebService Example Disconnected.PNG|link=|alt=Windows Control Panel WebService Example while Webservice 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 be enabled from the {{Code|Enable verbose output}} checkbox in the Phidget Control Panel.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]

If you are using 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.exe -v -n "myServer"
</syntaxhighlight>
</div>

The debugging information is shown in the {{Code|Output}} tab.

[[File:Windows ControlPanel WebService Output Running.PNG|link=|alt=Windows Control Panel Webservice Output Running]]

==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. This section will describe the purpose of each individual file and cover how to manually install and distribute the libraries with your code.

====Description of Library files====

* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is also placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#PhidgetWebservice | PhidgetWebservce]].
* <b>{{Code|PhidgetWindowsService21.exe}}</b> is a Windows service that controls {{Code|PhidgetWebService21.exe}}.
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts {{Code|phidget21.lib}} 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. {{Code|phidget21.lib}} is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler for details. Please note that we provide versions of the {{Code|phidget21.lib}} that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets}}; The 32 bit version of {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets\x86}}.
* <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. By default, our installer puts {{Code|phidget21.h}} 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.
* <b>{{Code|phidget21.jar}}</b> is an archive containing the Phidgets library, used by the [[Language - Java | Java]] programming language.
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidgets library for .NET framework 2.0 or greater. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidgets library for .NET framework 1.1. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio.
* <b>{{Code|Phidget21COM.dll}}</b> is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. This libraries is used by the [[Language - Adobe Director|AdobeDirector]], [[Language - AutoIt|AutoIT]], [[Language - Delphi|Delphi]], [[Language - Visual Basic 6.0|Visual Basic 6.0]], [[Language - Visual Basic for Applications|Visual Basic for Applications]], [[Language - Visual Basic Script|Visual Basic Script]].
* <b>{{Code|Phidget21Manager.exe}}</b> is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.
* <b>{{Code|Examples}} folder</b> contain example applications that allows you to quickly see if your Phidget is properly configured.
* <b>{{Code|x86 folder}} folder</b> contain the 32 bit versions of {{Code|phidget21.dll}}, {{Code|phidget21.lib}}, {{Code|Phidget21COM.dll}}. These folder will only appear on 64 bit installations and is useful if you want to code against the 32 bit libraries.

====Special Cases of Library Install====

Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|C:\WINDOWS\system32}} 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)

PhidgetWebService21.exe is also provided in the link above.

===Windows in a Virtual Machine===

Phidgets can also be used inside a virtual machine. Instructions for VMWare and VirtualBox are provided. Virtual PC is not supported as USB Phidgets requires a virtual platform that supports HID USB Devices. Since Virtual PC does not support HID USB devices, Phidgets may not be used.

As always, please ensure that you have the latest Phidget [[#Getting Started (Libraries and Drivers) | drivers]] installed on the virtual machine and that you are using the latest version of your virtual software.

<b>VMWare:</b>

To enable USB Phidgets, select Virtual Machine -> Removable Devices -> and select the Phidget Input Device -> Connect.

<b>VirtualBox</b>

To enable USB Phidgets, VirtualBox Guest Additions(Devices -> Install Guest Additions) may need to be installed. Afterwards, click on Devices -> USB Devices and select the Phidget device to enable. The state should go from Busy to Captured. VirtualBox may bring up a new hardware wizard in the host operating system, which has to be installed. Please note that Phidgets with USB hubs(i.e, [[Product - 1019 1 - PhidgetInterfaceKit 8/8/8 w/6 Port Hub|1019]]), are undetectable; Fortunately, Phidgets that are attached to such Phidgets are detectable.

==Common Problems and Solutions==

===Issue: A corrupt installation fails on uninstall or repair===
Affected Operating Systems: '''Windows'''

Solution: If the normal uninstall fails, or for whatever reason, you can choose to remove the Phidgets framework manually.
Please perform the following:
# Shut down any programs using the Phidget libraries, including the webservice and the Phidget Control Panel.
# Delete C:\Program Files\Phidgets\
# Remove the Phidgets key from the Registry [-HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services PhidgetWebservice21].

In most cases this is enough to get the installer working again. If you need to remove all traces of
the Phidgets libraries manually, perform the following additional steps:

# Unregister the COM library: regsvr32 /u “C:\Program Files\Phidgets\Phidget21COM.dll”
# Remove Phidget21.NET and Policy.2.1.Phidget21.NET from C:\Windows\Assembly\
# Delete ‘C:\Documents and Settings\All Users\Application Data\Phidgets’ (WindowsXP) or ‘C:\Users\All Users\Phidgets’ (Vista).
# Delete C:\Windows\system32\phidget21.dll
# Delete Phidgets from the start menu
# Search for and remove keys mentioning Phidgets from the registry in the following locations:
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\]
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Products\]
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders\Phidgets Inc]
:* [HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run\Phidget21Manager]
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Assemblies\Global\]

:9. Reboot

'''NOTE:''' You can go through the registry and purge any other keys mentioning Phidgets if you still
have problems, but at this point you should be able to reinstall under most cases. There will also be
keys relating to the installer, the .NET library and the COM library, but they should not interfere with
anything.

===Issue: Event data is sporadic/slow/clumped over the webservice===
Affected Operating Systems: '''Windows'''

Windows implements 200ms delayed ACKs for network traffic. When traffic is one-way only - as it is with event data, the data will all arrive in clumps every 200ms because of delayed ACKs.

This can be a great drawback for application which rely on low latency event data over the network. (source: http://support.microsoft.com/kb/214397)

This delayed ACK behavior can be disabled in windows to decrease event latency as documented here: http://support.microsoft.com/kb/328890

In the future, the Phidgets library may implement this differently, but so far we have been unable to match the performance achieved by disabling delayed ACK.
{{CreativeCommons}}

Software Overview

2012-04-05T16:31:07Z

Djrudiak: /* Third Party Support */

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.

We have developed a complete set of Application Programming Interfaces (API) that are supported for many different [[#Operating System Support|operating systems]], and which can be used through many different [[#Language Support | programming languages]].

We suggest starting with the ''Getting Started'' guide [[Device List|for your device]]. This will help you run a basic example to check your hardware and drivers.

The next step would be to choose your [[#Operating System Support|operating system below]], and from there [[#Language Support|choose a language]], learn about [[General Phidget Programming|how to write code for your Phidget]], and get API references for your [[#Language Support|programming language]].

The APIs are covered in more detail in the [[General API|API common to all devices]] and the API that pertains to your [[Device List| specific device]].

== Operating System Support ==

These operating system pages provide drivers for using Phidgets. They help you set up your system after following the '''Getting Started''' guide [[Device List|for your device]]. The operating systems links below are also on every ''Getting Started'' guide, so if you have not yet read the one for your device, [[Device List|head straight there]].

Phidgets can be run either ''directly'' through USB or ''remotely'' over a network via the [[Phidget Webservice]]. Most operating systems below can run Phidgets directly, but a few can only control them over a network. Phidgets can also probably be run on other operating systems that have support for compiling C code, and either a standard network connection for running a Phidget over a network, or a USB host controller for direct control. We don't offer support directly for these additional operating systems, but you may find the installation and setup instructions for [[OS - Linux|Linux]] useful because compiling and custom toolchains are discussed.

Phidgets can run either directly or over a network on these operating systems:

{| style="border:1px solid darkgray;" cellpadding="7px;"
|-style="background: #f0f0f0" align=center
! Operating System || Supported Version || Direct Control || Remote Network Control
|-

|'''Desktop OSes'''
|-

|[[Image:Icon-Windows.png|alt=OS - Windows|24x24px|link=OS - Windows]][[OS - Windows|Windows]]
| Windows 2000 or Newer
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|[[Image:Icon-Mac-OS.png|alt=OS - OS X|24x24px|link=OS - OS X]][[OS - OS X|OS X]]
| OS X 10.4 or newer
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|[[Image:Icon-Linux.png|alt=OS - Linux|24x24px|link=OS - Linuxs]][[OS - Linux|Linux]]
| Kernel 2.6 or newer
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|'''Mobile/Wireless OSes'''
|-

|[[Image:Icon-Linux.png|alt=OS - Phidget SBC|24x24px|link=OS - Phidget SBC]][[OS - Phidget SBC|Phidget SBC (Debian)]]
| All versions
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|[[Image:Icon-Android_Honeycomb.png|alt=OS - Android|24x24px|link=OS - Android]][[OS - Android|Android]]
| 3.1 and newer, with USB port
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|[[Image:Icon-Android.png|alt=OS - Android|link=OS - Android|24x24px|link=OS - Android]][[OS - Android|Android]]
| 1.5 to 3.0
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|[[Image:Icon-iOS.png|alt=OS - iOS|link=OS - iOS|24x24px|link=OS - iOS]][[OS - iOS|IPhone iOS]]
| 3.0 or newer
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|[[Image:Icon-Windows CE.png|alt=OS - Windows CE|24x24px|link=OS - Windows CE]][[OS - Windows CE|Windows CE]]
| 5.0 or newer
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|}

== Language Support ==

We provide a variety of supported languages for using Phidgets. Each language has its own ''libraries'', which may be found on the language pages below, along with code examples and an in-depth API.

Many languages also depend on the ''core drivers'' being installed as well. These drivers can be found on the [[#Operating System Support|operating system pages]] above.

Phidgets supports the following languages. If you have some flexibility in what language to use, we recommend using a '''Core Language''':

{| style="border:1px solid darkgray;" cellpadding="7px;"
|-style="background: #f0f0f0" align=center
! Language || API || Code Samples<sup>&dagger;</sup> || [[General Phidget Programming#Event Driven Code|Events]] || [[General Phidget Programming#Logic Code|Logic Code]] || Use via Direct USB* || [[Phidget Webservice]] || Native Library** || Phidget User Base
|-

|'''Core Languages'''
|-

|[[Image:Icon-CSharp.png|alt=C Sharp|24x24px|link=Language - C Sharp]] [[Language - C Sharp|C#]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-10.png|link=|alt=Extensive]]
|-

|[[Image:Icon-C++.png|alt=C/C++|24x24px|link=Language - C/C++]] [[Language - C/C++|C/C++]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-10.png|link=|alt=Extensive]]
|-

|[[Image:Icon-Java.png|alt=Java|24x24px|link=Language - Java]] [[Language - Java|Java]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-10.png|link=|alt=Extensive]]
|-

|[[Image:Icon-Python.png|alt=Python|24x24px|link=Language - Python]] [[Language - Python|Python]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-10.png|link=|alt=Extensive]]
|-

|[[Image:Icon-Cocoa.png|alt=Cocoa|24x24px|link=Language - Cocoa]] [[Language - Cocoa|Cocoa]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-10.png|link=|alt=Extensive]]
|-

|[[Image:Icon-Visual Basic.png|alt=Visual Basic 6.0|24x24px|link=Language - Visual Basic 6.0]] [[Language - Visual Basic 6.0|Visual Basic 6.0]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-10.png|link=|alt=Extensive]]
|-

|[[Image:Icon-Visual Basic Net.png|alt=Visual Basic .NET|24x24px|link=Language - Visual Basic .NET]] [[Language - Visual Basic .NET|Visual Basic .NET]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-10.png|link=|alt=Extensive]]
|-

|'''Mobile Languages'''
|-

|[[Image:Icon-iOS.png|alt=iOS|24x24px|link=Language - ios]] [[Language - iOS|iOS]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BABA55" align=center| InterfaceKit Only
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|[[Image:Icon-Android.png|alt=Android Java|24x24px|link=Language - Android]] [[Language - Android Java|Android Java]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BABA55" align=center| InterfaceKit Only
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #BF5656" align=center| X
|style="background: #BC8E56" align=center| Some Devices [[Image:Icon-Android_Honeycomb.png|24px|link=Software_Overview#Honeycomb|alt=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|'''Scripting'''
|-

|[[Image:Icon-Applescript.png|alt=Applescript|24x24px|link=Language - Applescript]] [[Language - Applescript|Applescript]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|[[Image:Icon-Autoit.png|alt=AutoIt|24x24px|link=Language - AutoIt]] [[Language - AutoIt|AutoIt]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BF5656" align=center| None
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-Ruby.png|alt=Ruby|24x24px|link=Language - Ruby]] [[Language - Ruby|Ruby]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|'''Science and Math'''
|-

|[[Image:Icon-LabVIEW.png|alt=LabVIEW|24x24px|link=Language - LabVIEW]] [[Language - LabVIEW|LabVIEW]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|[[Image:Icon-Matlab.png|alt=MATLAB|24x24px|link=Language - Matlab]] [[Language - MATLAB|MATLAB]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BC8E56" align=center| Some Devices
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|[[Image:Icon-Simulink.png|alt=Simulink|24x24px|link=Language - Simulink]] [[Language - Simulink|Simulink]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BABA55" align=center| InterfaceKit Only
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|'''Multimedia'''
|-

|[[Image:Icon-Adobe Director.png|alt=Adobe Director|24x24px|link=Language - Adobe Director]] [[Language - Adobe Director|Adobe Director]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| InterfaceKit Only
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-Flash AS3.png|alt=Flash AS3|24x24px|link=Language - Flash AS3]] [[Language - Flash AS3|Flash AS3]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-10.png|link=|alt=Extensive]]
|-

|[[Image:Icon-Flex AS3.png|alt=Flex AS3|24x24px|link=Language - Flex AS3]] [[Language - Flex AS3|Flex AS3]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|[[Image:Icon-LiveCode.png|alt=LiveCode|24x24px|link=Language - LiveCode]] [[Language - LiveCode|LiveCode]]
|style="background: #BABA55" align=center| InterfaceKit Only
|style="background: #BABA55" align=center| InterfaceKit Only
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-MaxMSP.png|24x24px|alt=Max/MSP|link=Language - Max/MSP]] [[Language - Max/MSP|Max/MSP]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|'''Other Languages'''
|-

|[[Image:Icon-CSharp.png|24x24px|alt=C Sharp (.NET Compact Framework)|link=Language - C Sharp (.NET Compact Framework)]] [[Language - C Sharp (.NET Compact Framework)|C# (.NET Compact)]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BC8E56" align=center| Some Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-REALBasic.png|alt=REALBasic|24x24px|link=Language - REALBasic]] [[Language - REALBasic|REALBasic]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BF5656" align=center| None
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-Visual Basic for Applications.png|alt=Visual Basic for Applications|24x24px|link=Language - Visual Basic for Applications]] [[Language - Visual Basic for Applications|Visual Basic for Apps]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BC8E56" align=center| Some Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-Visual Basic Script.png|alt=Visual Basic Script|24x24px|link=Language - Visual Basic Script]] [[Language - Visual Basic Script|Visual Basic Script]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BC8E56" align=center| Some Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-Delphi.png|alt=Delphi|24x24px|link=Language - Delphi]] [[Language - Delphi|Delphi]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BC8E56" align=center| Some Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|}
<nowiki>*</nowiki> A direct USB connection would be plugging the Phidget into a USB port and using it locally. This is the typical way to use a Phidget. However, some platforms (such as the iPhone platform) do not have USB ports and hence can only use a Phidget over a network, via the [[Phidget Webservice]].

<nowiki>**</nowiki> Native library support means that the calls you make to a Phidget in this language are in the language as well. If the calls are non-native, the use of Phidgets is through an external library linker, such as callib() in MATLAB, for example. The core Phidget library is written in C, and most other languages use this library as their core, but a 'Native' interface cleanly hides this detail.

<sup>&dagger;</sup> Most languages have code samples for all Phidgets, but some have only some devices (visit the language page to learn which ones), and some only have an Interface Kit example. The Phidget Interface Kit is a common Phidget with provides an interface with analog sensors, digital input, and digital output. So, when we choose which examples to write, the Interface Kit is often at the top of our customer's lists.

<span id="Honeycomb">[[Image:Icon-Android_Honeycomb.png|24px|link=]]</span>Android Honeycomb Version 3.1 or Higher Only

==Third Party Support==

{{GentleAlert|'''These products must be purchased directly from these companies and all support calls must be directed to them'''}}

Some third party companies also offer and support software programs that work with Phidgets boards. Phidgets does not have a certification program and does not make any warranty about these products.

In alphabetical order:

{| style="border:1px solid darkgray;" cellpadding="7px;"
|-style="background: #f0f0f0" align=center
! Company
! Product
! Runs On
! Website
! style="width:50%;" | Synopsis
! Product Information
|-

|'''24U'''
|24U Phidgets Plug-in 1.0
|Mac, Windows
|[http://www.24usoftware.com/plugins.php Website]
|24U Phidgets Plug-In lets you connect different kind of phidgets (www.phidgets.com) to your computer's USB port and interact with them directly from FileMaker Pro.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/24U.pdf]]
|-

|'''DSPRobotics'''
|Flowstone
|Windows 2000/XP/Vista/7/Embedded
|[http://www.dsprobotics.com/ Website]
|Graphical Programming Language aimed at real-time Digital Signal Processing.(DSP), Robotics and Embedded applications. FlowStone is a drag and drop environment where you combine high-level and low-level modules to build real time applications.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/FlowStone.pdf]]
|-

|'''MANIPIL'''
|Visual Domotique
|Windows XP/Vista/7
|[http://www.manipil.ch/cms1/vd/tutoriels/setup-and-to-use-a-phidget-module.html Website]
|Visual Domotique is a Graphical I/O programming for Windows XP/Vista/7. Various components allow you to draw electrical schema and control panel. No need to know how to program to use this software. Varied uses are possible: Home automation, security, hobby, Control process education... Available in French.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/Manipil_en.pdf]]
|-

|'''PCRBOX'''
|PCR Automation
|Windows XP/Vista/7 (32 & 64bit)
|[http://www.pcrbox.com/en/ Website]
|PCR Automation is an easy to use software that works immediately without the need for any programming. It interfaces with the 1018, 1070 and 1072. Several interfaces can be opened simultaneously, each in a different window. Each input / output can be customized (label, sensor, offset, units, sensitivity, recording ...). The log files can be automatically sent by E-mail. Users can add their own sensors to the library of thirty Phidgets sensors.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/pcr-automation-en.pdf]]
|-

|'''PiXCL Automation Technologies'''
|PiXCL Advanced Imaging 10.2
|Windows XP/Vista/7
|[http://www.pixcl.com/Using_Phidgets_with_PiXCL.htm Website]
|PiXCL is a powerful and easy-to-learn event driven interpreted language for the fast creation of image acquisition, processing and advanced analysis applications. The suite includes a compiler and development studio with context sensitive help and plenty of sample code. V10.1 provides you with the tools to create applications that combine Phidget devices with digital cameras and scanners.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/PiXCL.pdf]]
|-

|'''SoapBox Automation'''
|SoapBox Snap
|Windows XP/Vista/7
|[http://soapboxautomation.com/products/soapbox-snap/ Website]
|SoapBox Snap is a free and open source PC-based automation platform. It includes a ladder logic editor and a “soft” runtime right out of the box.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/SoapBox.pdf]]
|-

|'''UACh - Universida Austral de Chile'''
|monoBOTICS-icarus
|Linux
|[http://www.monobotics.ic.uach.cl/ Website]
|The monoBOTICS project aims to become an OpenSource Framework, to facilitate the tasks of design, simulation and implementation of solutions for areas of Robotics and Automation, both for people with basic knowledge of programming, as for more advanced developers.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/monoBOTICS.pdf]]
|-
|}
{{CreativeCommons}}

OS - Windows

2012-04-05T14:50:45Z

Djrudiak:

[[Category:OS]]
[[File:icon-Windows.png|64x64px|link=OS - Windows]]On Windows, 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 2000 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]]. If you already have the [[File:Ph.jpg]] icon in your task bar and know how to use it, then you've already followed the guide and are ready to learn more about the control panel, the Phidget Webservice, and more - all specific to Windows.

If you are already a pro, and just want the drivers:

*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20111028.exe 32 Bit]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20111028.exe 64 Bit]

For special cases where you want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section.
*[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)
*[http://www.phidgets.com/Drivers_Info.html#windows Software License]

===Installing===

Please ensure that your system has .NET framework 2.0 or higher. The .NET framework can be downloaded from [http://www.microsoft.com/net Microsoft].

To install the libraries, follow these steps:

1. Download one of the Phidget installer for your system, depending on whether your system is 32 or 64-bit.
*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20120216.exe 32-bit]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20120216.exe 64-bit]

2. Open up the installer, and proceed through the wizard.

[[File:Windows Install.PNG|link=|alt=Windows Install]]

Please note that by default, the installer places the [[#Description of Library files | Phidget libraries]] in {{Code|C:\Program Files\Phidgets}}.

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

Proceed onto to the [[#Phidget Control Panel | next]] section where the Phidget Control Panel will be discussed.

====Phidget Control Panel====

The Phidget Control Panel is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.

Once the Phidget libraries are installed using the installer, you should see the [[File:Ph.jpg]] icon in the taskbar. Double click on it to bring up the Phidget Control Panel. If the icon does not appear, just find and open the the Phidget Control Panel from the start menu.

[[File:Windows ControlPanel General.PNG|link=|alt=Windows Control Panel General]]

The general tab shows the list of Phidgets currently physically attached to the computer. You can also view the currently installed Phidget library version, as well as having the option to choose whether the Phidget Control Panel is to be started up automatically once Windows boots up. You can double click on a Phidget device to open up an example program for the device.

[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel 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 Control Panel, 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 Control Panel can still be running) when you are running your own applications.

The next tab is the {{Code|WebService}} tab, which allows you to control Phidgets over a network. There are four sub-tabs. The first sub-tab is the {{Code|Setup}} tab.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]

Here, you can start and stop the Webservice. Details are provided in the [[#Webservice | Webservice]] section. You can also determine whether the Phidget Webservice is currently running. There is also a check box that you can select to turn on verbose output, which will display useful troubleshooting information for the Webservice.

The next sub-tab is the {{Code|Output}} tab, which provides useful debugging information while you are using the WebService. This tab will only show up if the verbose output option is selected in the previous tab.

[[File:Windows ControlPanel WebService Output.PNG|link=|alt=Windows Control Panel WebService Output]]

The {{Code|Dictionary}} sub-tab comes next; it lists all the key-value pairs that gets created when the Webservice runs. More information is provided in the [[General Phidget Programming#Using the Dictionary|Dictionary]] section of the [[General Phidget Programming|General Phidget Programming]] page.

[[File:Windows ControlPanel WebService Dictionary.PNG|link=|alt=Windows Control WebService Dictionary]]

The {{Code|Bonjour}} sub-tab gives a list of all currently attached Phidgets that are connected to the Webservice. This tab will only appear if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system. You can also double click on the Phidget to connect to it over the network using one or more computers, and still use the Phidget on the computer it is directly connected to.

[[File:Windows ControlPanel WebService Bonjour.PNG|link=|alt=Windows Control Panel WebService Bonjour]]

The last tab is the {{Code|PhidgetSBC}} tab, which displays the complete list of PhidgetSBCs connected to the network. You can double click on the PhidgetSBC to bring up the PhidgetSBC Adminstration Console.

[[File:Windows ControlPanel WebService PhidgetSBC.PNG|link=|alt=Windows Control Panel WebService PhidgetSBC]]

---Advanced uses of the control panel (modifying, manual installation, etc) go in the advanced section below.

===Checking===

To confirm the libraries were installed and work correctly, you can check both the hardware and software sides 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 side is working by seeing if the Phidget device is listed in the {{Code|General}} tab of the Phidget Control Panel.

[[File:Windows_ControlPanel_General.PNG|link=|alt=Windows Control Panel General]]

The above screenshot shows that a PhidgetRFID and a PhidgetInterfaceKit are attached to the computer. 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 Windows Device Manager.
On Windows XP, you can access the Device Manager by right clicking on {{Code|My Computer}}, and selecting {{Code|Device Manager}} under the {{Code|Hardware}} tab. The Device Manager window will open.

[[File:WindowsXP DeviceManager.PNG|link=|alt=Windows Device Manager]]

Under the {{Code|Human Interface Devices}} heading, you can view whether your computer detects that the Phidget is connected through the USB if it is in the list. There should be a {{Code|HID-compliant device}} and a {{Code|USB Human Interface Device}} entry for every Phidget that is attached to the computer. Please note that there is currently no way of directly determining which entry belongs to which Phidget. A simple way of verifying which entry belongs to which Phidget is to simply connect or disconnect the Phidget from the USB port of the computer. The list will automatically refresh to show the updated list of all connected USB devices.

If you don't see the 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 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 2000 or newer.
* The Phidget Control Panel require that you have .NET framework 2.0 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)
* Some drivers or software will sometimes mistakenly claim Phidget devices when waiting on some hardware to be connected. Please see the section: [[Communication Protocols#Issue: Some third party software prevents communications with Phidgets|third party software prevents communications with Phidgets]] for more information.

* 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==

After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language.

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, we recommend the following languages:

*[[Language - C Sharp|C#]]
*[[Language - C/C++|C/C++]]
*[[Language - Flash AS3|Flash AS3]]
*[[Language - Java|Java]]
*[[Language - LabVIEW|LabView]]
*[[Language - Max/MSP|Max/MSP]]
*[[Language - Python|Python]]
*[[Language - Ruby|Ruby]]
*[[Language - Visual Basic .NET|Visual Basic .NET]]
*[[Language - Visual Basic 6.0|Visual Basic 6.0]]

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]]

The following languages are also supported, but to to a lack of demand, they full API is not implemented. Please refer to the specific language for more information on what features are unsupported.
*[[Language - Delphi|Delphi]]
*[[Language - Visual Basic for Applications|Visual Basic for Applications]]
*[[Language - Visual Basic Script|Visual Basic Script]]
*[[Language - LiveCode|LiveCode]]
*[[Language - Adobe Director|Adobe Director]]
*[[Language - AutoIt|AutoIt]]

==Webservice==

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

Drivers for the Phidget Webservice on Windows are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. If you have a [[File:Ph.jpg]] icon in your taskbar, you already have the Webservice drivers installed.

You can connect to a Phidget hosted on another computer if you know the IP address of the host computer. Phidgets optionally supports the use of mDNS, which allows Phidgets to be found and opened on the network by a server id instead of an IP address and port. 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. It is a tool, developed by Apple to locate devices such as Phidgets, and printers. It allows you to connect to a Phidget over the Webservice while specifying the server id. Alternatively, an IP address and port can be supplied to connect to a Phidget over the Webservice. If you do not have Bonjour installed on your system, you will have to use the second method to connect to a Phidget.

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 Control Panel. In the {{Code|Webservice}} tab, you can start, restart or stop the Webservice. You can also choose to have the Webservice start up automatically upon Windows boot up by selecting {{Code|Automatic}} as the {{Code|Startup Type}}. By leaving the {{Code|Startup Type}} as {{Code|Manual}}, you will have to manually turn the Webservice on everytime you wish to use it.

[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup]]

The second method of turning the Webservice on and off is through command line. If you used our installer, the Webservice utility is automatically installed in {{Code|C:\Program Files\Phidgets\PhidgetWebservice21.exe}}.

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>

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, type {{Code|hostname}} in the command line.
*For your IP address, type {{Code|ipconfig -all}} in the command line.
**A line in the return text, will say something like {{Code|192.168.2.198}}, which is your IP.

Here are some example usage:

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

To start the Webservice with a server name of {{Code|myServer}}:
<div class="source">
<syntaxhighlight lang=bash>
PhidgetWebservice21.exe -n myServer
</syntaxhighlight>
</div>

===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.

* 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 is [http://www.apple.com/support/downloads/bonjourforwindows.html download] and install Bonjour onto both the host and client. Next, we will set up the Webservice and run the Phidget program on the client. Please follow these steps:

1. On the host, open up the Phidget Control Panel and traverse to the {{Code|Setup}} tab of the {{Code|WebService}} section.

[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup Stopped]]

2. Leave all fields the way it is, and click on {{Code|Start}} to run the Webservice.

3. You can determine that the Webservice is running by looking at the WebService status at the bottom of the window.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]

4. Ensure that the Phidget is plugged in to the host.

5. On the client's Phidget Control Panel, open up the {{Code|Bonjour}} tab in the {{Code|Webservice}} section. 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:Windows ControlPanel WebService Bonjour Running.PNG|link=|alt=Windows Control Panel WebService Bonjour]]

6. The example application will open up, and you will be able to interact with the Phidget over the Webservice.

[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel Example]]

7. You can confirm that the Webservice was indeed behind this exchange by killing the Webservice process while still allowing the remote program to run. On the host's Phidget Control Panel, traverse to the {{Code|Setup}} tab of the {{Code|Webservice}} section. Hit {{Code|Stop}} to terminate the Webservice.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]

8. Take a look at the example application on the client. Since the application can no longer connect to the Webservice, the attached state of the Phidget is false.

[[File:Windows ControlPanel WebService Example Disconnected.PNG|link=|alt=Windows Control Panel WebService Example while Webservice 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 be enabled from the {{Code|Enable verbose output}} checkbox in the Phidget Control Panel.

[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]

If you are using 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.exe -v -n "myServer"
</syntaxhighlight>
</div>

==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. This section will describe the purpose of each individual file and cover how to manually install and distribute the libraries with your code.

====Description of Library files====

* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. It is also placed in {{Code|C:\Windows\System32}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#PhidgetWebservice | PhidgetWebservce]].
* <b>{{Code|PhidgetWindowsService21.exe}}</b> is a Windows service that controls {{Code|PhidgetWebService21.exe}}.
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts {{Code|phidget21.lib}} 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. {{Code|phidget21.lib}} is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler for details. Please note that we provide versions of the {{Code|phidget21.lib}} that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets}}; The 32 bit version of {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets\x86}}.
* <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. By default, our installer puts {{Code|phidget21.h}} 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.
* <b>{{Code|phidget21.jar}}</b> is an archive containing the Phidgets library, used by the [[Language - Java | Java]] programming language.
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidgets library for .NET framework 2.0 or greater. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidgets library for .NET framework 1.1. Any .NET language can be used, including [[Language - C Sharp | C#]] , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio.
* <b>{{Code|Phidget21COM.dll}}</b> is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. This libraries is used by the [[Language - Adobe Director|AdobeDirector]], [[Language - AutoIt|AutoIT]], [[Language - Delphi|Delphi]], [[Language - Visual Basic 6.0|Visual Basic 6.0]], [[Language - Visual Basic for Applications|Visual Basic for Applications]], [[Language - Visual Basic Script|Visual Basic Script]].
* <b>{{Code|Phidget21Manager.exe}}</b> is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.
* <b>{{Code|Examples}} folder</b> contain example applications that allows you to quickly see if your Phidget is properly configured.
* <b>{{Code|x86 folder}} folder</b> contain the 32 bit versions of {{Code|phidget21.dll}}, {{Code|phidget21.lib}}, {{Code|Phidget21COM.dll}}. These folder will only appear on 64 bit installations and is useful if you want to code against the 32 bit libraries.

---also explain the extra files that are installed as part of the 64 bit installer.

====Special Cases of Library Install====

Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|C:\WINDOWS\system32}} 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)

PhidgetWebService21.exe is also provided in the link above.

===Windows in a Virtual Machine===

Phidgets can also be used inside a virtual machine. Instructions for VMWare and VirtualBox are provided. Virtual PC is not supported as USB Phidgets requires a virtual platform that supports HID USB Devices. Since Virtual PC does not support HID USB devices, Phidgets may not be used.

As always, please ensure that you have the latest Phidget [[#Getting Started (Libraries and Drivers) | drivers]] installed on the virtual machine and that you are using the latest version of your virtual software.

<b>VMWare:</b>

To enable USB Phidgets, select Virtual Machine -> Removable Devices -> and select the Phidget Input Device -> Connect.

<b>VirtualBox</b>

To enable USB Phidgets, VirtualBox Guest Additions(Devices -> Install Guest Additions) may need to be installed. Afterwards, click on Devices -> USB Devices and select the Phidget device to enable. The state should go from Busy to Captured. VirtualBox may bring up a new hardware wizard in the host operating system, which has to be installed. Please note that Phidgets with USB hubs(i.e, [[Product - 1019 1 - PhidgetInterfaceKit 8/8/8 w/6 Port Hub|1019]]), are undetectable; Fortunately, Phidgets that are attached to such Phidgets are detectable.

==Common Problems and Solutions==

This content is primarily copied from the old page. Try to put as much of this as possible into the [[#Troubleshooting | Troubleshooting]] section above, or the Advanced Uses section. If you don't include all of the content, in those other sections, at least link between here and there.

===Issue: Installing .NET 2.0 on Windows 2000.===
Affected Operating Systems: '''Windows 2000'''

To install the Phidget Framework on Windows 2000 systems, the .NET 2.0 framework is required.
Also, although not explicitly required to use Phidgets on a Windows system, Phidgets under the .NET languages can use .NET 2.0.

Solution: The Microsoft .NET Framework Version 2.0 Redistributable Package for (x86) and (x64)
systems is freely available from www.microsoft.com. You will need to upgrade to at least Windows
2000 Service Pack 3 for the (x86) version.

===Issue: A corrupt installation fails on uninstall or repair===
Affected Operating Systems: '''Windows'''

Solution: If the normal uninstall fails, or for whatever reason, you can choose to remove the Phidgets framework manually.
Please perform the following:
# Shut down any programs using the Phidget libraries, including the webservice and the Phidget Control Panel.
# Delete C:\Program Files\Phidgets\
# Remove the Phidgets key from the Registry [-HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services PhidgetWebservice21].

In most cases this is enough to get the installer working again. If you need to remove all traces of
the Phidgets libraries manually, perform the following additional steps:

# Unregister the COM library: regsvr32 /u “C:\Program Files\Phidgets\Phidget21COM.dll”
# Remove Phidget21.NET and Policy.2.1.Phidget21.NET from C:\Windows\Assembly\
# Delete ‘C:\Documents and Settings\All Users\Application Data\Phidgets’ (WindowsXP) or ‘C:\Users\All Users\Phidgets’ (Vista).
# Delete C:\Windows\system32\phidget21.dll
# Delete Phidgets from the start menu
# Search for and remove keys mentioning Phidgets from the registry in the following locations:
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\]
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Products\]
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders\Phidgets Inc]
:* [HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run\Phidget21Manager]
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Assemblies\Global\]

:9. Reboot

'''NOTE:''' You can go through the registry and purge any other keys mentioning Phidgets if you still
have problems, but at this point you should be able to reinstall under most cases. There will also be
keys relating to the installer, the .NET library and the COM library, but they should not interfere with
anything.

===Issue: Event data is sporadic/slow/clumped over the webservice===
Affected Operating Systems: '''Windows'''

Windows implements 200ms delayed ACKs for network traffic. When traffic is one-way only - as it is with event data, the data will all arrive in clumps every 200ms because of delayed ACKs.

This can be a great drawback for application which rely on low latency event data over the network. (source: http://support.microsoft.com/kb/214397)

This delayed ACK behavior can be disabled in windows to decrease event latency as documented here: http://support.microsoft.com/kb/328890

In the future, the Phidgets library may implement this differently, but so far we have been unable to match the performance achieved by disabling delayed ACK.

===Issue: My system has a .NET version earlier than 2.0, and cannot run the Installer ===
Affected Operating Systems: '''Windows'''

For the best compatibility, it is recommended that you install the most up to date .NET version. However, if there are certain circumstances that prevent you from installing .NET 2.0 or higher, you can still control Phidgets. The drivers can be manually installed - check our [[#Manual_File_Installation|Manual Installation Instructions]].

The need for .NET 2.0 is because certain Phidgets features were built with .NET 2.0. Features include Phidget Control Panel, examples, and PhidgetWebService.
<hr>
{| align="center"
|-
|valign="top"|<font size="0">[http://creativecommons.org/licenses/by-nc-nd/3.0/ [[File:by-nc-nd-80x15.png|80px|alt=Creative Commons Licence]]]</font>||<font size="0">This work by [http://www.phidgets.com Phidgets Inc.], except where otherwise noted, is licensed under a [http://creativecommons.org/licenses/by-nc-nd/3.0/ Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License.]</font>
|}

Software Overview

2012-04-05T14:43:15Z

Djrudiak:

Software Overview

2012-04-05T14:34:46Z

Djrudiak:

Main Page

2012-04-03T17:26:57Z

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%2016&up_mon=4&up_dat=13&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]

Software Overview

2012-03-30T16:31:59Z

Djrudiak: /* Language Support */

Main Page

2012-03-30T15:32:23Z

Djrudiak: /* Dan */

<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%2015&up_mon=3&up_dat=30&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.
*[[VoiP 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 - Java

2012-03-30T15:21:35Z

Djrudiak:

[[Category:Language]]
[[File:icon-Java.png|64x64px||link=|alt=Java]]Java is a modern, object-oriented programming language maintained by Oracle.

__TOC__

==Introduction==

{{LanguageSupport|Java|the complete Phidget API, including events|all Phidget devices.|the {{Code|javac}} command line compiler as well as in integrated development environments(IDEs) such as [[#NetBeans | NetBeans]] and [[#Eclipse | Eclipse]]|}}

==Quick Downloads==

{{QuickDownloads|Java|
{{APIQuickDownloads|http://www.phidgets.com/documentation/JavaDoc.zip}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20111220.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/phidget21jar_2.1.8.20111220.zip|Java|(phidget21.jar)}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
{{LinuxQuickDownloads}}
}}

==Getting started with Java==

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===
Java programs on Windows depend on two files, which the installers in the [[#Libraries and Drivers | Quick Downloads]] section 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|phidget21.jar}}</b> is the Phidget Java library for JDK <i><b>1.4.2</b></i> or higher. Your compiler has to know where this file is. By default, it is placed 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. For more information, please see the section for your specific compiler/environment.

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}}] as well as the [http://www.phidgets.com/downloads/libraries/phidget21jar_2.1.8.20120131.zip {{Code|phidget21.jar}}] and manually install them where you want; refer to our [[Manual Installation Instructions|Manual Installation Instructions]].

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

You can program Phidgets with Java in command line with the {{Code|javac}} compiler as well as in IDEs such as NetBeans and Eclipse.

===Javac (Command Line)===

====Use Our Examples====

Download the [http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20111220.zip example] 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 are intended for the [[#NetBeans | NetBeans IDE]].

Ensure that the {{Code|phidget21.jar}} is in the same directory as the source code.

To compile in Windows command prompt:
<div class="source">
<syntaxhighlight lang=bash>
javac -classpath .;phidget21.jar example.java
</syntaxhighlight>
</div>

This will create Java bytecode in the form of {{Code|.class}} files. Type the following to run the program:
<div class="source">
<syntaxhighlight lang=bash>
java -classpath .;phidget21.jar example
</syntaxhighlight>
</div>

If you wish, you can compile the project as a {{Code|.jar}} so there are fewer files to maintain. The [[http://www.oracle.com/java Java SDK]] provides the {{Code|jar}} utility which packages all the {{Code|.class}} files into a single {{Code|.jar}} file.
To begin, you will have to provide a Manifest file to indicate the program entry point. With your favourite text editor, create a new file with the following content:
<div class="source">
<syntaxhighlight lang=text>
Manifest-Version: 1.0
Class-Path: phidget21.jar
Main-Class: example
</syntaxhighlight>
<br/>
</div>
Ensure that the file ends in a single new line or a carriage return character.
Save the file as {{Code|example.mf}} and place it in the same directory as the other {{Code|.class}} files.
Next, create the .{{Code|jar}} with:
<div class="source">
<syntaxhighlight lang=bash>
jar -cfm example.jar example.mf *.class
</syntaxhighlight>
</div>
Afterwards, you can run the {{Code|.jar}} with:
<div class="source">
<syntaxhighlight lang=bash>
java -jar example.jar
</syntaxhighlight>
</div>
Once you have the Java 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 Java library. Please see the [[#Use Our Examples| previous]] section for instructions.

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

<div class="source">
<syntaxhighlight lang=java>
import com.phidgets.*;
import com.phidgets.event.*;
</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.

===NetBeans===

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

You first download the [http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20111220.zip examples], unpack them into a folder, and then find the source code for your device. The source file will be named the same as the software object 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]]. The full examples were written in NetBeans, so the rest of this section will use these examples. To use the simple examples, you will have to import the source code into a new NetBeans project.

[[File:Java NetBeans Open Project.PNG|link=|alt=Open Project]]

The only thing left to do is to run the examples! Click on Run → Run Project. The project, by default tries to find the {{Code|phidget21.jar}} in {{Code|..\..\lib}}.

{{ContentNeeded|This file should link to something}}
[[File:Java NetBeans Run.PNG|link=|alt=Run]]

Once you have the Java 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 Java library. To begin:

1. Create a new Java application project with a descriptive name such as PhidgetTest.

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

2. Add a reference to the Phidget Java library. In the projects pane, right click {{Code|Libraries}} and add the {{Code|jar}}.

[[File:Java NetBeans Add Jar.PNG|link=|alt=Add Jar]]

3. Find and select {{Code|phidget21.jar}}.

[[File:Java NetBeans Add Jar 2.PNG|link=|alt=Add Jar]]

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

<div class="source">
<syntaxhighlight lang=java>
import com.phidgets.*;
import com.phidgets.event.*;
</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.

===Eclipse===

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

1. Download the [http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20111220.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 use the simple examples. The full examples were written in NetBeans, and are not compatible with Eclipse. The rest of this guide will assume that the simple examples are used. The example source code will be copied into your Eclipse project later on. Keep note of the file name of the example as a Java class will be created with the same name.

2. Generate a new Java project with a descriptive name such as PhidgetTest. Click next.

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

3. On the next screen, go to the libraries panel and add an external {{Code|jar}}.

[[File:Java Eclipse Add Jar 1.PNG|link=|alt=Add Jar]]

4. Find and select {{Code|phidget21.jar}}.

[[File:Java Eclipse Add Jar 2.PNG|link=|alt=Add Jar]]

5. Add a new Java class to the project.

[[File:Java Eclipse New Class.PNG|link=|alt=New Class]]

6. Name this class with the same name as the simple example's name.

[[File:Java Eclipse New Class 2.PNG|link=|alt=New Class]]

7. Copy and paste the example source code over to the class you created.

[[File:Java Eclipse Source.PNG|link=|alt=Source Code]]

8. The only thing left to do is to run the examples!

[[File:Java Eclipse Run.PNG|link=|alt=Run]]

Once you have the Java 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 Java library. Please see the [[#Use Our Examples 3| Use Our Examples]] section for instructions.

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

<div class="source">
<syntaxhighlight lang=java>
import com.phidgets.*;
import com.phidgets.event.*;
</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.

==Mac OS==

{{ContentNeeded|This section needs to be filled in}}

Java has excellent support on OS X through the Java Compiler.

The first step in using Java 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....

===Use Our Examples===

On Mac OS, type:
<div class="source">
<syntaxhighlight lang=bash>
java -classpath .:phidget21.jar example
</syntaxhighlight>
</div>

The command to compile in a OS X and Linux terminal are slightly different. Rather than prefixing {{Code|phidget21.jar}} with a semi-colon( {{Code|;}} ), a colon( {{Code|:}} ) is used.
<div class="source">
<syntaxhighlight lang=bash>
javac -classpath .:phidget21.jar example.java
</syntaxhighlight>
</div>

Perhaps refer to the Windows section of Eclipse and Netbeans for further information?

===Write Your Own Code===

==Linux==

Java has excellent support on Linux - there is an established implementation of the Java compiler and interpreter, and several Integrated Development Environments (IDEs) including NetBeans and Eclipse.

The first step in using Java on Linux is to install the base Phidget libraries. Compile and install them as explained on the main [[OS - Linux | Linux page]]. That Linux page also describes the different basic Phidget library files, their installed locations, and their roles.

You will also need the [http://www.phidgets.com/downloads/libraries/phidget21jar_2.1.8.20120131.zip Phidget Java Libraries (phidget21.jar)].

Once downloaded, the {{Code|phidget21.jar}} library file does not get 'installed' (i.e. do not run {{Code| java -jar phidget21.jar}}). Rather, the library file gets put into the path of whatever program you write, and you will link it via both the java compiler and the java interpreter. We walk you through this below.

We have two different types of Phidget examples in Java:
*Simple examples, to be run on the command line, and
*Full examples, to be run in NetBeans

Both are contained within the [http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20120131.zip Phidget Java example download package].

===Description of Library Files===

The Phidget Java libraries depend on the C libraries being installed as explained on the main [[OS - Linux | Linux page]]. If you browse around within the phidget21.jar archive, you will find Java class files (too many to reasonably list here) that have names related to the devices they provide an API for.

These Java class files use the functions available in the ''dynamic'' Phidget21 C-language library on Linux. Dynamic libraries end with {{Code|.so}}, and so the C library that the Phidget Java class files use is {{Code|/usr/lib/libphidget21.so}}.

===Javac (Command Line)===

====Use Our Examples====

Linux gets somewhat complicated in that two Java compilers exist: {{Code|openjdk}} and {{Code|gcj}}. Furthermore, a given IDE can ''usually'' use either compiler. That being said, we only offer support here for openJDK and IDEs running openJDK.

To find out which type of compiler your computer has, use the {{Code|-version}} option on the command line. You can use the same option for your runtime environment (interpreter):

<div class="source">
<syntaxhighlight lang=text>
$> java -version
java version "1.6.0_23"
OpenJDK Runtime Environment (IcedTea6 1.11pre) (6b23~pre11-0ubuntu1.11.10.1)
OpenJDK 64-Bit Server VM (build 20.0-b11, mixed mode)

$> javac -version
javac 1.6.0_23
</syntaxhighlight>
</div>

The good news is that you can have both {{Code|openjdk}} and {{Code|gcj}} on your machine, co-habitating happily. There can be only one linked java and javac in {{Code|/usr/bin/}} however, and so this will correspond to whichever java compiler and interpreter you installed last.

If you do not have {{Code|openjdk}} installed already (this is the default Java installation for most Linux machines, so you will probably know), and you choose to install it for Phidget purposes, it is important is that the {{Code|java}} version be greater than the {{Code|javac}} version. Otherwise, your runtime environment will consider the stuff your compiler produces to be newfangled nonsense. So when installing Java from a repository, you should install both the jdk and the jre. These are, unfortunately, usually separate packages in a repository (e.g. {{Code|openjdk-7-jre}} and {{Code|openjdk-7-jdk}}).

The simple examples in Java are meant to be compiled and run on the command line. The example package includes a {{Code|Makefile}} so you can either make all of the examples at once, with:

<div class="source">
<syntaxhighlight lang=bash>
make all
</syntaxhighlight>
</div>

...Or you can make them individually. You should pick out the example with the name that corresponds to the family of your Phidget hardware. If you're not sure what the family (software object) is, you can find out on the product API [[Device List|for your device]]. Once you've identified the right example - say, {{Code|HelloWorld.java}}, which will work with any Phidget - compile it on the command line with:

<div class="source">
<syntaxhighlight lang=bash>
javac -classpath .:phidget21.jar HelloWorld.java
</syntaxhighlight>
</div>

To run the example on a Linux machine [[OS - Linux#Setting udev Rules| without your udev USB rules set]], you will need to run the Java example as root:

<div class="source">
<syntaxhighlight lang=bash>
sudo java -classpath .:phidget21.jar HelloWorld
</syntaxhighlight>
</div>

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

You'll note that the Phidget Java library file {{Code|phidget21.jar}} needs to be explicitly linked at both points in the compile and run process. Alternatively, you can make a jar file which includes the Phidget Java library. This process takes two steps, the first of which is creating a text file called {{Code|MyProgram.mf}}, where {{Code|MyProgram}} is replaced by the name of your main class in both the filename and the text below:

<div class="source">
<syntaxhighlight lang=text>
Manifest-Version: 1.0
Class-Path: phidget21.jar
Main-Class: MyProgram

</syntaxhighlight>
</div>

'''Note:''' The manifest file should end with a carriage return. So, there should be an extra line at the bottom of the file.

After creating the manifest file, you can use the {{Code|jar}} function to create one self-contained file with your classes and the correct classpath.

<div class="source">
<syntaxhighlight lang=bash>
jar –cfm MyProgram.jar MyProgram.mf *.class
</syntaxhighlight>
</div>

If porting this for an external system, such as one that your customer would be running, the Phidget library would need to be compiled and distributed along with the {{Code|.jar}}. Although we do not directly support this, if you are interested in how to construct this, we provide both a distribution example and information on cross-compiling:
* The [[Language - Android Java | Android Java]] libraries have an ARM-compiled {{Code|libphidget21.so}} file included, as an example of distributing a compiled libphidget21.so with the jar file
* The [[OS - Linux#Cross-Compiling with a Custom Toolchain|Linux page]] has more detail for compiling the Phidget C Libraries for an external target.

===NetBeans===

We offer in-depth tutorials on using our examples in NetBeans and Eclipse in the [[#NetBeans|Windows NetBeans]] and [[#Eclipse|Windows Eclipse]] sections.

As our full examples are written with NetBeans, but NetBeans is not part of the standard Linux package repository, we offer installation instructions here before referring to the Windows sections.

====Installation====

Although Eclipse is standard in the Debian/Ubuntu package repository, NetBeans is no longer standard. What is more, Netbeans does not install by default into a folder within your path. As our Phidget full Java examples are written using NetBeans, we provide basic installation instructions here so you can actually run them.

To install NetBeans:

1. Download the install script from website: [http://netbeans.org/downloads/ http://netbeans.org/downloads/]<br>
2. Change the permissions of the downloaded file to be executable. Usually, this is something like:
:{{Code|chmod +x netbeans-7.1-ml-javase-linux.sh}}<br>
3. Run the downloaded file as a script. (This will result in a GUI interaction that walks you through installation.)<br>
4. To find the location where the NetBeans installation occurred, run:<br>
:{{Code|updatedb}}
:{{Code|locate netbeans | grep bin}}<br>
5. Usually, the location of the binary is {{Code|/usr/local/netbeans-7.1/bin/netbeans}}, where 7.1 is the installed version.

====Use Our Examples====

Once you have NetBeans installed, running our examples will be very similar to the process described in the [[#NetBeans|Windows NetBeans]] 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 Java library. Please see the [[#NetBeans| Windows NetBeans]] section for instructions if you are unfamiliar with NetBeans.

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

<div class="source">
<syntaxhighlight lang=java>
import com.phidgets.*;
import com.phidgets.event.*;
</syntaxhighlight>
</div>

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

The [[#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 Phidgets Java methods:

{{UsingAPhidgetInCodeGeneral|both of which are available in Java|[http://www.phidgets.com/documentation/JavaDoc.zip Java API]}}

===Example Flow===

{{ExamplePseudocode|In Java, 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. Some 'get data' functions are also specific to each device.
|Creating a Phidget software object in Java - when you are not using the Manager - is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a {{Code|SpatialPhidget}} object. The device-specific examples show how to do this and other API functions.<br><br>
The software object provides device specific methods which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/JavaDoc.zip Java API]}}

==Common Problems and Solutions/Workarounds==

None yet.

Software Overview

2012-03-30T15:13:50Z

Djrudiak: /* Language Support */

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.

We have developed a complete set of Application Programming Interfaces (API) that are supported for many different [[#Operating System Support|operating systems]], and which can be used through many different [[#Language Support | programming languages]].

We suggest starting with the ''Getting Started'' guide [[Device List|for your device]]. This will help you run a basic example to check your hardware and drivers.

The next step would be to choose your [[#Operating System Support|operating system below]], and from there [[#Language Support|choose a language]], learn about [[General Phidget Programming|how to write code for your Phidget]], and get API references for your [[#Language Support|programming language]].

The APIs are covered in more detail in the [[General API|API common to all devices]] and the API that pertains to your [[Device List| specific device]].

== Operating System Support ==

These operating system pages provide drivers for using Phidgets. They help you set up your system after following the '''Getting Started''' guide [[Device List|for your device]]. The operating systems links below are also on every ''Getting Started'' guide, so if you have not yet read the one for your device, [[Device List|head straight there]].

Phidgets can be run either ''directly'' through USB or ''remotely'' over a network via the [[Phidget Webservice]]. Most operating systems below can run Phidgets directly, but a few can only control them over a network. Phidgets can also probably be run on other operating systems that have support for compiling C code, and either a standard network connection for running a Phidget over a network, or a USB host controller for direct control. We don't offer support directly for these additional operating systems, but you may find the installation and setup instructions for [[OS - Linux|Linux]] useful because compiling and custom toolchains are discussed.

Phidgets can run either directly or over a network on these operating systems:

{| style="border:1px solid darkgray;" cellpadding="7px;"
|-style="background: #f0f0f0" align=center
! Operating System || Supported Version || Direct Control || Remote Network Control
|-

|'''Desktop OSes'''
|-

|[[Image:Icon-Windows.png|alt=OS - Windows|24x24px|link=OS - Windows]][[OS - Windows|Windows]]
| Windows 2000 or Newer
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|[[Image:Icon-Mac-OS.png|alt=OS - OS X|24x24px|link=OS - OS X]][[OS - OS X|OS X]]
| OS X 10.4 or newer
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|[[Image:Icon-Linux.png|alt=OS - Linux|24x24px|link=OS - Linuxs]][[OS - Linux|Linux]]
| Kernel 2.6 or newer
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|'''Mobile/Wireless OSes'''
|-

|[[Image:Icon-Linux.png|alt=OS - Phidget SBC|24x24px|link=OS - Phidget SBC]][[OS - Phidget SBC|Phidget SBC (Debian)]]
| All versions
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|[[Image:Icon-Android_Honeycomb.png|alt=OS - Android|24x24px|link=OS - Android]][[OS - Android|Android]]
| 3.1 and newer, with USB port
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|[[Image:Icon-Android.png|alt=OS - Android|link=OS - Android|24x24px|link=OS - Android]][[OS - Android|Android]]
| 1.5 to 3.0
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|[[Image:Icon-iOS.png|alt=OS - iOS|link=OS - iOS|24x24px|link=OS - iOS]][[OS - iOS|IPhone iOS]]
| 3.0 or newer
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|-

|[[Image:Icon-Windows CE.png|alt=OS - Windows CE|24x24px|link=OS - Windows CE]][[OS - Windows CE|Windows CE]]
| 5.0 or newer
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|}

== Language Support ==

We provide a variety of supported languages for using Phidgets. Each language has its own ''libraries'', which may be found on the language pages below, along with code examples and an in-depth API.

Many languages also depend on the ''core drivers'' being installed as well. These drivers can be found on the [[#Operating System Support|operating system pages]] above.

Phidgets supports the following languages. If you have some flexibility in what language to use, we recommend using a '''Core Language''':

{| style="border:1px solid darkgray;" cellpadding="7px;"
|-style="background: #f0f0f0" align=center
! Language || API || Code Samples<sup>&dagger;</sup> || [[General Phidget Programming#Event Driven Code|Events]] || [[General Phidget Programming#Logic Code|Logic Code]] || Use via Direct USB* || [[Phidget Webservice]] || Native Library** || Phidget User Base
|-

|'''Core Languages'''
|-

|[[Image:Icon-CSharp.png|alt=C Sharp|24x24px|link=Language - C Sharp]] [[Language - C Sharp|C#]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-11.png|link=|alt=Extensive]]
|-

|[[Image:Icon-C++.png|alt=C/C++|24x24px|link=Language - C/C++]] [[Language - C/C++|C/C++]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-11.png|link=|alt=Extensive]]
|-

|[[Image:Icon-Java.png|alt=Java|24x24px|link=Language - Java]] [[Language - Java|Java]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-11.png|link=|alt=Extensive]]
|-

|[[Image:Icon-Python.png|alt=Python|24x24px|link=Language - Python]] [[Language - Python|Python]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-11.png|link=|alt=Extensive]]
|-

|[[Image:Icon-Cocoa.png|alt=Cocoa|24x24px|link=Language - Cocoa]] [[Language - Cocoa|Cocoa]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-11.png|link=|alt=Extensive]]
|-

|[[Image:Icon-Visual Basic.png|alt=Visual Basic 6.0|24x24px|link=Language - Visual Basic 6.0]] [[Language - Visual Basic 6.0|Visual Basic 6.0]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-11.png|link=|alt=Extensive]]
|-

|[[Image:Icon-Visual Basic Net.png|alt=Visual Basic .NET|24x24px|link=Language - Visual Basic .NET]] [[Language - Visual Basic .NET|Visual Basic .NET]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-11.png|link=|alt=Extensive]]
|-

|'''Mobile Languages'''
|-

|[[Image:Icon-iOS.png|alt=iOS|24x24px|link=Language - ios]] [[Language - iOS|iOS]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BABA55" align=center| InterfaceKit Only
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|[[Image:Icon-Android.png|alt=Android Java|24x24px|link=Language - Android]] [[Language - Android Java|Android Java]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BABA55" align=center| InterfaceKit Only
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #BF5656" align=center| X
|style="background: #BC8E56" align=center| Some Devices [[Image:Icon-Android_Honeycomb.png|24px|link=Software_Overview#Honeycomb|alt=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|'''Scripting'''
|-

|[[Image:Icon-Applescript.png|alt=Applescript|24x24px|link=Language - Applescript]] [[Language - Applescript|Applescript]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|[[Image:Icon-Autoit.png|alt=AutoIt|24x24px|link=Language - AutoIt]] [[Language - AutoIt|AutoIt]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BF5656" align=center| None
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-Ruby.png|alt=Ruby|24x24px|link=Language - Ruby]] [[Language - Ruby|Ruby]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|'''Science and Math'''
|-

|[[Image:Icon-LabVIEW.png|alt=LabVIEW|24x24px|link=Language - LabVIEW]] [[Language - LabVIEW|LabVIEW]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|[[Image:Icon-Matlab.png|alt=MATLAB|24x24px|link=Language - Matlab]] [[Language - MATLAB|MATLAB]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BC8E56" align=center| Some Devices
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|[[Image:Icon-Simulink.png|alt=Simulink|24x24px|link=Language - Simulink]] [[Language - Simulink|Simulink]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BABA55" align=center| InterfaceKit Only
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|'''Multimedia'''
|-

|[[Image:Icon-Adobe Director.png|alt=Adobe Director|24x24px|link=Language - Adobe Director]] [[Language - Adobe Director|Adobe Director]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| InterfaceKit Only
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-Flash AS3.png|alt=Flash AS3|24x24px|link=Language - Flash AS3]] [[Language - Flash AS3|Flash AS3]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-11.png|link=|alt=Extensive]]
|-

|[[Image:Icon-Flex AS3.png|alt=Flex AS3|24x24px|link=Language - Flex AS3]] [[Language - Flex AS3|Flex AS3]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|[[Image:Icon-LiveCode.png|alt=LiveCode|24x24px|link=Language - LiveCode]] [[Language - LiveCode|LiveCode]]
|style="background: #BABA55" align=center| InterfaceKit Only
|style="background: #BABA55" align=center| InterfaceKit Only
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #BF5656" align=center| X
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-MaxMSP.png|24x24px|alt=Max/MSP|link=Language - Max/MSP]] [[Language - Max/MSP|Max/MSP]]
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| All Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-06.png|link=|alt=Moderate]]
|-

|'''Other Languages'''
|-

|[[Image:Icon-CSharp.png|24x24px|alt=C Sharp (.NET Compact Framework)|link=Language - C Sharp (.NET Compact Framework)]] [[Language - C Sharp (.NET Compact Framework)|C# (.NET Compact)]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BC8E56" align=center| Some Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-REALBasic.png|alt=REALBasic|24x24px|link=Language - REALBasic]] [[Language - REALBasic|REALBasic]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BF5656" align=center| None
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-Visual Basic for Applications.png|alt=Visual Basic for Applications|24x24px|link=Language - Visual Basic for Applications]] [[Language - Visual Basic for Applications|Visual Basic for Apps]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BC8E56" align=center| Some Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-Visual Basic Script.png|alt=Visual Basic Script|24x24px|link=Language - Visual Basic Script]] [[Language - Visual Basic Script|Visual Basic Script]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BC8E56" align=center| Some Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|-

|[[Image:Icon-Delphi.png|alt=Delphi|24x24px|link=Language - Delphi]] [[Language - Delphi|Delphi]]
|style="background: #5EC155" align=center| All Devices
|style="background: #BC8E56" align=center| Some Devices
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Checkmark.png|link=]]
|style="background: #5EC155" align=center| [[Image:Level-01.png|link=|alt=Small]]
|}
<nowiki>*</nowiki> A direct USB connection would be plugging the Phidget into a USB port and using it locally. This is the typical way to use a Phidget. However, some platforms (such as the iPhone platform) do not have USB ports and hence can only use a Phidget over a network, via the [[Phidget Webservice]].

<nowiki>**</nowiki> Native library support means that the calls you make to a Phidget in this language are in the language as well. If the calls are non-native, the use of Phidgets is through an external library linker, such as callib() in MATLAB, for example. The core Phidget library is written in C, and most other languages use this library as their core, but a 'Native' interface cleanly hides this detail.

<sup>&dagger;</sup> Most languages have code samples for all Phidgets, but some have only some devices (visit the language page to learn which ones), and some only have an Interface Kit example. The Phidget Interface Kit is a common Phidget with provides an interface with analog sensors, digital input, and digital output. So, when we choose which examples to write, the Interface Kit is often at the top of our customer's lists.

<span id="Honeycomb">[[Image:Icon-Android_Honeycomb.png|24px|link=]]</span>Android Honeycomb Version 3.1 or Higher Only

==Third Party Support==

{{GentleAlert|'''These products must be purchased directly from these companies and all support calls must be directed to them'''}}

Some third party companies also offer and support software programs that work with Phidgets boards. Phidgets does not have a certification program and does not make any warranty about these products.

In alphabetical order:

{| style="border:1px solid darkgray;" cellpadding="7px;"
|-style="background: #f0f0f0" align=center
! Company
! Product
! Runs On
! Website
! style="width:50%;" | Synopsis
! Product Information
|-

|'''24U'''
|24U Phidgets Plug-in 1.0
|Mac, Windows
|[http://www.24usoftware.com/plugins.php Website]
|24U Phidgets Plug-In lets you connect different kind of phidgets (www.phidgets.com) to your computer's USB port and interact with them directly from FileMaker Pro.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/24U.pdf]]
|-

|'''DSPRobotics'''
|Flowstone
|Windows 2000/XP/Vista/7/Embedded
|[http://www.dsprobotics.com/ Website]
|Graphical Programming Language aimed at real-time Digital Signal Processing.(DSP), Robotics and Embedded applications. FlowStone is a drag and drop environment where you combine high-level and low-level modules to build real time applications.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/FlowStone.pdf]]
|-

|'''MANIPIL'''
|Visual Domotique
|Windows XP/Vista/7
|[http://www.manipil.ch/cms1/vd/tutoriels/setup-and-to-use-a-phidget-module.html Website]
|Visual Domotique is a Graphical I/O programming for Windows XP/Vista/7. Various components allow you to draw electrical schema and control panel. No need to know how to program to use this software. Varied uses are possible: Home automation, security, hobby, Control process education... Available in French.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/Manipil_en.pdf]]
|-

|'''PCRBOX'''
|PCR Automation
|Windows XP/Vista/7 (32 & 64bit)
|[http://www.pcrbox.com/en/ Website]
|PCR Automation is an easy to use software that works immediately without the need for any programming. It interfaces with the 1018, 1070 and 1072. Several interfaces can be opened simultaneously, each in a different window. Each input / output can be customized (label, sensor, offset, units, sensitivity, recording ...). The log files can be automatically sent by E-mail. Users can add their own sensors to the library of thirty Phidgets sensors.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/pcr-automation-en.pdf]]
|-

|'''PiXCL Automation Technologies'''
|PiXCL Advanced Imaging 10.2
|Windows XP/Vista/7
|[http://www.pixcl.com/Using_Phidgets_with_PiXCL.htm Website]
|PiXCL is a powerful and easy-to-learn event driven interpreted language for the fast creation of image acquisition, processing and advanced analysis applications. The suite includes a compiler and development studio with context sensitive help and plenty of sample code. V10.1 provides you with the tools to create applications that combine Phidget devices with digital cameras and scanners.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/PiXCL.pdf]]
|-

|'''SoapBox Automation'''
|SoapBox Snap
|Windows XP/Vista/7
|[http://soapboxautomation.com/products/soapbox-snap/ Website]
|SoapBox Snap is a free and open source PC-based automation platform. It includes a ladder logic editor and a “soft” runtime right out of the box.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/SoapBox.pdf]]
|-

|'''UACh - Universida Austral de Chile'''
|monoBOTICS-icarus
|Linux
|[http://www.monobotics.ic.uach.cl/ Website]
|The monoBOTICS project aims to become an OpenSource Framework, to facilitate the tasks of design, simulation and implementation of solutions for areas of Robotics and Automation, both for people with basic knowledge of programming, as for more advanced developers.
|[[Image:Pdficon_small.gif|link=http://www.phidgets.com/documentation/ThirdPartyInfo/ThirdPartySoftware/monoBOTICS.pdf]]
|-
|}

Main Page

2012-03-28T14:13:20Z

Djrudiak: /* Internal Systems Documentation */

<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%2015&up_mon=3&up_dat=30&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.
*[[VoiP 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'''
#* [[Phidget Development Process]]
#* [[Projects Status]]
#* [[Processes]]
#* [[Standards]]
#* [[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 - Android Java

2012-03-27T21:42:20Z

Djrudiak:

[[Category:Language]]

==Getting Started (Libraries and Drivers)==

==Assessment for use with Phidgets==

On the Android platform, Java is currently the only available language.

==Support==

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]].

==Development Environments and Compilers==

The Phidget examples given below -- as well as the Android SDK examples given by Google -- use Eclipse for a development environment.

To download and configure Eclipse to work with the Android SDK and the Phidget Libraries, please see the [[OS - Android]] page.

==Drivers, Libraries and Resources==

After setting up your [[OS - Android|Android Development computer]] (Windows, Mac, Linux), you will need the following setup files to write code for your Phidget:

* <span style="color:red;">Phidget Libraries</span> for Android
* The [[Phidget Webservice]] should be installed on the remote computer hosting a Phidget for an Android device to control
* <span style="color:red;">Phidget Examples</span> for Android
* <span style="color:red;">The Java API</span> for using Phidgets
* You might also find the [[Language - Java|General Java]] page helpful, as it has more Java examples.

We also recommend that you read the [[Software Overview#General Phidget Programming|General Programming]] guide to get a feel for how to design your code.

When you download and unzip the <span style="color:red;">Phidget Library</span> for Android, it will contain three things:
# A libs/ folder
# 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)

How to use this library is described below.

===Remote Phidget Use===

To install libraries to run a Phidget '''remotely''':
* Add libs/ and phidget21.jar to your project
* 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>

===Direct Phidget Use===

To install libraries to run a Phidget '''directly''' (Android 3.1 and later, with USB port on device):
* Add libs/, phidget21.jar, and PhidgetsUSB.jar to your project
* 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>

===In Eclipse===

In Eclipse, jar files and library files can be added to a project by:
* Project → Properties → Java Build Path → Libraries (tab) → Add JAR
* Project → Properties → Java Build Path → Libraries (tab) → Add Library

==Getting Started==

===Import an Existing Example===

Unpack the <span style="color:red;">Phidget Examples</span> for Android.

Import one of the Existing Eclipse Projects:
* File → Import... → General → Existing Projects Into Workspace → (Next)
* Select root directory → Browse to find and select an existing example such as the InterfaceKitExample

Select all files, click Finish

Right-click on project in Package Explorer (To open this, 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. Otherwise, make sure you have an Android Virtual Device (AVD) set up to run the example on (you can do this by clicking <code>New...</code> on the right side).

===Coding For Your Phidget===

Before you can use the Phidget, you must include a reference in the code 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>

Remember to add your libraries and .jar files to where Java can find them. For Eclipse, this is described above in the Libraries and Drivers section.

===Connecting to the Phidget===

Before writing code of your own, it may help to read about [[General Phidget Programming]] before proceeding.

In your code, you can open and connect to a Phidget using open() or openAny().

Next, the program needs to try and connect to the Phidget through an open call.
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 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.

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

ik.openAny();
ik.waitForAttachment();

</syntaxhighlight></div>

The parameters can 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.
At the end of your program, don’t forget to call close to free any locks on the Phidget.

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

ik.close();
ik = null;

</syntaxhighlight></div>

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets. In Java, we hook
an event handler with the following code:

<div class="source"><source lang=java>

ik.addSensorChangeListener(new SensorChangeListener()
{
public void sensorChanged(SensorChangeEvent se)
{
//Insert your code here
System.out.println(se.getValue());
}
});

</source></div>

With this method, the code inside sensorChanged will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
The items from the event, such as the index or reported value, can be accessed from the SensorChangeEvent object properties.
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. Simply use the instance’s properties or call member functions such as getSensorValue(int index) or setOutputState(int index, boolean newVal) for PhidgetInterfaceKits.
These methods can be used inside a polling loop as an alternative to event driven programming.

===Working With Multiple Phidgets===

===Other Phidgets===

===Compiling a .jar File===

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

==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

Main Page

2012-03-27T14:58:13Z

Djrudiak: /* Internal Systems Documentation */

<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%2015&up_mon=3&up_dat=30&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.
*[[VoiP 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'''
#* [[Phidget Development Process]]
#* [[Projects Status]]
#* [[Processes]]
#* [[Standards]]
#* [[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-03-27T14:57:09Z

Djrudiak: /* Internal Systems Documentation */

<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%2015&up_mon=3&up_dat=30&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.
*[[VoiP 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'''
#* [[Phidget Development Process]]
#* [[Projects Status]]
#* [[Processes]]
#* [[Standards]]
#* [[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-03-22T21:28:20Z

Djrudiak: /* Internal Systems Documentation */

<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%2015&up_mon=3&up_dat=30&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]
*[[InternalTools]] documentation.
*Phidgets Inc. Internal [[Network]] information.
*[[VoiP 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'''
#* [[Phidget Development Process]]
#* [[Projects Status]]
#* [[Processes]]
#* [[Standards]]
#* [[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-03-22T21:28:06Z

Djrudiak: /* Phwiki */

<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%2015&up_mon=3&up_dat=30&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==

*[[InternalTools]] documentation.
*Phidgets Inc. Internal [[Network]] information.
*[[VoiP 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'''
#* [[Phidget Development Process]]
#* [[Projects Status]]
#* [[Processes]]
#* [[Standards]]
#* [[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-03-22T16:52:20Z

Djrudiak: /* Phwiki */

<table>
<tr><td>
__TOC__

==Phwiki==

[[File:trac.png|link=|alt=]] Bug Tracker for [http://sl/trac# Brian] or [http://trac/# Everyone else]
* [[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%2015&up_mon=3&up_dat=30&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==

*[[InternalTools]] documentation.
*Phidgets Inc. Internal [[Network]] information.
*[[VoiP 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'''
#* [[Phidget Development Process]]
#* [[Projects Status]]
#* [[Processes]]
#* [[Standards]]
#* [[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-03-22T16:52:04Z

Djrudiak: /* Phwiki */

<table>
<tr><td>
__TOC__

==Phwiki==

[[File:trac.png|link=|alt\]] Bug Tracker for [http://sl/trac# Brian] or [http://trac/# Everyone else]
* [[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%2015&up_mon=3&up_dat=30&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==

*[[InternalTools]] documentation.
*Phidgets Inc. Internal [[Network]] information.
*[[VoiP 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'''
#* [[Phidget Development Process]]
#* [[Projects Status]]
#* [[Processes]]
#* [[Standards]]
#* [[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-03-22T16:48:53Z

Djrudiak: /* Phwiki */

<table>
<tr><td>
__TOC__

==Phwiki==

* Bug Tracker for [http://sl/trac# Brian] or [http://trac/# Everyone else]
* [[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%2015&up_mon=3&up_dat=30&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==

*[[InternalTools]] documentation.
*Phidgets Inc. Internal [[Network]] information.
*[[VoiP 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'''
#* [[Phidget Development Process]]
#* [[Projects Status]]
#* [[Processes]]
#* [[Standards]]
#* [[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]