Language - C Sharp: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
 
(38 intermediate revisions by 5 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 the .NET CLI.</metadesc>
[[Category:Language]]
[[Category:Language]]
{{OSLang|[[File:icon-CSharp.png|64x64px|link=|left|alt=]]|C# is a modern, object-oriented programming language developed by [http://www.microsoft.com Microsoft].}}
__NOTOC__
__TOC__
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.


== Introduction ==
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 '''.NET CLI''' 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.


If this is your first time working with a Phidget, we suggest starting with the Getting Started page for your specific device. This can be found in the user guide for your device. That page will walk you through installing drivers and libraries for your operating system, and will then bring you back here to use C# specifically.
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#.


C# is capable of using the complete Phidget API, including events. We also provide example code in C# for all Phidget devices.
== 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_WIN_DOTNET}}{{PT3_CSHARP_MAC_DOTNET}}{{PT3_CSHARP_WIN_MONODEV}}
 
</div>


C# can be developed with the .NET or Mono framework. Both of the frameworks are supported on [[#Windows|Windows]]. For [[#Linux|Linux]] and [[#OS_X|OS X]], only the Mono framework can be used. We provide instructions on how to set up your environment/compilers for [[#Visual_Studio_2015|Visual Studio 2015]], [[#MonoDevelop/Xamarin_Studio|MonoDevelop]] and the [[#Mono|Mono]] command line compilers.


== Quick Downloads ==
== Quick Downloads ==
 
If you already know what you're doing and just need the files, you can find them all below.
'''<span style="color:#FF0000">List of download links, to be added once files are available</span>'''


=== Documentation ===
=== Documentation ===
=== Example Code ===
=== Libraries and Drivers ===


== Getting Started with C# ==
*{{Phidget22API}} (Select C# from drop-down menu)


If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
=== Example Code ===
{{ExampleCodeReasons}}
 
Instructions are divided up by operating system. Choose:
*[[#Windows|Windows XP / Vista / 7]]
*[[#OS X |OS X]]
*[[#Linux | Linux]] (including PhidgetSBC)
 
== Windows ==
 
===Description of Library Files===
C# programs on Windows depend on the following files, which the installers above put onto your system:
*'''phidget22.dll''' contains the actual Phidget library, which is used at run-time. By default, it is placed in C:\Windows\System32.
*'''Phidget22.NET.dll''' is the Phidget 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\Phidget22. 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:
*'''Phidget22.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.
 
Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.
 
===Visual Studio 2015===
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 [//www.visualstudio.com/en-us Microsoft Visual Studio] for more information.
 
====Use Our Examples====
Please start by downloading the examples and unpacking them into a folder. Since the examples were written in Visual Studio 2015, you will need to use Visual Studio 2015 or later in order to run the examples. To load all projects in Visual Studio, go to File → Open → Project, and open AllExamples/AllExamples.sln.
 
The easiest way to confirm that your environment is set up properly will be to compile and run the HelloWorld C# example.
 
Start by setting the HelloWorld project as your start up project.
 
The only thing left to do is to run the example! Click on Debug → Start Debugging. Please note that the projects, by default try to find the Phidget22.NET.dll in the C:\Program Files\Phidgets\Phidget22. 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 Phidget22 cannot be found, please re-add the reference to Phidget22.NET.dll. Please see the [[#Write Your Own Code|Write Your Own Code]] section for details.
 
[[Image:CSharp_VS2015_Run.png|link=|600px]]
 
This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:
 
[[Image:CSharp_VS2015_HelloWorld_Output.png|link=|600px]]
 
After confirming that the HelloWorld example is working, you can proceed to run the example for your device. The source file will be named the same as the software object you want to use with your device. A device will often use more than one software object, so you may need to run multiple examples to learn how to use your device (for example, a Phidget Spatial uses the Accelerometer, Gyroscope, Magnetometer, and Spatial software objects). If you are not sure what the software objects for your device are, find your Phidget on our [http://www.phidgets.com webpage], and then check the API documentation for it.
 
Once you have the C# examples running, we have a [[#Edit 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.
 
[[Image:CSharp_VS2015_New_Project.png|link=|600px]]
 
2. Add a reference to the Phidget .NET library.
 
[[Image:CSharp_VS2015_Add_Reference.png|link=]]
 
3. Click Browse and navigate to the location of Phidget22.NET.dll, and add the file. If you used our installer, these files are installed in C:\Program Files\Phidgets\Phidget22, by default. If you have already done this for a previous project, you should be able to find Phidget22.NET.dll under the Browse → Recent tab.
 
[[Image:CSharp_VS2015_Add_Reference_2.png|link=|600px]]
 
4. Then, in your code, you will need to include the Phidget .NET library:
 
<syntaxhighlight lang="csharp">
using Phidget22;
using Phidget22.Events;
</syntaxhighlight>
 
The project now has access to the Phidget function calls and you are ready to begin coding.
 
The same [[#Edit 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 mcs compiler. Other compilers such as gmcs, smcs, and dmcs all work in the same way.
 
====Use Our Examples====
 
Download the [[#Example_Code|examples]] and unpack them into a folder. Here, you can find the HelloWorld program that will work with any Phidget.
 
Note that the HelloWorld program is the only example that will work with Mono. The full examples use 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.
 
Place '''Phidget22.NET.dll''' in the same directory as your source code.
 
To compile and build an executable, run:
 
<syntaxhighlight lang='bash'>
mcs /out:example.exe /r:phidget22.NET.dll Program.cs
</syntaxhighlight>
 
If you have the Phidget22.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. Type the following to run the program:
 
<syntaxhighlight lang='bash'>
mono example.exe
</syntaxhighlight>
 
Once you have the HelloWorld example running, we have a [[#Edit 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|Use Our Examples]] section for instructions.
 
In your code, you will need to include the Phidget .NET library:
 
<syntaxhighlight lang='CSharp'>
using Phidget22;
using Phidget22.Events;
</syntaxhighlight>
 
The project now has access to the Phidget function calls and you are ready to begin coding.
 
The same [[#Edit_the_examples|teaching section]] which describes the examples also has further resources for programming your Phidget.
 
===MonoDevelop/Xamarin Studio===
 
====Use Our Examples====
 
Download the examples and unpack them into a folder. Here, you can find example programs for all the devices, as well as a HelloWorld program that will work with any Phidget. The source file will be named the same as the software object for your device. If you are not sure what the software object for your device is, find your Phidget on our [http://www.phidgets.com webpage], and then check the API documentation for it.
 
These examples were written in Visual Studio 2015, but are also compatible with MonoDevelop/Xamarin Studio.
 
To load all projects in MonoDevelop/Xamarin Studio, 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 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#.
 
[[Image: CSharp MonoDevelop setStartup.png|link=]]
 
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 Phidget22.NET.dll in the C\Program Files\Phidgets\Phidget22. 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 Phidget22 cannot be found, please re-add the reference to Phidget22.NET.dll. Please see the [[#Write Your Own Code|Write Your Own Code]] section for details.
 
[[Image: CSharp MonoDelevop Run.png|link=|600px]]
 
Once you have the C# examples running, we have a [[#Edit 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# .NET Console project with a descriptive name such as PhidgetTest.
 
[[Image: CSharp MonoDelevop NewProject.png|link=|600px]]
 
[[Image: CSharp MonoDelevop NewProject2.png|link=|600px]]
 
2. Add a reference to the Phidget .NET library.
 
[[Image: CSharp MonoDelevop EditReferences1.png|link=]]
 
3. Select Phidget22.NET.dll. If you used our installer, by default, this file is placed in C:\Program Files\Phidgets\Phidget22. If it is in another location, please change the path to the file's location accordingly.
 
[[Image: CSharp MonoDelevop EditReferences2.png|link=|600px]]
 
4. Then, in your code, you will need to include the Phidget .NET library:
 
<syntaxhighlight lang='CSharp'>
  using Phidgets;
  using Phidgets.Events;
</syntaxhighlight>
 
The project now has access to the Phidget function calls and you are ready to begin coding.
 
The same [[#Edit_the_examples|teaching]] section which describes the examples also has further resources for programming your Phidget.
 
== OS X ==
 
===Use Our Examples===
 
The first thing you are going to need to do is install Mono (Note that Mono is only available for Intel Macs and not PowerPC). You will need both the SDK and the runtime.
 
Then, you will need the Phidget .NET libraries. These are part of the Windows library zip file download:
 
*[[Phidget Windows Library Zip File]]
 
Extract the library zip file. Descriptions for the files are available on the OS - Windows page, but for now we only need the Phidget22.NET.dll file to run the Phidget C# examples in Mono. So remember where you unzipped these Windows libraries - you will need to copy the Phidget22.NET.dll file into your example directory shortly.
 
Next, you'll want to download and extract the Phidget C# Examples (For Windows, not for .NET Compact):
 
*[[#Example_Code|C# Examples for Windows]]
 
One more thing needs to be done before you can compile and run the examples. You need to set up a special configuration file so that Mono knows where to find the phidget22.dll. Since Mac does not use dll's you need to redirect it to the appropriate file. Create a new file in the same directory as the example you wish to compile and name it Phidget22.NET.dll.config. Put the following into the file:
 
<syntaxhighlight lang='xml'>
  <configuration>
<dllmap dll="phidget22.dll" target="/Library/Frameworks/Phidget22.framework/Versions/Current/Phidget22" />
  </configuration>
</syntaxhighlight>
 
All that is left is to compile and run the code. When compiling, you need to link to the Phidget library. As the Phidget22.NET file is an "additional assembly" in C#/Mono, you can link to the assembly using the -r "reference" switch:
 
<syntaxhighlight lang='bash'>
gmcs Program.cs -r:Phidget22.NET.dll
</syntaxhighlight>
 
This will compile a *.exe file - in this case, Program.exe. This you can then run under Mono:
 
<syntaxhighlight lang='bash'>
mono Program.exe
</syntaxhighlight>
 
If you will be compiling with an IDE such as GTK# or MonoDevelop, we don't have explicit instructions by IDE for OS X. However, you will probably find the MonoDevelop section in the Windows portion above useful.
 
===Write Your Own Code===
 
When writing your code from scratch, you start it as you would any C# code on OS X. In your .cs source code file, you must include a reference to the Phidget Library:
 
<syntaxhighlight lang='CSharp'>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
 
Then, you would compile your completed C# code the same way as the examples above.
 
Mono also has a few different IDEs which you can use to develop code, and these are especially useful if you are doing GUI development. We provide instructions for MonoDevelop - one such IDE - being used under [[OS - Windows|Windows]].
 
To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Edit the Examples|teaching section]] to help you follow the provided C# examples and which has resources such as the API reference.
 
== Linux ==
 
C# has support on Linux through the Mono framework.
 
===Use Our Examples===
 
The first step in using C# with Phidgets on Linux is to make sure that you have all of Mono installed. Although you probably have already done this if you're a C# programmer, you want to make sure you have all of the packages you'll need. Try:
 
<syntaxhighlight lang='bash'>
sudo apt-get mono-complete
</syntaxhighlight>
 
Next, you'll want to install the main 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.
 
Then, you will need the Phidget .NET libraries. These are part of the Windows library zip file download:
 
*[[Phidget Windows Library Zip File]]
 
Extract the library zip file. Descriptions for the files are available on the OS - Windows page, but for now we only need the Phidget22.NET.dll file to run the Phidget C# examples in Mono. So remember where you unzipped these Windows libraries - you will need to copy the Phidget22.NET.dll file into your example directory shortly.
 
Next, you'll want to download and extract the Phidget C# Examples (For Windows, not for .NET Compact):
 
*[[#Example_Code|C# Examples for Windows]]
 
To check that your Linux, Phidget, and Mono setup is all working together, you'll want to run the C# examples. Specifically, you'll want to run the simple C# examples. You can either use the HelloWorld program that will work with any Phidget, or you can find the source code for your device. The source file will be named the same as the software object for your device. If you are not sure what the software object for your device is, find your Phidget on our [http://www.phidgets.com webpage], and then check the API documentation for it.
 
Let's say you're running the Temperature Sensor example (for the 1048 or 1051). The source code for the example is in the directory:
 
    TemperatureSensorExamples → TemperatureSensor-simple → TemperatureSensor-simple → Program.cs
 
Other examples will be in directories named appropriately for their software object name. Once you have found the example you want to run, copy the Phidget22.NET.dll file that you unzipped earlier into that example directory where the Program.cs file is.
 
Then, compile the code. When compiling, you need to link to the Phidget library. As the Phidget22.NET file is an "additional assembly" in C#/Mono, you can link to the assembly using the -r "reference" switch:
 
<syntaxhighlight lang='bash'>
  gmcs Program.cs -r:Phidget22.NET.dll
</syntaxhighlight>
 
This will compile a *.exe file - in this case, Program.exe. This you can then run under Mono:
 
<syntaxhighlight lang='bash'>
sudo mono Program.exe
</syntaxhighlight>
 
Remember that the sudo is needed unless you have your [[OS_-_Linux#Setting_udev_Rules|udev rules set on your Linux system]].
 
If you will be compiling with an IDE such as GTK# or MonoDevelop, we don't have explicit instructions by IDE for Linux. However, you will probably find the MonoDevelop section in the Windows portion above useful.
 
===Write Your Own Code===
 
When writing your code from scratch, you start it as you would any C# code on Linux, such as within a text editor like Emacs, Vi, Gedit, or Kate. In your .cs source code file, you must include a reference to the Phidget Library:
 
<syntaxhighlight lang='CSharp'>
using Phidgets;
using Phidgets.Events;
</syntaxhighlight>
 
Then, you would compile your completed C# code the same way as the examples above.
 
Mono also has a few different IDEs which you can use to develop code, and these are especially useful if you are doing GUI development. We provide instructions for MonoDevelop - one such IDE - being used under [[OS - Windows|Windows]].
 
To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Edit the Examples|teaching section]] to help you follow the provided C# examples and which has resources such as the API reference.
 
== Edit 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.
Your main reference for writing C# code will be the {{Phidget22API}} Manual.
 
=== Code Snippets ===
 
The following code snippets describe how to do various general tasks with Phidgets. You should be able to find places in the examples where these snippets exist, and modify them to suit your requirements.
 
==== Step One: Initialize and Open ====
The Open() function opens the software object, but not hardware. So, it is not a guarantee you can use the Phidget immediately.
 
For example, if we were using an Digital Input as our device, the create and open calls would look like this:
 
<syntaxhighlight lang=csharp>
using Phidget22;
using Phidget22.Events;
 
namespace Program
{
    class Code
    {
        static void Main(string[] args)
        {
            try
            {
 
                // Declare a DigitalInput object
                DigitalInput device = new DigitalInput();
 
                // Hook in any event handlers
                // ...
 
                // Open the device
                device.Open();
 
            }
            catch (PhidgetException ex) { Console.WriteLine(ex.Description); }
        }
    }
}
</syntaxhighlight>
 
==== Step Two: Wait for Attachment (plugging in) of the Phidget ====
To use the Phidget, it must be plugged in (attached). We can handle this simply by calling open with a number as a parameter in place of the basic open. This function works for any Phidget. This will block until a connection is made to the Phidget, or the specified timeout is exceeded:
 
<syntaxhighlight lang=C>
device.Open(5000);
</syntaxhighlight>
 
Sometimes, it makes more sense to handle the attachment via an event. This would be in instances where the Phidget is being plugged and unplugged, and you want to handle these incidents. Or, when you want to use event-driven programming because you have a GUI-driven program. In these cases, an event-driven code snippet to handle the attachment might look something like this:
 
<syntaxhighlight lang=CSharp>
void attachEventHandler(object sender, Phidget22.Events.AttachEventArgs e) {
{
  Phidget attachedDevice = (Phidget)sender;
  int serialNumber = attachedDevice.DeviceSerialNumber;
  string deviceName = attachedDevice.DeviceName;
  Console.WriteLine("Hello Device {0},  Serial Number: {1}!", deviceName, serialNumber.ToString());
}
</syntaxhighlight>
 
And the code to set up the event handler within the code opening your device might look like:
 
<syntaxhighlight lang=CSharp>
//Code for -creating- device here....
 
device.Attach += attachEventHandler;
 
//Code for -opening- device here....
</syntaxhighlight>
 
==== Step Three: Do Things with the Phidget ====
We recommend the use of event driven programming when working with Phidgets. This allows the program to execute other tasks until the Phidget generates a new event. You can hook a custom function into an event trigger like this, using a Digital Input Phidget as an example:
 
<syntaxhighlight lang=csharp>
device.StateChange += input_change;
</syntaxhighlight>
 
The input_change method is defined as follows:
 
<syntaxhighlight lang=csharp>
void input_change(object sender, Phidget22.Events.DigitalInputStateChangeEventArgs e) {
    textBox1.Text = "State: " + e.State;
}
</syntaxhighlight>
 
Some values can be directly read and set on the Phidget. These functions can be used inside a polling loop as an alternative to event driven programming. The line inside the loop would be something like this, after which you could do something with the value:
 
<syntaxhighlight lang=csharp>
bool val = device.State;
 
device.State = true;
</syntaxhighlight>
 
==== Step Four: Close and Delete ====
At the end of your program, be sure to close your device.
 
<syntaxhighlight lang=csharp>
private void Form1_FormClosing(object sender, FormClosingEventArgs e)  {
    Private Sub Form1_FormClosing(ByVal sender As Object, ByVal e As System.Windows.Forms.FormClosingEventArgs) Handles Me.FormClosing
        If device.Attached Then
            device.Close()
        End If
    End Sub
}
</syntaxhighlight>
 
== Further Reading ==
 
[[Phidget Programming Basics]] - Here you can find the basic concepts to help you get started with making your own programs that use Phidgets.
 
[[Data Interval/Change Trigger]] - Learn about these two properties that control how much data comes in from your sensors.
 
[[Using Multiple Phidgets]] - It can be difficult to figure out how to use more than one Phidget in your program. This page will guide you through the steps.
 
[[Polling vs. Events]] - Your program can gather data in either a polling-driven or event-driven manner. Learn the difference to determine which is best for your application.
 
[[Logging, Exceptions, and Errors]] - Learn about all the tools you can use to debug your program.


[[Phidget Network Server]] - Phidgets can be controlled and communicated with over your network- either wirelessly or over ethernet.
*{{SampleCode|CSharp|C# Examples}}

Latest revision as of 22:53, 19 December 2024


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.

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 .NET CLI 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.

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#.

Setup Guide

C# - Select Development Environment

Select your Development Environment:

Windows

MacOS

Linux

Language - C#

Windows with Visual Studio

Welcome to using Phidgets with C#! By using C#, you will have access to the complete Phidget22 API, including events.

Visual Studio is an IDE provided by Microsoft that can be used to develop code in a wide variety of programming languages, including C#.

Requirements

First, make sure you have the following installed:

● Phidgets Drivers for Windows

● Microsoft Visual Studio


Nuget

The Phidget22.NET library is now available on nuget.org here. Nuget is the recommended way to install and use the .NET library in Visual Studio. The nuget package bundles the C library on Windows, so there are no other prerequisites that need to be installed. The nuget package adds targets for .NET Core and .NET Standard, so it should be usable from almost any .NET environment which also supports the C library.

Using Phidgets in Your Programs

There are two ways you can use Phidgets in Visual Studio. You can either start from a sample project provided by our code sample generator, or you can start a new project from scratch.

Select your preferred method below for instructions:

Use our Code Sample

New Project

«
»

Visual Studio Code Sample

Finding Code Samples

To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.

Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.

The code samples we provide for C# are written to be used as Console Applications, but the concepts within can easily be re-purposed for use in a Windows Forms Application.

Using the Code Samples

If it's unclear what any of the options do, click on the nearby '?' for more info.

Once you've made your selections, click the Visual Studio Project button under Downloads.

Using the Code Samples

Extract the files and open the .sln file.

Then start the example by pressing the Start button:

What's Next?

Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.

«
»

Visual Studio New Project

Setting up a New Project

When you're building a project from scratch or adding Phidget code to an existing project, you need to properly link the Phidget .NET library.

Create a new project (a Console Application will be created for this example):

Setting up a New Project

Next, right-click on References in the solution explorer and choose Add Reference.

Setting up a New Project

On the following screen, click Browse... and navigate to the location of Phidget22.NET.dll:

C:\Program Files\Phidgets\Phidget22\Phidget22.NET.dll

Setting up a New Project

Finally, to include the Phidget .NET library, add the following lines to main window class file:

using Phidget22;
using Phidget22.Events;

Success! The project now has access to Phidgets.

What's Next?

Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.

«
»

Language - C#

Windows with Mono

Welcome to using Phidgets with C#! By using C#, you will have access to the complete Phidget22 API, including events.

Mono is an open-source programming environment that aims to make Microsoft .NET applications available across all operating systems.

Requirements

First, make sure you have the following installed:

● Phidgets Drivers for Windows

● Mono

Finding Code Samples

To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.

Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.

Using the Code Samples

If it's unclear what any of the options do, click on the nearby '?' for more info.

Once you've made your selections, click the Download Example button under Downloads.

Setting up a New Project

When you are building a project from scratch, or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget .NET library.

The easiest way to allow Mono to access the Phidgets .NET library is to place a copy of the Phidget22.NET dll in the same folder as your program.

First, determine which version of the .NET Framework your version of Mono implements by checking the Mono Release Documentation.

Next, download the Phidget22 Development Libraries, which contain dlls for each .NET version.

Navigate in the zip file to /lib/dotnet/netXX where 'XX' is your .NET Framework version (for example, net46 for .NET 4.6), and grab the Phidget22.NET.dll from that folder.

Setting up a New Project

Next, move the Phidget22.NET.dll you extracted into the same folder as your program.

Your folder should look somehting like this:

Compile and Run

Once you are ready to run your program, open the Command Prompt and navigate to your project folder. Next, enter the following command:

mcs /r:Phidget22.NET.dll Program.cs

This will create an executable file called Program.exe. Type in the following command to run the example:

mono Program.exe

Success! The project is now using Phidgets.

What's Next?

Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.

«
»

Language - C#

macOS with Mono

Welcome to using Phidgets with C#! By using C#, you will have access to the complete Phidget22 API, including events.

Mono is an open-source programming environment that aims to make Microsoft .NET applications available across all operating systems.

Requirements

First, make sure you have the following installed:

● Phidgets Drivers for macOS

● Mono

● You'll also need a copy of Phidget22.NET.dll

Finding Code Samples

To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.

Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.

Using the Code Samples

If it's unclear what any of the options do, click on the nearby '?' for more info.

Once you've made your selections, click the Download Example button under Downloads.

Setting up a New Project

Whether you are running our examples or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget .NET library.

The easiest way to allow Mono to access the Phidgets .NET library is to place a copy of the Phidget22.NET dll in the same folder as your program.

First, determine which version of the .NET Framework your version of Mono implements by checking the Mono Release Documentation.

Next, download the Phidget22 Development Libraries, which contain dlls for each .NET version.

Navigate in the zip file to /lib/dotnet/netXX where 'XX' is your .NET Framework version (for example, net46 for .NET 4.6), and grab the Phidget22.NET.dll from that folder.

Setting up a New Project

Next, move the Phidget22.NET.dll you extracted into the same folder as your program.

Finally, you need to create a configuration file. Create a new file in the same directory and name it Phidget22.NET.dll.config. Copy the content below to the file. 

<configuration>
<dllmap dll="phidget22.dll" target="/Library/Frameworks/Phidget22.framework/Versions/Current/Phidget22" />
</configuration>

Setting up a New Project

Your project directory should now look like this:

Compile and Run

Once you are ready to run your program, open the Terminal and navigate to your project folder. Next, enter the following command:

mcs Program.cs -r:Phidget22.NET.dll

This will create an executable file called Program.exe. Type in the following command to run your program:

mono Program.exe

Success! The project is now using Phidgets.

What's Next?

Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.

«
»

Language - C#

Linux with Mono

Welcome to using Phidgets with C#! By using C#, you will have access to the complete Phidget22 API, including events.

Mono is an open-source programming environment that aims to make Microsoft .NET applications available across all operating systems.

Requirements

First, make sure you have the following installed:

● Phidgets Drivers for Linux

● Mono

● A copy of Phidget22.NET.dll


You need our C development libraries in order to use Mono. You can install them with:

apt-get install libphidget22-dev

If you don't already have Mono installed, you can get it with:

apt-get install mono-complete

Setting UDev Rules

By default, Linux will not allow regular users to access physical hardware, as a security feature. This means that you must grant yourself root privileges via sudo to run Phidgets code.

sudo mono program.exe

To avoid having to use sudo every time, you can set up a rules file to allow it automatically using the vendor code for Phidget USB devices. Create a text file called 99-libphidget22.rules containing the following line:

SUBSYSTEMS=="usb", ACTION=="add", ATTRS{idVendor}=="06c2", ATTRS{idProduct}=="00[3-a][0-f]", MODE="666"

Mode 666 means every user has permission to read and write to the specified devices. Next, move this file to /etc/udev/rules.d. Now you can run code that uses Phidgets as a regular user without sudo.

Finding Code Samples

To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.

Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.

Using the Code Samples

If it's unclear what any of the options do, click on the nearby '?' for more info.

Once you've made your selections, click the Download Example button under Downloads.

Setting up a New Project

Whether you are running our examples or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget .NET library.

The easiest way to allow Mono to access the Phidgets .NET library is to place a copy of the Phidget22.NET dll in the same folder as your program.

First, determine which version of the .NET Framework your version of Mono implements by checking the Mono Release Documentation.

Next, download the Phidget22 Development Libraries, which contain dlls for each .NET version.

Navigate in the zip file to /lib/dotnet/netXX where 'XX' is your .NET Framework version (for example, net46 for .NET 4.6), and grab the Phidget22.NET.dll from that folder.

Setting up a New Project

Move the Phidget22.NET.dll you extracted into the same folder as your program.

Your project directory should now look like this:

Compile and Run

Once you are ready to run your program, open the Terminal and navigate to your project folder. Next, enter the following command:

mcs Program.cs -r:Phidget22.NET.dll

An executable file will be created. Run the program using mono with the following command:

mono Program.exe

Success! The project is now using Phidgets.

What's Next?

Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.

«
»

Language - C#

Linux with dotnet CLI

Welcome to using Phidgets with C#! By using C#, you will have access to the complete Phidget22 API, including events.

The dotnet command-line interface is the quickest way to start programming in C#.

Setting UDev Rules

By default, Linux will not allow regular users to access physical hardware, as a security feature. This means that you must grant yourself root privileges via sudo to run Phidgets code.

sudo dotnet run

To avoid having to use sudo every time, you can set up a rules file to allow it automatically using the vendor code for Phidget USB devices. Create a text file called 99-libphidget22.rules containing the following line:

SUBSYSTEMS=="usb", ACTION=="add", ATTRS{idVendor}=="06c2", ATTRS{idProduct}=="00[3-a][0-f]", MODE="666"

Mode 666 means every user has permission to read and write to the specified devices. Next, move this file to /etc/udev/rules.d. Now you can run code that uses Phidgets as a regular user without sudo.

Installing dotnet CLI

For installation instructions, visit Microsoft's documentation and select your Linux distro.

Usually, this will involve adding Microsoft packages to your repository and then installing dotnet via apt-get.

If you are a Visual Studio Code user, you can get the '.NET Install Tool' extension instead of installing manually.

Setting up a New Project

Create a new C# project using the following command:

dotnet new console -o helloworld

This will create a new C# console application in a folder named helloworld in your current directory. Next, enter the folder and type:

dotnet run

If everything installed properly, the application should build and you'll see 'Hello, World!' printed in the terminal.

Getting Phidgets Sample Code

Next we'll use this base project to run some Phidgets sample code. Go to the product page for your Phidget and go to the Code Samples tab. Select C# from the language drop-down and use the check boxes to modify the example if you'd like.

Click the copy button in the corner of the code sample and paste it into the Program.cs for your HelloWorld program, overwriting the existing code.

Compile and Run

Once you've pasted the sample code into the .cs file and saved, you need to add the Phidgets .NET package to your project:

dotnet add package Phidget22.NET

Then you can re-build the project using

dotnet run

Success! The project is now using Phidgets.

What's Next?

Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.

«
»

Language - C#

Windows with dotnet CLI

Welcome to using Phidgets with C#! By using C#, you will have access to the complete Phidget22 API, including events.

The dotnet command-line interface is the quickest way to start programming in C#.

Installing dotnet CLI

First, visit Microsoft's .NET download page and select the latest version. On the next page, download the SDK that matches your computer's architecture (usually x64).

Run the .exe file once it's finished downloading, and follow the steps to install the .NET SDK.

If you are a Visual Studio Code user, you can get the '.NET Install Tool' extension instead of installing manually.

Setting up a New Project

Open the command prompt by pressing the windows key, typing 'cmd' and pressing enter. Create a new C# project using the following command:

dotnet new console -o helloworld

This will create a new C# console application in a folder named helloworld in your current directory. Next, type cd helloworld to enter the folder, and type:

dotnet run

If everything installed properly, the application will build and you'll see 'Hello, World!' printed in the terminal. You can open Program.cs using the text editor to see the code.

Getting Phidgets Sample Code

Next we'll use this base project to run some Phidgets sample code. Go to the product page for your Phidget and go to the Code Samples tab. Select C# from the language drop-down and use the check boxes to modify the example if you'd like.

Click the copy button in the corner of the code sample and paste it into the Program.cs for your HelloWorld program, overwriting the existing code.

Compile and Run

Once you've pasted the sample code into the .cs file and saved, you need to add the Phidgets .NET package to your project using this terminal command:

dotnet add package Phidget22.NET

Then you can re-build the project using

dotnet run

Success! The project is now using Phidgets.

What's Next?

Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.

«
»

Language - C#

MacOS with dotnet CLI

Welcome to using Phidgets with C#! By using C#, you will have access to the complete Phidget22 API, including events.

The dotnet command-line interface is the quickest way to start programming in C#.

Installing dotnet CLI

If you plan on using any USB Phidgets that use the HID stack, you'll need to install the Phidget drivers for MacOS. You can check which stack your USB Phidgets use by checking the 'USB Stack' in the product specifications. If all of your Phidgets use the PHIDUSB stack, you can skip installing the drivers.

Next, visit Microsoft's .NET page and download .NET after confirming compatibility with your version of MacOS.

Click on the .pkg file once it's finished downloading, and follow the steps to install the .NET SDK.

If you are a Visual Studio Code user, you can get the '.NET Install Tool' extension instead of installing manually.

Setting up a New Project

Open Finder and go to Utilities -> Terminal. Create a new C# project using the following command:

dotnet new console -o helloworld

This will create a new C# console application in a folder named helloworld in your current directory. Next, type cd helloworld to enter the folder, and type:

dotnet run

If everything installed properly, the application will build and you'll see 'Hello, World!' printed in the terminal. You can open Program.cs using the text editor to see the code.

Getting Phidgets Sample Code

Next we'll use this base project to run some Phidgets sample code. Go to the product page for your Phidget and go to the Code Samples tab. Select C# from the language drop-down and use the check boxes to modify the example if you'd like.

Click the copy button in the corner of the code sample and paste it into the Program.cs for your HelloWorld program, overwriting the existing code.

Compile and Run

Once you've pasted the sample code into the .cs file and saved, you need to add the Phidgets .NET package to your project using this terminal command:

dotnet add package Phidget22.NET

Then you can re-build the project using

dotnet run

Success! The project is now using Phidgets.

What's Next?

Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.

«
»

Language - C#

Windows with MonoDevelop / Xamarin Studio

Welcome to using Phidgets with C#! By using C#, you will have access to the complete Phidget22 API, including events.

MonoDevelop is an open-source programming environment that mimics the capabilities of Microsoft Visual Studio and is available across all operating systems.

Requirements

First, make sure you have the following installed:

● Phidgets Drivers for Windows

● MonoDevelop or Xamarin Studio

Setting up a New Project

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.

First, create a new .NET project:

Setting up a New Project

Name the project and click Create.

Setting up a New Project

Next, add a reference to the Phidget .NET library:

Setting up a New Project

On the following screen, select Phidget22.NET.dll:

Success! The project now has access to Phidgets.

Finding Code Samples

To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.

Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.

Using the Code Samples

If it's unclear what any of the options do, click on the nearby '?' for more info.

Once you've made your selections, click the copy button and paste the code into your new project.

What's Next?

Now that you've set up Phidgets in your programming environment, you should read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.

«
»


Quick Downloads

If you already know what you're doing and just need the files, you can find them all below.

Documentation

Example Code

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