Language - Visual Basic .NET: Difference between revisions

From Phidgets Support
No edit summary
 
(103 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<metadesc>Communicate over USB with sensors, controllers and relays with Phidgets! Our Visual Basic .NET library supports Windows using Visual Studio or Mono.</metadesc>
[[Category:Language]]
[[Category:Language]]
[[File:icon-Visual Basic Net.png|64x64px|link=|alt=]] Preamble about the language's origin and its main characteristics.
__NOTOC__
We provide support for the Visual Basic .NET language on the '''Windows''' operating system. 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.


__TOC__
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 Visual Basic .NET projects, but it also has a steep learning curve.


==Introduction==
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.


{{LanguageSupport|Visual Basic .NET|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]]|}}
== Setup Guide ==


==Quick Downloads==
<div class="phd-deck-sequence">
 
{{PT3_VBNET_CHOOSE}}{{PT3_VBNET_WIN_VS}}{{PT3_VBNET_WIN_MONO}}
Just need the Visual Basic .NET documentation, drivers, libraries, and examples?  Here they are:
 
===API Documentation===
*[http://www.phidgets.com/documentation/Phidget21.NET.zip API Manual]
 
===Example Code===
 
*[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Example Code]
 
===Libraries and Drivers===
*[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip .NET Framework Files]
*[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip 32 bit Windows Drivers and Libraries]
*[http://www.phidgets.com/downloads/libraries/phidget21-x64_2.1.8.20110615.zip 64 bit Windows Drivers and Libraries]
*[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]
*[http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20111028.tar.gz Linux Source]
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20111103.dmg Mac OS X Drivers Installer]
 
==Getting started with Visual Basic .NET==
 
If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}
 
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===
Visual Basic .NET 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, Visual Studio 2008 and 2010 will easily open and upgrade them with the Visual Studio Conversion Wizard.
 
[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]
 
This will load all of the examples available for Visual Basic .NET, 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 {{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 type Phidget is not defined, 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 Visual Basic .NET 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 Visual Basic .NET libraries. To begin:
 
1. Generate a new Visual Basic .NET Console Application project with a descriptive name such as PhidgetTest.
 
[[File:VBNET VS2005 New Project.PNG|link=|alt=New Project]]
 
2. Add a reference to the .NET Phidget library.
 
[[File:VBNET VS2005 Add Reference 1.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:VBNET VS2005 Add Reference 2.PNG|link=|alt=Add Reference]]
 
4. Then, in your code, you will need to declare your particular  Phidget. For example, you would include the following line for a PhidgetInterfaceKit:
<div class="source">
<syntaxhighlight lang=vbnet>
Dim  WithEvents phidgetIFK As Phidgets.InterfaceKit
</syntaxhighlight>
</div>
 
Please see the [http://www.phidgets.com/downloads/examples/VBNET_2.1.8.20120131.zip examples] on how to declare your particular Phidget.
 
The project now has access to the Phidget21 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 Visual Basic .NET project later on.
 
2. Next, a new project will need to be created. Generate a new Visual Basic .NET 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 .NET Phidget 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 Visual Basic .NET 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 Visual Basic .NET libraries. Please see the [[#Use Our Examples 2 | Use Our Examples ]] section for instructions.
 
Then, in your code, you will need to include the Phidget library:
<div class="source">
<syntaxhighlight lang=csharp>
  using Phidgets;
  using Phidgets.Events;
</syntaxhighlight>
</div>
 
The project now has access to the Phidget21 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.
 
===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. Start by downloading the Visual Basic .NET Examples.
 
=====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/>
 
To compile and build an executable, run:
<div class="source">
<syntaxhighlight lang=bash>
mcs /out:example.exe /lib:"C:\Program Files\Phidgets" /r:phidget21.NET.dll example.cs
</syntaxhighlight>
</div>
</div>


If you have the {{Code|Phidget21.NET.dll}} installed in another location, please change the path to the file's location accordingly.
Afterwards, you will have an executable named {{Code|example.exe}} that you can run. Place the {{Code|Phidget21.NET.dll}} in the same directory as the executable and type the following to run the program:
<div class="source">
<syntaxhighlight lang=bash>
mono example.exe
</syntaxhighlight>
</div>
Once you have the Visual Basic .NET 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 Visual Basic .NET libraries. Please see the [[#Use Our Examples 3 | Use Our Example ]] section for instructions.
In your code, you will need to include the Phidget library:
<div class="source">
<syntaxhighlight lang=vbnet>
Dim  WithEvents phidgetIFK As Phidgets.InterfaceKit
</syntaxhighlight>
</div>
The project now has access to the Phidget21 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 Visual Basic .NET, 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 Visual Basic .NET 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 Visual Basic .NET libraries. To begin:
1. Create a new Visual Basic .NET 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 .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 library:
<div class="source">
<syntaxhighlight lang=vbnet>
Dim Shared WithEvents phidgetRFID As Phidgets.RFID
</syntaxhighlight>
</div>
The project now has access to the Phidget21 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==
Visual Basic .NET has excellent support on Mac OS X through the Mono framework.
The first step in using Visual Basic .NET on Mac is to install the Phidget 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==
Visual Basic .NET has support on Linux through the Mono framework. 
The first step in using Visual Basic .NET on Linux is to install the Phidget 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 Visual Basic .NET Phidget functions:
== Quick Downloads ==
If you already know what you're doing and just need the files, you can find them all below.


{{UsingAPhidgetInCodeGeneral|both of which are available in Visual Basic .NET|[http://www.phidgets.com/documentation/Phidget21.NET.zip Visual Basic .NET API]}}
=== Documentation ===


===Example Flow===
*{{Phidget22API}} (Select Visual Basic .NET from drop-down menu)


{{ExamplePseudocode|In Visual Basic .NET, you can name these '''event''' functions whatever you like.  You will then pass them as function pointers to the Phidget 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>
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 Visual Basic .NET 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 Visual Basic .NET API]}}


==Code Snippets==
*{{SampleCode|VBNET|Visual Basic .NET Examples}}


==Common Problems and Solutions/Workarounds==
===Libraries===


Here you can put various frequent problems and our recommended solutions.
{{AllQuickDownloads}}

Latest revision as of 21:39, 10 August 2023


We provide support for the Visual Basic .NET language on the Windows operating system. 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 Visual Basic .NET 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.

Setup Guide

VB.NET - Select Development Environment

Select your Development Environment:

Windows

Language - VB.Net

Windows with Visual Studio

Welcome to using Phidgets with Visual Basic .NET! By using Visual Basic .NET, 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 Visual Basic .NET.

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.

Use Our Examples

One of the best ways to start programming with Phidgets is to use our example code as a guide.

VB.Net Code Samples

Download the example(s) that correspond to your Phidget's channel classes. You can find them listed on the enclosure in most cases, or on the API tab of the product page.

Use Our Examples

Unpack and open the example project and click 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. This would be a good time to play around with the device and experiment with some of its functionality.

Editing the Examples

The Visual Basic .Net examples are derived from the Windows Phidget Control Panel, so you'll need to modify a few things to adapt them for your own purposes. To begin with, you can remove the following line:

commandLineData phidgetParameters = open.parseCmdLine(); //get command line parameters

Then, you can modify any line that mentions phidgetParameters by setting it to the desired value instead of using PhidgetParameters object...

Editing the Examples

For instance:

Try 'set all the values grabbed from command line.  these values have defaults that are set in ExampleUtils.vb, you can check there to see them
    device.Channel = phidgetParameters.Channel 'selects the channel on the device to open
    device.DeviceSerialNumber = phidgetParameters.SerialNumber 'selects the device or hub to open
    device.HubPort = phidgetParameters.HubPort 'selects th eport on the hub to open
    device.IsHubPortDevice = phidgetParameters.isHubPortDevice 'is the device a port on a vint hub?

    If phidgetParameters.isRemote Then 'are we trying to open a remote device?
        device.IsRemote = True
        Net.EnableServerDiscovery(ServerType.Device) 'turn on network scan
        If phidgetParameters.Password <> vbNullString And 
           phidgetParameters.ServerName <> vbNullString Then
           
            Net.SetServerPassword(phidgetParameters.ServerName, phidgetParameters.Password)
        End If
    Else
        device.IsLocal = True
    End If

    device.Open() 'open the device specified by the above parameters
Catch ex As PhidgetException
    errorBox.addMessage("Error opening the device: " + ex.Message)
End Try

Might become:

Try
    device.Channel = 0
    device.DeviceSerialNumber = 370097
    device.HubPort = 0
    device.IsHubPortDevice = True
    device.IsLocal = True

    device.Open()
Catch ex As PhidgetException
    errorBox.addMessage("Error opening the device: " + ex.Message)
End Try

You can then manipulate the rest of the code as your application requires.

Write Code

You now have working examples and a project that is configured. This teaching section will help you understand how the examples were written so you can start writing your own code.

Remember: your main reference for writing VB.NET code will be:

● The Phidget22 API documentation

● The VB.Net Example Code

Write Code

Step One: Create And Address

You will need to declare your Phidget object in your code. For example, we can declare a digital input object like this:

ch = New Phidget22.DigitalInput()

Next, we can address which Phidget we want to connect to by setting parameters such as DeviceSerialNumber.

ch.DeviceSerialNumber = 496911

You can find information about all available parameters here or in the API documentation.

Write Code

Step One: Create And Address

Although we will not discuss it in-depth on this page, you should include error handling for all Phidget functions. Here is an example of the previous code with error handling:

Try
  ch = New Phidget22.DigitalInput()
  ch.DeviceSerialNumber = 496911
Catch ex As PhidgetException
  errorBox.addMessage("Error initializing: " + ex.Message)
End Try

Write Code

Step Two: Open And Wait For Attachment

After we have specified which Phidget to connect to, we can open the Phidget object like this:

ch.Open(5000)

To use a Phidget, it must be plugged in (attached). We can handle this by calling Open(timeout), which will block indefinitely until a connection is made, or until the timeout value is exceeded. Simply calling Open does not guarantee you can use the Phidget immediately.

Write Code

Alternately, you could verify the device is attached by using event driven programming and tracking the attach events.

To use events to handle attachments, we have to modify our code slightly:

Private Sub device_Attach(ByVal sender As Object, ByVal e As Phidget22.Events.AttachEventArgs) Handles ch.Attach
  Console.WriteLine("Phidget Attached!");
End Sub

We recommend using this attach handler to set any initialization parameters for the channel such as DataInterval and ChangeTrigger from within the AttachHandler, so the parameters are set as soon as the device becomes available.

Write Code

Step Three: Do Things With The Phidget

We recommend the use of event driven programming when working with Phidgets. In a similar way to handling an attach event as described above, we can also add an event handler for a state change event:

Private Sub device_DigitalInputChange(ByVal sender As Object, ByVal e As Phidget22.Events.DigitalInputStateChangeEventArgs) Handles ch.StateChange
  stateText.Text = "State: " + e.State;
End Sub

If you are using multiple Phidgets in your program, check out our page on Using Multiple Phidgets for information on how to properly address them and use them in events.

If events do not suit your needs, you can also poll the device directly for data using code like this:

state= device.State;
stateText.Text = "State: " + e.State;

Important Note: There will be a period of time between the attachment of a Phidget sensor and the availability of the first data from the device. Any attempts to get this data before it is ready will result in an exception. See more information on this on our page for Unknown Values.

Write Code

Step Three: Do Things With The Phidget

Enumerations: Some Phidget devices have functions that deal with specific predefined values called enumerations. Enumerations commonly provide readable names to a set of numbered options.

Enumerations with Phidgets in Visual Basic .NET will take the form of Phidget22.EnumerationType.Enumeration_Name.

For example, specifying a SensorType to use the 1142 for a voltage input would look like:

Phidget22.VoltageSensorType.PN_1142

and specifying a K-Type thermocouple for a temperature sensor would be:

Phidget22.ThermocoupleType.K

The Phidget error code for timing out could be specified as:

Phidget22.ErrorCode.Timeout

Write Code

Step Four: Close And Delete

At the end of your program, be sure to close and delete your device:

device.Close();

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

Create a new Windows Forms Application project:

Setting up a New Project

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

Setting up a New Project

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

Setting up a New Project

Finally, to include the Phidget .NET library, add the following lines to main window class file:

Imports Phidget22
Imports 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.

«
»

Language - VB.Net

Windows with Mono

Welcome to using Phidgets with Visual Basic .NET! By using Visual Basic .NET, 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


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.

Use Our Examples

First, download and unpack the HelloWorld example for VB.Net. This example uses the Phidget Manager to list all Phidget channels that can be accessed by your computer:

HelloWorld example

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

Use Our Examples

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:

Use Our Examples

Open the command prompt at the folder location and enter the following command:

vbnc /r:Phidget22.NET.dll Module1.vb

This will create an executable file called Module1.exe. Type in the following command to run the example:

mono Module1.exe

Use Our Examples

You should be able to see the channels of your Phidget listed when the program starts or whenever the Phidget is plugged in while the program is running.

Now that you've confirmed that your devices are properly connected, the next step is to download and edit sample code for your specific device.

Use Our Examples

To download the code samples, visit this page:

VB.Net Code Samples

Download the example(s) that correspond to your Phidget's channel classes. You can find them listed on the enclosure in most cases, or on the API tab of the product page.

Editing the Examples

The Visual Basic .Net examples are derived from the Windows Phidget Control Panel, so you'll need to modify a few things to adapt them for your own purposes. To begin with, you can remove the following line:

commandLineData phidgetParameters = open.parseCmdLine(); //get command line parameters

Then, you can modify any line that mentions phidgetParameters by setting it to the desired value instead of using PhidgetParameters object...

Editing the Examples

For instance:

Try 'set all the values grabbed from command line.  these values have defaults that are set in ExampleUtils.vb, you can check there to see them
    device.Channel = phidgetParameters.Channel 'selects the channel on the device to open
    device.DeviceSerialNumber = phidgetParameters.SerialNumber 'selects the device or hub to open
    device.HubPort = phidgetParameters.HubPort 'selects th eport on the hub to open
    device.IsHubPortDevice = phidgetParameters.isHubPortDevice 'is the device a port on a vint hub?

    If phidgetParameters.isRemote Then 'are we trying to open a remote device?
        device.IsRemote = True
        Net.EnableServerDiscovery(ServerType.Device) 'turn on network scan
        If phidgetParameters.Password <> vbNullString And 
           phidgetParameters.ServerName <> vbNullString Then
           
            Net.SetServerPassword(phidgetParameters.ServerName, phidgetParameters.Password)
        End If
    Else
        device.IsLocal = True
    End If

    device.Open() 'open the device specified by the above parameters
Catch ex As PhidgetException
    errorBox.addMessage("Error opening the device: " + ex.Message)
End Try

Might become:

Try
    device.Channel = 0
    device.DeviceSerialNumber = 370097
    device.HubPort = 0
    device.IsHubPortDevice = True
    device.IsLocal = True

    device.Open()
Catch ex As PhidgetException
    errorBox.addMessage("Error opening the device: " + ex.Message)
End Try

You can then manipulate the rest of the code as your application requires.

Write Code

You now have working examples and a project that is configured. This teaching section will help you understand how the examples were written so you can start writing your own code.

Remember: your main reference for writing VB.NET code will be:

● The Phidget22 API documentation

● The VB.Net Example Code

Write Code

Step One: Create And Address

You will need to declare your Phidget object in your code. For example, we can declare a digital input object like this:

ch = New Phidget22.DigitalInput()

Next, we can address which Phidget we want to connect to by setting parameters such as DeviceSerialNumber.

ch.DeviceSerialNumber = 496911

You can find information about all available parameters here or in the API documentation.

Write Code

Step One: Create And Address

Although we will not discuss it in-depth on this page, you should include error handling for all Phidget functions. Here is an example of the previous code with error handling:

Try
  ch = New Phidget22.DigitalInput()
  ch.DeviceSerialNumber = 496911
Catch ex As PhidgetException
  errorBox.addMessage("Error initializing: " + ex.Message)
End Try

Write Code

Step Two: Open And Wait For Attachment

After we have specified which Phidget to connect to, we can open the Phidget object like this:

ch.Open(5000)

To use a Phidget, it must be plugged in (attached). We can handle this by calling Open(timeout), which will block indefinitely until a connection is made, or until the timeout value is exceeded. Simply calling Open does not guarantee you can use the Phidget immediately.

Write Code

Alternately, you could verify the device is attached by using event driven programming and tracking the attach events.

To use events to handle attachments, we have to modify our code slightly:

Private Sub device_Attach(ByVal sender As Object, ByVal e As Phidget22.Events.AttachEventArgs) Handles ch.Attach
  Console.WriteLine("Phidget Attached!");
End Sub

We recommend using this attach handler to set any initialization parameters for the channel such as DataInterval and ChangeTrigger from within the AttachHandler, so the parameters are set as soon as the device becomes available.

Write Code

Step Three: Do Things With The Phidget

We recommend the use of event driven programming when working with Phidgets. In a similar way to handling an attach event as described above, we can also add an event handler for a state change event:

Private Sub device_DigitalInputChange(ByVal sender As Object, ByVal e As Phidget22.Events.DigitalInputStateChangeEventArgs) Handles ch.StateChange
  stateText.Text = "State: " + e.State;
End Sub

If you are using multiple Phidgets in your program, check out our page on Using Multiple Phidgets for information on how to properly address them and use them in events.

If events do not suit your needs, you can also poll the device directly for data using code like this:

state= device.State;
stateText.Text = "State: " + e.State;

Important Note: There will be a period of time between the attachment of a Phidget sensor and the availability of the first data from the device. Any attempts to get this data before it is ready will result in an exception. See more information on this on our page for Unknown Values.

Write Code

Step Three: Do Things With The Phidget

Enumerations: Some Phidget devices have functions that deal with specific predefined values called enumerations. Enumerations commonly provide readable names to a set of numbered options.

Enumerations with Phidgets in Visual Basic .NET will take the form of Phidget22.EnumerationType.Enumeration_Name.

For example, specifying a SensorType to use the 1142 for a voltage input would look like:

Phidget22.VoltageSensorType.PN_1142

and specifying a K-Type thermocouple for a temperature sensor would be:

Phidget22.ThermocoupleType.K

The Phidget error code for timing out could be specified as:

Phidget22.ErrorCode.Timeout

Write Code

Step Four: Close And Delete

At the end of your program, be sure to close and delete your device:

device.Close();

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

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

Imports Phidget22
Imports Phidget22.Events

Setting up a New Project

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

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

Place your program and the Phidget22.NET.dll file in the same location. Your folder should now look something like this:

Setting up a New Project

Open the command prompt at the folder location and enter the following command:

vbnc /r:Phidget22.NET.dll Module1.vb

This will create an executable file called Module1.exe. Type in the following command to run the example:

mono Module1.exe

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.

«
»


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