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.
|
OS - Windows CE: Difference between revisions
No edit summary |
|||
Line 1: | Line 1: | ||
[[Category:OS]] | [[Category:OS]] | ||
[[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 [[# | [[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]]. | ||
Line 10: | Line 10: | ||
==Getting Started (Libraries and Drivers)== | ==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 | 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: | If you are already a pro, and just want the drivers: | ||
Line 74: | Line 74: | ||
*[[Language - C/C++|C/C++]] | *[[Language - C/C++|C/C++]] | ||
== | ==WebService== | ||
The Phidget | The Phidget WebService allows you to remotely control a Phidget over a network. | ||
Drivers for the Phidget | Drivers for the Phidget WebService on Windows are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. If you have a [[File:Ph.jpg]] icon in your taskbar, you already have the WebService drivers installed. | ||
You can connect to a Phidget hosted on another computer if you know the IP address of the host computer. Phidgets optionally supports the use of mDNS, which allows Phidgets to be found and opened on the network by a server id instead of an IP address and port. When using a server id, both the client and server will need to be running an implementation of zero configuration networking. The Phidget | You can connect to a Phidget hosted on another computer if you know the IP address of the host computer. Phidgets optionally supports the use of mDNS, which allows Phidgets to be found and opened on the network by a server id instead of an IP address and port. When using a server id, both the client and server will need to be running an implementation of zero configuration networking. The Phidget WebService takes advantage [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] software. It is a tool, developed by Apple to locate devices such as Phidgets, and printers. It allows you to connect to a Phidget over the WebService while specifying the server id. Alternatively, an IP address and port can be supplied to connect to a Phidget over the WebService. If you do not have Bonjour installed on your system, you will have to use the second method to connect to a Phidget. | ||
This section helps you install, check, and use the | 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 | ===Turning the WebService On and Off=== | ||
The | 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\PhidgetWebservice21.exe}}. | ||
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 116: | Line 116: | ||
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 example usage. The Windows command line is used. Traverse to the Phidget installation directory(By default, it is located in {{Code|C:\Program Files\Phidgets}}). | ||
To start the | To start the WebService with default parameters: | ||
<div class="source"> | <div class="source"> | ||
<syntaxhighlight lang=bash> | <syntaxhighlight lang=bash> | ||
Line 123: | Line 123: | ||
</div> | </div> | ||
To start the | To start the WebService with a server name of {{Code|myServer}}: | ||
<div class="source"> | <div class="source"> | ||
<syntaxhighlight lang=bash> | <syntaxhighlight lang=bash> | ||
Line 130: | Line 130: | ||
</div> | </div> | ||
To stop the | 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 | ===Using the WebService=== | ||
To use a Phidget over the | 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 | * 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 | * 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 | ||
===Debugging the | ===Debugging the WebService=== | ||
In addition to enabling [[General Phidget Programming#Logging|logging]] in your Phidget code, you can get additional debugging information from the | In addition to enabling [[General Phidget Programming#Logging|logging]] in your Phidget code, you can get additional debugging information from the WebService itself. This additional debugging can be enabled by specifying the {{Code|-v}} option: | ||
<div class="source"> | <div class="source"> | ||
Line 161: | Line 161: | ||
* <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|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 [[# | * <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|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.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}}. | ||
Line 190: | Line 190: | ||
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. | If you receive a {{Code|Can't find PInvoke DLL}} error on deployment, check to make sure that the Phidget Framework {{Code|.dlls}} are installed to the device (normally in the Windows folder). Running the {{Code|CAB}} installer is the easiest way to ensure the files are installed and registered correctly. | ||
You can use the Phidget | You can use the Phidget WebService to connect to remote Phidgets if USB ports are not available. Note that Windows CE does not support mDNS and by extension some {{Code|open()}} calls. In .NET, use {{Code|open(serial,"IPAddress", port, "pass")}}. | ||
===Deploying the Program on an Emulator=== | ===Deploying the Program on an Emulator=== | ||
Your success for running Phidgets on an emulator may vary based on the type of the device being emulated, and whether it supports USB devices or the installation of the Phidget Framework. Here, if you receive a {{Code|Can't find PInvoke DLL}} error during execution, this means the emulator image does not have the Phidget Framework installed. One approach installing it | Your success for running Phidgets on an emulator may vary based on the type of the device being emulated, and whether it supports USB devices or the installation of the Phidget Framework. Here, if you receive a {{Code|Can't find PInvoke DLL}} error during execution, this means the emulator image does not have the Phidget Framework installed. One approach installing it | ||
on an emulator is to set up a shared folder (File → Configure... → General → Shared folder) with the ARMV4I or x86 Framework inside, then browse to its location and run the installer. Also, if you’re running the Phidget | 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=== | ===Compiling Your Own OS Build=== |
Revision as of 18:49, 13 April 2012
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.
Getting Started (Libraries and Drivers)
If this is your first Phidget, we highly recommend working through the Getting Started guide for your specific Phidget device. If you already have the 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:
For special cases where you want to install the Phidget libraries without the installer, please see the Advanced Uses section.
- Phidget21 WinCE Libraries (All architectures)
- Kernel Driver Source
- Software License
Installing
To install the libraries, 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 ran to confirm that the libraries were installed correctly.
Checking
To confirm the libraries were installed and work correctly, you can check if the software side works.
If you have the Phidgets library installed on your system, you can verify that the software side 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.
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.
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 systems'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
After you have installed the drivers above, you should pick a programming language, install libraries, and run the examples for that specific language.
Phidgets’ philosophy is that you do not have to be an electrical engineer in order to do projects that use devices like sensors, motors, motor controllers, and interface boards. All you need to know is how to program.
On Windows, we recommend the following languages:
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 Drivers above. If you have a icon in your taskbar, you already have the WebService drivers installed.
You can connect to a Phidget hosted on another computer if you know the IP address of the host computer. Phidgets optionally supports the use of mDNS, which allows Phidgets to be found and opened on the network by a server id instead of an IP address and port. When using a server id, both the client and server will need to be running an implementation of zero configuration networking. The Phidget WebService takes advantage Bonjour software. It is a tool, developed by Apple to locate devices such as Phidgets, and printers. It allows you to connect to a Phidget over the WebService while specifying the server id. Alternatively, an IP address and port can be supplied to connect to a Phidget over the WebService. If you do not have Bonjour installed on your system, you will have to use the second method to connect to a Phidget.
This section helps you install, check, and use the WebService on Windows, but we also have an overview of the Phidget WebService in general.
Turning the WebService On and Off
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\PhidgetWebservice21.exe
.
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
To find the defaults used by phidget21webservice
, the command line is the fastest way to learn the default server name and IP address of your computer:
- For the default server name, type
hostname
in the command line. - For your IP address, type
ipconfig -all
in the command line.- A line in the return text, will say something like
192.168.2.198
, which is your IP.
- A line in the return text, will say something like
Here are some example usage. The Windows command line is used. Traverse to the Phidget installation directory(By default, it is located in C:\Program Files\Phidgets
).
To start the WebService with default parameters:
PhidgetWebservice21.exe
To start the WebService with a server name of myServer
:
PhidgetWebservice21.exe -n myServer
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:
- Have two different computers connected to the same network. We will call the computer that has the Phidget directly connected to the USB port the host. The client will be the computer that runs a Phidget application to connect to the Phidget attached to the host. Please note that If you only have a single computer, you can also connect to the Phidget over the WebService. The computer will simply act as both a host and client.
- Start the WebService on the computer that directly connects to the Phidget
- Run your program on the remote computer that will control the Phidget over the network
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. This section will describe the purpose of each individual file and cover how to manually install and distribute the libraries with your code.
Description of Library files
phidget21.dll
contains the actual Phidget library, which is used at run-time. It is also placed inC:\Windows\System32
.PhidgetWebService21.exe
is used to control Phidgets remotely across a network using the PhidgetWebservce.PhidgetWindowsService21.exe
is a Windows service that controlsPhidgetWebService21.exe
.phidget21.lib
is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer putsphidget21.lib
intoC:\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.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 thephidget21.lib
that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, thephidget21.lib
is placed inC:\Program Files\Phidgets
; The 32 bit version ofphidget21.lib
is placed inC:\Program Files\Phidgets\x86
.phidget21.h
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 putsphidget21.h
intoC:\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.phidget21.jar
is an archive containing the Phidgets library, used by the Java programming language.Phidget21.NET.dll
is the Phidgets library for .NET framework 2.0 or greater. Any .NET language can be used, including C# , and Visual Basic .NET.Phidget21.NET1.1.dll
is the Phidgets library for .NET framework 1.1. Any .NET language can be used, including C# , and Visual Basic .NET.Phidget21.NET.XML
provides the IntelliSense in-line documentation for the .NET library in Visual Studio.Phidget21COM.dll
is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. This libraries is used by the AdobeDirector, AutoIT, Delphi, Visual Basic 6.0, Visual Basic for Applications, Visual Basic Script.Phidget21Manager.exe
is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.Examples
folder contain example applications that allows you to quickly see if your Phidget is properly configured.x86 folder
folder contain the 32 bit versions ofphidget21.dll
,phidget21.lib
,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 phidget21.dll
placed in the C:\WINDOWS\system32
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:
- Phidget21 Libraries (32-Bit and 64-Bit development files without an installer)
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 [#Getting Started (Libraries and Drivers) | beginning] of this page
Common Problems and Solutions
Issue: The Phidget Windows CE libraries need to be installed everytime the system restarts
This is discussed in the Compiling Your Own OS Build section.