Language - C Sharp: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<metadesc>Communicate over USB with sensors, controllers and relays with Phidgets! Our C# library supports Windows/MacOS/Linux using Visual Studio or Mono.</metadesc>
<metadesc>Communicate over USB with sensors, controllers and relays with Phidgets! Our C# library supports Windows/MacOS/Linux using Visual Studio or Mono.</metadesc>
[[Category:Language]]
[[Category:Language]]
__TOC__
__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.
 
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.
 
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 ==
<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}}
 
</div>
 


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


Line 15: Line 30:


{{AllQuickDownloads}}
{{AllQuickDownloads}}
===Nuget===
The Phidget22.NET library is now available on nuget.org [https://www.nuget.org/packages/Phidget22.NET/ here]. Nuget is the recommended way to install and use the .NET library. 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.
== Getting Started with C# ==
Welcome to using Phidgets with C#! By using C#, you will have access to the complete {{Phidget22API}}, including events. We also provide example code in C# for all Phidget devices.
Note that the following sections talk about installing the .NET library manually, but it is also possible to install from nuget.org.
If you are developing for Windows, keep reading. Otherwise, select your operating system to jump ahead:
*[[#macOS | macOS]]
*[[#Linux | Linux]]
== Windows ==
{{Windows_Languages}}
===Visual Studio===
====Use Our Examples====
One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install [https://www.visualstudio.com/ Microsoft Visual Studio].
Now that you have Microsoft Visual Studio installed, select an example that will work with your Phidget:
*{{SampleCode|CSharp|C# Examples}}
Open the example project and start the example by pressing the ''Start'' button:
[[File:Csharp_visualstudio_run.png ‎|link=|center]]
The application will open the Phidget, list basic information about the Phidget, and demonstrate the Phidget's functionality. Here is an example of a Digital Output channel on a RFID Phidget:
[[File:Csharp_visualstudio_rfid.PNG|link=|center]]
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
=====VINT Hub=====
If you are trying to connect to one of the VINT hub ports directly rather than to a VINT device connected through a VINT hub then there is one additional step.  There is a isHubPort property of the Phidget class that must be set before calling open.  It defaults to false but in this case it will need to be set to true.  In our examples this is done via command line though in practice you can just set it before calling open.  To add command line parameters to your project in Visual Studio, you can go to the Project->Properties screen.  Under the Debug section there is a field to enter command line parameters for startup.  Use "-h" to make sure isHubPort is set before open is called and then you should be good to go.
[[File:Csharp_visualstudio_commandLineParameters.png|link=|center]]
====Configure Your 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. To begin:
Create a new Windows Forms Application project:
[[Image:CSharp_VS2015_New_Project.png|link=|center]]
Next, right-click to add a reference to the Phidget .NET library:
[[Image:CSharp_VS2015_Add_Reference.png|link=|center]]
On the following screen, click ''Browse...'' and navigate to the location of Phidget22.NET.dll:
*C:\Program Files\Phidgets\Phidget22\Phidget22.NET.dll
[[Image:CSharp_VS2015_Add_Reference_2.png|link=|center]]
Finally, to include the Phidget .NET library, add the following lines to main window class file:
<syntaxhighlight lang="csharp">
using Phidget22;
using Phidget22.Events;
</syntaxhighlight>
Success! The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
===Mono===
====Use Our Examples====
One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install [http://www.mono-project.com/download/ Mono] for Windows.
Now that you have Mono installed, download and unpack the HelloWorld example for C#:
*[{{SERVER}}/downloads/phidget22/examples/dotnet/csharp/Manager/Phidget22_HelloWorld_CSharp_Windows_Ex.zip HelloWorld example]
Note: The HelloWorld example is compatible with Mono because it does not use Windows Forms. All other C# examples use Windows Forms.
Next, copy Phidget22.NET.dll from type the following location:
*C:\Program Files\Phidgets\Phidget22\Phidget22.NET.dll
Place both the HelloWorld example and the Phidget22.NET.dll file in the same location. Your folder should now look something like this:
[[File:Csharp_mono_folder.PNG|link=|center]]
Open the command prompt at the folder location and enter the following command:
<syntaxhighlight lang='bash'>
mcs /r:Phidget22.NET.dll Program.cs
</syntaxhighlight>
This will create an executable file called ''Program.exe''. Type in the following command to run the example:
<syntaxhighlight lang='bash'>
mono Program.exe
</syntaxhighlight>
[[File:Csharp_mono.PNG|link=|center]]
You should now have the example up and running. When you are ready, the next step is configuring your project and writing your own code!
====Configure Your Project====
When you are building a project from scratch, or adding Phidget functionality to an exisiting project, you'll need to configure your development environment to properly link the Phidget .NET library.
To include the Phidget .NET library, simply add the following lines to your code:
<syntaxhighlight lang='CSharp'>
using Phidget22;
using Phidget22.Events;
</syntaxhighlight>
You can now compile the file as shown in the previous section.
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
===MonoDevelop/Xamarin Studio===
====Use Our Examples====
One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install [http://www.monodevelop.com/download/ Xamarin Studio] for Windows.
Now that you have Xamarin Studio installed, select an example that will work with your Phidget:
*{{SampleCode|CSharp|C# Examples}}
Next, open the example project:
[[Image: Csharp_xamarin.PNG|link=|center]]
Right click the project, and click Run Item:
[[Image: Chsarp_xamarin_run.png|link=|center]]
The application will open the Phidget, list basic information about the Phidget, and demonstrate the Phidget's functionality. Here is an example of a Digital Output channel on a RFID Phidget:
[[File:Csharp_visualstudio_rfid.PNG|link=|center]]
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
====Configure Your 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. To begin:
Create a new .NET project:
[[Image:Csharp_xamarin_newproject.PNG|link=|center]]
[[Image:Csharp_xamarin_nameproject.PNG|link=|center]]
Next, add a reference to the Phidget .NET library:
[[Image:Csharp_xamarin_editreference.png|link=|center]]
On the following screen, select Phidget22.NET.dll:
[[Image:Csharp_xamarin_addreference.PNG|link=|center]]
Finally, to include the Phidget .NET library, add the following lines to main window class file:
<syntaxhighlight lang='CSharp'>
  using Phidget22;
  using Phidget22.Events;
</syntaxhighlight>
Success! The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
==macOS==
{{macOS_Languages}}
===Mono===
====Use Our Examples====
One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install [http://www.mono-project.com/download/ Mono] for macOS. You will also need a copy of [{{SERVER}}/downloads/phidget22/libraries/windows/Phidget22-windevel.zip Phidget22.NET.dll].
Now that you have Mono installed and Phidget22.NET.dll on hand, download and unpack the HelloWorld example for C#:
*[{{SERVER}}/downloads/phidget22/examples/dotnet/csharp/Manager/Phidget22_HelloWorld_CSharp_Windows_Ex.zip HelloWorld example download]
Note: The HelloWorld example is compatible with Mono because it does not use Windows Forms. All other C# examples use Windows Forms.
Finally, you need to create a configuration file. Create a new file in the same directory as the example you wish to compile and name it Phidget22.NET.dll.config. Copy the content below to the file.
<syntaxhighlight lang='xml'>
  <configuration>
  <dllmap dll="phidget22.dll" target="/Library/Frameworks/Phidget22.framework/Versions/Current/Phidget22" />
  </configuration>
</syntaxhighlight>
Your project folder should now look like this:
[[Image:Csharp_macos_mono_folder.png|link=|center]]
To compile the program, enter the following command in the terminal:
<syntaxhighlight lang='bash'>
mcs Program.cs -r:Phidget22.NET.dll
</syntaxhighlight>
An executable file will be created. Run the program using mono:
<syntaxhighlight lang='bash'>
mono Program.exe
</syntaxhighlight>
[[Image:Csharp_macos_mono_run.png|link=|center]]
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
====Configure Your Project====
When you are building a project from scratch, or adding Phidget functionality to an exisiting project, you'll need to configure your development environment to properly link the Phidget .NET library.
To include the Phidget .NET library, simply add the following lines to your code:
<syntaxhighlight lang='CSharp'>
using Phidget22;
using Phidget22.Events;
</syntaxhighlight>
You can now compile the file as shown in the previous section.
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
== Linux ==
{{Linux_Languages}}
===Mono===
====Use Our Examples====
One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install Mono. You can do this by entering the following command in the terminal:
<syntaxhighlight lang='bash'>
apt-get install mono-complete
</syntaxhighlight>
You will also need a copy of [{{SERVER}}/downloads/phidget22/libraries/windows/Phidget22-windevel.zip Phidget22.NET.dll].
Now that you have Mono installed and Phidget22.NET.dll on hand, download and unpack the HelloWorld example for C#:
*[{{SERVER}}/downloads/phidget22/examples/dotnet/csharp/Manager/Phidget22_HelloWorld_CSharp_Windows_Ex.zip HelloWorld example download]
Note: The HelloWorld example is compatible with Mono because it does not use Windows Forms. All other C# examples use Windows Forms.
Your project folder should now look like this:
[[Image:Csharp_linux_folder.PNG|link=|center]]
Finally, to compile the program, enter the following command in the terminal:
<syntaxhighlight lang='bash'>
mcs Program.cs -r:Phidget22.NET.dll
</syntaxhighlight>
An executable file will be created. Run the program using mono:
<syntaxhighlight lang='bash'>
mono Program.exe
</syntaxhighlight>
[[Image:Csharp_linux_mono_run.PNG|link=|center]]
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
====Configure Your Project====
When you are building a project from scratch, or adding Phidget functionality to an exisiting project, you'll need to configure your development environment to properly link the Phidget .NET library.
To include the Phidget .NET library, simply add the following lines to your code:
<syntaxhighlight lang='CSharp'>
using Phidget22;
using Phidget22.Events;
</syntaxhighlight>
You can now compile the file as shown in the previous section.
The project now has access to Phidgets. Next, view the [[#Write Code | write your own code]] section located below.
==Write Code==
{{WriteCode_Intro|C#}}
==== Step One: Initialize and Open ====
You will need to declare your Phidget object in your code. For example, we can declare a digital input object like this:
<syntaxhighlight lang=csharp>
DigitalInput ch;
</syntaxhighlight>
Next, the Phidget object needs to be initialized and opened:
<syntaxhighlight lang=cSharp>
ch = new DigitalInput();
ch.Open();
</syntaxhighlight>
Although we are not including it on this page, you should include error handling for all Phidget functions. Here is an example of the previous code with error handling:
<syntaxhighlight lang=cSharp>
try{
  ch = new DigitalInput();
  ch.Open();
}catch(PhidgetException ex){
  Console.WriteLine("Error: " + ex.Description);
}
</syntaxhighlight>
==== Step Two: Wait for Attachment of the Phidget ====
Simply calling open does not guarantee you can use the Phidget immediately. To use a Phidget, it must be plugged in (attached). We can handle this by using event driven programming and tracking the attach events. Alternatively, we can modify our code so we wait for an attachment:
<syntaxhighlight lang=CSharp>
ch = new DigitalInput();
ch.Open(5000); //wait for attach for 5 seconds, if not time out
</syntaxhighlight>
Waiting for attachment will block indefinitely until a connection is made, or until the timeout value is exceeded.
To use events, we have to modify our code slightly:
<syntaxhighlight lang=CSharp>
ch = new DigitalInput();
ch.Attach += onAttachHandler;
ch.Open();
</syntaxhighlight>
Next, we have to declare the function that will be called when an attach event is fired - in this case the function ''onAttachHandler'' will be called.
<syntaxhighlight lang=CSharp>
void onAttachHandler (object sender, Phidget22.Events.AttachEventArgs e){
  attachedText.Text = "Attached";
}
</syntaxhighlight>
==== Step Three: Do Things with the Phidget ====
We recommend the use of event driven programming when working with Phidgets. In a similar way to handling an attach event as described above, we can also add an event handler for a state change event:
<syntaxhighlight lang=csharp>
ch = new DigitalInput();
ch.Attach += onAttachHandler;
ch.StateChange += onStateChangeHandler;
ch.Open();
</syntaxhighlight>
This code will connect a function and an event. In this case, the ''onStateChangeHandler'' function will be called when there has been a change to the devices input. Next, we need to create the ''onStateChangeHandler'' function:
<syntaxhighlight lang=cSharp>
void onStateChangeHandler(object sender, Phidget22.Events.DigitalInputStateChangeEventArgs e) {
    stateText.Text = "State: " + e.State;
}
</syntaxhighlight>
If events do not suit your needs, you can also poll the device directly for data using code like this:
<syntaxhighlight lang=cSharp>
stateText.Text = "State: " + ch.State;
</syntaxhighlight>
==== Step Four: Close and Delete ====
At the end of your program, be sure to close your device.
<syntaxhighlight lang=cSharp>
ch.Close()
</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.

Latest revision as of 21:03, 27 May 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 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.

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 (see Part 1 of this user guide)

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

Continue reading below for advanced information and troubleshooting for your device.

«
»

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.

Continue reading below for advanced information and troubleshooting for your device.

«
»

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 (see Part 1 of this user guide)

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

Continue reading below for advanced information and troubleshooting for your device.

«
»

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 (see Part 1 of this user guide)

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

Continue reading below for advanced information and troubleshooting for your device.

«
»

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 (see Part 1 of this user guide)

● 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

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.

Continue reading below for advanced information and troubleshooting for your device.

«
»

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# on Linux and MacOS.

Requirements

First, make sure you have the Phidgets Drivers for Linux installed (see this page for installation instructions).


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

apt-get install libphidget22-dev

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.

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.

Continue reading below for advanced information and troubleshooting for your device.

«
»

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# on MacOS and Linux.

Installing dotnet CLI

First, make sure you have the Phidgets Drivers for MacOS installed (see this page for installation instructions).

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.

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.

Continue reading below for advanced information and troubleshooting for your device.

«
»

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 (see Part 1 of this user guide)

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

Continue reading below for advanced information and troubleshooting for your device.

«
»


Quick Downloads

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

Documentation

Example Code

Libraries

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