Alert.png

Notice: This page contains information for the legacy Phidget21 Library.

Phidget21 is out of support. Bugfixes may be considered on a case by case basis.

Phidget21 does not support VINT Phidgets, or new USB Phidgets released after 2020. We maintain a selection of legacy devices for sale that are supported in Phidget21.

We recommend that new projects be developed against the Phidget22 Library.


Click on the 2phidget22.jpg button in the menu bar to go to the Phidget22 version of this page.

Alert.png

OS - Windows CE: Difference between revisions

From Phidgets Legacy Support
No edit summary
No edit summary
 
(84 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category:OS]]
[[Category:OS]]
[[Image:Icon-Windows CE.png|alt=OS - Windows CE|24x24px|link=Windows CE]]On Windows CE, Phidgets can be either plugged directly into a USB Port or run over a network using the [[#Webservice | Webservice]].
{{OSLang|[[File:Icon-Windows CE.png‎|64x64px|link=]]|On Windows CE, Phidgets can be either plugged directly into a USB Port or run over a network using the [[#WebService | WebService]].}}
 
__TOC__
__TOC__


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


==Getting Started (Libraries and Drivers)==
==Quick Downloads==


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 this is your first Phidget, we highly recommend working through the Getting Started guide for your specific Phidget device, which may be found in its [[:Category:UserGuide|user guide]].


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


*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20111028.exe 32 Bit]
* [{{SERVER}}/downloads/phidget21/libraries/wince/Phidget21ARMV4I.CAB ARM4VI Installer]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20111028.exe 64 Bit]
* [{{SERVER}}/downloads/phidget21/libraries/wince/Phidget21x86.CAB x86 Installer]
* [{{SERVER}}/downloads/phidget21/libraries/wince/Phidget21MIPSII.CAB MIPSII Installer]


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


For special cases where you want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section.
* [{{SERVER}}/downloads/phidget21/examples/dotnetcompact/CE.zip CE Example Code]
*[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===
In addition to owning a Windows CE system, you will also need a Windows (2000/XP/Vista/7) system for developing and deploying Windows CE applications. (View our page on [[OS - Windows|Phidgets with Windows (2000/XP/Vista/7)]])


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.
For special cases where you want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section. You will also have to download the Windows CE Libraries on your development machine.
*[{{SERVER}}/downloads/phidget21/libraries/wince/Phidget21-wincedevel.zip Phidget21 Windows CE Libraries] (All architectures)
*[{{SERVER}}/downloads/phidget21/libraries/wince/Phidget21CEkernalsource.zip Kernel Driver Source]
*[[Software License]]


To install the libraries, follow these steps:
==Getting Started with Windows CE==


1. Download one of the Phidget installer for your system, depending on whether your system is 32 or 64-bit.
===Installing===
*[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.
To install the libraries on the Windows CE machine, follow these steps:


[[File:Windows Install.PNG|link=|alt=Windows Install]]
1. Download one of the Phidget installer for your system, depending on whether your system is ARM4VI, x86, or MIPSII.
* [{{SERVER}}/downloads/phidget21/libraries/wince/Phidget21ARMV4I.CAB ARM4VI Installer]
* [{{SERVER}}/downloads/phidget21/libraries/wince/Phidget21x86.CAB x86 Installer]
* [{{SERVER}}/downloads/phidget21/libraries/wince/Phidget21MIPSII.CAB MIPSII Installer]


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


3. Once the installation is complete, you are ready to program with Phidgets.
3. Once the installation is complete, you are ready to program with Phidgets.
Line 40: Line 43:
For a description of what was installed onto your system, please see the [[#Description of Library files | Description of Library Files]] section.  
For a description of what was installed onto your system, please see the [[#Description of Library files | Description of Library Files]] section.  


Proceed onto to the [[#Phidget Control Panel | next]] section where the Phidget Control Panel will be discussed.
Proceed onto to the next section where an example program will be run to confirm that the libraries were installed correctly.
 
====Phidget Control Panel====
 
The Phidget Control Panel is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.
 
Once the Phidget libraries are installed using the installer, you should see the [[File:Ph.jpg]] icon in the taskbar. Double click on it to bring up the Phidget Control Panel. If the icon does not appear, just find and open the the Phidget Control Panel from the start menu.
 
[[File:Windows ControlPanel General.PNG|link=|alt=Windows Control Panel General]]
 
The general tab shows the list of Phidgets currently physically attached to the computer. You can also view the currently installed Phidget library version, as well as having the option to choose whether the Phidget Control Panel is to be started up automatically once Windows boots up. You can double click on a Phidget device to open up an example program for the device.
 
[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel Example]]
 
In the above screenshot, the RFID example was opened. These examples are intended for demonstration and debugging purposes. If you have not yet already, please see the '''Getting Started''' guide [[Device List|for your device]]. It is important to keep in mind that when an example Phidget application is opened from the Phidget Control Panel, it holds a lock on the Phidget. This prevents any other program from accessing the Phidget. Please ensure that this example application is closed(the Phidget Control Panel can still be running) when you are running your own applications. 
 
The next tab is the {{Code|WebService}} tab, which allows you to control Phidgets over a network. There are four sub-tabs. The first sub-tab is the {{Code|Setup}} tab.
 
[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]
 
Here, you can start and stop the Webservice. Details are provided in the [[#Webservice | Webservice]] section. You can also determine whether the Phidget Webservice is currently running. There is also a check box that you can select to turn on verbose output, which will display useful troubleshooting information for the Webservice.
 
The next sub-tab is the {{Code|Output}} tab, which provides useful debugging information while you are using the Webservice. This tab will only show up if the verbose output option is selected in the previous tab.
 
[[File:Windows ControlPanel WebService Output.PNG|link=|alt=Windows Control Panel WebService Output]]
 
The {{Code|Dictionary}} sub-tab comes next; it lists all the key-value pairs that gets created when the Webservice runs. More information is provided in the [[General Phidget Programming#Using the Dictionary|Dictionary]] section of the [[General Phidget Programming|General Phidget Programming]] page.
 
[[File:Windows ControlPanel WebService Dictionary.PNG|link=|alt=Windows Control WebService Dictionary]]
 
The {{Code|Bonjour}} sub-tab gives a list of all currently attached Phidgets that are connected to the Webservice. This tab will only appear if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system. You can also double click on the Phidget to connect to it over the network using one or more computers, and still use the Phidget on the computer it is directly connected to.
 
[[File:Windows ControlPanel WebService Bonjour.PNG|link=|alt=Windows Control Panel WebService Bonjour]]
 
The last tab is the {{Code|PhidgetSBC}} tab, which displays the complete list of PhidgetSBCs connected to the network. You can double click on the PhidgetSBC to bring up the PhidgetSBC Adminstration Console. This tab will be enabled if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system.
 
[[File:Windows ControlPanel WebService PhidgetSBC.PNG|link=|alt=Windows Control Panel WebService PhidgetSBC]]


===Checking===
===Checking===


To confirm the libraries were installed and work correctly, you can check both the hardware and software sides of the interface. It is worth checking the software side first, because if it works then you know the hardware side is also okay.
To confirm the libraries were installed and work correctly, you can check if the software component works.
 
====Software====
 
If you have the Phidgets library installed on your system, you can verify that the software side is working by seeing if the Phidget device is listed in the {{Code|General}} tab of the Phidget Control Panel.
 
[[File:Windows_ControlPanel_General.PNG|link=|alt=Windows Control Panel General]]
 
The above screenshot shows that a PhidgetRFID and a PhidgetInterfaceKit are attached to the computer. If the Phidget is plugged into a USB port and you are not able to see that the Phidget is in the list, there may be a hardware issue. Please see the [[#Hardware| hardware]] section for more details.


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


You can verify that your computer detects that the Phidget is plugged in through a USB connection by going to the Windows Device Manager.
If the Phidget is plugged into an USB port and you are not able to see that the Phidget is in the list, there may be a hardware issue.  
On Windows XP, you can access the Device Manager by right clicking on {{Code|My Computer}}, and selecting {{Code|Device Manager}} under the {{Code|Hardware}} tab. The Device Manager window will open. 
 
[[File:WindowsXP DeviceManager.PNG|link=|alt=Windows Device Manager]]
 
Under the {{Code|Human Interface Devices}} heading, you can view whether your computer detects that the Phidget is connected through the USB if it is in the list. There should be a {{Code|HID-compliant device}} and a {{Code|USB Human Interface Device}} entry for every Phidget that is attached to the computer. Please note that there is currently no way of directly determining which entry belongs to which Phidget. A simple way of verifying which entry belongs to which Phidget is to simply connect or disconnect the Phidget from the USB port of the computer. The list will automatically refresh to show the updated list of all connected USB devices.
 
If you don't see the the Phidget in the list, then take a look at the [[#Troubleshooting|troubleshooting]] section below, as well as the '''Communications''' section of our [[General Troubleshooting#Communications Troubleshooting|general troubleshooting page]].


====Troubleshooting====
====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:
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.  
* You are using Windows CE 5.0 or greater.
* The Phidget Control Panel require that you have .NET framework 2.0 or newer.
* You have the correct package installed according to your system's architecture.
* No other programs, drivers, or processes are using that USB port in software
* No other programs, drivers, or processes are using that USB port in software
* The Phidget libraries are the latest version (visit the [[#Getting Started (Libraries and Drivers)| getting started section]] to download them)
* The Phidget libraries are the latest version (visit the [[#Quick Downloads| getting started section]] to download them)
* Some drivers or software will sometimes mistakenly claim Phidget devices when waiting on some hardware to be connected. Please see the section: [[Communication Protocols#Issue: Some third party software prevents communications with Phidgets|third party software prevents communications with Phidgets]] for more information.


* Check the [[#Common Problems and Solutions|common problems]] section below, some specific combinations can cause problems
* 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]]!
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 Us|ask us]]!


==Programming Languages==
==Programming Languages==


After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language.
Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.
 
After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language. You can learn more about what is needed to program in a particular language by choosing the language of your preference below. If you need help choosing a language, please look at the [[Software Overview#Language Support |language comparison table]].  


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


On Windows, we recommend the following languages:
On Windows CE, we recommend the following languages:


*[[Language - C Sharp|C#]]
*[[Language - C Sharp (.NET Compact Framework)|C Sharp (.NET Compact Framework)]]
*[[Language - C/C++|C/C++]]
*[[Language - C/C++|C/C++]]
*[[Language - Flash AS3|Flash AS3]]
*[[Language - Visual Basic (.NET Compact Framework)|Visual Basic (.NET Compact Framework)]]
*[[Language - Java|Java]]
*[[Language - LabVIEW|LabView]]
*[[Language - Max/MSP|Max/MSP]]
*[[Language - Python|Python]]
*[[Language - Ruby|Ruby]]
*[[Language - Visual Basic .NET|Visual Basic .NET]]
*[[Language - Visual Basic 6.0|Visual Basic 6.0]]
 
You can also use these languages, but they do not support [[General Phidget Programming#Event Driven Code | event driven code]], and must use [[General Phidget Programming#Logic Code | logic code]] only:
 
*[[Language - MATLAB|MATLAB]]
*[[Language - Simulink|Simulink]]
 
The following languages are also supported, but to to a lack of demand, they full API is not implemented. Please refer to the specific language for more information on what features are unsupported.
*[[Language - Delphi|Delphi]]
*[[Language - Visual Basic for Applications|Visual Basic for Applications]]
*[[Language - Visual Basic Script|Visual Basic Script]]
*[[Language - LiveCode|LiveCode]]
*[[Language - Adobe Director|Adobe Director]]
*[[Language - AutoIt|AutoIt]]
 
==Webservice==
 
The Phidget Webservice allows you to remotely control a Phidget over a network.


Drivers for the Phidget Webservice on Windows are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. If you have a [[File:Ph.jpg]] icon in your taskbar, you already have the Webservice drivers installed.
==WebService==


You can connect to a Phidget hosted on another computer if you know the IP address of the host computer. Phidgets optionally supports the use of mDNS, which allows Phidgets to be found and opened on the network by a server id instead of an IP address and port. When using a server id, both the client and server will need to be running an implementation of zero configuration networking. The Phidget Webservice takes advantage [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] software. It is a tool, developed by Apple to locate devices such as Phidgets, and printers. It allows you to connect to a Phidget over the Webservice while specifying the server id. Alternatively, an IP address and port can be supplied to connect to a Phidget over the Webservice. If you do not have Bonjour installed on your system, you will have to use the second method to connect to a Phidget.  
The Phidget WebService allows you to remotely control a Phidget over a network.


This section helps you install, check, and use the Webservice on Windows, but we also have an overview of the [[Phidget Webservice]] in general.
Drivers for the Phidget WebService on Windows CE are already included in the [[#Quick Downloads | Drivers]] above. The WebService is started with the {{Code|PhidgetWebservice21.exe}} application.  


===Turning the Webservice On and Off===
You can connect to a Phidget hosted on another computer if you know the IP address/host name of the host computer.


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


[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup]]
===Turning the WebService On and Off===


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


You can get command line help with {{Code|PhidgetWebservice21.exe}} using the -h option:
You can get command line help with {{Code|PhidgetWebservice21.exe}} using the -h option:
Line 185: Line 114:
</div>
</div>


To find the defaults used by {{Code|phidget21webservice}}, the command line is the fastest way to learn the default server name and IP address of your computer:
Please note that as Windows CE does not support the use of mDNS, the -n option cannot be used.
*For the default server name, type {{Code|hostname}} in the command line.
 
*For your IP address, type {{Code|ipconfig -all}} in the command line.
To find the defaults used by {{Code|phidget21webservice}}, the command line is the fastest way to learn the IP address of your computer:
**A line in the return text, will say something like {{Code|192.168.2.198}}, which is your IP.
*For your IP address, type {{Code|ipconfig}} in the command line.
**A line in the return text, will say something like {{Code|IP Address ........ 192.168.2.198}}, which is your IP.


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


To start the Webservice with default parameters:
To start the WebService with default parameters:
<div class="source">
<div class="source">
<syntaxhighlight lang=bash>
<syntaxhighlight lang=bash>
Line 199: Line 129:
</div>
</div>


To start the Webservice with a server name of {{Code|myServer}}:
To start the WebService on port 5002:
<div class="source">
<div class="source">
<syntaxhighlight lang=bash>
<syntaxhighlight lang=bash>
  PhidgetWebservice21.exe -n myServer
  PhidgetWebservice21.exe -p 5002
</syntaxhighlight>
</syntaxhighlight>
</div>
</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.
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===
===Using the WebService===


To use a Phidget over the Webservice, you'll want to:
To use a Phidget over the WebService, you'll want to:
* Have two different computers connected to the same network. We will call the computer that has the Phidget directly connected to the USB port the host. The client will be the computer that runs a Phidget application to connect to the Phidget attached to the host. Please note that If you only have a single computer, you can also connect to the Phidget over the Webservice. The computer will simply act as both a host and client.


* Start the Webservice on the computer that directly connects to the Phidget
* 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
* 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:
The easiest way to test these steps on Windows CE is simply to start the WebService and run the Phidget program on the same computer.  Later, you can replace one of the two ends with a different computer and/or operating system.


1. On the host, open up the Phidget Control Panel and traverse to the {{Code|Setup}} tab of the {{Code|WebService}} section.
To quickly create code to run remotely, we will need to modify the example code. We will go over how to modify the C#(.NET Compact Framework) in Visual Studio. Please go ahead and download the [{{SERVER}}/downloads/phidget21/examples/dotnetcompact/CE.zip example code]. Extract it, and open up the {{Code|\CE\HelloWorld\HelloWorld.sln}} in Visual Studio.  


[[File:Windows ControlPanel WebService Setup Stopped.PNG|link=|alt=Windows Control Panel WebService Setup Stopped]]
Find the line in our {{Code|HelloWorld}} example that says:


2. Leave all fields the way it is, and click on {{Code|Start}} to run the Webservice.
<div class="source">
<syntaxhighlight lang=bash>
manager.open();
</syntaxhighlight>
</div>


3. You can determine that the Webservice is running by looking at the WebService status at the bottom of the window.
and change it to be:


[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]
<div class="source">
<syntaxhighlight lang=bash>
manager.open("127.0.0.1", 5001);
</syntaxhighlight>
</div>


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


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


[[File:Windows ControlPanel WebService Bonjour Running.PNG|link=|alt=Windows Control Panel WebService Bonjour]]
1. Start a command line window to run this test. First, traverse to the {{Code|\Program Files\Phidgets}} directory and start the WebService.


6. The example application will open up, and you will be able to interact with the Phidget over the Webservice.
This will broadcast any Phidget events, and receive any Phidget requests, both over the network.


[[File:Windows ControlPanel Example.PNG|link=|alt=Windows Control Panel Example]]
2. Transfer the newly created executable onto the Windows CE system. Double click on the application to run it.  


7. You can confirm that the Webservice was indeed behind this exchange by killing the Webservice process while still allowing the remote program to run. On the host's Phidget Control Panel, traverse to the {{Code|Setup}} tab of the {{Code|Webservice}} section. Hit {{Code|Stop}} to terminate the Webservice.  
3. Now, plug in the Phidget to the Windows CE system!  The {{Code|Phidget21webservice}} program captures the {{Code|Attach}} event and other events and sends them out over the network and the example application will receive them.


[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup Running]]
4. You can confirm that the WebService was indeed behind this exchange by killing the WebService process while still allowing the remote program to run. Simply, in the command line window, press {{Code|Ctrl}} and {{Code|c}} at the same time.


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.  
Note that since Windows CE does not have mDNS and cannot be detected using the Windows Control Panel or the OS X Preference Pane.


[[File:Windows ControlPanel WebService Example Disconnected.PNG|link=|alt=Windows Control Panel WebService Example while Webservice Stopped]]
===Debugging the WebService===


===Debugging the Webservice===
In addition to enabling [[General Phidget Programming#Logging|logging]] in your Phidget code, you can get additional debugging information from the WebService itself.  This additional debugging can be enabled by specifying the {{Code|-v}} option:
 
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">
<div class="source">
Line 270: Line 197:
===Manual File Installation===
===Manual File Installation===


The Phidget installer installs the most commonly used files onto your system. However, there may be special cases where you want to install the Phidget libraries without the installers. This section will describe the purpose of each individual file and cover how to manually install and distribute the libraries with your code.
The Phidget installer installs the most commonly used files onto your system. However, there may be special cases where you want to install the Phidget libraries without the installers. Please take a look at the [[#Description of Installer files | Description of Installer files]] sections to see which files you will need to install yourself.  


====Description of Library files====
Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|\WINDOWS}} directory. Additional files are needed for the language that you choose. Please refer to the documentation provided by your [[Software Overview#Language Support|language]] to determine what files are needed and the steps needed to install them 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}}.
You can find the {{Code|phidget21.dll}} in the link below:
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#PhidgetWebservice | PhidgetWebservce]].
* <b>{{Code|PhidgetWindowsService21.exe}}</b> is a Windows service that controls {{Code|PhidgetWebService21.exe}}.
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll.  Your compiler has to know where this file is, by default our installer puts {{Code|phidget21.lib}} into {{Code|C:\Program Files\Phidgets}}, so you can either point your compiler to that location, or copy and link to it in a directory for your project workspace. {{Code|phidget21.lib}} is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler for details. Please note that we provide versions of the {{Code|phidget21.lib}} that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets}}; The 32 bit version of {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets\x86}}.
* <b>{{Code|phidget21.h}}</b> lists all the Phidget API function calls available to your code.  Your compiler also has to know where this file is.  By default, our installer puts {{Code|phidget21.h}} into {{Code|C:\Program Files\Phidgets}} so you can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
* <b>{{Code|phidget21.jar}}</b> is an archive containing the Phidgets library, used by the [[Language -  Java | Java]] programming language.
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidgets library for .NET framework 2.0 or greater. Any .NET language can be used, including [[Language - C Sharp | C#]]  , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidgets library for .NET framework 1.1. Any .NET language can be used, including [[Language - C Sharp | C#]]  , and [[Language - Visual Basic .NET | Visual Basic .NET]].
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio.
* <b>{{Code|Phidget21COM.dll}}</b> is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. This libraries is used by the [[Language - Adobe Director|AdobeDirector]], [[Language - AutoIt|AutoIT]], [[Language - Delphi|Delphi]], [[Language -  Visual Basic 6.0|Visual Basic 6.0]], [[Language - Visual Basic for Applications|Visual Basic for Applications]], [[Language - Visual Basic Script|Visual Basic Script]].
* <b>{{Code|Phidget21Manager.exe}}</b> is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.
* <b>{{Code|Examples}} folder</b> contain example applications that allows you to quickly see if your Phidget is properly configured.
* <b>{{Code|x86 folder}} folder</b> contain the 32 bit versions of {{Code|phidget21.dll}}, {{Code|phidget21.lib}}, {{Code|Phidget21COM.dll}}. These folder will only appear on 64 bit installations and is useful if you want to code against the 32 bit libraries.
 
====Special Cases of Library Install====
 
Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|C:\WINDOWS\system32}} directory. Additional files are needed for the language that you choose. Please refer to the documentation provided by your [[Device List|language]] to determine what files are needed and the steps needed to install them onto your system.


You can find the {{Code|phidget21.dll}} in the link below:
*[{{SERVER}}/downloads/phidget21/libraries/windows/Phidget21-windevel.zip Phidget21 Libraries] (32-Bit and 64-Bit development files without an installer)


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


PhidgetWebService21.exe is also provided in the link above.
===Deploying the Program===


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


Phidgets can also be used inside a virtual machine. Instructions for VMWare and VirtualBox are provided. Virtual PC is not supported as USB Phidgets requires a virtual platform that supports HID USB Devices. Since Virtual PC does not support HID USB devices, Phidgets may not be used.
If you receive a {{Code|Can't find PInvoke DLL}} error on deployment, check to make sure that the Phidget Framework {{Code|.dlls}} are installed to the device (normally in the Windows folder). Running the {{Code|CAB}} installer is the easiest way to ensure the files are installed and registered correctly.


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


<b>VMWare:</b>
===Deploying the Program on an Emulator===


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


<b>VirtualBox</b>
===Compiling Your Own OS Build===


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


==Common Problems and Solutions==
==Common Problems and Solutions==


===Issue: A corrupt installation fails on uninstall or repair===
===Issue: The Phidget Windows CE libraries need to be installed everytime the system restarts===
Affected Operating Systems: '''Windows'''
This is discussed in the [[#Compiling Your Own OS Build | Compiling Your Own OS Build]] section.
 
Solution: If the normal uninstall fails, or for whatever reason, you can choose to remove the Phidgets framework manually.
Please perform the following:
# Shut down any programs using the Phidget libraries, including the webservice and the Phidget Control Panel.
# Delete C:\Program Files\Phidgets\
# Remove the Phidgets key from the Registry [-HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services PhidgetWebservice21].
 
In most cases this is enough to get the installer working again. If you need to remove all traces of
the Phidgets libraries manually, perform the following additional steps:
 
# Unregister the COM library: regsvr32 /u “C:\Program Files\Phidgets\Phidget21COM.dll”
# Remove Phidget21.NET and Policy.2.1.Phidget21.NET from C:\Windows\Assembly\
# Delete ‘C:\Documents and Settings\All Users\Application Data\Phidgets’ (WindowsXP) or ‘C:\Users\All Users\Phidgets’ (Vista).
# Delete C:\Windows\system32\phidget21.dll
# Delete Phidgets from the start menu
# Search for and remove keys mentioning Phidgets from the registry in the following locations:
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\]
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Products\]
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders\Phidgets Inc]
:* [HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run\Phidget21Manager]  
:* [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Assemblies\Global\]
 
:9. Reboot
 
'''NOTE:''' You can go through the registry and purge any other keys mentioning Phidgets if you still
have problems, but at this point you should be able to reinstall under most cases. There will also be
keys relating to the installer, the .NET library and the COM library, but they should not interfere with
anything.
 
===Issue: Event data is sporadic/slow/clumped over the webservice===
Affected Operating Systems: '''Windows'''


Windows implements 200ms delayed ACKs for network traffic. When traffic is one-way only - as it is with event data, the data will all arrive in clumps every 200ms because of delayed ACKs.  
===Issue: The Phidget is not attaching to my Program===
If the Phidgets are already plugged into the USB port of the Windows CE device, the Phidgets will need to be re-attached to the device once the Phidget libraries are installed. The reason for this is that when the Phidget drivers are not present on the system, the devices will associate with a generic USB HID driver. Installing the Phidget drivers will then allow them to be associated with the proper driver, but it does not disconnect them from the HID driver.  Unplugging and reconnecting the device will cause the OS to look for the appropriate drivers again and it will now be able to find the Phidget drivers.


This can be a great drawback for application which rely on low latency event data over the network. (source: http://support.microsoft.com/kb/214397)
==Appendix==


This delayed ACK behavior can be disabled in windows to decrease event latency as documented here: http://support.microsoft.com/kb/328890
===Description of Installer files===


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.
Here is the list of files and their description for each file that is distributed through the iOS drivers.
{{CreativeCommons}}
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time.  It is placed in {{Code|\Windows}}.
* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebService]].
* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll.  Your compiler has to know where this file is.
* <b>{{Code|phidget21.h}}</b> lists all the Phidget API function calls available to your code.  Your compiler also has to know where this file is.
* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver. It is placed in {{Code|\Windows}}.
* <b>{{Code|Phidget21CE.NET.dll}}</b> is the .NET(Compact Framework) Phidgets library. It is placed in {{Code|\Windows}}.

Latest revision as of 16:43, 7 June 2017

Icon-Windows CE.png On Windows CE, Phidgets can be either plugged directly into a USB Port or run over a network using the WebService.

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

Quick Downloads

If this is your first Phidget, we highly recommend working through the Getting Started guide for your specific Phidget device, which may be found in its user guide.

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

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

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

For special cases where you want to install the Phidget libraries without the installer, please see the Advanced Uses section. You will also have to download the Windows CE Libraries on your development machine.

Getting Started with Windows CE

Installing

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

1. Download one of the Phidget installer for your system, depending on whether your system is ARM4VI, x86, or MIPSII.

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

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

For a description of what was installed onto your system, please see the Description of Library Files section.

Proceed onto to the next section where an example program will be run to confirm that the libraries were installed correctly.

Checking

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

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

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

Troubleshooting

If the examples do not work but USB does work (i.e. your computer can consistently see the device in the hardware), take a moment to check the basics:

  • You are using Windows CE 5.0 or greater.
  • You have the correct package installed according to your system's architecture.
  • No other programs, drivers, or processes are using that USB port in software
  • The Phidget libraries are the latest version (visit the getting started section to download them)
  • Check the 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 guide). If you are still having problems after using the troubleshooting guide, please 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 language comparison table.

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

On Windows CE, we recommend the following languages:

WebService

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

Drivers for the Phidget WebService on Windows CE are already included in the Drivers above. The WebService is started with the PhidgetWebservice21.exe application.

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

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

Turning the WebService On and Off

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

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

 PhidgetWebservice21 -h
'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

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

To find the defaults used by phidget21webservice, the command line is the fastest way to learn the IP address of your computer:

  • For your IP address, type ipconfig in the command line.
    • A line in the return text, will say something like IP Address ........ 192.168.2.198, which is your IP.

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

To start the WebService with default parameters:

 PhidgetWebservice21.exe

To start the WebService on port 5002:

 PhidgetWebservice21.exe -p 5002

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

Using the WebService

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

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

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

To quickly create code to run remotely, we will need to modify the example code. We will go over how to modify the C#(.NET Compact Framework) in Visual Studio. Please go ahead and download the example code. Extract it, and open up the \CE\HelloWorld\HelloWorld.sln in Visual Studio.

Find the line in our HelloWorld example that says:

 manager.open();

and change it to be:

 manager.open("127.0.0.1", 5001);

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

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

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

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

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

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

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

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

Debugging the WebService

In addition to enabling logging in your Phidget code, you can get additional debugging information from the WebService itself. This additional debugging can be enabled by specifying the -v option:

 PhidgetWebservice21.exe -v -n "myServer"

The debugging information is shown command line output.

Advanced Uses

Manual File Installation

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

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

You can find the phidget21.dll in the link below:

PhidgetWebService21.exe is also provided in the link above.

Deploying the Program

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

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

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

Deploying the Program on an Emulator

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

Compiling Your Own OS Build

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

Common Problems and Solutions

Issue: The Phidget Windows CE libraries need to be installed everytime the system restarts

This is discussed in the Compiling Your Own OS Build section.

Issue: The Phidget is not attaching to my Program

If the Phidgets are already plugged into the USB port of the Windows CE device, the Phidgets will need to be re-attached to the device once the Phidget libraries are installed. The reason for this is that when the Phidget drivers are not present on the system, the devices will associate with a generic USB HID driver. Installing the Phidget drivers will then allow them to be associated with the proper driver, but it does not disconnect them from the HID driver. Unplugging and reconnecting the device will cause the OS to look for the appropriate drivers again and it will now be able to find the Phidget drivers.

Appendix

Description of Installer files

Here is the list of files and their description for each file that is distributed through the iOS drivers.

  • phidget21.dll contains the actual Phidget library, which is used at run-time. It is placed in \Windows.
  • PhidgetWebService21.exe is used to control Phidgets remotely across a network using the PhidgetWebService.
  • phidget21.lib is used by your compiler to link to the dll. Your compiler has to know where this file is.
  • phidget21.h lists all the Phidget API function calls available to your code. Your compiler also has to know where this file is.
  • phidget.dll is the Phidgets kernel driver. It is placed in \Windows.
  • Phidget21CE.NET.dll is the .NET(Compact Framework) Phidgets library. It is placed in \Windows.