Language - C Sharp: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
Line 1: Line 1:
[[File:icon-CSharp.png|64x64px|link=Language - C Sharp]]C# is a modern, object-oriented programming language developed by Microsoft.
[[File:icon-CSharp.png|64x64px|link=Language - C Sharp]]C# is a modern, object-oriented programming language developed by Microsoft.


==Support==
__TOC__
C# 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==


Since C# supports event-driven programming and is object-oriented, it is capable of using all of the functionality Phidgets has to offer.
{{LanguageSupport|C#|the complete Phidget API, including events|all Phidget devices.|various Windows compilers (including Mono), Mac OS X, and Linux}}


Due to the popularity of C#, you can also find plenty of other programmers on the C# section of [http://www.phidgets.com/phorum/viewforum.php?f=22 our forums].
==Quick Downloads==
 
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:
*[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip 32 bit Windows (drivers, with libraries)]
*[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#==
 
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|Windows 2000 / XP / Vista / 7]]
*[[#Mac OS X |Mac OS X]]
*[[#Linux | Linux]] (including PhidgetSBC)
 
==Windows(2000/XP/Vista/7)==
 
===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)]


==Development Environments and Compilers==
===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...


===Mono===
Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.
Mono is a free, open-source C# compiler. If you want to program with Phidgets using C# on Linux, Mono is your best option.  


You can visit Mono's website [http://www.mono-project.com/Main_Page here].


===Visual Studio 2003===
===Visual Studio===
Visual Studio 2003 requires our .NET 1.1 libraries. Make sure you download the latest version of our [http://www.phidgets.com/drivers.php drivers] and add a reference in your project to Phidget21.NET version 1.1.


Our code samples were designed for use with Visual Studio 2005 or 2008. You can try to build a new project in Visual Studio 2003 using the source code we provide, but we cannot guarantee that it will work.  
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]


===Visual Studio 2005===
If you are using Visual Studio 2003, please start by downloading the Generic C# examples.
Visual Studio 2005 requires our .NET 2.0 libraries. Make sure you download the latest version of our [http://www.phidgets.com/drivers.php drivers] and add a reference in your project to Phidget21.NET version 2.0.
*[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Microsoft Visual C# Examples]


When running our sample code, if you're using Visual Studio 2005, open the project file that does '''not''' have "2008" after the project name.
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 2008 and 2010===
Visual Studio 2008 and 2010 require our .NET 2.0 libraries. Make sure you download the latest version of our [http://www.phidgets.com/drivers.php drivers] and add a reference in your project to Phidget21.NET version 2.0. We do not currently provide support for new features in newer versions of the .NET framework.


When running our sample code, if you're using Visual Studio 2008 or 2010, open the project file that has "2008" after the project name.
====Visual Studio 2005/2008/2010====


===Visual Studio Express Editions===
=====Use Our Examples=====


Visual Studio Express is the free version of Visual Studio.
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.  
As long as you use the correct version of the .NET framework as mentioned above, Visual Studio Express should work just fine.
<br/><br/>[[File:VS2005 Conversion Wizard.PNG]]<br/><br/>


==Quick Downloads==
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.
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:
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]].
* [http://www.phidgets.com/drivers.php Phidget Framework]
 
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
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.  
* [http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API Manual]
<br/><br/>
* [http://www.phidgets.com/documentation/web/NETDoc/Index.html .NET API Reference].
[[File:VS2005 Run.PNG]]
The .NET API manual lists calls and events for every type of Phidget and can be used as a reference.
<br/><br/>
* Example Programs written in C# [[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Windows]] [[http://www.phidgets.com/downloads/examples/CE_2.1.8.20110615.zip .NET Compact Framework]]
Once you have the C/C++ examples running, we have a [[#Follow The Examples|teaching section]] below to help you follow them.
* 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.
=====Write Your Own Code=====


You may want to have these pages open while working through these instructions.
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:


==Getting Started==
* 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/>


===Setting up a Phidgets Project===
* Open the project properties window.
The Phidget examples were written using Visual C# 2005 and this tutorial assumes its use. Newer
* Navigate to Configuration Properties | C/C++.
versions of Visual Studio Express are freely available for download from Microsoft. Older versions of
* 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.
Visual Studio work as well and would be set up in a similar manner (Note: you would have to recreate
<br/>[[File:VS2005 Header.PNG]]
the user interface in the examples for Visual Studio versions earlier than 2005). In Visual Studio:
<br/><br/>
* Generate a new C# Windows Application with a descriptive name such as PhidgetTest.
* Navigate to Configuration Properties | Linker | Input.
* Launch the Add Reference window (Project | Add Reference).
* 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.  
* Under the .NET tab, select the most recent Phidget21.NET library. If it does not appear in this list, then you can Browse to the Phidget Framework installation directory and add the Phidget21.NET. dll. For earlier versions of Visual Studio, you will want to use the Phidget21.NET1.1.dll instead.  
<br/>[[File:VS2005 Library.PNG]]
* Place a TextBox on your main form for the purpose of capturing output.
<br/><br/>
* Hook the form's Load and FormClosing events. Phidget initialization and shutdown will take place
The project now has access to the Phidget21 function calls and you are ready to begin coding.
there.
The project now has access to Phidgets and we are ready to begin coding.


===Coding For Your Phidget===
Then, in your code, you will need to include the Phidget library:
Before you can use the Phidget, you must include a reference in the code to the libraries. Launch the
code editor for your form and add this to your using statements:Getting_Started_CSharp created: 11/10/10 Page 2
using Phidgets;
using Phidgets.Events;
Afterwards, a Phidget object will need to be declared and then initialized. For example, we can
declare a PhidgetInterfaceKit inside our form with:


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<font size="3">
<source lang=CSharp>
<source lang=cpp>
 
  #include <phidget21.h>


    namespace PhidgetTest
    {
        public partial class Form1 : Form
        {
            //The Phidget object declaration
            private InterfaceKit ifKit;
            public Form1()
            {
                InitializeComponent();
            }
            //... Form1_Load and Form1_OnClosing here
        }
    }
</source>
</source>
</font>
</font>
</div>
</div>


The same [[#Follow The Examples|teaching section]] which describes the examples also has further resources for programming your Phidget.


The object name for any type of Phidget is listed in the API manual. Every type of Phidget also
====Visual Studio 2003====
inherits functionality from the Phidget base class.


===Connecting to the Phidget===
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]


Next, the program needs to try and connect to the Phidget through a call to open(). Open will tell the  
=====Use Our Examples=====
program to continuously try to connect to a Phidget, based on the parameters given, even trying to  
<br/>
reconnect if it gets disconnected. This means that simply calling open does not guarantee you can
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.
use the Phidget immediately. We can handle this by using event driven programming and tracking
 
the AttachEvents and DetachEvents, or by calling waitForAttachment. WaitForAttachment will block
Next, a new project will need to be created.
indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.
* 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;">
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<font size="3">
<source lang=CSharp>  
<source lang=bash>
   
  reimp.exe "C:\Program Files\Phidgets\phidget21.lib"
private void Form1_Load(object sender, EventArgs e)
{
    ifKit = new InterfaceKit();
    ifKit.open();
    ifKit.waitForAttachment(3000);
}
</source>
</source>
</font>
</font>
</div>
</div>
The different types of open can be used with parameters to try and get the first device it can find,
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>.
open based on its serial number, or even open across the network. The API manual lists all of the  
* Place <code>libphidget21.a</code> in <code><Dev-Cpp Install Directory>/lib</code>.
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.


===Event Driven Programming===
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 CC# 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.
 
{{ContentNeeded|The information we say that we say on the OS - Mac OS X page (i.e. the different files, locations, and roles) should actually be added there}}
 
===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/phidget21-c-examples_2.1.8.20111028.tar.gz Generic C/C++ Examples]
 
To run the example code, you'll need to find the source code ''for your specific device''.  Then, compile the code under your platform and run it.
 
The examples assume that the compiled libraries have been set up properly.  To set them up on Mac OS X, follow the ''Getting Started'' page for [[Device List | your specific device]]
 
To compile, link the Phidget libraries, and build an executable binary on Mac OS X, do (for example, depending on the Headers location):


We recommend the use of event driven programming when working with Phidgets. In C# we can
hook an event handler at loading with the following code:
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<font size="3">
<source lang=CSharp>
<source lang=bash>
  gcc example.c -o example -framework Phidget21 -I/Library/Frameworks/Phidget21.framework/Headers
</source>
</font>
</div>
 
After using gcc, you will have an executable named <code>example</code> that you can run.
 
===Write Your Own Code===
 
When writing your code from scratch, 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.  Even more help and references are provided from there.
 
==Linux==


ifKit.SensorChange += new SensorChangeEventHandler(ifKit_SensorChange);
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>
</source>
</font>
</font>
</div>
</div>


The ifKit_SensorChange method is defined as follows:
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;">
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<font size="3">
<source lang=CSharp>
<source lang=bash>


        void ifKit_SensorChange(object sender, SensorChangeEventArgs e)
    sudo ./example
        {
            textBox1.Text = "Index " + e.Index + " Value: " + e.Value;
        }


</source>
</source>
Line 158: Line 299:
</div>
</div>


With this function, the code inside ifKit_SensorChange will get executed every time the
===Write Your Own Code===
PhidgetInterfaceKit reports a change on one of its analog inputs. Some events such as Attach and
 
Detach belong to the base Phidget object and thus are common to all types of Phidgets. Please refer
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:
to the API manual for a full list of events and their usage.  
At the end of your program, unhook any events and call Application.DoEvents(). This will make sure
there are no outstanding events being processed before calling close.


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<font size="3">
<source lang=CSharp>
<source lang=cpp>


        private void Form1_FormClosing(object sender, FormClosingEventArgs e)
  #include <phidget21.h>
        {
            ifKit.SensorChange -= new SensorChangeEventHandler(ifKit_SensorChange);
            //run any events in the message queue
            Application.DoEvents();
            ifKit.close();
        }


</source>
</source>
</font>
</font>
</div>
</div>
Working directly with the Phidget
Some values can be read and sent directly to the Phidget, simply use the instance members and
properties. This is also how you would set properties on the Phidget such as the output state or
sensor sensitivity. These functions can be used inside a polling loop as an alternative to event driven
programming.
int val = ifKit.sensors[0].Value;


===Working with multiple Phidgets===
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:


Multiple Phidgets of the same type can easily be run inside the same program. In our case, it 
{{UsingAPhidgetInCodeGeneral|both of which are available in C/C++|[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API]}}
requires another PhidgetInterfaceKit instance 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. For example, if
{{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>
you were using a PhidgetRFID instead of an PhidgetInterfacekit, you would declare an RFID object  
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
instead of an InterfaceKit. The methods and events available would change but they can be accessed
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.
in a similar manner.  
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]}}


<!-- Not sure if this section is even necessary
==Building your Project==
Describe the different ways a project could be built using this language.
-->
==Common Problems and Solutions/Workarounds==
==Common Problems and Solutions/Workarounds==


There are no known issues specific to C# at this time.
Here you can put various frequent problems and our recommended solutions.

Revision as of 22:57, 11 January 2012

Icon-CSharp.pngC# is a modern, object-oriented programming language developed by Microsoft.

Introduction

Template:LanguageSupport

Quick Downloads

Just need the C/C++ drivers, libraries, and examples? Here they are:

C# API Documentation:

C# Example Code:

Libraries and Drivers:

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:

  • 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)

Libraries

Description

C# programs on Windows depend on three files, which the installers above put onto your system:

  • phidget21.dll contains the actual Phidgets library, which is used at run-time. If you used our installer, it's already correctly placed in C:\Windows\System32. It can be manually installed - check our Manual Installation instructions.
  • Phidget21.NET.dll is used...
  • Phidget21.NET1.1.dll 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.

If you are using Visual Studio 2003, please start by downloading the Generic 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 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.

VS2005 Conversion Wizard.PNG

To run the examples, you first download them from above and unpack them into a folder. To load all projects in Visual Studio, go to File | Open | Project | Solution, and open Visual Studio Phidgets Examples.sln 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 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.h and phidget21.lib in the $(SystemDrive)\Program Files\Phidgets. If you have these files installed in another location, please change the path accordingly. Please see the next section for details.

VS2005 Run.PNG

Once you have the C/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 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.


VS2005 New Project.PNG

Next, select Console Application

VS2005 New Project 2.PNG

  • Open the project properties window.
  • Navigate to Configuration Properties | C/C++.
  • Add "C:\Program Files\Phidgets" to the additional directories field. This step will find the phidget21.h file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.


VS2005 Header.PNG

  • Navigate to Configuration Properties | Linker | Input.
  • Edit the additional dependencies and add "C:\Program Files\Phidgets\phidget21.lib". This step will find the phidget21.lib file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.


VS2005 Library.PNG

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:

  #include <phidget21.h>

The same 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.

Use Our Examples


Download the examples 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 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.


VS2003 New Project.PNG

To import the example program into your project, please:

  • Create a new C++ file by adding a new item to the source files folder.


VS2003 New File.PNG

VS2003 New File 2.PNG

  • An empty C++ file will pop up. Please copy and paste the contents of the example program into here.


VS2003 Source.PNG

Next, the project setting needs to be set up.

  • Open the project properties window.
  • Navigate to Configuration Properties | C/C++.
  • Add "C:\Program Files\Phidgets" to the additional include directories field. This step will find the phidget21.h file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.


VS2003 Header.PNG

  • Navigate to Configuration Properties | Linker | Input.
  • Add "C:\Program Files\Phidgets\phidget21.lib" to the additional dependencies field. This step will find the phidget21.lib file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.


VS2003 Library.PNG

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.

VS2003 Run.PNG

Once you have the C/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 compiler / development environment to properly link the Phidget C/C++ libraries. Please see the previous section for instructions.

Mono

Start by downloading the C# Examples.

Use Our Examples


Once you have the C/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 compiler / development environment to properly link the Phidget C/C++ libraries. Please see the previous section for instructions.

MonoDevelop

Start by downloading the Generic C/C++ Examples. You can import these examples into a Dev C++ project.

Use Our Examples

Download the examples 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 Getting Started guide for your device. You will need this example source code to be copied into your Dev C++ project later on.

In order to control Phidgets with Dev C++, the phidget21.lib file will need to be converted to a format that Dev C++ accepts, as described in the following steps:

  • Download the reimp tool
  • Open up command line and traverse to the directory containing the reimp tool. Type the following command to create libphidget21.a

  reimp.exe "C:\Program Files\Phidgets\phidget21.lib"

The command above assumes that the phidget21.lib 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 phidget21.lib is not supported on Dev C/C++. Please use the 32 bit version of phidget21.lib.

  • Place libphidget21.a in <Dev-Cpp Install Directory>/lib.

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.


DevC New Project.PNG

Next, the project settings needs to be set up.

  • Navigate to Project Options | Directories | Include Directories.
  • Add a new path to C:\Program Files\Phidgets. This step will find the phidget21.h file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.


DevC Header.PNG

  • Navigate to Project Options | Parameters | Linker.
  • Add -lphidget21 to the field. This step will find the libphidget21.a file in <Dev-Cpp Install Directory>/lib.


DevC Library.PNG

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 main.c in the editor.
  • An empty C file will pop up. Please copy and paste the contents of the example program here.


DevC Source.PNG

Now, you can run the example. Click on Execute | Compile & Run.

DevC Run.PNG

Once you have the C/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 compiler / development environment to properly link the Phidget C/C++ libraries. Please see the previous section for instructions.

Mac OS X

C# has excellent support on Mac OS X through the gcc compiler.

The first step in using CC# 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.

Template:ContentNeeded

Use Our Examples

After installing the Phidget libraries for Linux as above, you're ready to run the examples:

To run the example code, you'll need to find the source code for your specific device. Then, compile the code under your platform and run it.

The examples assume that the compiled libraries have been set up properly. To set them up on Mac OS X, follow the Getting Started page for your specific device

To compile, link the Phidget libraries, and build an executable binary on Mac OS X, do (for example, depending on the Headers location):

  gcc example.c -o example -framework Phidget21 -I/Library/Frameworks/Phidget21.framework/Headers

After using gcc, you will have an executable named example that you can run.

Write Your Own Code

When writing your code from scratch, you must include a reference to the library header:

  #include <phidget21.h>

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 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 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:

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 example.c:

  gcc example.c -o example -lphidget21

In this case, example.c would be the .c file specific to your device. After using gcc, you will have an executable named example that you can run.

On Linux, if you have not set up your udev rules for USB access, you will need to run the program as root:

     sudo ./example

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 .c source code file, you must include a reference to the library header:

  #include <phidget21.h>

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 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:

Template:UsingAPhidgetInCodeGeneral

Example Flow

Template:ExamplePseudocode

Common Problems and Solutions/Workarounds

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