Difference between revisions of "Language - Visual Basic .NET"

From Phidgets Support
Jump to: navigation, search
Line 3: Line 3:
 
__TOC__
 
__TOC__
  
==Introduction==
+
== Introduction ==
  
{{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]]|}}
+
If this is your first time working with a Phidget, we suggest starting with the Getting Started page for your specific device. This can be found in the user guide for your device. That page will walk you through installing drivers and libraries for your operating system, and will then bring you back here to use VB.NET specifically.
 +
VB.NET is capable of using the complete Phidget API, including events. We also provide example code in VB.NET for all Phidget devices.
  
==Quick Downloads==
+
VB.NET with Phidgets is only supported on Windows, and can be used with [[#Visual_Studio_2015|Visual Studio 2015]], [[#Mono|Mono]], or [[#MonoDevelop/Xamarin_Studio|MonoDevelop]].
{{QuickDownloads|Visual Basic .NET|
+
{{APIQuickDownloads|{{SERVER}}/documentation/Phidget21.NET.zip .NET}}
+
{{ExtraAPIQuickDownloads|{{SERVER}}/documentation/web/NETDoc/Index.html|HTML Version of}}|
+
{{ExampleQuickDownloads|{{SERVER}}/downloads/examples/VBNET.zip|}}|
+
{{ExtraLibraryQuickDownloads|{{SERVER}}/downloads/libraries/phidget21-x86.zip|.NET Framework Files|}}
+
{{WindowsQuickDownloads}}
+
}}
+
  
==Getting started with Visual Basic .NET==
+
== Quick Downloads ==
 +
 
 +
'''<span style="color:#FF0000">List of download links, to be added once files are available</span>'''
 +
 
 +
=== Documentation ===
 +
=== Example Code ===
 +
=== Libraries and Drivers ===
 +
 
 +
== Getting Started with VB.NET ==
  
 
If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
 
If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
Line 22: Line 24:
  
 
Instructions are divided up by operating system. Choose:
 
Instructions are divided up by operating system. Choose:
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
+
*[[#Windows(XP/Vista/7)|Windows XP / Vista / 7]]
*[[#OS X |OS X]]
+
*[[#Linux | Linux]] (including PhidgetSBC)
+
 
+
==Windows (XP/Vista/7/8)==
+
  
 +
== Windows ==
 
===Description of Library Files===
 
===Description of Library Files===
 
Visual Basic .NET programs on Windows depend on the following files, which the installers above put onto your system:
 
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}}.
+
*'''phidget22.dll''' contains the actual Phidget library, which is used at run-time. By default, it is placed in C:\Windows\System32.
You will also need one of the following two files, depending on the .NET framework version you are targeting:
+
*'''Phidget22.NET.dll''' is the Phidget library for .NET framework 2.0 or higher. Your compiler has to know where this file is. By default, it is placed into C:\Program Files\Phidgets\Phidget22. 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.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:
 
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}}.
+
*'''Phidget22.NET.XML''' 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 C:\Program Files\Phidgets\Phidget22.
* <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 [{{SERVER}}/downloads/libraries/Phidget21-windevel.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 2015===
  
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]].
+
====Use Our Examples====
 +
Please start by downloading the examples and unpacking them into a folder. Since the examples were written in Visual Studio 2015, you will need to use Visual Studio 2015 or later in order to run the examples. To load all projects in Visual Studio, go to File → Open → Project, and open AllExamples/AllExamples.sln.
  
===Visual Studio 2005/2008/2010===
+
The easiest way to confirm that your environment is set up properly will be to compile and run the HelloWorld Visual Basic .NET example.
  
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.
+
Start by setting the HelloWorld project as your start up project.
  
=====Use Our Examples=====
+
The only thing left to do is to run the example! Click on Debug → Start Debugging. Please note that the projects, by default try to find the Phidget22.NET.dll in the C:\Program Files\Phidgets\Phidget22. 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 Phidget22 cannot be found, please re-add the reference to Phidget22.NET.dll. Please see the [[#Write Your Own Code|Write Your Own Code]] section for details.
  
Please start by downloading the [{{SERVER}}/downloads/examples/VBNET.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.
+
[[Image:VB_VS2015_Run.png|600px]]
  
[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]
+
This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:
  
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.
+
[[Image:VB_VS2015_HelloWorld_Output.png|600px]]
  
This will load all of the examples available for Visual Basic .NET, and then you can set your main project to be the HelloWorld project that will work with any Phidget board. Or you can choose the example that matches your device. {{FindYourDevice}}
+
After confirming that the HelloWorld example is working, you can proceed to run the example for your device. The source file will be named the same as the software object for your device. If you are not sure what the software object for your device is, find your Phidget on our [http://www.phidgets.com webpage], and then check the API documentation for it.
  
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.  
+
Once you have the Visual Basic .NET examples running, we have a [[#Edit the Examples|teaching section]] below to help you follow them.
  
[[File:VBNET VS2005 Run.PNG|link=|alt=Run]]
+
====Write Your Own Code====
  
Once you have the Visual Basic .NET examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.
+
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 libraries. To begin:
  
=====Write Your Own Code=====
+
1. Generate a new Visual Basic .NET Windows Applications project with a descriptive name such as PhidgetTest.
  
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:
+
[[Image:VB_VS2015_New_Project.png|600px]]
 
+
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.
 
2. Add a reference to the Phidget .NET library.
  
[[File:VBNET VS2005 Add Reference 1.PNG|link=|alt=Add Reference]]
+
[[Image:VB_VS2015_Add_Reference.png]]
  
3. Under the .NET tab, select {{Code|Phidget21.NET.dll}}.
+
3. Click Browse and navigate to the location of Phidget22.NET.dll, and add the file. If you used our installer, these files are installed in C:\Program Files\Phidgets\Phidget22, by default. If you have already done this for a previous project, you should be able to find Phidget22.NET.dll under the Browse → Recent tab.
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]]
+
[[Image:VB_VS2015_Add_Reference_2.png|600px]]
  
 
The project now has access to the Phidget function calls and you are ready to begin coding.
 
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.
+
The same [[#Edit 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===
 
===Mono===
  
This section will provide instructions on how to compile using the {{Code|vbnc}} compiler.
+
This section will provide instructions on how to compile using the vbnc compiler.  
  
=====Use Our Examples=====
+
====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 [{{SERVER}}/downloads/examples/CSharp.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.
+
We do not have Visual Basic .NET examples for the Mono framework. Fortunately, you can take a look at the source code for our [[Visual Studio 2015 examples]] for valuable programming insight. We have a [[#Edit the Examples|teaching section]] below to help you follow them.
  
=====Write Your Own Code=====
+
====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.
 
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.  
+
Place '''Phidget22.NET.dll''' in the same directory as your source code. To compile and build an executable, run:
 +
 
 
To compile and build an executable, run:
 
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>
 
  
Afterwards, you will have an executable named {{Code|example.exe}} that you can run. Type the following to run the program:
 
 
<div class="source">
 
<div class="source">
<syntaxhighlight lang=bash>
+
<syntaxhighlight lang='bash'>
mono example.exe
+
vbnc /out:example.exe /r:phidget22.NET.dll Example.vb
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</div>
 
</div>
  
The [[#Follow the Examples|teaching]] section also has further resources for programming your Phidget.
+
If you have the Phidget22.NET.dll installed in another location, please change the path to the file's location accordingly.
  
===MonoDevelop===
+
Afterwards, you will have an executable named example.exe that you can run. Type the following to run the program:
 
+
=====Use Our Examples=====
+
 
+
Download the [{{SERVER}}/downloads/examples/VBNET.zip examples] and unpack them into a folder. Here, you can find example programs for all the devices, as well as a HelloWorld program that will run with any Phidget.
+
 
+
These examples were written in Visual Studio 2005 and 2008, but they are also compatible with MonoDevelop. Please note that the examples are only designed to be run under the .NET framework. The examples are not compatible with the Mono framework. Despite this, if you are using the Mono framework, you can use the code within the examples for valuable programming insight.
+
 
+
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.  {{FindYourDevice}}
+
 
+
[[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 [[OS - OS X]] page, which also describes the different Phidget files, their installed locations, and their roles.... 
+
 
+
===Use Our Examples===
+
+
The first thing you are going to need to do is install [http://www.mono-project.com/Main_Page Mono] (Note that Mono is only available for Intel Macs and not PowerPC).  You will need both the SDK and the runtime. 
+
 
+
Then, you will need the Phidget .NET libraries.  These are part of the Windows library zip file download:
+
 
+
* [{{SERVER}}/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 VB.NET 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):
+
 
+
* [{{SERVER}}/downloads/examples/VBNET.zip Visual Basic .NET Examples for Windows]
+
 
+
One more thing needs to be done before you can compile and run the examples.  You need to set up a special configuration file so that Mono knows where to find the phidget21.dll.  Since Mac does not use dll's you need to redirect it to the appropriate file.  Create a new file in the same directory as the example you wish to compile and name it <code>Phidget21.NET.dll.config</code>.  Put the following into the file:
+
  
 
<div class="source">
 
<div class="source">
<syntaxhighlight lang=xml>
+
<syntaxhighlight lang='bash'>
<configuration>
+
mono example.exe
<dllmap dll="phidget21.dll" target="/Library/Frameworks/Phidget21.framework/Versions/Current/Phidget21" />
+
</configuration>
+
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</div>
 
</div>
  
All that is left is to compile and run the code.  When compiling, you need to link to the Phidget library. As the Phidget21.NET file is an "additional assembly" in VB.NET/Mono, you can link to the assembly using the {{Code|-r}} "reference" switch:
+
The [[#Edit the Examples|teaching section]] also has further resources for programming your Phidget.
  
To check that your Mac, 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.  Alternatively, you could find the source code for your device. {{Template:FindYourDevice}}
+
===MonoDevelop/Xamarin Studio===
  
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.
+
====Use Our Examples====
  
Let's say you're running the Hello World example. The source code for the example is in the directory:  
+
Download the [[examples]] and unpack them into a folder. Here, you can find example programs for all the devices, as well as a HelloWorld program that will work with any Phidget. The source file will be named the same as the software object for your device. If you are not sure what the software object for your device is, find your Phidget on our [http://www.phidgets.com webpage], and then check the API documentation for it.
  
:{{Code|VBNET/}} &rarr; {{Code|Hello World/}} &rarr; {{Code|Module1.vb}}
+
These examples were written in Visual Studio 2015, but are also compatible with MonoDevelop/Xamarin Studio.
  
Other examples will be in directories named appropriately for their software object name, rather than {{Code|Hello World}}.  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|Module1.vb}} file is.
+
To load all projects in MonoDevelop/Xamarin Studio, go to File → Open, and open AllExamples/AllExamples.sln
  
Then, compile the code. When compiling, you need to link to the Phidget library. As the Phidget21.NET file is an "additional assembly" in Visual Basic/Mono, you can link to the assembly using the {{Code|-r}} "reference" switch:
+
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 are running under the .NET framework, you can use full examples. Otherwise, if you are running under the Mono framework, please only use the HelloWorld example. The full examples use Windows Forms, which is not completely compatible with Mono's Gtk#.
  
<div class="source">
+
[[Image: VB MonoDevelop setStartup.png]]
<syntaxhighlight lang=bash>
+
vbnc Module1.vb -r:Phidget21.NET.dll
+
</syntaxhighlight>
+
</div>
+
  
This will compile a {{Code|*.exe}} file - in this case, {{Code|Module1.exe}}.  This you can then run under Mono:
+
The only thing left to do is to run the examples! Right click the project, and click on Run With and select the target framework. Please note that the projects, by default try to find the Phidget22.NET.dll in the C\Program Files\Phidgets\Phidget22. 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 Phidget22 cannot be found, please re-add the reference to Phidget22.NET.dll. Please see the [[#Write Your Own Code|Write Your Own Code]] section for details.
  
<div class="source">
+
[[Image: VB MonoDelevop Run.png|600px]]
<syntaxhighlight lang=bash>
+
sudo mono Program.exe
+
</syntaxhighlight>
+
</div>
+
  
Remember that the {{Code|sudo}} is needed unless you have your [[OS - Linux#Setting udev Rules|udev rules set on your Linux system]].
+
Once you have the Visual Basic .NET examples running, we have a [[#Edit the Examples|teaching section]] below to help you follow them.
  
If you will be compiling with an IDE such as GTK# or MonoDevelop, we don't have explicit instructions by IDE for Linux.  However, you will probably find the [[#MonoDevelop | MonoDevelop]] section in the Windows portion above useful.
+
====Write Your Own Code====
  
===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:
  
When writing your code from scratch, you start it as you would any Visual Basic code on OS X, such as within a text editor. In your .vb source code file, you must include a reference to the Phidget software object.  In the case of a Phidget interface kit device, this would look like:
+
1. Create a new Visual Basic .NET Console project with a descriptive name such as PhidgetTest.
  
<div class="source">
+
[[Image: VB MonoDelevop NewProject.png|600px]]
<syntaxhighlight lang=vbnet>
+
Public Class Form1
+
  'The Phidget object declaration
+
+
  Dim WithEvents ifKit As Phidgets.InterfaceKit
+
+
  '... Form1_Load and Form1_OnClosing here
+
End Class
+
</syntaxhighlight>
+
</div>
+
  
For other devices, check the API for your device on our webpage for the software object name, and the [{{SERVER}}/documentation/Phidget21.NET.zip API for .NET] for the specific syntax to use.  Then, you would compile your completed VB code the same way as the examples above.
+
[[Image: VB MonoDelevop NewProject2.png|600px]]
  
Mono also has a few different IDEs which you can use to develop code, and these are especially useful if you are doing GUI development. We provide instructions for MonoDevelop - one such IDE - being used [[#MonoDevelop|under Windows]].
+
2. Add a reference to the Phidget .NET library.
  
To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Follow the Examples|teaching section]] to help you follow the provided VB examples and which has resources such as the API reference.
+
[[Image: VB MonoDelevop EditReferences1.png]]
  
==Linux==
+
3. Select Phidget22.NET.dll. If you used our installer, by default, this file is placed in C:\Program Files\Phidgets\Phidget22. If it is in another location, please change the path to the file's location accordingly.
  
Visual Basic .NET has support on Linux through the Mono framework. 
+
[[Image: VB MonoDelevop EditReferences2.png|600px]]
  
===Use Our Examples===
+
The project now has access to the Phidget function calls and you are ready to begin coding.
+
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">
+
The same [[#Edit The Examples|teaching section]] which describes the examples also has further resources for programming your Phidget.
<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:
+
== Edit the Examples ==
  
<div class="source">
+
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.
<syntaxhighlight lang=bash>
+
Your main reference for writing VB.NET code will be the Phidget22 API Manual:
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.
+
'''<span style="color:#FF0000">Link to API manual</span>'''
  
Then, you will need the Phidget .NET libraries.  These are part of the Windows library zip file download:
+
=== Example Flow ===
  
* [{{SERVER}}/downloads/libraries/Phidget21-windevel.zip Phidget Windows Library Zip File]
+
{{ExamplePseudocode|In Visual Basic .NET, you can name these '''event''' functions whatever you like.  You will add them to the Phidget library in the Main Code section.  This hooks them into the actual events when they occur. <br><br>
 +
In the example code, the event functions common to all Phidgets are things like attach, detach, and error handling.<br>
 +
Other 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.
 +
|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.|
 +
[{{SERVER}}/documentation/Phidget22.NET.zip .NET API]}}
  
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 Visual Basic 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.
+
=== Code Snippets ===
  
Next, you'll want to download and extract the Phidget Visual Basic .NET Examples (not the ones for .NET Compact):
+
==== Step One: Initialize and Open ====
  
* [{{SERVER}}/downloads/examples/VBNET.zip Visual Basic .NET Examples for Windows]
+
The Open() function opens the software object, but not hardware. So, it is not a guarantee you can use the Phidget immediately.
  
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.  Alternatively, you could find the source code for your device. {{Template:FindYourDevice}}
+
For example, if we were using an Digital Input as our device, the create and open calls would look like this:
 
+
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.
+
 
+
Let's say you're running the Hello World example.  The source code for the example is in the directory:
+
 
+
:{{Code|VBNET/}} &rarr; {{Code|Hello World/}} &rarr; {{Code|Module1.vb}}
+
 
+
Other examples will be in directories named appropriately for their software object name, rather than {{Code|Hello World}}.  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|Module1.vb}} 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 Visual Basic/Mono, you can link to the assembly using the {{Code|-r}} "reference" switch:
+
  
 
<div class="source">
 
<div class="source">
<syntaxhighlight lang=bash>
+
<syntaxhighlight lang='vbnet'>
vbnc Module1.vb -r:Phidget21.NET.dll
+
device = New Phidget22.DigitalInput()
 +
device.Open()
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</div>
 
</div>
  
This will compile a {{Code|*.exe}} file - in this case, {{Code|Module1.exe}}.  This you can then run under Mono:
+
==== Step Two: Wait for Attachment (plugging in) of the Phidget ====
 
+
<div class="source">
+
<syntaxhighlight lang=bash>
+
sudo mono Program.exe
+
</syntaxhighlight>
+
</div>
+
 
+
Remember that the {{Code|sudo}} is needed unless you have your [[OS - Linux#Setting udev Rules|udev rules set on your Linux system]].
+
 
+
If you will be compiling with an IDE such as GTK# or MonoDevelop, we don't have explicit instructions by IDE for Linux.  However, you will probably find the [[#MonoDevelop | MonoDevelop]] section in the Windows portion above useful.
+
 
+
===Write Your Own Code===
+
  
When writing your code from scratch, you start it as you would any Visual Basic code on Linux, such as within a text editor like Emacs, Vi, Gedit, or Kate. In your .vb source code file, you must include a reference to the Phidget software object.  In the case of a Phidget interface kit device, this would look like:
+
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:
  
 
<div class="source">
 
<div class="source">
<syntaxhighlight lang=vbnet>
+
<syntaxhighlight lang='vbnet'>
Public Class Form1
+
device.Open(5000);
  'The Phidget object declaration
+
+
  Dim WithEvents ifKit As Phidgets.InterfaceKit
+
+
  '... Form1_Load and Form1_OnClosing here
+
End Class
+
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</div>
 
</div>
  
For other devices, check the API for your device on our webpage for the software object name, and the [{{SERVER}}/documentation/Phidget21.NET.zip API for .NET] for the specific syntax to use.  Then, you would compile your completed VB code the same way as the examples above.
+
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:
 
+
Mono also has a few different IDEs which you can use to develop code, and these are especially useful if you are doing GUI development.  We provide instructions for MonoDevelop - one such IDE - being used [[#MonoDevelop|under Windows]].
+
 
+
To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Follow the Examples|teaching section]] to help you follow the provided VB examples and which has resources such as the API reference.
+
 
+
==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:
+
 
+
{{UsingAPhidgetInCodeGeneral|both of which are available in .NET|[{{SERVER}}m/documentation/Phidget21.NET.zip .NET API]}}
+
 
+
===Example Flow===
+
 
+
{{ExamplePseudocode|In Visual Basic .NET, you can name these '''event''' functions whatever you like, although you must catch the events by name in the "Handles" portion of the function declaration.  The "Handles" portion of the function hooks them into the actual events when they occur. See our examples for details.<br>
+
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 device-specific examples to show you more detail on using your Phidget. 
+
|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.|
+
[{{SERVER}}/documentation/Phidget21.NET.zip .NET API]}}
+
 
+
===Code Snippets===
+
 
+
Specific calls in Visual Basic (VB) .NET will differ in syntax from those on the [[General Phidget Programming]] page, but the concepts stay the same.  
+
 
+
It may help to have the [[General Phidget Programming]] page and this section open at the same time, because they parallel each other and you can refer to the VB .NET syntax.  However, ''many'' additional concepts are covered on the General Phidget Programming page on a high level, such as using multiple Phidgets, handling errors, and different styles of programming.
+
 
+
====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.
+
 
+
The different types of open can be used with parameters to try and get the first device it can find, open based on its serial number, or even open across the network. The API manual lists and [[General Phidget Programming]] discusses all of the available modes that open provides.
+
 
+
For example, if we were using an Interface Kit Phidget board as our device, the create and open calls would look like this:
+
  
 
<div class="source">
 
<div class="source">
<syntaxhighlight lang=vbnet>
+
<syntaxhighlight lang='vbnet'>
ifKit = New Phidgets.InterfaceKit
+
Private Sub device_Attach(ByVal sender As Object, ByVal e As Phidget22.Events.AttachEventArgs) Handles device.Attach
ifKit.open()
+
  Dim attachedDevice As Phidget22.Phidget = CType(sender, Phidget22.Phidget)
 +
  Dim serialNumber as Integer
 +
  Dim deviceName as String
 +
  serialNumber = attachedDevice.DeviceSerialNumber;
 +
  deviceName = attachedDevice.DeviceName;
 +
  Console.WriteLine("Hello Device {0},  Serial Number: {1}!", deviceName, serialNumber.ToString());
 +
End Sub
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</div>
 
</div>
  
====Step Two: Wait for Attachment (plugging in) of the Phidget====
+
==== 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:
To use the Phidget, it must be plugged in (attached). We can handle this by using event driven programming and tracking the AttachEvents and DetachEvents, or we can handle this by calling waitForAttachment. This function works for any Phidget. WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.
+
 
+
When combined in your initialization function with the initialization and open from above, the wait for attachment would look like this:
+
 
+
 
<div class="source">
 
<div class="source">
 
<syntaxhighlight lang=vbnet>
 
<syntaxhighlight lang=vbnet>
Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs)
+
Private Sub device_DigitalInputChange(ByVal sender As Object, ByVal e As Phidget22.Events.DigitalInputStateChangeEventArgs) Handles device.StateChange
Handles MyBase.Load
+
  textBox1.Text = "State: " + e.State;
    ifKit = New Phidgets.InterfaceKit
+
    ifKit.open()
+
    ifKit.waitForAttachment(3000)
+
 
End Sub
 
End Sub
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</div>
 
</div>
  
====Step Three: Do Things with the Phidget====
+
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:
 
+
We recommend the use of event driven programming when working with Phidgets. In VB.NET we can hook an event handler into the event of a sensor changing on an Interface Kit board with the following code:
+
  
 
<div class="source">
 
<div class="source">
 
<syntaxhighlight lang=vbnet>
 
<syntaxhighlight lang=vbnet>
Private Sub ifKit_SensorChange(ByVal sender As Object, ByVal e As Phidgets.Events.SensorChangeEventArgs) Handles ifKit.SensorChange
+
val = device.State;
    TextBox1.Text = "Index " + e.Index.ToString() + " Value: " + e.Value.ToString()
+
End Sub
+
</syntaxhighlight>
+
</div>
+
  
With this function, the code inside ifKit_SensorChange will get executed every time the Phidget Interface Kit reports a change on one of its analog inputs. This is because it "Handles" the SensorChange event.  Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
+
device.State = true;
 
+
Some values can be read and sent directly to the Phidget, simply use the instance members and properties. This is also how you would set properties on the Phidget such as the output state or
+
sensor sensitivity.  For example, obtaining the value of analog input (sensor) 0 on an Interface Kit board would be via:
+
 
+
<div class="source">
+
<syntaxhighlight lang=vbnet>
+
Dim val As Integer = ifKit.sensors(0).Value
+
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</div>
 
</div>
  
====Step Four: Close and Delete====
+
==== Step Four: Close and Delete ====
 
+
At the end of your program, be sure to close your device.
At the end of your program, unhook any events and call Application.DoEvents(). This will make sure there are no outstanding events being processed before calling close.
+
  
 
<div class="source">
 
<div class="source">
 
<syntaxhighlight lang=vbnet>
 
<syntaxhighlight lang=vbnet>
 
Private Sub Form1_FormClosing(ByVal sender As Object, ByVal e As System.Windows.Forms.FormClosingEventArgs) Handles Me.FormClosing
 
Private Sub Form1_FormClosing(ByVal sender As Object, ByVal e As System.Windows.Forms.FormClosingEventArgs) Handles Me.FormClosing
     RemoveHandler ifKit.SensorChange, AddressOf ifKit_SensorChange
+
     device.Close();
    Application.DoEvents()
+
    ifKit.close()
+
 
End Sub
 
End Sub
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</div>
 
</div>
  
{{MoreHowTos}}
+
==== More How-To's ====
  
The ''complete'' set of functions you have available for all Phidgets can be found in the [{{SERVER}}/documentation/Phidget21.NET.zip .NET API].  You can also find more description on any device-specific function in the Device API page for your specific Phidget, which can be found in its [[:Category:UserGuide|user guide]].
+
'''<span style="color:#FF0000">Link to other common pages like polling vs. events</span>'''
  
==Common Problems and Solutions/Workarounds==
+
== Common Problems and Solutions/Workarounds ==
  
==={{ProblemSolution|All Operating Systems|The Phidgets.Events.ErrorEventHandler conflicts with System.IO.ErrorEventHandler.}}===
+
'''<span style="color:#FF0000">If you know of common problems using this lanaguage (for example, having to create sub-VIs when using multiple phidgets in labview) put them here. </span>'''
 
+
<div class="source">
+
<syntaxhighlight lang=csharp>
+
using System.IO;
+
using Phidgets;
+
using Phidgets.Events;
+
...
+
spatial.Error += new ErrorEventHandler(spatial_Error);
+
 
+
...
+
void spatial_Error(object sender, ErrorEventArgs e){
+
  ...
+
}
+
</syntaxhighlight>
+
</div>
+
 
+
The above code produces the following errors:
+
 
+
{{Code|'ErrorEventHandler' is an ambiguous reference between 'System.IO.ErrorEventHandler' and 'Phidgets.Events.ErrorEventHandler'}}.
+
 
+
and
+
 
+
{{Code|'ErrorEventArgs' is an ambiguous reference between 'System.IO.ErrorEventArgs' and 'Phidgets.Events.ErrorEventArgs'}}.
+
 
+
The error is due to the {{Code|System.IO}} and {{Code|Phidgets.Events}} namespaces both having a class called {{Code|ErrorEventHandler}}.
+
 
+
To get around this issue, use the fully qualified namespace when referring to the {{Code|ErrorEventHandler}} and {{Code|ErrorEventArgs}} classes:
+
<div class="source">
+
<syntaxhighlight lang=csharp>
+
using System.IO;
+
using Phidgets;
+
using Phidgets.Events;
+
...
+
spatial.Error += new Phidgets.Events.ErrorEventHandler(spatial_Error);
+
...
+
 
+
void spatial_Error(object sender, Phidgets.Events.ErrorEventArgs e){
+
  ...
+
}
+
 
+
</syntaxhighlight>
+
</div>
+

Revision as of 21:19, 18 January 2017

Visual Basic .NET, developed by Microsoft is a modern object oriented programming language and the successor to Visual Basic 6.0.


Introduction

If this is your first time working with a Phidget, we suggest starting with the Getting Started page for your specific device. This can be found in the user guide for your device. That page will walk you through installing drivers and libraries for your operating system, and will then bring you back here to use VB.NET specifically. VB.NET is capable of using the complete Phidget API, including events. We also provide example code in VB.NET for all Phidget devices.

VB.NET with Phidgets is only supported on Windows, and can be used with Visual Studio 2015, Mono, or MonoDevelop.

Quick Downloads

List of download links, to be added once files are available

Documentation

Example Code

Libraries and Drivers

Getting Started with VB.NET

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:

  • Make sure your libraries are properly linked
  • Go from source code to a test application as quickly as possible
  • Ensure your Phidget is hooked up properly

Instructions are divided up by operating system. Choose:

Windows

Description of Library Files

Visual Basic .NET programs on Windows depend on the following files, which the installers above put onto your system:

  • phidget22.dll contains the actual Phidget library, which is used at run-time. By default, it is placed in C:\Windows\System32.
  • Phidget22.NET.dll is the Phidget library for .NET framework 2.0 or higher. Your compiler has to know where this file is. By default, it is placed into C:\Program Files\Phidgets\Phidget22. 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:

  • Phidget22.NET.XML 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 C:\Program Files\Phidgets\Phidget22.

Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.

Visual Studio 2015

Use Our Examples

Please start by downloading the examples and unpacking them into a folder. Since the examples were written in Visual Studio 2015, you will need to use Visual Studio 2015 or later in order to run the examples. To load all projects in Visual Studio, go to File → Open → Project, and open AllExamples/AllExamples.sln.

The easiest way to confirm that your environment is set up properly will be to compile and run the HelloWorld Visual Basic .NET example.

Start by setting the HelloWorld project as your start up project.

The only thing left to do is to run the example! Click on Debug → Start Debugging. Please note that the projects, by default try to find the Phidget22.NET.dll in the C:\Program Files\Phidgets\Phidget22. 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 Phidget22 cannot be found, please re-add the reference to Phidget22.NET.dll. Please see the Write Your Own Code section for details.

VB VS2015 Run.png

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:

VB VS2015 HelloWorld Output.png

After confirming that the HelloWorld example is working, you can proceed to run the example for your device. The source file will be named the same as the software object for your device. If you are not sure what the software object for your device is, find your Phidget on our webpage, and then check the API documentation for it.

Once you have the Visual Basic .NET examples running, we have a 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 libraries. To begin:

1. Generate a new Visual Basic .NET Windows Applications project with a descriptive name such as PhidgetTest.

VB VS2015 New Project.png

2. Add a reference to the Phidget .NET library.

VB VS2015 Add Reference.png

3. Click Browse and navigate to the location of Phidget22.NET.dll, and add the file. If you used our installer, these files are installed in C:\Program Files\Phidgets\Phidget22, by default. If you have already done this for a previous project, you should be able to find Phidget22.NET.dll under the Browse → Recent tab.

VB VS2015 Add Reference 2.png

The project now has access to the Phidget function calls and you are ready to begin coding.

The same 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 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 Visual Studio 2015 examples for valuable programming insight. We have a 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 Phidget22.NET.dll in the same directory as your source code. To compile and build an executable, run:

To compile and build an executable, run:

vbnc /out:example.exe /r:phidget22.NET.dll Example.vb

If you have the Phidget22.NET.dll installed in another location, please change the path to the file's location accordingly.

Afterwards, you will have an executable named example.exe that you can run. Type the following to run the program:

mono example.exe

The teaching section also has further resources for programming your Phidget.

MonoDevelop/Xamarin Studio

Use Our Examples

Download the examples and unpack them into a folder. Here, you can find example programs for all the devices, as well as a HelloWorld program that will work with any Phidget. The source file will be named the same as the software object for your device. If you are not sure what the software object for your device is, find your Phidget on our webpage, and then check the API documentation for it.

These examples were written in Visual Studio 2015, but are also compatible with MonoDevelop/Xamarin Studio.

To load all projects in MonoDevelop/Xamarin Studio, go to File → Open, and open 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 are running under the .NET framework, you can use full examples. Otherwise, if you are running under the Mono framework, please only use the HelloWorld example. The full examples use Windows Forms, which is not completely compatible with Mono's Gtk#.

VB MonoDevelop setStartup.png

The only thing left to do is to run the examples! Right click the project, and click on Run With and select the target framework. Please note that the projects, by default try to find the Phidget22.NET.dll in the C\Program Files\Phidgets\Phidget22. 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 Phidget22 cannot be found, please re-add the reference to Phidget22.NET.dll. Please see the Write Your Own Code section for details.

VB MonoDelevop Run.png

Once you have the Visual Basic .NET examples running, we have a 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.

VB MonoDelevop NewProject.png

VB MonoDelevop NewProject2.png

2. Add a reference to the Phidget .NET library.

VB MonoDelevop EditReferences1.png

3. Select Phidget22.NET.dll. If you used our installer, by default, this file is placed in C:\Program Files\Phidgets\Phidget22. If it is in another location, please change the path to the file's location accordingly.

VB MonoDelevop EditReferences2.png

The project now has access to the Phidget function calls and you are ready to begin coding.

The same teaching section which describes the examples also has further resources for programming your Phidget.

Edit 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 VB.NET code will be the Phidget22 API Manual:

Link to API manual

Example Flow

Template:ExamplePseudocode

Code Snippets

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:

device = New Phidget22.DigitalInput()
device.Open()

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:

Private Sub device_Attach(ByVal sender As Object, ByVal e As Phidget22.Events.AttachEventArgs) Handles device.Attach
  Dim attachedDevice As Phidget22.Phidget = CType(sender, Phidget22.Phidget)
  Dim serialNumber as Integer
  Dim deviceName as String
  serialNumber = attachedDevice.DeviceSerialNumber;
  deviceName = attachedDevice.DeviceName;
  Console.WriteLine("Hello Device {0},  Serial Number: {1}!", deviceName, serialNumber.ToString());
End Sub

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:

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

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:

val = device.State;

device.State = true;

Step Four: Close and Delete

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

Private Sub Form1_FormClosing(ByVal sender As Object, ByVal e As System.Windows.Forms.FormClosingEventArgs) Handles Me.FormClosing
    device.Close();
End Sub

More How-To's

Link to other common pages like polling vs. events

Common Problems and Solutions/Workarounds

If you know of common problems using this lanaguage (for example, having to create sub-VIs when using multiple phidgets in labview) put them here.