Language - C Sharp Windows MonoDevelop: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Language]]
[[Category:Language]]{{NoTitle}}
{{NoTitle}}
{{Language_-_CSharp_Dev_Environment_Table}}
{|
{|
|style="vertical-align:middle; width: 60%;"|
|style="vertical-align:middle; width: 60%;"|
Line 15: Line 13:


{{Language_-_C_Sharp_Intro|Windows|Visual Studio}}
{{Language_-_C_Sharp_Intro|Windows|Visual Studio}}
 
{{Finding Code Samples|C#|CSharp}}
==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!
 
==Editing the Examples==
 
You'll need to modify a few things to adapt these examples for your own purposes. Start by removing 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 102: Line 22:




[[Image:Csharp_xamarin_newproject.PNG|link=|center]]
[[Image:Csharp_xamarin_newproject.PNG|link=|center|850px]]




[[Image:Csharp_xamarin_nameproject.PNG|link=|center]]
[[Image:Csharp_xamarin_nameproject.PNG|link=|center|850px]]




Line 111: Line 31:




[[Image:Csharp_xamarin_editreference.png|link=|center]]
[[Image:Csharp_xamarin_editreference.png|link=|center|850px]]




Line 117: Line 37:




[[Image:Csharp_xamarin_addreference.PNG|link=|center]]
[[Image:Csharp_xamarin_addreference.PNG|link=|center|850px]]




Finally, to include the Phidget .NET library, add the following lines to main window class file:
Success! The project now has access to Phidgets.


<syntaxhighlight lang='CSharp'>
==Using the Code Samples==
  using Phidget22;
Now that you have configured a project to use Phidgets, you can copy the code sample from the [{{server}}/?view=code_samples&lang=CSharp Code Samples] page into your project, and run it.
  using Phidget22.Events;
</syntaxhighlight>
 
Success! The project now has access to Phidgets. You can now continue to write code as described in the [[#Write Code|Write Code]] section.
 
Success! The project now has access to Phidgets.


{{Language Page What's Next}}
{{Language Page What's Next}}

Revision as of 21:46, 16 October 2019

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.

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

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.

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


Create a new .NET project:


Csharp xamarin newproject.PNG


Csharp xamarin nameproject.PNG


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


Csharp xamarin editreference.png


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


Csharp xamarin addreference.PNG


Success! The project now has access to Phidgets.

Using the Code Samples

Now that you have configured a project to use Phidgets, you can copy the code sample from the Code Samples page into your project, and run it.

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