Language - C Sharp Windows Mono: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
Line 13: Line 13:


{{Language_-_C_Sharp_Intro|Windows|Mono}}
{{Language_-_C_Sharp_Intro|Windows|Mono}}
*You will also need to install [https://www.mono-project.com/download/stable/ Mono] on your machine


==Use Our Examples==
{{Finding Code Samples|C#|CSharp}}
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.


==Using the Code Samples==
To use the code sample from the [{{server}}/?view=code_samples&lang=CSharp Code Samples] page, you can click the '''Download Example''' button to download a CS file with the sample code.


Now that you have Mono installed, download and unpack the HelloWorld example for C#:
[[Image:CSharp_Sample_Code_Download.png|link=|center|800px]]
*[{{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 and thus cannot be used directly with Mono.




Next, copy Phidget22.NET.dll from type the following location:
Once you have the example, you can compile and run your code:
*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!
 
==Editing the Examples==
 
With the exception of the HelloWorld example mentioned earlier, the C# examples are what comprise the Windows [[Phidget Control Panel]]. These are all graphical examples, and Mono is a non-graphical environment so you'll need to modify a few things to adapt them for your own purposes. Start with copying the contents of '''Form1_Load''' from one of the examples into your mono program's main function.
 
Next, 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'll also have to remove some references to graphical elements such as {{Code|ErrorEventBox}}. If you assign event handler functions, you'll have to define them before your main function, similar to the manager events in the HelloWorld example we covered earlier.
 
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==


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.
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 include the Phidget .NET library, simply add the following lines to the top of your code:
<syntaxhighlight lang='CSharp'>
using Phidget22;
using Phidget22.Events;
</syntaxhighlight>


Then, proceed to add your code to your main function.
The easiest way to allow Mono to access the Phidgets .NET library is to place a copy of ''Phidget22.NET.dll'' from the following location in the same folder as your program:
*'''C:\Program Files\Phidgets\Phidget22\Phidget22.NET.dll'''


Next, copy Phidget22.NET.dll from type the following location, and place in in the same folder as your program:
Your folder should look somehting like this:
*C:\Program Files\Phidgets\Phidget22\Phidget22.NET.dll
[[Image:CSharp_mono_folder_new_project.png|link= | center]]


Open the command prompt at the folder location and enter the following command:
==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:
<syntaxhighlight lang='bash'>
<syntaxhighlight lang='bash'>
mcs /r:Phidget22.NET.dll Program.cs
mcs /r:Phidget22.NET.dll Program.cs
Line 127: Line 46:
</syntaxhighlight>
</syntaxhighlight>


Success! The project now has access to Phidgets.
[[Image:CSharp_Windows_Mono_Run_Example.png|link=|center]]
 
Success! The project is now using Phidgets.


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

Revision as of 21:31, 16 October 2019

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.

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
  • You will also need to install Mono on your machine

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.

Using the Code Samples

To use the code sample from the Code Samples page, you can click the Download Example button to download a CS file with the sample code.

CSharp Sample Code Download.png


Once you have the example, you can compile and run your code:

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 Phidget22.NET.dll from the following location in the same folder as your program:

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

Your folder should look somehting like this:

CSharp mono folder new project.png

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
CSharp Windows Mono Run Example.png

Success! The project is now using 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