|
|
(115 intermediate revisions by 9 users not shown) |
Line 1: |
Line 1: |
| | <metadesc>Communicate over USB with sensors, controllers and relays with Phidgets! Our C# library supports Windows/MacOS/Linux using Visual Studio or Mono.</metadesc> |
| [[Category:Language]] | | [[Category:Language]] |
| [[File:icon-CSharp.png|64x64px||link=|alt=]]C# is a modern, object-oriented programming language developed by [[http://www.microsoft.com Microsoft]].
| | __NOTOC__ |
| | We provide support for the C# language in all major operating systems. We also provide instructions on how to get your project started in a number of common development environments. Select your operating system and preferred development environment below, and follow the instructions to get your project running with Phidgets. |
|
| |
|
| __TOC__
| | If you do not know which development environment you want to use, or your development environment of choice is not listed, we recommend starting with Mono as the simplest path to getting your code running. Visual Studio is the most popular way to build C# projects, but it also has a steep learning curve. |
|
| |
|
| ==Introduction==
| | Once you have set up your development environment to run with Phidgets, we recommend you follow our guide on [[Phidget Programming Basics]]. The guide will showcase the fundamentals of programming with Phidgets, with examples in C#. |
|
| |
|
| {{LanguageSupport|C#|the complete Phidget API, including events|all Phidget devices.|the .NET or Mono framework. Both of the frameworks are supported on Windows. For Linux and OS X, only the Mono framework can be used. 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]]|}} | | == Setup Guide == |
| | <div class="phd-deck-sequence"> |
| | {{PT3_CSHARP_CHOOSE}}{{PT3_CSHARP_WIN_VS}}{{PT3_CSHARP_WIN_VS_1}}{{PT3_CSHARP_WIN_VS_2}} |
| | {{PT3_CSHARP_WIN_MONO}}{{PT3_CSHARP_MAC_MONO}}{{PT3_CSHARP_LNX_MONO}}{{PT3_CSHARP_LNX_DOTNET}}{{PT3_CSHARP_MAC_DOTNET}}{{PT3_CSHARP_WIN_MONODEV}} |
|
| |
|
| ==Quick Downloads==
| |
| {{QuickDownloads|C#|
| |
| {{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip .NET}}|
| |
| {{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip|}}|
| |
| {{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip|.NET Framework Files|}}
| |
| {{WindowsQuickDownloads}}
| |
| {{MacQuickDownloads}}
| |
| {{LinuxQuickDownloads}}
| |
| }}
| |
|
| |
| ==Getting started with C#==
| |
|
| |
| If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
| |
| {{ExampleCodeReasons}}
| |
|
| |
| Instructions are divided up by operating system. Choose:
| |
| *[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
| |
| *[[#OS X |OS X]]
| |
| *[[#Linux | Linux]] (including PhidgetSBC)
| |
|
| |
| ==Windows(2000/XP/Vista/7)==
| |
|
| |
| ===Description of Library Files===
| |
| C# programs on Windows depend on the following files, which the installers above put onto your system:
| |
| * <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time. By default, it is placed in {{Code|C:\Windows\System32}}.
| |
| 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 Phidget 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 Phidget 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 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 folder. 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 {{Code|AllExamples/AllExamples.sln}} or {{Code|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.
| |
| [[File:VS2005 Conversion Wizard.PNG|link=|alt=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 [[Device List | 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 {{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.
| |
|
| |
| [[File:CSharp VS2005 Run.PNG|link=|alt=Run?]]
| |
|
| |
| 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 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.
| |
|
| |
| [[File:CSharp VS2005 New Project.PNG|link=|alt=New Project]]
| |
|
| |
| 2. Add a reference to the Phidget .NET library.
| |
|
| |
| [[File:CSharp VS2005 Add Reference.PNG|link=|alt=Add Reference]]
| |
|
| |
| 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.
| |
|
| |
| [[File:CSharp VS2005 Add Reference 2.PNG|link=|alt=Add Reference]]
| |
|
| |
| 4. Then, in your code, you will need to include the Phidget .NET library:
| |
|
| |
| <div class="source">
| |
| <syntaxhighlight lang=csharp>
| |
| using Phidgets;
| |
| using Phidgets.Events;
| |
| </syntaxhighlight>
| |
| </div>
| |
|
| |
|
| |
| The project now has access to the Phidget function calls and you are ready to begin coding.
| |
|
| |
| The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.
| |
|
| |
| ===Visual Studio 2003===
| |
|
| |
| =====Use Our Examples=====
| |
|
| |
| 1. 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 Phidget .NET 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>
| |
|
| |
| [[File:CSharp VS2003 Source Code 2.PNG|link=|alt=Source Code]]
| |
|
| |
| 9. Now, you can run the example. Click on Debug → Start.
| |
|
| |
| [[File:CSharp VS2003 Run.PNG|link=|alt=Run]]
| |
|
| |
| 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 .NET library. Please see the [[#Use Our Examples 2 | Use Our Examples ]] section for instructions.
| |
|
| |
| Then, in your code, you will need to include the Phidget .NET library:
| |
| <div class="source">
| |
| <syntaxhighlight lang=csharp>
| |
| using Phidgets;
| |
| using Phidgets.Events;
| |
| </syntaxhighlight>
| |
| </div>
| |
|
| |
| The project now has access to the Phidget function calls and you are ready to begin coding.
| |
|
| |
| The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.
| |
|
| |
| ===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.
| |
|
| |
| =====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/>
| |
|
| |
| Place the {{Code|Phidget21.NET.dll}} in the same directory as your source code.
| |
|
| |
| To compile and build an executable, run:
| |
| <div class="source">
| |
| <syntaxhighlight lang=bash>
| |
| mcs /out:example.exe /r:phidget21.NET.dll example.cs
| |
| </syntaxhighlight>
| |
| </div>
| |
|
| |
| If you have the {{Code|Phidget21.NET.dll}} installed in another location, please change the path to the file's location accordingly.
| |
|
| |
| Afterwards, you will have an executable named {{Code|example.exe}} that you can run. Type the following to run the program:
| |
| <div class="source">
| |
| <syntaxhighlight lang=bash>
| |
| mono example.exe
| |
| </syntaxhighlight>
| |
| </div>
| |
|
| |
| 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 .NET library. Please see the [[#Use Our Examples 3 | Use Our Example ]] section for instructions.
| |
|
| |
| In your code, you will need to include the Phidget .NET library:
| |
|
| |
| <div class="source">
| |
| <syntaxhighlight lang=csharp>
| |
| using Phidgets;
| |
| using Phidgets.Events;
| |
| </syntaxhighlight>
| |
| </div>
| |
|
| |
|
| |
| The project now has access to the Phidget function calls and you are ready to begin coding.
| |
|
| |
| The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.
| |
|
| |
| ===MonoDevelop===
| |
|
| |
| =====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. 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 {{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 .NET library. 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 Phidget .NET library.
| |
|
| |
| [[File:CSharp MonoDevelop Win Reference.PNG|link=|alt=Add Reference]]
| |
|
| |
| 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.
| |
|
| |
| [[File:CSharp MonoDevelop Win Reference 2.PNG|link=|alt=Add Reference]]
| |
|
| |
| 4. Then, in your code, you will need to include the Phidget .NET library:
| |
|
| |
| <div class="source">
| |
| <syntaxhighlight lang=csharp>
| |
| using Phidgets;
| |
| using Phidgets.Events;
| |
| </syntaxhighlight>
| |
| </div> | | </div> |
|
| |
|
| The project now has access to the Phidget function calls and you are ready to begin coding.
| |
|
| |
| The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.
| |
|
| |
| ==OS X==
| |
|
| |
| C# has excellent support on OS X through the Mono framework.
| |
|
| |
| The first step in using C# on Mac is to install the Phidget .NET libraries. Compile and install them as explained on the [[Device List|getting started guide for your device]]. Then, the [[OS - OS X]] page also describes the different Phidget files, their installed locations, and their roles....
| |
|
| |
| ==Linux==
| |
|
| |
| C# has support on Linux through the Mono framework.
| |
|
| |
| The first step in using C# on Linux is to install the Phidget .NET 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.
| |
|
| |
| ==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 C# Phidget functions:
| |
|
| |
| {{UsingAPhidgetInCodeGeneral|both of which are available in C#|[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}
| |
|
| |
| ===Example Flow===
| |
|
| |
| {{ExamplePseudocode|In C#, you can name these '''event''' functions whatever you like. You will then pass them as function pointers to the Phidget .NET library below in the Main Code section. This hooks them into the actual events when they occur. <br>
| |
| In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
| |
| Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
| |
| Other functions are given in the examples to show you more detail on using your Phidget. For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
| |
| |Creating a Phidget software object in C# is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating 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/Phidget21.NET.zip .NET API]}}
| |
|
| |
| ==Code Snippets==
| |
|
| |
| ==Common Problems and Solutions/Workarounds==
| |
|
| |
|
| ==={{ProblemSolution|All Operating Systems|The Phidgets.Events.ErrorEventHandler conflicts with System.IO.ErrorEventHandler.}}=== | | == Quick Downloads == |
| | If you already know what you're doing and just need the files, you can find them all below. |
|
| |
|
| <div class="source">
| | === Documentation === |
| <syntaxhighlight lang=csharp>
| |
| using System.IO;
| |
| using Phidgets;
| |
| using Phidgets.Events;
| |
| ...
| |
| spatial.Error += new ErrorEventHandler(spatial_Error);
| |
|
| |
|
| ...
| | *{{Phidget22API}} (Select C# from drop-down menu) |
| void spatial_Error(object sender, ErrorEventArgs e){
| |
| ...
| |
| }
| |
| </syntaxhighlight>
| |
| </div>
| |
|
| |
|
| The above code produces the following error:
| | === Example Code === |
|
| |
|
| {{Code|'ErrorEventHandler' is an ambiguous reference between 'System.IO.ErrorEventHandler' and 'Phidgets.Events.ErrorEventHandler'}}. | | *{{SampleCode|CSharp|C# Examples}} |
|
| |
|
| The error is due to the {{Code|System.IO}} and {{Code|Phidgets.Events}} namespaces both having a class called {{Code|ErrorEventHandler}}.
| | ===Libraries=== |
|
| |
|
| To get around this issue, use the fully qualified namespace when referring to the {{Code|ErrorEventHandler}} class:
| | {{AllQuickDownloads}} |
| <div class="source">
| |
| <syntaxhighlight lang=csharp>
| |
| using System.IO;
| |
| using Phidgets;
| |
| using Phidgets.Events;
| |
| ...
| |
| spatial.Error += new Phidgets.Events.ErrorEventHandler(spatial_Error);
| |
| ...
| |
| | |
| void spatial_Error(object sender, Phidgets.Events.ErrorEventArgs e){
| |
| ...
| |
| }
| |
| | |
| </syntaxhighlight>
| |
| </div>
| |