Language - Visual Basic: Difference between revisions

From Phidgets Support
m (Mparadis moved page Language - Visual Basic .NET to Language - Visual Basic: language was renamed)
 
(51 intermediate revisions by 7 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]]
{{OSLang|[[File:icon-Visual Basic Net.png|64x64px|link=|alt=]]|Visual Basic .NET, developed by [http://www.microsoft.com Microsoft] is a modern object oriented programming language and the successor to [[Language - Visual Basic 6.0 | Visual Basic 6.0]].}}
__NOTOC__
__TOC__
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.


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


{{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 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]]|}}
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.


==Quick Downloads==
== Setup Guide ==
{{QuickDownloads|Visual Basic .NET|
{{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip .NET}}|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/VBNET_2.1.8.20120216.zip|}}|
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip|.NET Framework Files|}}
{{WindowsQuickDownloads}}
}}


==Getting started with Visual Basic .NET==
<div class="phd-deck-sequence">
 
{{PT3_VBNET_CHOOSE}}{{PT3_VBNET_WIN_VS}}{{PT3_VBNET_WIN_MONO}}
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]]
*[[#OS X |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 environment-specific, so we include instructions 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 compiler]].
 
===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/VBNET_2.1.8.20120131.zip examples] and unpack them into a folder.  While these examples were written in Visual Studio 2005 and Visual Studio 2008, Visual Studio 2010 will easily open and upgrade them with the Visual Studio Conversion Wizard.
 
[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]
 
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.
 
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:VBNET 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 .NET library. 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 Phidget .NET 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]]
 
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=====
 
As the Visual Basic .NET examples were written in Visual Studio 2005 and 2008, Visual Studio 2003 is not able to open the examples. Furthermore, it will be difficult to import the examples into your Visual Studio 2003 project as you will need to recreate the GUI components. Fortunately, taking a look at the source code will give you valuable programming insight. 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.
 
1. Generate a new Visual Basic Console Application project with a descriptive name such as PhidgetTest.
 
[[File:VBNET VS2003 New Project.PNG|link=|alt=New Project]]
 
2. Add a reference to the Phidget .NET library.
 
[[File:VBNET VS2003 Add Reference 1.PNG|link=|alt=Add Reference]]
 
3. Under the .NET tab, select {{Code|Phidget21.NET1.1.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 VS2003 Add Reference 2.PNG|link=|alt=Add Reference]]
 
The project now has access to the Phidget21 function calls and you are ready to begin coding.
 
The [[#Follow the Examples|teaching ]] section also has further resources for programming your Phidget.
 
===Mono===
 
This section will provide instructions on how to compile using the {{Code|vbnc}} compiler.
 
=====Use Our Examples=====
 
We do not have Visual Basic .NET examples for the Mono framework. Fortunately, you can take a look at the source code for our [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Visual Studio 2005 and 2008 examples] for valuable programming insight. 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 compiler to properly link the Phidget .NET library.
 
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>
vbnc /out:example.exe /r:Phidget21.NET.dll Example.vb
</syntaxhighlight>
</div>
</div>


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>
mono example.exe
</syntaxhighlight>
</div>
The [[#Follow the Examples|teaching]] section also has further resources for programming your Phidget.
===MonoDevelop===
=====Use Our Examples=====
Download the [http://www.phidgets.com/downloads/examples/VBNET_2.1.8.20120131.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. Please note that the examples are only designed to be ran under the .NET framework. The examples are not compatible with the Mono framework. Despite this, if you are using the Mono framework, you can take a look at the source code for our [http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Visual Studio examples] for valuable programming insight. We have a [[#Follow the Examples|teaching ]] section below to help you follow them.
The rest of this section will explain the steps needed to run our examples under the .NET framework. 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]].
[[File:VBNET Win MonoDevelop Startup Project.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 Microsoft .NET 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 Phidget is not defined, 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:VBNET Win MonoDevelop 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 .NET library. To begin:
1. Create a new Visual Basic .NET console project with a descriptive name such as PhidgetTest.
[[File:VBNET Win MonoDevelop New Project.PNG|link=|alt=New Project]]
2. Add a reference to the Phidget .NET library.
[[File:VBNET Win MonoDevelop Add Reference 1.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:VBNET Win MonoDevelop Add Reference 2.PNG|link=|alt=Add Reference]]
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.
==OS X==
Visual Basic .NET has excellent support on 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 - 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. 
===Use Our Examples===
The first step in using Visual Basic .NET with Phidgets on Linux is to install Mono.  Although you probably have already done this if you're a Visual Basic .NET programmer, you want to make sure you have all of the packages you'll need.  Try:
<div class="source">
<syntaxhighlight lang=bash>
sudo apt-get mono-complete
</syntaxhighlight>
</div>
The Visual Basic Mono framework also requires the Visual Basic .NET compiler, {{Code|vbnc}}.  This can be installed via another Mono package:
<div class="source">
<syntaxhighlight lang=bash>
sudo apt-get install mono-vbnc
</syntaxhighlight>
</div>
Next, you'll want to install the main 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.
Then, you will need the Phidget .NET libraries.  These are part of the Windows library zip file download:
* [http://www.phidgets.com/downloads/libraries/Phidget21-windevel.zip Phidget Windows Library Zip File]
Extract the library zip file.  Descriptions for the files are available on the [[OS - Windows]] page, but for now we only need the {{Code|Phidget21.NET.dll}} file to run the Phidget C# examples in Mono.  So remember where you unzipped these Windows libraries - you will need to copy the {{Code|Phidget21.NET.dll}} file into your example directory shortly.
Next, you'll want to download and extract the Phidget Visual Basic .NET Examples (not the ones for .NET Compact):
* [http://www.phidgets.com/downloads/examples/VBNET.zip Visual Basic .NET Examples for Windows]
To check that your Linux, Phidget, and Mono setup is all working together, you'll want to run the Visual Basic (VB) examples.  You'll probably want to start with the Hello World VB example. All of the .NET examples are much larger projects through Visual Studio, so you'll need to dig around within the project and find the source code and compile only that source code using Mono.
Alternatively, you could find the source code for your device. {{Template:FindYourDevice}}
Let's say you're running the Temperature Sensor example (for the 1048 or 1051).  The source code for the example is in the directory:
:{{Code|TemperatureSensorExamples}} &rarr; {{Code|TemperatureSensor-simple}} &rarr; {{Code|TemperatureSensor-simple}} &rarr; {{Code|Program.cs}}
Other examples will be in directories named appropriately for their software object name.  Once you have found the example you want to run, copy the {{Code|Phidget21.NET.dll}} file that you unzipped earlier into that example directory where the {{Code|Program.cs}} file is. 
Then, compile the code.  When compiling, you need to link to the Phidget library. As the Phidget21.NET file is an "additional assembly" in C#/Mono, you can link to the assembly using the {{Code|-r}} "reference" switch:
<div class="source">
<syntaxhighlight lang=bash>
gmcs Program.cs -r:Phidget21.NET.dll
</syntaxhighlight>
</div>
This will compile a {{Code|*.exe}} file - in this case, {{Code|Program.exe}}.  This you can then run under Mono:
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.


Your main reference for writing Visual Basic .NET code will be our .NET API information, with syntax for all of our 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 .NET|[http://www.phidgets.com/documentation/Phidget21.NET.zip .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 .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 22:40, 13 December 2024


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

Windows with Visual Studio

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

Requirements

First, make sure you have the following installed:

Phidgets Drivers for Windows

● 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 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 code will be:

● The Phidget22 API documentation

● The VB 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 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.

«
»

Language - VB.Net

Windows with Mono

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

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. 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 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 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 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 code will be:

● The Phidget22 API documentation

● The VB 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 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.

«
»


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