Language - Python: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
Line 1: Line 1:
[[Category:Language]]
[[Category:Language]]
[[File:icon-Python.png|64x64px]] Preamble about the language's origin and its main characteristics.
[[File:icon-Python.png|64x64px]] Python is an object oriented programming language developed by the [http://www.python.org/psf/summary/ Python Software Foundation], is powerful and easy to learn.


==Support==
__TOC__
Python has a complete API and sample code for all Phidgets devices.


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


* Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
{{LanguageSupport|Python|the complete Phidget API, including events|all Phidget devices.|Windows, Mac OS X and Linux. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]], [[#Visual Studio 2003 | Visual Studio 2003]], [[#MonoDevelop | MonoDevelop]] and the [[#Mono | Mono command line compilers]]|}}
* In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.


==Development Environments and Compilers==
==Quick Downloads==
 
Just need the Python documentation, drivers, libraries, and examples?  Here they are:
 
API Documentation:
*[http://www.phidgets.com/documentation/PythonDoc.zip API Manual]
 
Example Code:
 
*[http://www.phidgets.com/downloads/examples/Python_2.1.8.20120131.zip Example Code]
 
Libraries and Drivers:
*[http://www.phidgets.com/downloads/libraries/PhidgetsPython_2.1.8.20120131.zip Python Library]
*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20111220.exe 32-bit Windows Drivers Installer]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20111220.exe 64-bit Windows Drivers Installer]
*[http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20111028.tar.gz Linux Source]
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20111103.dmg General Mac OS X Drivers Installer]
 
==Getting started with Python==
 
If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}
 
Instructions are divided up by operating system. Choose:
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#Mac OS X |Mac OS X]]
*[[#Linux | Linux]] (including PhidgetSBC)
 
==Windows(2000/XP/Vista/7)==
 
===Description of Library Files===
Python programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidgets library, which is used at run-time.  By default, it is placed in {{Code|C:\Windows\System32}}.
You will also need one of the following two files, depending on the .NET framework version you are targeting:
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidgets library for .NET framework <i><b>2.0</b></i> or higher. Your compiler has to know where this file is. By default, it is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidgets library for .NET framework <i><b>1.1</b></i>. Your compiler has to know where this file is. By default, is is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
You can optionally install the following files:
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio/MonoDevelop. This documentation is also visible in the Object Browser in Visual Studio. By default, it is placed into {{Code|C:\Program Files\Phidgets}}.
* <b>{{Code|Policy.2.1.Phidget21.NET.dll}}</b> is the policy assembly for {{Code|Phidget21.NET.dll}}. Our installer places this file in the Global Assembly Cache(GAC) directory. It directs any programs compiled against version 2.1.0 or higher of {{Code|Phidget21.NET.dll}} to use the most recent installed version.
 
If you do not want to use our installer, you can download the five [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20111220.zip file files].
 
 
Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.
 
===Visual Studio 2005/2008/2010===
 
Microsoft makes free versions of Visual Studio available known as Express Editions.  The Express editions are suitable for most applications, but are limited in features for more complex applications. Please see [http://www.microsoft.com/visualstudio Microsoft Visual Studio] for more information.
 
=====Use Our Examples=====
 
Please start by downloading the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a foler.  While these examples were written in Visual Studio 2005 and 2008, Visual Studio 2010 will easily open and upgrade them. To load all projects in Visual Studio, go to File &rarr; Open &rarr; Project, and open {{Code|AllExamples/AllExamples.sln}} or {{Code|AllExamples/AllExamples_vs2008.sln}} for Visual Studio 2005 and 2008, respectively.


Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.  
If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.
[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]


==Quick Downloads==
This will load all of the examples available for C#, and then you can set your main project to be the one that matches your device.  If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]].
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.  
 
Visit the drivers section at www.phidgets.com and get the latest:
The only thing left to do is to run the examples! Click on Debug &rarr; Start Debugging. Please note that the projects, by default try to find the {{Code|Phidget21.NET.dll}} in the {{Code|C:\Program Files\Phidgets}}. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to {{Code|Phidget21.NET.dll}}. Please see the [[#Write Your Own Code | Write Your Own Code ]] section for details.
* [http://www.phidgets.com/drivers.php Phidget Framework]
 
* [http://www.phidgets.com/downloads/libraries/PhidgetsPython_2.1.8.20110804.zip Phidgets Python Module]
[[File:CSharp VS2005 Run.PNG|link=|alt=Run‎]]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
 
* [http://www.phidgets.com/documentation/PythonDoc.zip API Manual]
Once you have the C# examples running, we have a [[#Follow The Examples|teaching]] section below to help you follow them.
* [http://www.phidgets.com/documentation/web/PythonDoc/Phidgets.html API Reference]
 
* [http://www.phidgets.com/downloads/examples/Python_2.1.8.20110804.zip Python Sample Code]
=====Write Your Own Code=====
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] page.  
 
* The [[Device Functionality]] page explains the general operational information for your device.  
When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget C# libraries. To begin:


You may want to have these pages open while working through these instructions.
1. Generate a new Visual C# Windows Applications project with a descriptive name such as PhidgetTest.  


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


The Phidget examples were written in Python 3.0 and this tutorial assumes its use. 
2. Add a reference to the .NET Phidgets library.
However, they should still be compatible with Python 2.6. 
To run the examples using Python 2.5, you will need to modify the example code in the exception handling to read “except RuntimeError, e:”, instead of “except RuntimeError as e:”.
Please ensure you have extracted the “Phidgets” directory from the Python Module into your project directory or into the lib\site-packages\ directory in your python install.


===Coding For Your Phidget===
[[File:CSharp VS2005 Add Reference.PNG|link=|alt=Add Reference]]


Before you can use the Phidget, you must include a reference in the code to the library. In Python:
3. Under the .NET tab, select {{Code|Phidget21.NET.dll}}.
If you used our installer, these files are installed in {{Code|C:\Program Files\Phidgets}}, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
[[File:CSharp VS2005 Add Reference 2.PNG|link=|alt=Add Reference]]
<font size="3">
<source lang=python>


  from Phidgets.PhidgetException import *
4. Then, in your code, you will need to include the Phidget library:
  from Phidgets.Events.Events import *
  from Phidgets.Devices.InterfaceKit import *


</source>
<div class="source">
</font>
<syntaxhighlight lang=csharp>
  using Phidgets;
  using Phidgets.Events;
</syntaxhighlight>
</div>
</div>


Afterwards, the Phidget object will need to be declared and then initialized.
For example, we can declare a PhidgetInterfaceKit with:


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
The project now has access to the Phidget21 function calls and you are ready to begin coding.
<font size="3">
 
<source lang=python>
The same [[#Follow The Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.


  try:
===Visual Studio 2003===
    interfaceKit = InterfaceKit()
  except RuntimeError as e:
    print("Runtime Error: %s" % e.message)


</source>
=====Use Our Examples=====
</font>
 
1. Download the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. If you are not sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. As the examples were written in newer versions of Visual Studio, Visual Studio 2003 is not able to open the examples. Fortunately, you can import the simple examples to a Visual Studio 2003 project. It will be difficult to import the full examples as you will need to recreate the GUI components. In the [[#Use Our Examples 2 | Use Our Examples]] section, it will be assumed that the simple examples are used. You will need this example source code to be copied into your C# project later on.
 
2. Next, a new project will need to be created. Generate a new Visual C# console application project with a descriptive name such as PhidgetTest.
 
[[File:CSharp_VS2003 New Project.PNG|link=|alt=New Project]]
 
3. Add a reference to the .NET Phidgets library.
 
[[File:CSharp_VS2003 Add Reference 1.PNG|link=|alt=Add Reference]]
 
4. Under the .NET tab, select {{Code|Phidget21.NET1.1.dll}}. If you used our installer, by default, this file is placed in {{Code|C:\Program Files\Phidgets}}. If it is in another location, please change the path to the file's location accordingly.
 
[[File:CSharp_VS2003 Add Reference 2.PNG|link=|alt=Add Reference]]
 
5. To import the simple example program into your project, please: open up {{Code|Class1.cs}}.
 
6. Traverse to the example in Windows Explorer and locate the {{Code|Program.cs}} file.
 
[[File:CSharp VS2003 Source Code.PNG|link=|alt=Source Code]]
 
7. Copy and paste the contents from that file into {{Code|Class1.cs}}.
 
8. Comment out the following line as it is not supported in .NET 1.1:
<div class="source">
<syntaxhighlight lang=csharp>
  using System.Collections.Generic;
</syntaxhighlight>
</div>
</div>


The initialization of the Phidget as well as calls using the Phidget object should be surrounded by a try catch block to handle any errors thrown by the library.
[[File:CSharp VS2003 Source Code 2.PNG|link=|alt=Source Code]]
Calls to the Phidget object will throw a PhidgetException on an error.


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
9. Then, in your code, you will need to include the Phidget library:
<font size="3">
<div class="source">
<source lang=python>
<syntaxhighlight lang=csharp>
  using Phidgets;
  using Phidgets.Events;
</syntaxhighlight>
</div>


  try:
10. Now, you can run the example. Click on Debug &rarr; Start.
    #Your program Code here
  except PhidgetException as e:
    print (“Phidget Exception %i: %s” % (e.code, e.detail))
    exit(1)


</source>
[[File:CSharp VS2003 Run.PNG|link=|alt=Run]]
</font>
 
Once you have the C# examples running, we have a [[#Follow The Examples|teaching ]] section below to help you follow them.
 
=====Write Your Own Code=====
 
When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget C# libraries. Please see the [[#Use Our Examples 2 | Use Our Examples ]] section for instructions.
 
===Mono===
 
This section will provide instructions on how to compile using the {{Code|mcs}} compiler. Other compilers such as {{Code|gmcs}}, {{Code|smcs}}, and {{Code|dmcs}} all work in the same way. Start by downloading the C# Examples.
 
=====Use Our Examples=====
 
Download the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. Please only use the simple examples. The full examples uses Windows Forms, which Mono and the Gtk# toolkit are not completely compatible with. Locate the {{Code|Program.cs}} file as this contains the example source code. Copy the file into your working directory, and rename it to {{Code|example.cs}}.
<br/>
 
To compile and build an executable, run:
<div class="source">
<syntaxhighlight lang=bash>
mcs /out:example.exe /lib:"C:\Program Files\Phidgets" /r:phidget21.NET.dll example.cs
</syntaxhighlight>
</div>
</div>


The object name for any type of Phidget is listed in the API manual.  
If you have the {{Code|Phidget21.NET.dll}} installed in another location, please change the path to the file's location accordingly.
Every type of Phidget also inherits functionality from the Phidget base class.
 
Afterwards, you will have an executable named {{Code|example.exe}} that you can run. Place the {{Code|Phidget21.NET.dll}} in the same directory as the executable and type the following to run the program:
<div class="source">
<syntaxhighlight lang=bash>
mono example.exe
</syntaxhighlight>
</div>


===Connecting to the Phidget===
Once you have the C# examples running, we have a [[#Follow The Examples|teaching]] section below to help you follow them.


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


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget C# libraries. Please see the [[#Use Our Examples 3 | Use Our Example ]] section for instructions.
<font size="3">
<source lang=python>


  interfaceKit.openPhidget()
In your code, you will need to include the Phidget library:
  interfaceKit.waitForAttach(10000)
  print (“%d attached!” % (interfaceKit.getSerialNum()))


</source>
<div class="source">
</font>
<syntaxhighlight lang=csharp>
  using Phidgets;
  using Phidgets.Events;
</syntaxhighlight>
</div>
</div>


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


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
The project now has access to the Phidget21 function calls and you are ready to begin coding.
<font size="3">
 
<source lang=python>
The same [[#Follow The Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.
 
===MonoDevelop===


  interfaceKit.closePhidget()
=====Use Our Examples=====


</source>
Download the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. These examples were written in Visual Studio 2005 and 2008, but are also compatible with MonoDevelop.
</font>
 
</div>
To load all projects in MonoDevelop, go to File &rarr; Open, and open {{Code|AllExamples/AllExamples.sln}}
 
This will load all of the examples available for C#, and then you can set your main project to be the one that matches your device.  If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. If you are running under the .NET framework, you can use either the full or simple examples. Otherwise, if you are running under the Mono framework, please only use the simple examples. The full examples uses Windows Forms, which is not completely compatible with Mono's Gtk#.
 
[[File:CSharp MonoDevelop Win Start Up.PNG|link=|alt=Start Up Project]]
 
The only thing left to do is to run the examples! Right click the project, and click on {{Code|Run With}} and select the target framework. Please note that the projects, by default try to find the {{Code|Phidget21.NET.dll}} in the {{Code|C\Program Files\Phidgets}}. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to {{Code|Phidget21.NET.dll}}. Please see the [[#Write Your Own Code 4 | Write Your Own Code]] section for details.
 
[[File:CSharp MonoDevelop Win Run As.PNG|link=|alt=Run As]]
 
Once you have the C# examples running, we have a [[#Follow The Examples|teaching]] section below to help you follow them.
 
=====Write Your Own Code=====
 
When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your  development environment to properly link the Phidget C# libraries. To begin:
 
1. Create a new C# empty project with a descriptive name such as PhidgetTest.
 
[[File:CSharp MonoDevelop Win New Project.PNG|link=|alt=New Project]]
 
2. Add a reference to the .NET library.


===Event Driven Programming===
[[File:CSharp MonoDevelop Win Reference.PNG|link=|alt=Add Reference]]


We recommend the use of event driven programming when working with Phidgets.  
3. Select {{Code|Phidget21.NET.dll}}. If you used our installer, by default, this file is placed in {{Code|C:\Program Files\Phidgets}}. If it is in another location, please change the path to the file's location accordingly.  
In Python, we hook an event handler by defining the callback function and then calling a set handler function on it.


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
[[File:CSharp MonoDevelop Win Reference 2.PNG|link=|alt=Add Reference]]
<font size="3">
<source lang=python>


  def interfaceKitSensorChanged(e):
4. Then, in your code, you will need to include the Phidget library:
  print (“Sensor %i: %i” % (e.index, e.value))
  return 0
    interfaceKit.setOnSensorChangeHandler(interfaceKitSensorChanged)


</source>
<div class="source">
</font>
<syntaxhighlight lang=csharp>
  using Phidgets;
  using Phidgets.Events;
</syntaxhighlight>
</div>
</div>


With this, the code inside interfaceKitSensorChanged will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.  
The project now has access to the Phidget21 function calls and you are ready to begin coding.
The values from the report can be accessed from the PhidgetDataEvent object properties.
 
The same [[#Follow The Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.
 
==Mac OS X==
 
Python has excellent support on Mac OS X.  


Certain events such as Attach and Detach belong to the base Phidget object and thus are common to
The first step in using Python on Mac is to install the Phidget libraries.  Compile and install them as explained on the [[Device List|getting started guide for your device]]. Then, the [[OS - Mac OS X]] page also describes the different Phidget files, their installed locations, and their roles....
all types of Phidgets. Please refer to the API manual for a full list of events and their usage.  


===Working directly with the Phidget===
==Linux==


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


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
The first step in using Python on Linux is to install the Phidget libraries.  Compile and install them as explained on the main [[OS - Linux | Linux page]].  That Linux page also describes the different Phidget files, their installed locations, and their roles.
<font size="3">
<source lang=python>


  interfaceKit.setOutputState(0, 1)
==Follow The Examples==


</source>
By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want.  This teaching section has resources for you to learn from the examples and write your own.
</font>
</div>


===Working with multiple Phidgets===
Next, comes our API information.  These resources outline the Python Phidget functions:


Multiple Phidgets of the same type can easily be run inside the same program.  
{{UsingAPhidgetInCodeGeneral|both of which are available in Python|[http://www.phidgets.com/documentation/PythonDoc.zip Python API]}}
In our case, it requires another instance of a PhidgetInterfaceKit to be defined and initialized.  
The new instance can then be set up, opened and used in the same process as the previous one.
If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.


===Other Phidgets===
===Example Flow===


The design given in this document can also be followed for almost all Phidgets.  
{{ExamplePseudocode|In Python, you can name these '''event''' functions whatever you like.  You will then pass them as function pointers to the Phidget library below in the Main Code section.  This hooks them into the actual events when they occur. <br>
For example, if you were using a PhidgetRFID instead of a PhidgetInterfacekit, you would declare an RFID instead of an InterfaceKit.  
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
The functions and events available would change but they can be accessed in a similar manner.
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget.  For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in Python is specific to the Phidget.  For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object.  The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/PythonDoc.zip Python API]}}


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


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

Revision as of 22:47, 6 February 2012

Icon-Python.png Python is an object oriented programming language developed by the Python Software Foundation, is powerful and easy to learn.

Introduction

Template:LanguageSupport

Quick Downloads

Just need the Python documentation, drivers, libraries, and examples? Here they are:

API Documentation:

Example Code:

Libraries and Drivers:

Getting started with Python

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:

  • Make sure your libraries are properly linked
  • Go from source code to a test application as quickly as possible
  • Ensure your Phidget is hooked up properly

Instructions are divided up by operating system. Choose:

Windows(2000/XP/Vista/7)

Description of Library Files

Python programs on Windows depend on the following files, which the installers above put onto your system:

  • phidget21.dll contains the actual Phidgets library, which is used at run-time. By default, it is placed in C:\Windows\System32.

You will also need one of the following two files, depending on the .NET framework version you are targeting:

  • Phidget21.NET.dll is the Phidgets library for .NET framework 2.0 or higher. Your compiler has to know where this file is. By default, it is placed into C:\Program Files\Phidgets. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
  • Phidget21.NET1.1.dll is the Phidgets library for .NET framework 1.1. Your compiler has to know where this file is. By default, is is placed into C:\Program Files\Phidgets. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.

You can optionally install the following files:

  • Phidget21.NET.XML provides the IntelliSense in-line documentation for the .NET library in Visual Studio/MonoDevelop. This documentation is also visible in the Object Browser in Visual Studio. By default, it is placed into C:\Program Files\Phidgets.
  • Policy.2.1.Phidget21.NET.dll is the policy assembly for Phidget21.NET.dll. Our installer places this file in the Global Assembly Cache(GAC) directory. It directs any programs compiled against version 2.1.0 or higher of Phidget21.NET.dll to use the most recent installed version.

If you do not want to use our installer, you can download the five file files.


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

Visual Studio 2005/2008/2010

Microsoft makes free versions of Visual Studio available known as Express Editions. The Express editions are suitable for most applications, but are limited in features for more complex applications. Please see Microsoft Visual Studio for more information.

Use Our Examples

Please start by downloading the examples and unpack them into a foler. While these examples were written in Visual Studio 2005 and 2008, Visual Studio 2010 will easily open and upgrade them. To load all projects in Visual Studio, go to File → Open → Project, and open AllExamples/AllExamples.sln or AllExamples/AllExamples_vs2008.sln for Visual Studio 2005 and 2008, respectively.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project. Conversion Wizard

This will load all of the examples available for C#, and then you can set your main project to be the one that matches your device. If you aren't sure what the software example for your device is called, check the software object listed in the Getting Started guide for your device.

The only thing left to do is to run the examples! Click on Debug → Start Debugging. Please note that the projects, by default try to find the Phidget21.NET.dll in the C:\Program Files\Phidgets. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to Phidget21.NET.dll. Please see the Write Your Own Code section for details.

Run‎

Once you have the C# examples running, we have a teaching section below to help you follow them.

Write Your Own Code

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget C# libraries. To begin:

1. Generate a new Visual C# Windows Applications project with a descriptive name such as PhidgetTest.

New Project

2. Add a reference to the .NET Phidgets library.

Add Reference

3. Under the .NET tab, select Phidget21.NET.dll. If you used our installer, these files are installed in C:\Program Files\Phidgets, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.

Add Reference

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

  using Phidgets;
  using Phidgets.Events;


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

The same teaching section which describes the examples also has further resources for programming your Phidget.

Visual Studio 2003

Use Our Examples

1. Download the examples and unpack them into a folder. Here, you can find example programs for all the devices. If you are not sure what the software example for your device is called, check the software object listed in the Getting Started guide for your device. As the examples were written in newer versions of Visual Studio, Visual Studio 2003 is not able to open the examples. Fortunately, you can import the simple examples to a Visual Studio 2003 project. It will be difficult to import the full examples as you will need to recreate the GUI components. In the Use Our Examples section, it will be assumed that the simple examples are used. You will need this example source code to be copied into your C# project later on.

2. Next, a new project will need to be created. Generate a new Visual C# console application project with a descriptive name such as PhidgetTest.

New Project

3. Add a reference to the .NET Phidgets library.

Add Reference

4. Under the .NET tab, select Phidget21.NET1.1.dll. If you used our installer, by default, this file is placed in C:\Program Files\Phidgets. If it is in another location, please change the path to the file's location accordingly.

Add Reference

5. To import the simple example program into your project, please: open up Class1.cs.

6. Traverse to the example in Windows Explorer and locate the Program.cs file.

Source Code

7. Copy and paste the contents from that file into Class1.cs.

8. Comment out the following line as it is not supported in .NET 1.1: 

  using System.Collections.Generic;

Source Code

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

  using Phidgets;
  using Phidgets.Events;

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

Run

Once you have the C# examples running, we have a teaching section below to help you follow them.

Write Your Own Code

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget C# libraries. Please see the Use Our Examples section for instructions.

Mono

This section will provide instructions on how to compile using the mcs compiler. Other compilers such as gmcs, smcs, and dmcs all work in the same way. Start by downloading the C# Examples.

Use Our Examples

Download the examples and unpack them into a folder. Here, you can find example programs for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the Getting Started guide for your device. Please only use the simple examples. The full examples uses Windows Forms, which Mono and the Gtk# toolkit are not completely compatible with. Locate the Program.cs file as this contains the example source code. Copy the file into your working directory, and rename it to example.cs.

To compile and build an executable, run: 

mcs /out:example.exe /lib:"C:\Program Files\Phidgets" /r:phidget21.NET.dll example.cs

If you have the Phidget21.NET.dll installed in another location, please change the path to the file's location accordingly.

Afterwards, you will have an executable named example.exe that you can run. Place the Phidget21.NET.dll in the same directory as the executable and type the following to run the program: 

mono example.exe

Once you have the C# examples running, we have a teaching section below to help you follow them.

Write Your Own Code

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget C# libraries. Please see the Use Our Example section for instructions.

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

  using Phidgets;
  using Phidgets.Events;


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

The same teaching section which describes the examples also has further resources for programming your Phidget.

MonoDevelop

Use Our Examples

Download the examples and unpack them into a folder. Here, you can find example programs for all the devices. These examples were written in Visual Studio 2005 and 2008, but are also compatible with MonoDevelop.

To load all projects in MonoDevelop, go to File → Open, and open AllExamples/AllExamples.sln

This will load all of the examples available for C#, and then you can set your main project to be the one that matches your device. If you aren't sure what the software example for your device is called, check the software object listed in the Getting Started guide for your device. If you are running under the .NET framework, you can use either the full or simple examples. Otherwise, if you are running under the Mono framework, please only use the simple examples. The full examples uses Windows Forms, which is not completely compatible with Mono's Gtk#.

Start Up Project

The only thing left to do is to run the examples! Right click the project, and click on Run With and select the target framework. Please note that the projects, by default try to find the Phidget21.NET.dll in the C\Program Files\Phidgets. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to Phidget21.NET.dll. Please see the Write Your Own Code section for details.

Run As

Once you have the C# examples running, we have a teaching section below to help you follow them.

Write Your Own Code

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your development environment to properly link the Phidget C# libraries. To begin:

1. Create a new C# empty project with a descriptive name such as PhidgetTest.

New Project

2. Add a reference to the .NET library.

Add Reference

3. Select Phidget21.NET.dll. If you used our installer, by default, this file is placed in C:\Program Files\Phidgets. If it is in another location, please change the path to the file's location accordingly.

Add Reference

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

  using Phidgets;
  using Phidgets.Events;

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

The same teaching section which describes the examples also has further resources for programming your Phidget.

Mac OS X

Python has excellent support on Mac OS X.

The first step in using Python on Mac is to install the Phidget libraries. Compile and install them as explained on the getting started guide for your device. Then, the OS - Mac OS X page also describes the different Phidget files, their installed locations, and their roles....

Linux

Python has support on Linux.

The first step in using Python on Linux is to install the Phidget libraries. Compile and install them as explained on the main Linux page. That Linux page also describes the different Phidget files, their installed locations, and their roles.

Follow The Examples

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the Python Phidget functions:

Template:UsingAPhidgetInCodeGeneral

Example Flow

Template:ExamplePseudocode

Code Snippets

Common Problems and Solutions/Workarounds

Here you can put various frequent problems and our recommended solutions.

Retrieved from "https://www.phidgets.com/docs/index.php?title=Language_-_Python&oldid=14777"