OS - Windows: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
(39 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<metadesc>Communicate over USB with sensors, controllers and relays with Phidgets! Program in Windows using a wide variety of programming languages.</metadesc>
[[Category:OS]]
[[Category:OS]]
__TOC__
{|
 
|style="vertical-align:middle; width: 60%;"|
==Quick Downloads==
 
Already know what you're doing? Here you go:
 
*[{{SERVER}}/downloads/phidget22/libraries/windows/Phidget22-x86.exe 32 Bit Installer Download]
*[{{SERVER}}/downloads/phidget22/libraries/windows/Phidget22-x64.exe 64 Bit Installer Download]
 
Don't want the installer? After downloading the files, be sure to check out the [[#Advanced Information | Advanced Information]] section below.
*[{{SERVER}}/downloads/libraries/Phidget22-windevel.zip Phidget22 Libraries] (32-Bit and 64-Bit development files without an installer)
*[[Software License]]
 
==Getting Started with Windows==
==Getting Started with Windows==
Welcome to using Phidgets with Windows. If you haven't already, check out the [[:Category:UserGuide|user guide]] for your device. If you are ready to go, the first step in creating Windows applications with Phidgets is installing the Phidget libraries!
Welcome to using Phidgets with Windows!  


===Installing===
If you are ready to go, the first step in creating Windows applications with Phidgets is installing our libraries.
|{{TOC limit|2}}
|}
===Install===
To install our libraries, download the installer for your system:
*[{{SERVER}}/downloads/phidget22/libraries/windows/Phidget22-x86.exe 32-bit Installer Download]
*[{{SERVER}}/downloads/phidget22/libraries/windows/Phidget22-x64.exe 64-bit Installer Download]


To install the libraries, follow these steps:
Before installing our libraries, be sure to read our [[Software License]].


When prompted, continue with the installation:
[[image:Windows_Install.png|link=|center]]


1. Download the Phidget installer for your system


*[{{SERVER}}/downloads/libraries/Phidget-x86.exe Windows 32-bit installer download]
The libraries are now installed on your machine. Next, let's verify that they are working properly.
*[{{SERVER}}/downloads/libraries/Phidget-x64.exe Windows 64-bit installer download]


 
''For instructions on installing our libraries without an installer, check out the [[OS - Windows Advanced Information]] page.''
2. Continue with the installation
 
[[image:Windows_Install.png|link=|center]]
 
 
Success! You have finished installing the Phidgets software on your machine. Before you begin coding, let's verify that your Phidget is able to communicate with your machine.


===Verify===
===Verify===
The best way to verify that your libraries are installed and your Phidget is working is to use the Phidget Control Panel. The Phidget Control Panel is a powerful tool that will help you develop your applications using Phidgets. Get started by following the instructions below:
The best way to verify that your libraries are working properly is to use the Phidget Control Panel. The control panel is a powerful tool that will help you develop your Phidgets applications. Get started by following the instructions below:




1. Find the  [[File:Ph.jpg]]  icon in the taskbar. If it is not there, open up the start menu and search for ''Phidget Control Panel''
Find the  [[File:Ph.jpg|link=]]  icon in the taskbar. If it is not there, open up the start menu and search for ''Phidget Control Panel''
 
[[File:Windows PhidgetTaskbar.PNG|link=|center]]
[[File:Windows PhidgetTaskbar.PNG|link=|center]]




2. Double click on the Phidgets icon to bring up the Phidget Control Panel. You can now see all the Phidgets that are plugged into your machine, as well as any Phidgets that are on the network.
Next, double-click on the Phidgets icon to bring up the Phidget Control Panel. You can now see all the Phidgets that are plugged into your machine, as well as any Phidgets that are on the network:
 
[[File:Windows ControlPanel General.PNG|link=|alt=Windows Control Panel General|center]]
[[File:Windows ControlPanel General.PNG|link=|alt=Windows Control Panel General|center]]




3. Click on the + beside a device to expand it so that you can see all available channels. Double click on one of these channels to open up a window that lets you interact with it.  
Click on the '''+''' beside a device to expand it so that you can see all available channels. Double-click on one of these channels to open up a window that lets you interact with it.:
 
[[File:Windows ControlPanelChannel.PNG|link=|alt=Windows Control Panel General|center]]
[[File:Windows ControlPanelChannel.PNG|link=|alt=Windows Control Panel General|center]]




The Phidget Control Panel can be used for testing devices, updating firmware, enabling a network server, and more! Visit the [[Phidget Control Panel#Windows|Phidget Control Panel]] page if you want to delve a little deeper.
The Phidget Control Panel can be used for testing devices, updating firmware, enabling a Phidget Network Server, and more! Visit the [[Phidget Control Panel|Phidget Control Panel page]] for more information.
 
Your Phidget is now able to communicate with your development machine. The next step is selected a programming language so you can start to write some code!


''If you do not see your device in the Phidget Control Panel, visit the [[General Troubleshooting|general troubleshooting page]].''


===Programming===
Your Phidget is now able to communicate with your development machine. The next step is selecting a programming language so you can start to write some code!
Ready to write some code? Select on of the programming languages below:


''Great choices for beginners:''
==Programming==
*[[Language - C Sharp|C#]]
Ready to write some code? Select one of the programming languages below:
*[[Language - C/C++|C/C++]]
*[[Language - Java|Java]]
*[[Language - Python|Python]]


''Also supported:''
{{Programming_Languages_Table}}
*[[Language - JavaScript|JavaScript]]
*[[Language - Visual Basic .NET|Visual Basic .NET]]
*[[Language - LabVIEW|LabView]]
*[[Language - Max/MSP|Max/MSP]]


==Phidget Network Server==
==Phidget Network Server==
The Phidget Network Server is an extremely useful tool that allows you to remotely control Phidgets over your network. If you haven't already, check out the [[Phidget Network Server]] page for a complete overview.


The Phidget Network Server allows you to remotely control Phidgets over a network. For more information, please see the [[Phidget Network Server]]  page.
===Try it Out!===
 
In order to try the Phidget Network Server out, first download and install [https://www.apple.com/support/downloads/bonjourforwindows.html Bonjour for Windows] on your host computer and your client computer.
Drivers for the Phidget Network Server on Windows are already included in the [[#Quick Downloads | Drivers]] above. If you have a [[File:Ph.jpg]] icon in your taskbar, you already have the Network Server installed.
*'''Host computer:''' the computer that is physically connected to the Phidgets via USB and is running the Phidget Network Server.
 
*'''Client computer:''' a computer running a Phidgets application that accesses Phidgets connected to the host computer.
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 Network Server takes advantage of the [https://support.apple.com/kb/DL999?locale=en_US 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.
If you only have one computer, don't worry, your machine can act as both a host and a client.  
 
This section helps you install, check, and use the Network Server on Windows, but we also have an overview of the [[Phidget Network Server]] in general.
 
===Using the Network Server===
 
To use a Phidget over the  Network Server, 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 Network Server. 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 Network Server 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 Network Server and run the Phidget program on the client. Please follow these steps:


1. On the host computer, double click on the [[File:Ph.jpg|link=]] icon in the system tray to bring up the Control Panel window. In the {{Code|Network Server}} tab, you can start, restart or stop the Network Server. You can also choose to have the Network Server 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 Network Server on everytime you wish to use it. You'll need administrator privileges in order to make changes to these settings. You can see the status of the Network Server at the bottom of the window, where it will say "Network Server: Running" or "Network Server: Stopped".


[[File:Windows_ControlPanel_NetworkService_Setup_Stopped.jpg|link=|left|alt=Windows Control Panel Network Server Setup]]
Next, open the Phidget Control Panel on your host computer. Do this by double-clicking on the [[File:Ph.jpg|link=]] icon in your taskbar, or by searching for ''Phidget Control Panel'' in the start menu.
Navigate to the Network Server tab, you will see something like this:
[[File:windows_networkserver.PNG|link=|center]]


[[File:Windows_ControlPanel_NetworkService_Running.jpg|link=|alt=Windows Control Panel Network Server Setup]]


2. Ensure that the Phidget is plugged in to the host.  
From here, you can start, stop, or restart the Network Server. You can also decide how and when the Network Server will start.
[[File:windows_networkserver_startuptype.png|link=|center]]


3. On the client computer, open up the Phidget Control Panel. On the {{Code|Phidgets}} tab you will see the Phidget that is plugged into the host as one of the entries listed under the heading of {{Code|Remote Server: <Hostname>}}. Double click on one of the Phidget's objects to open the example application. If the Remote server is not listed, click on File->Options and make sure {{Code|List Remote Phidgets}} is checked.


[[File:Windows_ControlPanel_NetworkService_List.PNG|link=|center|alt=Windows Control Panel Network Server]]
Select ''Automatic'' as the startup type from the list and press the start button. By enabling automatic startup, the Network Server will run immediately after Windows boots, so you won't have to manually start it again.


4. The example application will open up, and you will be able to communicate with the Phidget over the Network Server.


[[File:RFIDReadWrite_Example.jpg|link=|center|alt=Windows Control Panel Example]]
Now that you have the Network Server running on your host computer, the next step will be accessing the Phidgets connected to your host computer from your client computer. Follow the steps below:


5. You can confirm that this Phidget is truly being used of the Network Server by stopping the Network Server while the example application is still open. On the host's Phidget Control Panel, go to the {{Code|Network Server}} tab and hit {{Code|Stop}} to terminate the Network Server. Now, take a look at the example application on the client. Since the application can no longer find this Phidget over the Network Server, all of the information disappears and the window says that "Nothing" is attached to this channel.


[[File:Windows_ControlPanel_NetworkService_Disconnected.PNG|link=|center|alt=Windows Control Panel Network Server Stopped]]
Open the Phidget Control Panel on your client computer. You will see something like this:
[[File:Windows_controlpanel_remote.PNG |link=|center]]


===Debugging the Network Service===


In addition to enabling [[General Phidget Programming#Logging|logging]] in your Phidget code, you can get additional debugging information from the Network Service itself.  This additional debugging can be found in the log file, if logging has been enabled. To enable logging, go to File -> Options and check the box next to {{Code|Enable Logging}}. From the {{Code|Level}} drop-down, you can select how detailed you want the output to be. {{Code|Critical}} is the most basic setting, which will only log messages that are deemed to be very important. {{Code|Verbose}}, on the other hand, will log ''everything'', although it may be harder to find the messages that are important to you among all of the rest of the messages.
As you can see from the image above, Phidget servers are listed under the following heading:
*Remote Server: Servername (link local address)


[[File:Windows_ControlPanel_NetworkService_LogLevel.PNG|link=|alt=Windows Control Panel Network Service Setup|center]]


You can find the log files at {{Code|C:\ProgramData\Phidgets\Logs}}, or you can click on {{Code|Logs}} in the bottom right corner of the Control Panel window:  
You now have access to the Phidgets that are connected to your host computer. Try double-clicking one of them to bring up an example:
[[File:Windows_controlpanel_remoteexample.PNG|link=|center]]


[[File:Windows_ControlPanel_General.PNG|link=|alt=Windows Control Panel General|center]]


There is a separate log file for each of the examples, to make it easier to find messages that are relevant to the Phidget you're debugging. There are are also separate log files for different aspects of the Network Service.
Note the label in the example indicating a remote connection. This means the example is using the Phidget Network Server in order to communicate with the device.


[[File:Windows_ControlPanel_NetworkService_Log.PNG|link=|alt=Windows Control Panel Network Service Output Running|center]]
===What's Next?===
Now that you have seen the Phidget Network Server in action, you may be interested in implementing an application that takes advantage of all it's features. Luckily, every programming language we support comes with example code on how to do this! Jump to [[#Programming|programming languages]] above.


Each message in the log file will list the type of the message, the time and date, the place in the libraries the message came from, and a description. This can be very useful for figuring out why certain parts of one of the examples or the Network Service are not working properly.
For more information about the Network Server tab on the Phidget Control Panel, visit the Visit the [[Phidget Control Panel|Phidget Control Panel]] page.


==Advanced Information==
==Advanced Information==


===Manual File Installation===
For information on advanced Windows topics, such as installing our libraries without an installer, installing our libraries without an internet connection, or using Windows in a Virtual Machine, check our page on [[OS - Windows Advanced Information|Windows Advanced Information]]
 
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 automatic installer. This section will describe the purpose of the most important files file and cover how to manually install the libraries. You can get the files [{{SERVER}}/downloads/libraries/Phidget22-windevel.zip here]. Once you've moved every file and folder in that .zip into the locations in the table in the next section, your manual installation will be complete.
 
====Description of Library files====
 
Here is the list of files and their description for each file the installer puts onto your system. You don't need to know this if you're just using our installer, but if you are looking to distribute our libraries with your code (without your clients having to use our installer) this list will help you pick and choose what you need. Please note that not all of these files are available in the package linked above.
 
{| class="wikitable"
| align="center" colspan="2" style="color:white; background:black;"| Location: '''C:\Program Files\Phidgets\Phidget22'''
|-
| align="center" style="background:#f0f0f0;"|'''File'''
| align="center" style="background:#f0f0f0;"|'''Description'''
|-
| phidget22.dll||contains the actual Phidget library, which is used at run-time.
|-
| phidget22.lib||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|phidget22.lib}} into {{Code|C:\Program Files\Phidgets\Phidget22}}, so you can either point your compiler to that location, or copy and link to it in a directory for your project workspace. {{Code|phidget22.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.
|-
| x86 Folder|| contains the versions of {{Code|phidget22.lib}} and {{Code|phidget22.dll}} that are optimized for 32-bit systems. This folder will only appear on 64 bit installations and is useful if you want to code against the 32-bit libraries.
|-
| NetworkServer.exe||is used to control Phidgets remotely across a network using the [[Phidget Network Server]]
|-
| phidget22.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 puts {{Code|phidget22.h}} into {{Code|C:\Program Files\Phidgets\Phidget22}} so you can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
|-
| phidget22.jar||is an archive containing the Phidgets library, used by the [[Language -  Java | Java]] programming language.
|-
| Phidget22.NET.dll||is the Phidgets library for the .NET framework used by .NET languages such as [[Language - C Sharp | C#]] and [[Language - Visual Basic .NET | Visual Basic .NET]].
|-
| Phidget22.NET.XML||provides the IntelliSense in-line documentation for the .NET library in Visual Studio.
|-
| Phidget22java.dll||is the library for Phidgets in Java.
|-
| Phidget22Manager.exe||is the [[Phidget Control Panel]], a tool to quickly determine whether your system is able to control Phidgets, and also acts as a debugging tool.
|-
| align="center" colspan="2" style="color:white; background:black;"| Location: '''C:\Windows\System32'''
|-
| phidget22.dll||contains the actual Phidget library, which is used at run-time.
|-
| Phidget22java.dll||is the library for Phidgets in Java.
|-
| align="center" colspan="2" style="color:white; background:black;"| Location: '''C:\Windows\SysWOW64'''
|-
| phidget22.dll||contains the actual Phidget library, which is used at run-time.
|-
|}
 
===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 [[#Quick Downloads | 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 (for example, the [{{SERVER}}/products.php?product_id=1019 1019 Interface Kit with 6-port hub]), are undetectable; Fortunately, Phidgets that are attached to such Phidgets are detectable.
 
Note that Windows XP "mode" in Windows 7 does '''not''' support Phidgets.
 
===Installing Without an Internet Connection===
When running the Phidgets installer it will check for other applications such as .NET.  Part of this requires an active internet connection.  The downside to this is that even if you have the applications installed already, if you do not have an internet connection you cannot complete the installation process.  There is a way around this however which involves extracting the Phidget22 .msi file out of the .exe installer.  To do this follow these steps:
 
*Run the installer.
 
[[image:Windows_Install.png|link=|center]]
 
*Once the installer has started up and you are at the first informational window, navigate to your
{{Code|Local Disk\Users\"username"\AppData\Local\Temp}} folder.
*Look for the most recently modified folders. The Phidgets one will not have an obvious title, most likely a seemingly random string of numbers and characters. 
 
[[image:Windows_Installer_Folder.jpg|link=|center]]
 
*In this example the folder was named "IXP000.tmp" but it may be different for you. In the folder you will find the {{Code|Phidget22_x64.msi}} or {{Code|Phidget22_x86.msi}} file. This file can be run to install the Phidgets libraries without needing an internet connection.

Revision as of 18:44, 31 October 2018

Getting Started with Windows

Welcome to using Phidgets with Windows!

If you are ready to go, the first step in creating Windows applications with Phidgets is installing our libraries.

Install

To install our libraries, download the installer for your system:

Before installing our libraries, be sure to read our Software License.

When prompted, continue with the installation:

Windows Install.png


The libraries are now installed on your machine. Next, let's verify that they are working properly.

For instructions on installing our libraries without an installer, check out the OS - Windows Advanced Information page.

Verify

The best way to verify that your libraries are working properly is to use the Phidget Control Panel. The control panel is a powerful tool that will help you develop your Phidgets applications. Get started by following the instructions below:


Find the Ph.jpg icon in the taskbar. If it is not there, open up the start menu and search for Phidget Control Panel

Windows PhidgetTaskbar.PNG


Next, double-click on the Phidgets icon to bring up the Phidget Control Panel. You can now see all the Phidgets that are plugged into your machine, as well as any Phidgets that are on the network:

Windows Control Panel General


Click on the + beside a device to expand it so that you can see all available channels. Double-click on one of these channels to open up a window that lets you interact with it.:

Windows Control Panel General


The Phidget Control Panel can be used for testing devices, updating firmware, enabling a Phidget Network Server, and more! Visit the Phidget Control Panel page for more information.


Your Phidget is now able to communicate with your development machine. The next step is selecting a programming language so you can start to write some code!

Programming

Ready to write some code? Select one of the programming languages below:

Core Languages Mobile Languages Other Languages
C Sharp C# Objective C Objective C LabVIEW LabVIEW
C/C++ C/C++ Swift Swift Max/MSP Max/MSP
Python Python Android Android Java
Java Java
Visual Basic .NET Visual Basic .NET
JavaScript JavaScript

Phidget Network Server

The Phidget Network Server is an extremely useful tool that allows you to remotely control Phidgets over your network. If you haven't already, check out the Phidget Network Server page for a complete overview.

Try it Out!

In order to try the Phidget Network Server out, first download and install Bonjour for Windows on your host computer and your client computer.

  • Host computer: the computer that is physically connected to the Phidgets via USB and is running the Phidget Network Server.
  • Client computer: a computer running a Phidgets application that accesses Phidgets connected to the host computer.

If you only have one computer, don't worry, your machine can act as both a host and a client.


Next, open the Phidget Control Panel on your host computer. Do this by double-clicking on the Ph.jpg icon in your taskbar, or by searching for Phidget Control Panel in the start menu. Navigate to the Network Server tab, you will see something like this:

Windows networkserver.PNG


From here, you can start, stop, or restart the Network Server. You can also decide how and when the Network Server will start.

Windows networkserver startuptype.png


Select Automatic as the startup type from the list and press the start button. By enabling automatic startup, the Network Server will run immediately after Windows boots, so you won't have to manually start it again.


Now that you have the Network Server running on your host computer, the next step will be accessing the Phidgets connected to your host computer from your client computer. Follow the steps below:


Open the Phidget Control Panel on your client computer. You will see something like this:

Windows controlpanel remote.PNG


As you can see from the image above, Phidget servers are listed under the following heading:

  • Remote Server: Servername (link local address)


You now have access to the Phidgets that are connected to your host computer. Try double-clicking one of them to bring up an example:

Windows controlpanel remoteexample.PNG


Note the label in the example indicating a remote connection. This means the example is using the Phidget Network Server in order to communicate with the device.

What's Next?

Now that you have seen the Phidget Network Server in action, you may be interested in implementing an application that takes advantage of all it's features. Luckily, every programming language we support comes with example code on how to do this! Jump to programming languages above.

For more information about the Network Server tab on the Phidget Control Panel, visit the Visit the Phidget Control Panel page.

Advanced Information

For information on advanced Windows topics, such as installing our libraries without an installer, installing our libraries without an internet connection, or using Windows in a Virtual Machine, check our page on Windows Advanced Information