Notice: This page contains information for the legacy Phidget21 Library. Phidget21 does not support VINT Phidgets, and will not support any new Phidgets. Phidget21 will be maintained until 2020. We recommend that new projects be developed against the Phidget22 Library.

Click on the 2phidget22.jpg button in the menu bar to go to the Phidget22 version of this page.


Difference between revisions of "Language - AutoIt"

From Phidgets Legacy Support
Jump to: navigation, search
(Quick Downloads)
Line 1: Line 1:
[[File:icon-Autoit.png|64x64px]] Preamble about the language's origin and its main characteristics.
{{OSLang|[[File:icon-Autoit.png|64x64px]]|Preamble about the language's origin and its main characteristics.}}
AutoIt has a complete API for all Phidgets devices, but no sample code at this time.
AutoIt has a complete API for all Phidgets devices, but no sample code at this time.

Revision as of 17:10, 20 April 2012

Icon-Autoit.png Preamble about the language's origin and its main characteristics.


AutoIt has a complete API for all Phidgets devices, but no sample code at this time.

For a complete list of our supported languages and their support status, click here

  • Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
  • In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

Development Environments and Compilers

Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.

Quick Downloads

Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website. Visit the drivers section at and get the latest:

You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:

  • API Manual
  • At this time, we do not have sample code available for AutoIt.
  • You can find a high level discussion about programming with Phidgets in general on the General Phidget Programming page.
  • The Device Functionality page explains the general operational information for your device.

You may want to have these pages open while working through these instructions.

Getting Started

Applications using Phidgets can be developed in AutoIt v3 through the COM API and this tutorial assumes its use. The Phidget framework will register the necessary .dlls for you. To begin, create a new AutoIt script file and open it with your preferred editor. Then, create a simple user interface to work with and then place an input control for the purpose of capturing some simple output.

  #include <GUIConstantsEx.au3>
  GUICreate("Phidget Test")
  $InputControl = GUICtrlCreateInput("", 20, 40, 160)
  ;Phidget initialization code goes here
     $msg = GUIGetMsg()
  Until $msg = $GUI_EVENT_CLOSE
  ;Phidget Event Handlers go here

Coding For Your Phidget

Before you can use the Phidget, you must create the object from the Phidget21COM library at initialization. This can be accomplished through a call to ObjCreate. For example, we can declare and create a PhidgetInterfaceKit with:

  $oPhid1 = ObjCreate("Phidget21COM.PhidgetInterfacekit")

The object name for any type of Phidget is listed in the API manual. Every type of Phidget also shares some functionality from the base Phidget class.

Connecting to the Phidget

The program can try to connect to the Phidget through a call to open. Open will continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected. This means that simply calling open does not guarantee you can use the Phidget immediately. We can account for a connection by using event driven programming and tracking the AttachEvents and DetachEvents, or by calling WaitForAttachment. WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.

  If NOT $oPhid1.IsAttached Then
     MsgBox(0, "Error", "Phidget Device not attached")

The different parameters and open calls can be used to open the first Phidget of a type it can find, open based on a serial number, or even open across the network. The API manual lists all of the available modes that open provides. One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed. This prevents any other instances from retrieving data from the Phidget, including other programs. The one connection per device limit does not apply when exclusively using the Phidget Webservice.

Event Driven Programming

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. In AutoIt, you enable event handlers for a Phidget at initialization with the following line:

  $oPhidEvents = ObjEvent($oPhid1, "phid1_")

AutoIt will use the phidl1_ prefix we declared when looking for the handler to execute. You can define the handler functions for events such as OnSensorChange or Attached elsewhere in your code:

  Func phid1_OnSensorChange($Index, $SensorValue)
     GUICtrlSetData($InputControl, $SensorValue)

With this method, the code inside phid1_OnSensorChange will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs. Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets. Please refer to the API manual for a full list of events and their usage.

Working directly with the Phidget

Some values can be directly read and set on the Phidget, and inside polling loops used as an alternative to event driven programming. Simply use the instance properties such as SensorValue(Index as Long) or OutputState(Index as Long) for PhidgetInterfaceKits.

  $oPhid1.OutputState(0) = "true"

Note that when setting booleans on the Phidget, it must be encapsulated in quotes. Alternatively, you can usually use the integer value 0 for false and 1 for true.

Working with multiple Phidgets

Multiple Phidgets of the same type can easily be run inside the same program. In our case, it requires another PhidgetInterfaceKit object to be defined and initialized. The new object can then be set up, opened and used in the same process as the previous one. If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.

Other Phidgets

The design given in this document can also be followed for almost all Phidgets. For example, if you were using a PhidgetRFID instead of an PhidgetInterfacekit, you would declare a PhidgetRFID object instead of a PhidgetInterfaceKit. The methods and events available would change but they can be accessed in a similar manner.

Building your Project

Describe the different ways a project could be built using this language.

Common Problems and Solutions/Workarounds

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