Difference between revisions of "Language - C Sharp"

From Phidgets Support
Jump to: navigation, search
 
(3 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#.
 +
 
 +
==Choose Your Development Environment:==
 +
 
 +
{{Language_-_CSharp_Dev_Environment_Table}}
  
 
== 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 26:
  
 
{{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 22:14, 28 February 2019


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

Choose Your Development Environment:

C# Development Environments
OS - Windows Windows

CS VS WIN.png CS VS WIN on.png

CS MONO WIN.png CS MONO WIN on.png

CS MONODEV WIN.png CS MONODEV WIN on.png

OS - macOS macOS

CS MONO MAC.png CS MONO MAC on.png

OS - Linux Linux

CS MONO LNX.png CS MONO LNX on.png

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