Language - C Sharp

Quick Downloads

Documentation

Phidget22 API (Select C# from drop-down menu)

Example Code

C# Examples

Libraries

Getting started with C#

Welcome to using Phidgets with C#! By using C#, you will have access to the complete Phidget22 API, including events. We also provide example code in C# for all Phidget devices.

If you are developing for Windows, keep reading. Otherwise, select your operating system to jump ahead:

macOS
Linux

Windows

If you haven't already, please visit the Windows page before you continue reading. There you will be instructed on how to properly set up your Windows machine so you can follow the guides below!

Visual Studio

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 Microsoft Visual Studio.

Now that you have Microsoft Visual Studio installed, select an example that will work with your Phidget:

C# Examples

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

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 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!

Configure your 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 Windows Forms Application project:

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

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

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

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. Next, view the write your own code section located below.

Mono

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 Mono for Windows.

Now that you have Mono installed, download and unpack the HelloWorld example for C#:

HelloWorld example

Note: The HelloWorld example is compatible with Mono because it does not use Windows Forms. All other C# examples use Windows Forms.

Next, copy Phidget22.NET.dll from type the following location:

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:

Open the command prompt at the folder location and 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

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!

Configure your 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.

To include the Phidget .NET library, simply add the following lines to your code:

using Phidget22;
using Phidget22.Events;

You can now compile the file as shown in the previous section.

The project now has access to Phidgets. Next, view the write your own code section located below.

MonoDevelop/Xamarin Studio

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 Xamarin Studio for Windows.

Now that you have Xamarin Studio installed, select an example that will work with your Phidget:

C# Examples

Next, open the example project:

Right click the project, and click Run Item:

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 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!

=Configure your 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:

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

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

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. Next, view the write your own code section located below.

macOS

If you haven't already, please visit the macOS page before you continue reading. There you will be instructed on how to properly set up your macOS machine so you can follow the guides below!

Mono

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 Mono for macOS. You will also need a copy of Phidget22.NET.dll.

Now that you have Mono installed and Phidget22.NET.dll on hand, download and unpack the HelloWorld example for C#:

HelloWorld example download

Note: The HelloWorld example is compatible with Mono because it does not use Windows Forms. All other C# examples use Windows Forms.

Finally, you need to create a configuration file. Create a new file in the same directory as the example you wish to compile 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>

Your project folder should now look like this:

To compile the program, enter the following command in the terminal:

mcs Program.cs -r:Phidget22.NET.dll

An executable file will be created. Run the program using mono:

mono Program.exe

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!

Configure your 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.

To include the Phidget .NET library, simply add the following lines to your code:

using Phidget22;
using Phidget22.Events;

You can now compile the file as shown in the previous section.

The project now has access to Phidgets. Next, view the write your own code section located below.

Linux

If you haven't already, please visit the Linux page before you continue reading. There you will be instructed on how to properly set up your Linux machine so you can follow the guides below!

Mono

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 Mono. You can do this by entering the following command in the terminal:

apt-get install mono-complete

You will also need a copy of Phidget22.NET.dll.

Now that you have Mono installed and Phidget22.NET.dll on hand, download and unpack the HelloWorld example for C#:

HelloWorld example download

Note: The HelloWorld example is compatible with Mono because it does not use Windows Forms. All other C# examples use Windows Forms.

Your project folder should now look like this:

Finally, to compile the program, enter the following command in the terminal:

mcs Program.cs -r:Phidget22.NET.dll

An executable file will be created. Run the program using mono:

mono Program.exe

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!

Configure your 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.

To include the Phidget .NET library, simply add the following lines to your code:

using Phidget22;
using Phidget22.Events;

You can now compile the file as shown in the previous section.

The project now has access to Phidgets. Next, view the write your own code section located below.

Write Code

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. Your main reference for writing C# code will be the Phidget22 API Manual.

The following code snippets describe how to do various general tasks with Phidgets. You should be able to find places in the examples where these snippets exist, and modify them to suit your requirements.

Step One: Initialize and open

The Open() function opens the software object, but not hardware. So, it is not a guarantee you can use the Phidget immediately.

For example, if we were using an Digital Input as our device, the create and open calls would look like this:

using Phidget22;
using Phidget22.Events;

namespace Program
{
    class Code
    {
        static void Main(string[] args)
        {
            try
            {

                // Declare a DigitalInput object
                DigitalInput device = new DigitalInput();

                // Hook in any event handlers
                // ...

                // Open the device
                device.Open();

            }
            catch (PhidgetException ex) { Console.WriteLine(ex.Description); }
        }
    }
}

Step Two: Wait for attachment (plugging in) of the Phidget

To use the Phidget, it must be plugged in (attached). We can handle this simply by calling open with a number as a parameter in place of the basic open. This function works for any Phidget. This will block until a connection is made to the Phidget, or the specified timeout is exceeded:

device.Open(5000);

Sometimes, it makes more sense to handle the attachment via an event. This would be in instances where the Phidget is being plugged and unplugged, and you want to handle these incidents. Or, when you want to use event-driven programming because you have a GUI-driven program. In these cases, an event-driven code snippet to handle the attachment might look something like this:

void attachEventHandler(object sender, Phidget22.Events.AttachEventArgs e) {
{
  Phidget attachedDevice = (Phidget)sender;
  int serialNumber = attachedDevice.DeviceSerialNumber;
  string deviceName = attachedDevice.DeviceName;
  Console.WriteLine("Hello Device {0},  Serial Number: {1}!", deviceName, serialNumber.ToString());
}

And the code to set up the event handler within the code opening your device might look like:

//Code for -creating- device here....

device.Attach += attachEventHandler;

//Code for -opening- device here....

Step Three: Do things with the Phidget

We recommend the use of event driven programming when working with Phidgets. This allows the program to execute other tasks until the Phidget generates a new event. You can hook a custom function into an event trigger like this, using a Digital Input Phidget as an example:

device.StateChange += input_change;

The input_change method is defined as follows:

void input_change(object sender, Phidget22.Events.DigitalInputStateChangeEventArgs e) {
    textBox1.Text = "State: " + e.State;
}

Some values can be directly read and set on the Phidget. These functions can be used inside a polling loop as an alternative to event driven programming. The line inside the loop would be something like this, after which you could do something with the value:

bool val = device.State;

device.State = true;

Step Four: Close and delete

At the end of your program, be sure to close your device.

private void Form1_FormClosing(object sender, FormClosingEventArgs e)  {
    Private Sub Form1_FormClosing(ByVal sender As Object, ByVal e As System.Windows.Forms.FormClosingEventArgs) Handles Me.FormClosing
        If device.Attached Then
            device.Close()
        End If
    End Sub
}

Personal tools

Views

More

Tools

Language - C Sharp

Contents

Quick Downloads

Documentation

Example Code

Libraries

Getting started with C#

Windows

Visual Studio

Use our examples

Configure your project

Mono

Use our examples

Configure your project

MonoDevelop/Xamarin Studio

Use our examples

=Configure your project

macOS

Mono

Use our examples

Configure your project

Linux

Mono

Use our examples

Configure your project

Write Code

Step One: Initialize and open

Step Two: Wait for attachment (plugging in) of the Phidget

Step Three: Do things with the Phidget

Step Four: Close and delete

Further Reading

Navigation menu