Difference between revisions of "Language - C Sharp Windows Visual Studio"

From Phidgets Support
Jump to: navigation, search
 
Line 17: Line 17:
 
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 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.
 
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 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.
  
==Use Our Examples==
+
==Using Phidgets in Your Programs==
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].
+
  
 +
There are two main ways you can go about adding Phidgets to your programs in Visual Studio. You can either start from a working project provided by the Phidgets code sample generator, or you can add the Phidgets libraries to an existing Visual Studio project.
  
Now that you have Microsoft Visual Studio installed, select an example that will work with your Phidget:
+
Select your preferred method below for instructions:
*{{SampleCode|CSharp|C# Examples}}
+
  
  
Open the example project and start the example by pressing the ''Start'' button:
+
<tabber>
 +
Using Code Samples=
 +
{{Finding Code Samples|C#|CSharp}}
  
  
[[File:Csharp_visualstudio_run.png ‎|link=|center]]
+
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==
  
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:
+
You can download a working '''Visual Studio''' project for '''C#''' directly from the [{{server}}/?view=code_samples&lang=CSharp Code Samples] page. Simply make your selections, and click the '''Visual Studio Project''' button under '''Downloads'''.
  
 +
[[File:CSharp_Visual_Studio_Sample_Download.jpg|border|center|800px|link=]]
  
[[File:Csharp_visualstudio_rfid.PNG|link=|center]]
 
  
 +
Open the example project and start the example by pressing the ''Start'' button:
  
{{Edit_the_Examples}}
+
[[File:Csharp_visualstudio_run.png ‎|link=|center]]
  
==Editing the Examples==
+
|-|
 
+
Adding Phidgets to an Existing Project=
The C# examples are what comprise the Windows [[Phidget Control Panel]], so you'll need to modify a few things to adapt them for your own purposes. To begin with, you can remove the following line:
+
<syntaxhighlight lang='CSharp'>
+
commandLineData phidgetParameters = open.parseCmdLine(); //get command line parameters
+
</syntaxhighlight>
+
Then, you can modify any line that mentions <code>phidgetParameters</code> by setting it to the desired value instead of using PhidgetParameters object.
+
 
+
For instance:
+
<syntaxhighlight lang='CSharp'>
+
try
+
{ //set all the values grabbed from command line.  these values have defaults that are set in ExampleUtils.cs, you can check there to see them.
+
    digout.Channel = phidgetParameters.Channel; //selects the channel on the device to open
+
    digout.DeviceSerialNumber = phidgetParameters.SerialNumber; //selects the device or hub to open
+
    digout.HubPort = phidgetParameters.HubPort; //selects the port on the hub to open
+
    digout.IsHubPortDevice = phidgetParameters.isHubPortDevice; //is the device a port on a VINT hub?
+
 
+
    if (phidgetParameters.isRemote) //are we trying to open a remote device?
+
    {
+
        digout.IsRemote = true;
+
        Net.EnableServerDiscovery(ServerType.Device); //turn on network scan
+
        if (phidgetParameters.Password != null && phidgetParameters.ServerName != null)
+
            Net.SetServerPassword(phidgetParameters.ServerName, phidgetParameters.Password); //set the password if there is one
+
    }
+
    else
+
        digout.IsLocal = true;
+
 
+
    digout.Open(); //open the device specified by the above parameters
+
}
+
catch (PhidgetException ex) { errorBox.addMessage("Error opening device: " + ex.Message); }
+
</syntaxhighlight>
+
 
+
Might become:
+
 
+
<syntaxhighlight lang='CSharp'>
+
try
+
{
+
    digout.Channel = 0;
+
    digout.DeviceSerialNumber = 370097;
+
    digout.HubPort = 0;
+
    digout.IsHubPortDevice = true;
+
    digout.IsRemote = false;   
+
    digout.Open();
+
}
+
catch (PhidgetException ex) { errorBox.addMessage("Error opening device: " + ex.Message); }
+
</syntaxhighlight>
+
 
+
 
+
You can then manipulate the rest of the code as your application requires. A more in-depth description of programming with Phidgets will be covered in the next section.
+
  
 
==Setting up a New Project==
 
==Setting up a New Project==
Line 93: Line 49:
  
  
Create a new project (a Windows Forms Application will be created for this example):
+
Create a new project (a Console Application will be created for this example):
  
<tabber>
+
{{#tag:tabber|
 
Visual Studio 2017=
 
Visual Studio 2017=
[[Image:CSharp_VS2017_New_Project.png|link=|center|700px]]
+
[[Image:CSharp_VS2017_New_Project_Console.png|link=|center|700px]]
|-|
+
{{!}}-{{!}}
 
Visual Studio 2015=
 
Visual Studio 2015=
[[Image:CSharp_VS2015_New_Project.png|link=|center|700px]]
+
[[Image:CSharp_VS2015_New_Project_Console.png|link=|center|700px]]
</tabber>
+
}}
  
  
Line 114: Line 70:
  
  
[[Image:CSharp_VS2015_Add_Reference_2.png|link=|center]]
+
[[Image:CSharp_VS2015_Add_Reference_2.png|link=|center|850px]]
  
  
Line 125: Line 81:
  
 
Success! The project now has access to Phidgets.
 
Success! The project now has access to Phidgets.
 +
 +
</tabber>
 +
  
 
{{Language Page What's Next}}
 
{{Language Page What's Next}}

Latest revision as of 21:24, 16 October 2019

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

Install Phidget Drivers for Windows

Before getting started with the guides below, ensure you have the following components installed on your machine:

  1. You will need the Phidgets Windows Drivers

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 main ways you can go about adding Phidgets to your programs in Visual Studio. You can either start from a working project provided by the Phidgets code sample generator, or you can add the Phidgets libraries to an existing Visual Studio project.

Select your preferred method below for instructions:


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.

CSharp sample code.jpg


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

You can download a working Visual Studio project for C# directly from the Code Samples page. Simply make your selections, and click the Visual Studio Project button under Downloads.

CSharp Visual Studio Sample Download.jpg


Open the example project and start the example by pressing the Start button:

Csharp visualstudio run.png

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. To begin:


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

CSharp VS2017 New Project Console.png

CSharp VS2015 New Project Console.png


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


CSharp VS2015 Add Reference.png


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

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


CSharp VS2015 Add Reference 2.png


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 have set up Phidgets to work with your programming environment, we recommend you read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.Next Arrow.png