Mphi:

Language - Ruby

2012-04-19T19:05:50Z

Mphi: /* Use Our Examples */

Language - Ruby

2012-04-19T18:46:36Z

Mphi: /* Visual Studio 2005/2008/2010 */

Language - Flex AS3

2012-04-19T18:11:34Z

Mphi:

[[Category:Language]]
Flex AS3 is no longer maintained by Phidgets. Preamble about the language and its general strengths and weaknesses.

==Assessment for use with Phidgets==
Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.

==Support==
Flex AS3 has a complete API and code samples for all Phidgets devices.

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

==Restrictions==
In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

==Development Environments and Compilers==

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

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

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

==Getting Started==

The Phidget examples were written using Actionscript 3.0 under Adobe Flex Builder 3 and this tutorial assumes its use.
Other development environments should work provided they support Actionscript 3.0, and each would be set up in a similar manner.
First launch Flex and generate a new project with a descriptive name such as PhidgetTest.
You will then need to add the Phidget Library to your project library path.
This can be done under Project | Properties | Flex Build Path on the Library tab, by clicking the “Add SWC” button and selecting the Phidget21Library.swc from the Flex examples.
As an alternative, you can copy the “com” folder that is located in the Flash AS3 examples into your project source directory and it should work as well.

===Coding For Your Phidget===

Before you can use the Phidget, you must import references from the library to the device in the main body of code. In MXML and Actionscript 3.0:

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

<?xml version="1.0" encoding="utf-8"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" layout="absolute">
<mx:Script>
<![CDATA[
import com.phidgets.PhidgetInterfaceKit;
import com.phidgets.events.*;
//More code goes here
]]>
</mx:Script>
</mx:Application>

</syntaxhighlight></div>

Afterwards, the Phidget object will need to be declared and then initialized.
For example, a start function is set to execute on initialization, and then an instance of a PhidgetInterfaceKit is declared and then set inside with:

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

public var phid:com.phidgets.PhidgetInterfaceKit;
public function start():void{
phid = new PhidgetInterfaceKit();
//More code goes here
}

</syntaxhighlight></div>

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

===Connecting to the Phidget===

Next, the program needs to try and connect to the Phidget through an open call.
Open will continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that simply calling open does not guarantee you can use the Phidget immediately.
We can handle this by using event driven programming and tracking the AttachEvents and DetachEvents, or checking the isAttached property.

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

phid.open("localhost", 5001);

</syntaxhighlight></div>

The API manual lists all of the available modes that open provides.
In Flash, the parameters can be used to open the first Phidget of a type it can find or based on its serial number.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This means other programs that open the Phidget may end up preventing other instances from retrieving data.
The one connection per device limit does not apply when exclusively using the Phidget WebService, and the Actionscript libraries by extension.

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
In Actionscript 3.0, we hook an event handler with the following code:

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

phid.addEventListener(PhidgetDataEvent.SENSOR_CHANGE, onSensorChange);

</syntaxhighlight></div>

The onSensorChange method will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
The values from the report can be accessed from the PhidgetDataEvent object.

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

private function onSensorChange(evt:PhidgetDataEvent):void{
//Insert your code here
}

</syntaxhighlight></div>

Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
Please refer to the API manual for a full list of events and their usage.

===Working directly with the Phidget===

Some values can be directly read and set on the Phidget and used as an alternative to event driven programming.
Simply use the instance properties or call member functions such as getSensorValue(index: int) or setOutputState(index: int, val: Boolean) for PhidgetInterfaceKits.

===Working with multiple Phidgets===

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

===Flash Security Settings===

During debugging or after publishing the project, you may encounter some difficulties with Flash network security settings either inside or outside of the development environment with Phidgets.
Permissions for your project folder can be added through the settings manager at [http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04a.html here], under “Always trust files in these locations” | “Edit locations...” | “Add location...”.

===Other Phidgets===

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

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

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

Language - REALBasic

2012-04-19T18:11:07Z

Mphi:

[[Category:Language]]
[[File:icon-REALBasic.png|64x64px]] REALBasic is no longer maintained by Phidgets. Preamble about the language's origin and its main characteristics.

==Support==
REALBasic has a complete API for all Phidgets devices, but no sample code at this time.

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

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

==Development Environments and Compilers==

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

==Quick Downloads==
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip API Manual]
* [http://www.phidgets.com/documentation/web/cdoc/index.html API Reference]
* We currently do not have any sample code for REALBasic.
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] page.
* The [[Device Functionality]] page explains the general operational information for your device.

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

==Getting Started==

Applications using Phidget can be developed in REALbasic through the C API.
This tutorial assumes the use of REALbasic 2009, other recent versions should work as well and would be set up in a similar manner.
Phidgets will not run under REALbasic 2006. Although it’s possible to import Phidgets as ActiveX controls, this is not recommended due to the way REALbasic handles them.
To begin, launch REALbasic and create a new “Desktop Application”.
Then, place an EditField “EditField1” in the form designer for the purpose of capturing some simple output.

===Coding For Your Phidget===

Before you can use the Phidget, you must declare each of the functions from the C library that the program will use.
For example, you can declare at initialization (inside Windows1.Open) some C functions for a PhidgetInterfaceKit with the following syntax:

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

Declare Function CPhidget_open lib "phidget21" (phid as Ptr, serialNumber as Integer) as integer
Declare Function CPhidget_waitForAttachment lib "phidget21" (phid as Ptr, milliseconds asInteger) as Integer
Declare Function CPhidgetInterfaceKit_create lib "phidget21" (CPhidgetInterfaceKitHandle as Ptr) as Integer
Declare Function CPhidgetInterfaceKit_set_OnSensorChange_Handler lib "phidget21"(CPhidgetInterfaceKitHandle as Ptr, fptr as Ptr, UserPtr as Ptr) as Integer

</syntaxhighlight></div>

The declaration closely follows the C API with a few minor changes.
Generally, when any type of PhidgetHandle is used, it’s safe to change the type to Ptr.
You will also need to copy the phidget21.dll file from the Phidget Framework directory into your project output directory for these declarations to work.

Afterwards, the Phidget object itself will need to be declared and then initialized.
This can be done by declaring a property on Windows1 named “ifKitHandle” as a Ptr, calling create on an empty block of memory, and then setting the handle to the result.

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

Dim tmp As MemoryBlock
Dim result As Integer
tmp = NewMemoryBlock(1000)
Call CPhidgetInterfaceKit_create(tmp)
ifKitHandle = tmp.Ptr(0)

</syntaxhighlight></div>

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

===Connecting to the Phidget===

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

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

result = CPhidget_open(ifKitHandle, -1)
if CPhidget_waitForAttachment(ifKitHandle, 3000)<>0 Then
MsgBox("Can’t find a PhidgetInterfaceKit")
else
'More code goes here
end if

</syntaxhighlight></div>

The different parameters and open calls can be used to open the first Phidget of a type it can find, open based on a serial number, or even open across the network.
The API manual lists all of the available modes that open provides.
One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
This prevents any other instances from retrieving data from the Phidget, including other programs.
The one connection per device limit does not apply when exclusively using the Phidget Webservice.

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
In Real Basic, a few steps will need to be followed to properly hook C events.
Event handler methods with matching definitions must be created inside their own module (Project | Add | Module).

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

Function ifKit_OnSensorChange(ByVal phid As Ptr, ByVal userPtr As Ptr, ByVal index
As Integer, ByVal sensorValue As Integer) As Integer
#pragma X86CallingConvention StdCall
Window1.EditField1.text = Str(index) + ":" + Str(sensorValue)
End Function

</syntaxhighlight></div>

In this example, a new module “Module1” was created and given the ifKit_OnSensorChange method.
Note that the handler must have “#pragma X86CallingConvention StdCall” as the first line.
Inside Window1.Open we can then link to the method we wrote with a call to CPhidgetInterfaceKit_set_OnSensorChange_Handler.

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

Call CPhidgetInterfaceKit_set_OnSensorChange_Handler(ifKitHandle, AddressOf Module1.ifKit_OnsensorChange, nil)

</syntaxhighlight></div>

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

===Working directly with the Phidget===

Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming.
Simply declare the C function before using calls such as CPhidgetInterfaceKit_getSensorValue for PhidgetInterfaceKits.

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

Declare Function CPhidgetInterfaceKit_getSensorValue lib "phidget21" (phid as Ptr, index as Integer, sensorValue as Ptr) as Integerresult = CPhidgetInterfaceKit_getSensorValue(ifKitHandle, 0, tmp)
Dim sensorValue As Integer = tmp.Long(0)
Window1.EditField1.Text = Str(sensorValue)

</syntaxhighlight></div>

===Working with multiple Phidgets===

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

===Other Phidgets===

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

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

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

Language - C

2012-04-19T17:52:54Z

Mphi: /* Description of Library Files */

[[Category:Language]]
[[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.

OS - Windows

2012-04-19T17:46:25Z

Mphi: /* Hardware */

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

OS - Windows

2012-04-19T17:45:29Z

Mphi: /* Hardware */

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

File:Windows7 DeviceManager.PNG

2012-04-19T17:45:14Z

Mphi:

Language - C

2012-04-19T17:35:28Z

Mphi: /* Write Your Own Code */

[[Category:Language]]
[[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]].
* <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.

File:WinCE VS C NewProject 4.PNG

2012-04-19T17:29:26Z

Mphi:

File:WinCE VS C NewProject 3.PNG

2012-04-19T17:29:20Z

Mphi:

File:WinCE VS C NewProject 1.PNG

2012-04-19T17:29:12Z

Mphi: