Language - LabVIEW: Difference between revisions

From Phidgets Support
No edit summary
Line 1: Line 1:
[[Category:Language]]
[[Category:Language]]
{{OSLang|[[File:icon-LabVIEW.png|64x64px|left|link=|alt=]]|LabVIEW, developed by [http://www.ni.com National Instruments] is dataflow programming language for data processing.}}
__TOC__
__TOC__


== 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 LabVIEW specifically.
== Quick Downloads ==
LabVIEW is capable of using the complete {{Phidget22API}}, including events. We also provide example code in LabVIEW for all Phidget devices.
=== Documentation ===
 
=== Example Code ===
 
=== Libraries ===


LabVIEW can be developed with Windows. A minimum version of LabVIEW 2009 is required. OS X and Linux are unsupported as the Labview/Phidgets combination has not been tested on those systems.
{{WindowsQuickDownloads}}


You can compare LabVIEW with our other supported languages.
== Getting Started with LabVIEW ==
Welcome to using Phidgets with LabVIEW! By using LabVIEW, you will have access to the complete {{Phidget22API}}, including events. We also provide example code in LabVIEW for all Phidget devices.


Note that with LabVIEW you can install a 32-bit version on a 64-bit computer without any issues, but the 64-bit version cannot obviously be installed on a 32-bit computer. The reason this is relevant is that the respective versions cannot create executables that the other can run. I.E. 64-bit LabVIEW cannot generate a 32-bit executable. The upshot of this is that if you need your executable to be compatible with older machines (such as Windows XP machines) then you will need to use a 32-bit version of LabVIEW to create your program.
== Windows ==
{{Windows_Languages}}
====Use our examples====
One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install the LabVIEW from [http://www.ni.com/en-ca/shop/labview.html Nation Instruments].


== Quick Downloads ==


=== Documentation ===
Next, download and unpack the Phidgets LabVIEW library:
*[{{SERVER}}/downloads/phidget22/all/https://wwwdev/downloads/phidget22/libraries/any/Phidget22Labview.zip Phidget LabVIEW library]
 


Rename the folder to ''Phidgets''
[[Image:Labview_rename.png|link=|center]]




=== Example Code ===


Navigate to the following directory:
*For 32-bit LabVIEW -> C:/Program Files (x86)/National Instruments/LabVIEW 20xx/instr.lib
*For 64-bit LabVIEW -> C:/Program Files/National Instruments/LabVIEW 20xx/instr.lib




=== Libraries and Drivers ===


{{WindowsQuickDownloads}}
Place the renamed folder at this location:
[[Image:Labview_copy.png|link=|center]]


== Getting Started with LabVIEW ==


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:
Next, open LabVIEW and create a new VI:
*[[#Windows(XP/Vista/7)|Windows XP / Vista / 7]]
[[Image:Labview_newvi.png|link=|center]]


== Windows ==
===Description of Library Files===


LabVIEW programs on Windows depend on the following two items, The installers in the Quick Downloads section put only the phidget22.dll into your system. You will need to manually put the Phidget LabVIEW library 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.
*'''Phidgets LabVIEW library''' contains the Phidget library for LabVIEW. Instructions are explained in the [[#Installing the Library|Installing the Library]] section.


If you do not want to use our installer, you can download the [[phidget22.dll]] and manually install it where you want; refer to our [[OS_-_Windows#Manual_File_Installation|Manual Installation Instructions]].
Navigate to the block diagram window that was generated and open the functions palette (''View'' -> ''Functions Palette''). Next, navigate to ''Instrument I/O'' -> ''Instrument Drivers'' -> ''Phidgets''
[[Image:Labview_functionspalette.PNG|link=|center]]


We include instructions for LabVIEW 2012 on [[#Use Our Examples|using our examples]] and [[#Write Your Own Code|writing your own code]].


====Installing the Library====


1. To install the Phidgets Library, simply download the [[#Libraries_and_Drivers|Phidgets Labview Library]] folder into the instr.lib folder corresponding to your LabVIEW installation.
Next, select a palette that will work for your Phidget and drag the ''VI Tree.vi'' onto your block diagram:
[[Image:Labview_vitree.png|link=|center]]


If LabVIEW was installed using default settings, this will be under C:\Program Files (x86)\National Instruments\LabVIEW 20xx\instr.lib if you are using 32 bit LabVIEW, or C:\Program Files\National Instruments\LabVIEW 20xx\instr.lib if you are using 64 bit LabVIEW, where 20xx is the version of LabVIEW being used (eg. 2015 for LabVIEW 2015).


2. Open or restart LabVIEW to refresh the VI palettes.


3. The Phidgets palette is located in the Instr Drivers palette under Instrument IO.
Right-click on ''VI Tree.vi'' and select ''Open Front Panel'':
[[Image:Labview_openfrontpanel.png|link=|center]]


[[Image:Phidget22_LabVIEW_Palette.png|link=|400px]]


====Use Our Examples====
1. To find our examples, open a new VI.


2. Navigate to the palette you want the example for, place "VI Tree.vi" on your block diagram.
From the front panel, navigate to the block diagram (''Window'' -> ''Block Diagram'')
[[Image:Labview_showblock.png|link=|center]]


[[Image:VI Tree in Palette.png|link=|600px]]


3. Right click "VI Tree.vi" and select Open Front Panel. From the front panel, open VI Tree.vi's block diagram.


[[Image:VI Tree Open Front Panel.png|link=]]
The examples are located near the bottom of the block diagram. Right-click the example you would like to use and select ''Open Front Panel'':
[[Image:Labview_runexample.png|link=|center]]


4. Examples will be located near the bottom of the diagram, as plain white VIs. Open the front panel of the example to use it.


[[Image:VI Tree Examples.png|link=|600px]]
When you are ready, press run and the application will demonstrate the Phidget's functionality. Here is an example of a Accelerometer channel on a Spatial Phidget:
[[Image:Labview_run.PNG|link=|center]]


[[Image: Example Front Panel.png|link=]]


You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
====Write Your Own Code====
====Write Your Own Code====



Revision as of 23:39, 5 June 2017


Quick Downloads

Documentation

Example Code

Libraries

Getting Started with LabVIEW

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

Windows

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

Use our examples

One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install the LabVIEW from Nation Instruments.


Next, download and unpack the Phidgets LabVIEW library:


Rename the folder to Phidgets

Labview rename.png


Navigate to the following directory:

  • For 32-bit LabVIEW -> C:/Program Files (x86)/National Instruments/LabVIEW 20xx/instr.lib
  • For 64-bit LabVIEW -> C:/Program Files/National Instruments/LabVIEW 20xx/instr.lib


Place the renamed folder at this location:

Labview copy.png


Next, open LabVIEW and create a new VI:

Labview newvi.png


Navigate to the block diagram window that was generated and open the functions palette (View -> Functions Palette). Next, navigate to Instrument I/O -> Instrument Drivers -> Phidgets

Labview functionspalette.PNG


Next, select a palette that will work for your Phidget and drag the VI Tree.vi onto your block diagram:

Labview vitree.png


Right-click on VI Tree.vi and select Open Front Panel:

Labview openfrontpanel.png


From the front panel, navigate to the block diagram (Window -> Block Diagram)

Labview showblock.png


The examples are located near the bottom of the block diagram. Right-click the example you would like to use and select Open Front Panel:

Labview runexample.png


When you are ready, press run and the application will demonstrate the Phidget's functionality. Here is an example of a Accelerometer channel on a Spatial Phidget:

Labview run.PNG


You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!

Write Your Own Code

1. To start working with a new Phidget, you will first need matching Start and Close VIs. These are found at the top of the Phidgets palette.

LabVIEW Phidget Start.png

2. Next, select the type of Phidget you wish to use from the drop-down menu.

LabVIEW Phidget Start Menu.png

3. Add device information and any desired initialization paramaters to the Start VI. Many Phidgets VIs use terminals with special values or formats. For these is is best to right click the terminal, and select Create->Control or Create->Constant.

Labview Create Control.png

LabVIEW Phidget Device Info.png

4. You are now ready to write code for your Phidget, as outlined in the Code Snippets section, and the methods outlined in the examples for your device.

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 LabVIEW code will be this page, the examples, the Phidget22 API, and the VI help files.

Examples of more complex general topics such as using multiple Phidgets and connecting to a Phidget over the Network Server can be found under the VI Tree for the Phidget Common palette.

Example Flow

Most LabVIEW examples follow the same basic flow of starting a Phidget, reading some data, and closing the Phidget.

Digital Input Example.png

Code Snippets

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

Step One: Initialize, Open and Wait for Attachment (plugging in) of the Phidget

The entire process of opening and initializing a Phidget can be done by using the version of StartPhidget.vi that corresponds to your device.

In most cases, StartPhidget.vi will also attempt to wait for the first data to become available from the device for 5 seconds after initialization.

StartPhidget VI.png

If you'd prefer to initialize the device manually, you can use OpenPhidget.vi for your device and call the individual functions to set up the device.

OpenPhidgetVI.png

Step Two: Do Things with the Phidget

You can read data and interact with your Phidget both by polling it for its current state (or to set a state), or by catching events that trigger when the data changes.

To poll devices, simply place the corresponding blocks.

LabVIEW polling 1.png LabVIEW polling 2.png

To use events, there are three main blocks for each type, to create, execute, and close the event handler.

When creating the event, all devices using an event of the same type must be grouped into an array to ensure the events get processed correctly.

Event Array grouping.png

Once created, the events will be processed by [Name]EventExe.vi. When an event occurs, the pertinent information will be output, as well as information to reference which device caused it.

Event Exe.png

After a program has run its course, the event handler must be closed.

Event Close.png

Step Three: Close and Delete

Closing a Phidget is done by using the appropriate version of ClosePhidget.vi

Close Phidget VI.png

Further Reading

Phidget Programming Basics - Here you can find the basic concepts to help you get started with making your own programs that use Phidgets.

Data Interval/Change Trigger - Learn about these two properties that control how much data comes in from your sensors.

Using Multiple Phidgets - It can be difficult to figure out how to use more than one Phidget in your program. This page will guide you through the steps.

Polling vs. Events - Your program can gather data in either a polling-driven or event-driven manner. Learn the difference to determine which is best for your application.

Logging, Exceptions, and Errors - Learn about all the tools you can use to debug your program.

Phidget Network Server - Phidgets can be controlled and communicated with over your network- either wirelessly or over ethernet.

Common Problems and Solutions/Workarounds

Issue: I cannot attach to an object any more after running my program once

What this means is you probably aborted the VI which stopped the program before the Phidget could be closed. Aborting execution will not release the Phidget device properly and will consequently make it unusable until the Phidgets library (or LabVIEW) has been restarted.

To resolve this, you may open a new VI, place PhidgetResetLibrary.vi, and run it. This will completely reset the current Phidget library, making it possible again to connect to all Phidgets.

Note that this action will close all Phidgets that are currently open in LabVIEW, and should not be used while other Phidgets-related LabVIEW VIs are running.

Phidget Reset All Palette.png

Phidget Reset All.png

In order to prevent this from happening you should use a software stop button when possible instead of halting operation. That way the Close subVI gets called and the Phidget will be released.