|
|
(298 intermediate revisions by 9 users not shown) |
Line 1: |
Line 1: |
| [[File:icon-CSharp.png|64x64px|link=Language - C Sharp]]C# is a modern, object-oriented programming language developed by Microsoft. | | <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]] |
| | __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.|various Windows compilers (including Mono), Mac OS X, and Linux}} | | == 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==
| | </div> |
| | |
| Just need the C/C++ drivers, libraries, and examples? Here they are:
| |
| | |
| C# API Documentation:
| |
| *[http://www.phidgets.com/documentation/Phidget21.NET.zip C# API Manual Download] or [http://www.phidgets.com/documentation/web/NETDoc/Index.html (HTML online version)]
| |
| *[[General API]] (more help on functions common to all Phidgets)
| |
| *[[Device List | Device Specific APIs]] (more help on functions specific to your Phidget)
| |
| | |
| C# Example Code:
| |
|
| |
|
| *[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip C# Example Code]
| |
|
| |
|
| Libraries and Drivers:
| | == Quick Downloads == |
| *[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip 32 bit Windows (drivers, with libraries)]
| | If you already know what you're doing and just need the files, you can find them all below. |
| *[http://www.phidgets.com/downloads/libraries/phidget21-x64_2.1.8.20110615.zip 64 bit Windows (drivers, with libraries)]
| |
| *[http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20111028.tar.gz General Linux Libraries] ([[OS - Linux | Linux Library Setup Instructions]])
| |
| *[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20111103.dmg General Mac OSX Libraries] ([[OS - Mac OS X | Mac OS X Library Setup Instructions]])
| |
|
| |
|
| ==Getting started with C#== | | === Documentation === |
|
| |
|
| If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
| | *{{Phidget22API}} (Select C# from drop-down menu) |
| {{ExampleCodeReasons}} | |
|
| |
|
| Instructions are divided up by operating system. Choose:
| | === Example Code === |
| *[[#Windows|Windows 2000 / XP / Vista / 7]]
| |
| *[[#Mac OS X |Mac OS X]]
| |
| *[[#Linux | Linux]] (including PhidgetSBC)
| |
|
| |
|
| ==Windows(2000/XP/Vista/7)==
| | *{{SampleCode|CSharp|C# Examples}} |
|
| |
|
| ===Libraries=== | | ===Libraries=== |
| *[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip 32 bit Windows Installer (drivers, with libraries)]
| |
| *[http://www.phidgets.com/downloads/libraries/phidget21-x64_2.1.8.20110615.zip 64 bit Windows Installer (drivers, with libraries)]
| |
|
| |
| ===Description===
| |
| C# programs on Windows depend on three files, which the installers above put onto your system:
| |
| * <code>phidget21.dll</code> contains the actual Phidgets library, which is used at run-time. If you used our installer, it's already correctly placed in <code>C:\Windows\System32</code>. It can be manually installed - check our [[Manual Installation instructions]].
| |
| * <code>Phidget21.NET.dll</code> is used...
| |
| * <code>Phidget21.NET1.1.dll</code> is used...
| |
|
| |
| Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.
| |
|
| |
|
| |
| ===Visual Studio===
| |
|
| |
| If you are using Visual Studio 2005/2008/2010, please start by downloading the C# Examples. These examples were written in Visual Studio 2005 and 2008, but Visual Studio 2010 will easily upgrade them.
| |
| *[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Microsoft Visual C# Examples]
| |
|
| |
| If you are using Visual Studio 2003, please start by downloading the Generic C# examples.
| |
| *[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Microsoft Visual C# Examples]
| |
|
| |
| 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.
| |
|
| |
|
| |
| ====Visual Studio 2005/2008/2010====
| |
|
| |
| =====Use Our Examples=====
| |
|
| |
| 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.
| |
| <br/><br/>[[File:VS2005 Conversion Wizard.PNG]]<br/><br/>
| |
|
| |
| To run the examples, you first download them [[#Visual Studio|from above]] and unpack them into a folder. To load all projects in Visual Studio, go to File | Open | Project | Solution, and open <code>Visual Studio Phidgets Examples.sln</code> in the VCpp folder of the examples.
| |
|
| |
| 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.h</code> and <code>phidget21.lib</code> in the <code>$(SystemDrive)\Program Files\Phidgets</code>. If you have these files installed in another location, please change the path accordingly. Please see the [[#Write Your Own Code | next section]] for details.
| |
| <br/><br/>
| |
| [[File:VS2005 Run.PNG]]
| |
| <br/><br/>
| |
| Once you have the C/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 compiler / development environment to properly link the Phidget C/C++ libraries. To begin:
| |
|
| |
| * Generate a new Visual C++: Win32 Console Application project with a descriptive name such as PhidgetTest.
| |
| <br/>[[File:VS2005 New Project.PNG]]
| |
| <br/><br/>Next, select Console Application<br/><br/>
| |
| [[File:VS2005 New Project 2.PNG]]
| |
| <br/><br/>
| |
|
| |
| * Open the project properties window.
| |
| * Navigate to Configuration Properties | C/C++.
| |
| * Add <code>"C:\Program Files\Phidgets"</code> to the additional directories field. This step will find the <code>phidget21.h</code> file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.
| |
| <br/>[[File:VS2005 Header.PNG]]
| |
| <br/><br/>
| |
| * Navigate to Configuration Properties | Linker | Input.
| |
| * Edit the additional dependencies and add <code>"C:\Program Files\Phidgets\phidget21.lib"</code>. This step will find the <code>phidget21.lib</code> file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.
| |
| <br/>[[File:VS2005 Library.PNG]]
| |
| <br/><br/>
| |
| The project now has access to the Phidget21 function calls and you are ready to begin coding.
| |
|
| |
| Then, in your code, you will need to include the Phidget library:
| |
|
| |
| <div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
| |
| <font size="3">
| |
| <source lang=cpp>
| |
|
| |
| #include <phidget21.h>
| |
|
| |
| </source>
| |
| </font>
| |
| </div>
| |
|
| |
| The same [[#Follow The Examples|teaching section]] which describes the examples also has further resources for programming your Phidget.
| |
|
| |
| ====Visual Studio 2003====
| |
|
| |
| Start by downloading the C# Examples. You can import the simple examples into a Visual Studio 2003 C# project.
| |
| *[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Microsoft Visual C# Examples]
| |
|
| |
| =====Use Our Examples=====
| |
| <br/>
| |
| Download the examples [[#Visual Studio 2003|from above]] 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]]. You will need this example source code to be copied into your C++ project later on.
| |
|
| |
| Next, a new project will need to be created.
| |
| * Generate a new Visual C++ empty project(.NET) with a descriptive name such as PhidgetTest.
| |
| <br/>[[File:VS2003 New Project.PNG]]<br/><br/>
| |
|
| |
| To import the example program into your project, please:
| |
| * Create a new C++ file by adding a new item to the source files folder.
| |
| <br/>[[File:VS2003 New File.PNG]]<br/>
| |
| <br/>[[File:VS2003 New File 2.PNG]]<br/><br/>
| |
| * An empty C++ file will pop up. Please copy and paste the contents of the example program into here.
| |
| <br/>[[File:VS2003 Source.PNG]]<br/><br/>
| |
|
| |
| Next, the project setting needs to be set up.
| |
| * Open the project properties window.
| |
| * Navigate to Configuration Properties | C/C++.
| |
| * Add <code>"C:\Program Files\Phidgets"</code> to the additional include directories field. This step will find the <code>phidget21.h</code> file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.
| |
| <br/>[[File:VS2003 Header.PNG]]<br/><br/>
| |
| * Navigate to Configuration Properties | Linker | Input.
| |
| * Add <code>"C:\Program Files\Phidgets\phidget21.lib"</code> to the additional dependencies field. This step will find the <code>phidget21.lib</code> file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.
| |
| <br/>[[File:VS2003 Library.PNG]]<br/><br/>
| |
| The project now has access to the Phidget21 function calls and you are ready to begin coding.
| |
|
| |
| Now, you can run the example. Click on Debug | Start Without Debugging.
| |
| <br/><br/>[[File:VS2003 Run.PNG]]<br/><br/>
| |
|
| |
| Once you have the C/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 compiler / development environment to properly link the Phidget C/C++ libraries. Please see the [[#Use Our Examples 2 | previous section]] for instructions.
| |
|
| |
| ====Mono====
| |
|
| |
| Start by downloading the C# Examples.
| |
| *[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Microsoft Visual C# Examples]
| |
|
| |
| =====Use Our Examples=====
| |
| <br/>
| |
| Once you have the C/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 compiler / development environment to properly link the Phidget C/C++ libraries. Please see the [[#Use Our Examples 3 | previous section]] for instructions.
| |
|
| |
| ===MonoDevelop===
| |
|
| |
| Start by downloading the Generic C/C++ Examples. You can import these examples into a Dev C++ project.
| |
| *[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz Generic C/C++ Examples]
| |
|
| |
| =====Use Our Examples=====
| |
|
| |
| Download the examples [[#Dev C++|from above]] 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]]. You will need this example source code to be copied into your Dev C++ project later on.
| |
| <br/>
| |
|
| |
| In order to control Phidgets with Dev C++, the <code>phidget21.lib</code> file will need to be converted to a format that Dev C++ accepts, as described in the following steps:
| |
| * Download the [http://www.phidgets.com reimp tool]
| |
| * Open up command line and traverse to the directory containing the reimp tool. Type the following command to create <code>libphidget21.a</code>
| |
| <div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
| |
| <font size="3">
| |
| <source lang=bash>
| |
| reimp.exe "C:\Program Files\Phidgets\phidget21.lib"
| |
| </source>
| |
| </font>
| |
| </div>
| |
| The command above assumes that the <code>phidget21.lib</code> is in the corresponding directory. If the file is placed in another location, please adjust the path accordingly. Please note that the 64 bit version of <code>phidget21.lib</code> is not supported on Dev C/C++. Please use the 32 bit version of <code>phidget21.lib</code>.
| |
| * Place <code>libphidget21.a</code> in <code><Dev-Cpp Install Directory>/lib</code>.
| |
|
| |
| Next, a new project will need to be created. The following steps are written under Dev-C++ 4.9.9.2.
| |
| * Generate a new console application with a descriptive name such as PhidgetTest. Please select C as the project type.
| |
| <br/>[[File:DevC New Project.PNG]]<br/><br/>
| |
|
| |
| Next, the project settings needs to be set up.
| |
| * Navigate to Project Options | Directories | Include Directories.
| |
| * Add a new path to <code>C:\Program Files\Phidgets</code>. This step will find the <code>phidget21.h</code> file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.
| |
| <br/>[[File:DevC Header.PNG]]<br/><br/>
| |
| * Navigate to Project Options | Parameters | Linker.
| |
| * Add <code>-lphidget21</code> to the field. This step will find the <code>libphidget21.a</code> file in <code><Dev-Cpp Install Directory>/lib</code>.
| |
| <br/>[[File:DevC Library.PNG]]<br/><br/>
| |
| The project now has access to the Phidget21 function calls and you are ready to begin coding.
| |
|
| |
| To import the example program into your project, please:
| |
| * Open up <code>main.c</code> in the editor.
| |
| * An empty C file will pop up. Please copy and paste the contents of the example program here.
| |
| <br/>[[File:DevC Source.PNG]]<br/><br/>
| |
| Now, you can run the example. Click on Execute | Compile & Run.
| |
| <br/><br/>[[File:DevC Run.PNG]]<br/><br/>
| |
|
| |
| Once you have the C/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 compiler / development environment to properly link the Phidget C/C++ libraries. Please see the [[#Use Our Examples 4 | previous section]] for instructions.
| |
|
| |
| ==Mac OS X==
| |
|
| |
| C# has excellent support on Mac OS X through the gcc compiler.
| |
|
| |
| The first step in using C# 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....
| |
|
| |
| ===Use Our Examples===
| |
|
| |
| After installing the Phidget libraries for Linux as above, you're ready to run the examples:
| |
| *[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip C# Examples]
| |
| After using gcc, you will have an executable named <code>example</code> that you can run.
| |
|
| |
| ===Write Your Own Code===
| |
|
| |
| Then, you would compile your completed C/C++ code the same way as the examples above.
| |
|
| |
| To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Follow The Examples|teaching section]] to help you follow the provided C/C++ examples. Even more help and references are provided from there.
| |
|
| |
| ==Linux==
| |
|
| |
| C# has support on Linux through the gcc compiler.
| |
|
| |
| The first step in using C/C++ 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.
| |
|
| |
| ===Use Our Examples===
| |
|
| |
| After installing the Phidget libraries for Linux as above, you're ready to download and run the examples:
| |
| *[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz Generic C/C++ Examples]
| |
|
| |
| To run the example code, you'll need to download and unpack the examples, and then find the source code ''for your specific device''. The source file is usually named similarly to your device. Then, compile the code under your platform and run it. When compiling, you need to link to the phidget21 library.
| |
|
| |
| To compile, link the Phidget libraries and build a binary executable on Linux, do the following in a terminal in the directory with <code>example.c</code>:
| |
|
| |
| <div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
| |
| <font size="3">
| |
| <source lang=bash>
| |
| gcc example.c -o example -lphidget21
| |
| </source>
| |
| </font>
| |
| </div>
| |
|
| |
| In this case, <code>example.c</code> would be the '''.c''' file specific to your device. After using gcc, you will have an executable named <code>example</code> that you can run.
| |
|
| |
| On Linux, if you have not set up [[OS - Linux | your udev rules for USB access]], you will need to run the program '''as root''':
| |
|
| |
| <div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
| |
| <font size="3">
| |
| <source lang=bash>
| |
|
| |
| sudo ./example
| |
|
| |
| </source>
| |
| </font>
| |
| </div>
| |
|
| |
| ===Write Your Own Code===
| |
|
| |
| When writing your code from scratch, you start it as you would any C/C++ code on Linux, such as within a text editor like Emacs, Vi, Gedit, or Kate. In your '''<code>.c</code>''' source code file, you must include a reference to the library header:
| |
|
| |
| <div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
| |
| <font size="3">
| |
| <source lang=cpp>
| |
|
| |
| #include <phidget21.h>
| |
|
| |
| </source>
| |
| </font>
| |
| </div>
| |
|
| |
| Then, you would compile your completed C/C++ code the same way as the examples above.
| |
|
| |
| To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Follow The Examples|teaching section]] to help you follow the provided C/C++ examples and which has resources such as the API reference.
| |
|
| |
| ==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/C++ Phidget functions:
| |
|
| |
| {{UsingAPhidgetInCodeGeneral|both of which are available in C/C++|[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API]}}
| |
|
| |
| ===Example Flow===
| |
|
| |
| {{ExamplePseudocode|In C/C++, 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>
| |
| 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 an object with the <code>CPhidgetSpatialHandle</code> type, and then initializing it using the <code>CPhidgetSpatial_create</code> function. The examples show how to do this and other API functions.<br><br>
| |
| Other C calls follow a similar syntax - <code>CPhidgetXXX_function</code>, where XXX is the name of your device, and function is an action available from the API for your specific Phidget.|
| |
| [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API]}}
| |
|
| |
| ==Common Problems and Solutions/Workarounds==
| |
|
| |
|
| Here you can put various frequent problems and our recommended solutions.
| | {{AllQuickDownloads}} |