|
|
| (66 intermediate revisions by 9 users not shown) |
| Line 1: |
Line 1: |
| | <metadesc>Communicate over USB with sensors, controllers and relays with Phidgets! Our Visual Basic .NET library supports Windows using Visual Studio or Mono.</metadesc> |
| [[Category:Language]] | | [[Category:Language]] |
| [[File:icon-Visual Basic Net.png|64x64px|link=|alt=]] Preamble about the language's origin and its main characteristics.
| | __NOTOC__ |
| | We provide support for the Visual Basic .NET language on the Windows operating system. We also provide instructions on how to get your project started in a number of common development environments. Select your operating system and preferred development environment below, and follow the instructions to get your project running with Phidgets. |
|
| |
|
| __TOC__
| | If you do not know which development environment you want to use, or your development environment of choice is not listed, we recommend starting with Mono as the simplest path to getting your code running. Visual Studio is the most popular way to build Visual Basic .NET projects, but it also has a steep learning curve. |
|
| |
|
| ==Introduction==
| | Once you have set up your development environment to run with Phidgets, we recommend you follow our guide on [[Phidget Programming Basics]]. The guide will showcase the fundamentals of programming with Phidgets. |
|
| |
|
| {{LanguageSupport|Visual Basic .NET|the complete Phidget API, including events|all Phidget devices.|the .NET or Mono framework. Both of the frameworks are supported on Windows. For Linux and Mac OS X, only the Mono framework can be used. We provide instructions on how to set up your environment/compilers for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]], [[#Visual Studio 2003 | Visual Studio 2003]], [[#MonoDevelop | MonoDevelop]] and the [[#Mono | Mono command line compilers]]|}}
| | ==Choose Your Development Environment:== |
|
| |
|
| ==Quick Downloads==
| | {{Language_-_Visual_Basic_.NET_Dev_Environment_Table}} |
|
| |
|
| {{QuickDownloads|Visual Basic .NET|
| | == Quick Downloads == |
| {{APIQuickDownloads|http://www.phidgets.com/documentation/Phidget21.NET.zip}}|
| | If you already know what you're doing and just need the files, you can find them all below. |
| {{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip}}|
| |
| {{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip|.NET|}}
| |
| {{WindowsQuickDownloads}}
| |
| {{MacQuickDownloads}}
| |
| {{LinuxQuickDownloads}}
| |
| }}
| |
|
| |
|
| ==Getting started with Visual Basic .NET== | | === Documentation === |
|
| |
|
| If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
| | *{{Phidget22API}} (Select Visual Basic .NET from drop-down menu) |
| {{ExampleCodeReasons}} | |
|
| |
|
| Instructions are divided up by operating system. Choose:
| | === Example Code === |
| *[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
| |
| *[[#Mac OS X |Mac OS X]]
| |
| *[[#Linux | Linux]] (including PhidgetSBC)
| |
|
| |
|
| ==Windows(2000/XP/Vista/7)==
| | *{{SampleCode|VBNET|Visual Basic .NET Examples}} |
|
| |
|
| ===Description of Library Files=== | | ===Libraries=== |
| 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].
| | {{AllQuickDownloads}} |
| | |
| | |
| 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 foler. 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 → Open → 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 → 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 VB.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>
| |
| | |
| 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 → 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.
| |
| | |
| ==Mac OS X==
| |
| | |
| Visual Basic .NET has excellent support on Mac OS X through the Mono framework.
| |
| | |
| The first step in using Visual Basic .NET on Mac is to install the Phidget libraries. Compile and install them as explained on the [[Device List|getting started guide for your device]]. Then, the [[OS - Mac OS X]] page also describes the different Phidget files, their installed locations, and their roles....
| |
| | |
| ==Linux==
| |
| | |
| Visual Basic .NET has support on Linux through the Mono framework.
| |
| | |
| The first step in using Visual Basic .NET on Linux is to install the Phidget libraries. Compile and install them as explained on the main [[OS - Linux | Linux page]]. That Linux page also describes the different Phidget files, their installed locations, and their roles.
| |
| | |
| ==Follow the Examples==
| |
| | |
| By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.
| |
| | |
| Next, comes our API information. These resources outline the Phidget .NET functions:
| |
| | |
| {{UsingAPhidgetInCodeGeneral|both of which are available in .NET|[http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API]}}
| |
| | |
| ===Example Flow===
| |
| | |
| {{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>
| |
| 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 Phidget.NET API]}}
| |
| | |
| ==Code Snippets==
| |
| | |
| ==Common Problems and Solutions/Workarounds==
| |
| | |
| Here you can put various frequent problems and our recommended solutions.
| |
Windows
