Language - C Sharp: Difference between revisions

From Phidgets Support
No edit summary
 
(128 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{#seo:|description=Learn how to use Phidget USB devices with C#.}}
[[Category:Language]]
[[Category:Language]]
[[File:icon-CSharp.png|64x64px||link=|alt=]]C# is a modern, object-oriented programming language developed by [[http://www.microsoft.com Microsoft]].


__TOC__
==Get Started==
With the Phidget22.NET library, it's easy to create C# applications that work with Phidget devices.


==Introduction==
==C# Libraries==
===Nuget Package===
The Phidget22.NET library is available as a [https://www.nuget.org/packages/Phidget22.NET/ nuget package]. This is the recommend way to install and manage the Phidget22.NET library.


{{LanguageSupport|C#|the complete Phidget API, including events|all Phidget devices.|the .NET or Mono framework. Both of the frameworks are supported on Windows. For Linux and Mac OS X, only the Mono framework can be used. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]], [[#Visual Studio 2003 | Visual Studio 2003]], [[#MonoDevelop | MonoDevelop]] and the [[#Mono | Mono command line compilers]]|}}
====macOS Considerations====
Phidget devices running a HID USB stack require the installation of the macOS libraries or the standalone Phidget Control Panel ([{{SERVER}}/docs/OS_-_macOS download here]).


==Quick Downloads==
To determine what USB stack your Phidget device is on, navigate to the product page and then to the specification tab, and look for the ''USB Stack'' specification. If you are using a VINT device, navigate to the product page for the VINT Hub you are using.


Just need the C# documentation, drivers, libraries, and examples?  Here they are:
[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/Javascript_networkserver_webusb_spec.png]]


===API Documentation===
====Linux Considerations====
*[http://www.phidgets.com/documentation/Phidget21.NET.zip API Manual]
Linux restricts access to USB devices to the root user. To run your .NET application as a regular user, you'll need to [{{SERVER}}/docs/OS_-_Linux#Setting_udev_Rules set up udev rules] on your system.


===Example Code===
===Library Files===
If you would like to manually manage the Phidget22.NET library files, you can download them [https://cdn.phidgets.com/downloads/phidget22/libraries/windows/Phidget22-windevel.zip here].


*[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Example Code]
==Development Environment Configuration==
===Visual Studio===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| Create your Visual Studio project, and navigate to the '''Solution Explorer'''. From there, right-click on '''Dependencies''' and select '''Manage NuGet Packages...'''|| [[Image:Language_csharp_vs_managenuget.png|center|350px|link=https://cdn.phidgets.com/docs/images/c/cc/Language_csharp_vs_managenuget.png]]
|-
| Next, click '''Browse''' and enter '''Phidget22.NET''' in the search bar. || [[Image:Language_csharp_vs_browsenuget.png|center|350px|link=https://cdn.phidgets.com/docs/images/6/61/Language_csharp_vs_browsenuget.png]]
|-
| Click on the package and press the '''Install''' button. || [[Image:Language_csharp_vs_installnuget.png|center|350px|link=https://cdn.phidgets.com/docs/images/b/b8/Language_csharp_vs_installnuget.png]]
|-
| Finally, add your C# code and run it using the button at the top of the screen. || [[Image:Language_csharp_vs_run.png|center|350px|link=https://cdn.phidgets.com/docs/images/5/5a/Language_csharp_vs_run.png]]
|-
|}


===Libraries and Drivers===
===Visual Studio Code===
*[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip .NET Framework Files]
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
*[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip 32 bit Windows Drivers and Libraries]
|+ '''Instructions'''
*[http://www.phidgets.com/downloads/libraries/phidget21-x64_2.1.8.20110615.zip 64 bit Windows Drivers and Libraries]
| Install the [https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit C# Dev Kit extension for Visual Studio Code].|| [[Image:Language_csharp_vscode_installext.png|center|350px|link=https://cdn.phidgets.com/docs/images/b/b8/Language_csharp_vscode_installext.png]]
*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20111220.exe 32-bit Windows Drivers Installer]
|-
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20111220.exe 64-bit Windows Drivers Installer]
| Next, create a directory and open it in Visual Studio Code. You can do this by opening Visual Studio Code and selecting '''File > Open Folder...''' || [[Image:Language_csharp_vscode_newfolder.png|center|350px|link=https://cdn.phidgets.com/docs/images/4/43/Language_csharp_vscode_newfolder.png]]
*[http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20111028.tar.gz Linux Libraries (Source Code)]  
|-
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20111103.dmg Mac OS X Drivers Installer]
| Open the Command Palette (Ctrl + Shift + P), type '''.NET: New Project''', and press Enter. A list of supported project types will appear. || [[Image:Language_csharp_vscode_netnewproject.png|center|350px|link=https://cdn.phidgets.com/docs/images/f/f7/Language_csharp_vscode_netnewproject.png]]
|-
| Select your preferred project type from the list. For this example, we will select '''Console App'''. || [[Image:Language_csharp_vscode_netconsoleapp.png|center|350px|link=https://cdn.phidgets.com/docs/images/b/bc/Language_csharp_vscode_netconsoleapp.png]]
|-
| Next, we need to add the Phidget22.NET library using NuGet. Open the Command Palette again (Ctrl + Shift + P), and enter '''NuGet: Add NuGet package...'''.
|| [[Image:Language_csharp_vscode_addnugetpackage.png|center|350px|link=https://cdn.phidgets.com/docs/images/2/26/Language_csharp_vscode_addnugetpackage.png]]
|-
| When prompted, enter '''Phidget22.NET''' and install the latest package.<br><br>'''Note''': Ensure you are downloading the latest version which can be seen [{{SERVER}}/?view=changelog here]. Visual Studio Code may incorrectly show an older version as the ''latest'' by default.|| [[Image:Language_csharp_vscode_phidget22net.png|center|350px|link=https://cdn.phidgets.com/docs/images/d/d5/Language_csharp_vscode_phidget22net.png]]
|-
|-
| Finally, add your C# code and run it using the button at the top of the screen. || [[Image:Language_csharp_vscode_runcodepng.png|center|350px|link=https://cdn.phidgets.com/docs/images/d/dc/Language_csharp_vscode_runcodepng.png]]
|-
|}


==Getting started with C#==
===.NET Command-Line Interface (CLI)===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| Download and install the latest version of.NET from [https://dotnet.microsoft.com/en-us/download/dotnet Microsoft's .NET download page].|| [[Image:Language_csharp_cli_download.png|center|350px|link=https://cdn.phidgets.com/docs/images/9/90/Language_csharp_cli_download.png]]
|-
| Next, open a command prompt or terminal in a new folder and enter the following command:


If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
<syntaxhighlight lang=bash>
{{ExampleCodeReasons}}
dotnet new console
 
Instructions are divided up by operating system. Choose:
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#Mac OS X |Mac OS X]]
*[[#Linux | Linux]] (including PhidgetSBC)
 
==Windows(2000/XP/Vista/7)==
 
===Description of Library Files===
C# programs on Windows depend on the following files, which the installers above put onto your system:
* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time.  By default, it is placed in {{Code|C:\Windows\System32}}.
You will also need one of the following two files, depending on the .NET framework version you are targeting:
* <b>{{Code|Phidget21.NET.dll}}</b> is the Phidget library for .NET framework <i><b>2.0</b></i> or higher. Your compiler has to know where this file is. By default, it is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
* <b>{{Code|Phidget21.NET1.1.dll}}</b> is the Phidget library for .NET framework <i><b>1.1</b></i>. Your compiler has to know where this file is. By default, is is placed into {{Code|C:\Program Files\Phidgets}}. You can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
You can optionally install the following files:
* <b>{{Code|Phidget21.NET.XML}}</b> provides the IntelliSense in-line documentation for the .NET library in Visual Studio/MonoDevelop. This documentation is also visible in the Object Browser in Visual Studio. By default, it is placed into {{Code|C:\Program Files\Phidgets}}.
* <b>{{Code|Policy.2.1.Phidget21.NET.dll}}</b> is the policy assembly for {{Code|Phidget21.NET.dll}}. Our installer places this file in the Global Assembly Cache(GAC) directory. It directs any programs compiled against version 2.1.0 or higher of {{Code|Phidget21.NET.dll}} to use the most recent installed version.
 
If you do not want to use our installer, you can download the five [http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20111220.zip files].
 
Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.
 
===Visual Studio 2005/2008/2010===
 
Microsoft makes free versions of Visual Studio available known as Express Editions.  The Express editions are suitable for most applications, but are limited in features for more complex applications. Please see [http://www.microsoft.com/visualstudio Microsoft Visual Studio] for more information.
 
=====Use Our Examples=====
 
Please start by downloading the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a foler.  While these examples were written in Visual Studio 2005 and 2008, Visual Studio 2010 will easily open and upgrade them. To load all projects in Visual Studio, go to File &rarr; Open &rarr; Project, and open {{Code|AllExamples/AllExamples.sln}} or {{Code|AllExamples/AllExamples_vs2008.sln}} for Visual Studio 2005 and 2008, respectively.
 
If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.
[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]
 
This will load all of the examples available for C#, and then you can set your main project to be the one that matches your device.  If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]].
 
The only thing left to do is to run the examples! Click on Debug &rarr; Start Debugging. Please note that the projects, by default try to find the {{Code|Phidget21.NET.dll}} in the {{Code|C:\Program Files\Phidgets}}. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to {{Code|Phidget21.NET.dll}}. Please see the [[#Write Your Own Code | Write Your Own Code ]] section for details.
 
[[File:CSharp VS2005 Run.PNG|link=|alt=Run‎]]
 
Once you have the C# examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.
 
=====Write Your Own Code=====
 
When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your environment to properly link the Phidget C# libraries. To begin:
 
1. Generate a new Visual C# Windows Applications project with a descriptive name such as PhidgetTest.
 
[[File:CSharp VS2005 New Project.PNG|link=|alt=New Project]]
 
2. Add a reference to the Phidget .NET library.
 
[[File:CSharp VS2005 Add Reference.PNG|link=|alt=Add Reference]]
 
3. Under the .NET tab, select {{Code|Phidget21.NET.dll}}.
If you used our installer, these files are installed in {{Code|C:\Program Files\Phidgets}}, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.
 
[[File:CSharp VS2005 Add Reference 2.PNG|link=|alt=Add Reference]]
 
4. Then, in your code, you will need to include the Phidget .NET library:
 
<div class="source">
<syntaxhighlight lang=csharp>
  using Phidgets;
  using Phidgets.Events;
</syntaxhighlight>
</div>
 
 
The project now has access to the Phidget function calls and you are ready to begin coding.
 
The same [[#Follow the Examples|teaching ]] section which describes the examples also has further resources for programming your Phidget.
 
===Visual Studio 2003===
 
=====Use Our Examples=====
 
1. Download the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. If you are not sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. As the examples were written in newer versions of Visual Studio, Visual Studio 2003 is not able to open the examples. Fortunately, you can import the simple examples to a Visual Studio 2003 project. It will be difficult to import the full examples as you will need to recreate the GUI components. In the [[#Use Our Examples 2 | Use Our Examples]] section, it will be assumed that the simple examples are used. You will need this example source code to be copied into your C# project later on.
 
2. Next, a new project will need to be created. Generate a new Visual C# console application project with a descriptive name such as PhidgetTest.
 
[[File:CSharp_VS2003 New Project.PNG|link=|alt=New Project]]
 
3. Add a reference to the Phidget .NET library.
 
[[File:CSharp_VS2003 Add Reference 1.PNG|link=|alt=Add Reference]]
 
4. Under the .NET tab, select {{Code|Phidget21.NET1.1.dll}}. If you used our installer, by default, this file is placed in {{Code|C:\Program Files\Phidgets}}. If it is in another location, please change the path to the file's location accordingly.
 
[[File:CSharp_VS2003 Add Reference 2.PNG|link=|alt=Add Reference]]
 
5. To import the simple example program into your project, please: open up {{Code|Class1.cs}}.
 
6. Traverse to the example in Windows Explorer and locate the {{Code|Program.cs}} file.
 
[[File:CSharp VS2003 Source Code.PNG|link=|alt=Source Code]]
 
7. Copy and paste the contents from that file into {{Code|Class1.cs}}.
 
8. Comment out the following line as it is not supported in .NET 1.1:
<div class="source">
<syntaxhighlight lang=csharp>
  using System.Collections.Generic;
</syntaxhighlight>
</div>
 
[[File:CSharp VS2003 Source Code 2.PNG|link=|alt=Source Code]]
 
9. Now, you can run the example. Click on Debug &rarr; Start.
 
[[File:CSharp VS2003 Run.PNG|link=|alt=Run]]
 
Once you have the C# examples running, we have a [[#Follow the Examples|teaching ]] section below to help you follow them.
 
=====Write Your Own Code=====
 
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. Please see the [[#Use Our Examples 2 | Use Our Examples ]] section for instructions.
 
Then, in your code, you will need to include the Phidget .NET library:
<div class="source">
<syntaxhighlight lang=csharp>
  using Phidgets;
  using Phidgets.Events;
</syntaxhighlight>
</syntaxhighlight>
</div>
The project now has access to the Phidget function calls and you are ready to begin coding.


The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.
|| [[Image:Language_csharp_cli_newconsole.png|center|350px|link=https://cdn.phidgets.com/docs/images/3/3a/Language_csharp_cli_newconsole.png]]
|-
| This previous command will create a new console application at the folder location. || [[Image:Language_csharp_cli_newproject.png|center|350px|link=https://cdn.phidgets.com/docs/images/c/cb/Language_csharp_cli_newproject.png]]
|-
| Navigate back to the command prompt or terminal, and add the Phidget22.NET package with the following command:


===Mono===
This section will provide instructions on how to compile using the {{Code|mcs}} compiler. Other compilers such as {{Code|gmcs}}, {{Code|smcs}}, and {{Code|dmcs}} all work in the same way.
=====Use Our Examples=====
Download the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. Please only use the simple examples. The full examples uses Windows Forms, which Mono and the Gtk# toolkit are not completely compatible with. Locate the {{Code|Program.cs}} file as this contains the example source code. Copy the file into your working directory, and rename it to {{Code|example.cs}}.
<br/>
Place the {{Code|Phidget21.NET.dll}} in the same directory as your source code.
To compile and build an executable, run:
<div class="source">
<syntaxhighlight lang=bash>
<syntaxhighlight lang=bash>
mcs /out:example.exe /r:phidget21.NET.dll example.cs
dotnet add package Phidget22.NET
</syntaxhighlight>
</syntaxhighlight>
</div>


If you have the {{Code|Phidget21.NET.dll}} installed in another location, please change the path to the file's location accordingly.
|| [[Image:Language_csharp_cli_addpackage.png|center|350px|link=https://cdn.phidgets.com/docs/images/7/78/Language_csharp_cli_addpackage.png]]
|-
| You can now open the '''Program.cs''' file and add your code. Run the program by entering the following command into your command prompt or terminal:


Afterwards, you will have an executable named {{Code|example.exe}} that you can run. Type the following to run the program:
<div class="source">
<syntaxhighlight lang=bash>
<syntaxhighlight lang=bash>
mono example.exe
dotnet run
</syntaxhighlight>
</syntaxhighlight>
</div>
Once you have the C# examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.
=====Write Your Own Code=====
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. Please see the [[#Use Our Examples 3 | Use Our Example ]] section for instructions.
In your code, you will need to include the Phidget .NET library:
<div class="source">
<syntaxhighlight lang=csharp>
  using Phidgets;
  using Phidgets.Events;
</syntaxhighlight>
</div>
The project now has access to the Phidget function calls and you are ready to begin coding.
The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.
===MonoDevelop===
=====Use Our Examples=====
Download the [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices. These examples were written in Visual Studio 2005 and 2008, but are also compatible with MonoDevelop.
To load all projects in MonoDevelop, go to File &rarr; Open, and open {{Code|AllExamples/AllExamples.sln}}
This will load all of the examples available for C#, and then you can set your main project to be the one that matches your device.  If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. If you are running under the .NET framework, you can use either the full or simple examples. Otherwise, if you are running under the Mono framework, please only use the simple examples. The full examples uses Windows Forms, which is not completely compatible with Mono's Gtk#.
[[File:CSharp MonoDevelop Win Start Up.PNG|link=|alt=Start Up Project]]
The only thing left to do is to run the examples! Right click the project, and click on {{Code|Run With}} and select the target framework. Please note that the projects, by default try to find the {{Code|Phidget21.NET.dll}} in the {{Code|C\Program Files\Phidgets}}. If you have it installed in another location, please change the path to the file's location accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to {{Code|Phidget21.NET.dll}}. Please see the [[#Write Your Own Code 4 | Write Your Own Code]] section for details.
[[File:CSharp MonoDevelop Win Run As.PNG|link=|alt=Run As]]
Once you have the C# examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.
=====Write Your Own Code=====
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:
1. Create a new C# empty project with a descriptive name such as PhidgetTest.
[[File:CSharp MonoDevelop Win New Project.PNG|link=|alt=New Project]]
2. Add a reference to the Phidget .NET library.
[[File:CSharp MonoDevelop Win Reference.PNG|link=|alt=Add Reference]]
3. Select {{Code|Phidget21.NET.dll}}. If you used our installer, by default, this file is placed in {{Code|C:\Program Files\Phidgets}}. If it is in another location, please change the path to the file's location accordingly.
[[File:CSharp MonoDevelop Win Reference 2.PNG|link=|alt=Add Reference]]
4. Then, in your code, you will need to include the Phidget .NET library:
<div class="source">
<syntaxhighlight lang=csharp>
  using Phidgets;
  using Phidgets.Events;
</syntaxhighlight>
</div>
The project now has access to the Phidget function calls and you are ready to begin coding.
The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.
==Mac OS X==
C# has excellent support on Mac OS X through the Mono framework.
The first step in using C# on Mac is to install the Phidget .NET libraries.  Compile and install them as explained on the [[Device List|getting started guide for your device]].  Then, the [[OS - Mac OS X]] page also describes the different Phidget files, their installed locations, and their roles....
==Linux==
C# has support on Linux through the Mono framework. 
The first step in using C# on Linux is to install the Phidget .NET libraries.  Compile and install them as explained on the main [[OS - Linux | Linux page]].  That Linux page also describes the different Phidget files, their installed locations, and their roles.
==Follow the Examples==
By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want.  This teaching section has resources for you to learn from the examples and write your own.
Next, comes our API information.  These resources outline the C# Phidget functions:
{{UsingAPhidgetInCodeGeneral|both of which are available in C#|[http://www.phidgets.com/documentation/Phidget21.NET.zip C# API]}}


===Example Flow===
|| [[Image:Language_csharp_cli_runcode.png|center|350px|link=https://cdn.phidgets.com/docs/images/f/f3/Language_csharp_cli_runcode.png]]
|-
|}


{{ExamplePseudocode|In C#, you can name these '''event''' functions whatever you like.  You will then pass them as function pointers to the Phidget .NET library below in the Main Code section.  This hooks them into the actual events when they occur. <br>
==Example Code==
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Navigate to our [https://www.phidgets.com/?view=code_samples&lang=CSharp Code Sample Generator] to view and download code samples that are tailored to your specific device.
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget.  For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in C# is specific to the Phidget.  For a Phidget Spatial, for example, this would involve creating a {{Code|Spatial}} object.  The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip C# API]}}


==Code Snippets==
[[Image:Language_csharp_codesample.png|center|600px|link=https://cdn.phidgets.com/docs/images/0/03/Language_csharp_codesample.png]]


==Common Problems and Solutions/Workarounds==
===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}


Here you can put various frequent problems and our recommended solutions.
==API==
[{{SERVER}}/?view=api&lang=CSharp Phidget22 API]

Latest revision as of 19:47, 13 June 2025


Get Started

With the Phidget22.NET library, it's easy to create C# applications that work with Phidget devices.

C# Libraries

Nuget Package

The Phidget22.NET library is available as a nuget package. This is the recommend way to install and manage the Phidget22.NET library.

macOS Considerations

Phidget devices running a HID USB stack require the installation of the macOS libraries or the standalone Phidget Control Panel (download here).

To determine what USB stack your Phidget device is on, navigate to the product page and then to the specification tab, and look for the USB Stack specification. If you are using a VINT device, navigate to the product page for the VINT Hub you are using.

Javascript networkserver webusb spec.png

Linux Considerations

Linux restricts access to USB devices to the root user. To run your .NET application as a regular user, you'll need to set up udev rules on your system.

Library Files

If you would like to manually manage the Phidget22.NET library files, you can download them here.

Development Environment Configuration

Visual Studio

Instructions
Create your Visual Studio project, and navigate to the Solution Explorer. From there, right-click on Dependencies and select Manage NuGet Packages...
Language csharp vs managenuget.png
Next, click Browse and enter Phidget22.NET in the search bar.
Language csharp vs browsenuget.png
Click on the package and press the Install button.
Language csharp vs installnuget.png
Finally, add your C# code and run it using the button at the top of the screen.
Language csharp vs run.png

Visual Studio Code

Instructions
Install the C# Dev Kit extension for Visual Studio Code.
Language csharp vscode installext.png
Next, create a directory and open it in Visual Studio Code. You can do this by opening Visual Studio Code and selecting File > Open Folder...
Language csharp vscode newfolder.png
Open the Command Palette (Ctrl + Shift + P), type .NET: New Project, and press Enter. A list of supported project types will appear.
Language csharp vscode netnewproject.png
Select your preferred project type from the list. For this example, we will select Console App.
Language csharp vscode netconsoleapp.png
Next, we need to add the Phidget22.NET library using NuGet. Open the Command Palette again (Ctrl + Shift + P), and enter NuGet: Add NuGet package....
Language csharp vscode addnugetpackage.png
When prompted, enter Phidget22.NET and install the latest package.

Note: Ensure you are downloading the latest version which can be seen here. Visual Studio Code may incorrectly show an older version as the latest by default.
Language csharp vscode phidget22net.png
Finally, add your C# code and run it using the button at the top of the screen.
Language csharp vscode runcodepng.png

.NET Command-Line Interface (CLI)

Instructions
Download and install the latest version of.NET from Microsoft's .NET download page.
Language csharp cli download.png
Next, open a command prompt or terminal in a new folder and enter the following command: 
dotnet new console
Language csharp cli newconsole.png
This previous command will create a new console application at the folder location.
Language csharp cli newproject.png
Navigate back to the command prompt or terminal, and add the Phidget22.NET package with the following command: 
dotnet add package Phidget22.NET
Language csharp cli addpackage.png
You can now open the Program.cs file and add your code. Run the program by entering the following command into your command prompt or terminal: 
dotnet run
Language csharp cli runcode.png

Example Code

Navigate to our Code Sample Generator to view and download code samples that are tailored to your specific device.

Language csharp codesample.png

Phidget Programming Basics

To learn more about the structure of the example code, visit our Phidget Programming Basics guide.

API

Phidget22 API

Retrieved from "https://www.phidgets.com/docs/index.php?title=Language_-_C_Sharp&oldid=35293"