|
|
| (3 intermediate revisions by 2 users not shown) |
| Line 6: |
Line 6: |
| 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. | | 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. |
|
| |
|
| General information of how to use Phidgets with C# can be found in the '''Write Code''' section of each development environment page. This information is consistent across all pages.
| | 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:== | | == 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> |
|
| |
|
| {{Language_-_CSharp_Dev_Environment_Table}}
| |
|
| |
|
| == Quick Downloads == | | == Quick Downloads == |
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
Select your Development Environment:
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:
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.
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.
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.
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.
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.
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.
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.
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
