Phidgets Legacy Support - User contributions [en]

Language - Flex AS3

2011-11-14T15:45:19Z

192.168.3.159: /* Drivers, Libraries and Resources */

Language - Flash AS3

2011-11-14T15:44:58Z

192.168.3.159: /* Drivers, Libraries and Resources */

Language - Delphi

2011-11-14T15:42:56Z

192.168.3.159: /* Drivers, Libraries and Resources */

Preamble about the language and its general strengths and weaknesses.

==Assessment for use with Phidgets==
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.

==Support==
Delphi has a complete API for all Phidgets devices, and code samples for some devices.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

==Restrictions==
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 www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/COM_API_Manual.pdf API Manual]
* [http://www.phidgets.com/downloads/examples/Delphi_2.1.8.20110615.zip Delphi Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] 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==

The Phidget examples were written using Borland Delphi 2005 and 7, and this tutorial assumes its use.
The ActiveX objects installed with the Phidget libraries are not automatically imported into Delphi, so to begin you will need to manually import them:

#Go to Component >> Import ActiveX Control...
#Select the Phidget Library 2.1 and click install
#In the next popup select the “install into new package” tab
#Give the package a suitable name and description such as “Phidgets”, and then click OK
#Compile and Install the newly created package if not done so automatically.

In Delphi 2005/2006:

#Go to File >> New >> Package - Delphi for Win32. Rename and save the package using File >> Save Project As...
#Import the ActiveX component, go to Component >> Import Component.
#Choose Inport ActiveX Control and click Next
#Select Phidget Library 2.1 and click Next
#Click Next
#Select ‘Add unit to [Package Name] project’ and click Finish.
#Install the ActiveX package you have created by right-mouse-clicking the package name in the Project Manager pane and selecting ‘Install’.
#Delphi should now display a confirmation that the package was installed. Click ok and save the package.
#When you open a new or existing application, you should now see all the Phidget device control objects listed under the ActiveX category.

In newer versions of Delphi:

#Go to Component >> Import Component...
#Choose “Import ActiveX Control” and click Next
#Pick Phidget Library 2.1 from the list and click Next
#Set the palette Page to ActiveX and check the Generate Component Wrappers option
#Choose Install into a new package and click next
#Give the package a name and description such as “Phidgets”, and then click Finish

Once installed, all future projects will be able to use the Phidget ActiveX objects.

===Coding For Your Phidget===

Before you can use the Phidget, you must declare and initialize its ActiveX object.
The simplest method is to place the control from the ActiveX component tab on to your form.
For this tutorial, create a PhidgetInterfaceKit control (PhidgetInterfaceKit1) and then add a text edit field to the form for the purpose of capturing simple output.
The object name for any type of Phidget is listed in the API manual.
Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

Next, we need to tell the program to try and connect to the Phidget through a call to open().
The open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
This means that calling open does not guarantee you can use the Phidget immediately.
We can handle it by either 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.

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=delphi>

procedure TForm1.FormCreate(Sender: TObject);
begin
PhidgetInterfaceKit1.Open(-1);
PhidgetInterfaceKit1.WaitForAttachment(3000);
end;

</source>
</font>
</div>

The parameters can also be used to open the first Phidget of a type it can find, open based on its 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.
You can call Close any time outside of the Phidget’s own event handlers to end the connection.

===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 fires a new event.

In Delphi, when the event library was installed it added Phidget ActiveX components for each type of Phidget.
These ActiveX components will show up in the toolbox under the ActiveX tab.
The ActiveX object for your Phidget can be added to the form and then hooked to the event handlers you wish to use like any other control.
For a Phidget21COMIPhidgetInterfaceKitEvents control, the event handler looks like the following:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=delphi>

procedure TForm1.PhidgetInterfaceKit1SensorChange(ASender: TObject; Index,
SensorValue: Integer);
begin
Edit1.Text := IntToStr(Index) + ': ' + IntToStr(SensorValue);
end;

</source>
</font>
</div>

With this method, the code inside PhidgetInterfaceKit1SensorChange 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 COM API manual for a full list of events and their general 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 CallString such as SensorValue[Index] or OutputState[Index] for PhidgetInterfaceKits.

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=delphi>

PhidgetInterfaceKit1.OutputState[0] := true;

</source>
</font>
</div>

===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 ActiveX object to be added to the project.
The new instance can then be set up, opened and used in the same fashion 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 place a PhidgetRFID ActiveX object instead of a PhidgetInterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

===Enabling Logging===

Often it’s a good idea to enable logging during development for debugging purposes.
This log, depending on the level set, will record certain events and errors from Phidgets.
In Delphi, this is accomplished by calling EnableLogging(logLevel, filename) on the Phidget object.

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=delphi>

PhidgetInterfaceKit1.EnableLogging(6, 'testlog.txt');

</source>
</font>
</div>

Similarly, you can call DisableLogging() at the end of your program to shut it off.
Should you need to contact Phidgets for support, including this log is very helpful for revealing the cause of the problem.
Please see the Programming Manual for a general discussion on Phidget logging and the levels provided.

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

Language - iOS

2011-11-14T15:42:16Z

192.168.3.159: /* Drivers, Libraries and Resources */

Preamble about the language and its general strengths and weaknesses.

==Assessment for use with Phidgets==
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.

==Support==
iOS has a complete API for all Phidgets devices, and code samples for PhidgetInterfaceKit devices.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

==Restrictions==
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 www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
* [http://www.phidgets.com/drivers.php iOS Library]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip API Manual]
* [http://www.phidgets.com/documentation/web/cdoc/index.html API Reference]
* [http://www.phidgets.com/downloads/examples/iOS_2.1.8.20110712.zip iOS Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] 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==

You will need the Phidget21 library and the iOS library to use and program with Phidgets.
As iOS devices do not have USB ports, support for Phidgets is made available through the WebService.
The system that is hosting the Phidgets will need to have the Phidget21 library installed.
After the framework is installed, the WebService must be started.
For more information on the WebService, please see the [[Phidgets Webservice|Webservice Page]].

===Setting up a Phidgets Project===

The Phidget examples were written in Objective-C and Xcode 4.0, and this tutorial assumes their use.
Other versions of Xcode should work as well and would be set up in a similar manner. In Xcode:
* Generate a new iOS Windows-based Application project with a descriptive name such as PhidgetTest.
* Set up the Provisioning Profiles and Code Signing settings, if necessary.
* Download the Phidget21 iOS library, extract the file, and move the iphoneos and the iphonesimulator folders, as well as the phidget21.h into the same directory as the the .xcodeproj file.
* In xCode, open up the Project Settings > Build Settings.
* In Linking > Other Linker Flags, follow these steps for both Debug, and Release:
** Select "Any iOS Simulator SDK" and enter:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=c>

$(SRCROOT)/iphonesimulator/libPhidget21.a

</source>
</font>
</div>

:* Select "Any iOS SDK" and enter:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=c>

$(SRCROOT)/iphoneos/libPhidget21.a

</source>
</font>
</div>

* In Search Path > Header Search Path, enter:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=c>

$(SRCROOT)

</source>
</font>
</div>

* In the header file, add a reference to phidget21.h:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

#import "phidget21.h"

</source>
</font>
</div>

* A text field will be used for the purpose of capturing output. Open MainMenu.nib to bring up the Interface Builder. Drag a text field from the Library to the Window.
* Add a text field outlet in the header file. For example,

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

@interface PhidgetTestAppDelegate : NSObject <UIApplicationDelegate>{
IBOutlet UITextField *sensorValueTxt;
}
@property (nonatomic, retain) IBOutlet UIWindow *window;
@property (nonatomic, retain) IBOutlet UITextField *sensorValueTxt;
@end

</source>
</font>
</div>

* In the implementation file, add the following line to the implementation section:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

@synthesize sensorValueTxt;

</source>
</font>
</div>

* Also, be sure release the object in the dealloc method [sensorValueTxt release];
* Connect the PhidgetTestAppDelegate class instance to sensorValueTxt.

The project now has access to Phidgets and we are ready to begin coding.
Please note that the iPhone library also contains a sample skeleton xCode project for iOS.
This project contains the neccessary project settings for Phidgets development.
Alternatively, you can use it to start developing with Phidgets.

===Coding For Your Phidget===

A Phidget object will need to be declared. For example, we can declare a PhidgetInterfaceKit in the .h header file with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

CPhidgetInterfaceKitHandle ifkit

</source>
</font>
</div>

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

===Connecting to the Phidget===

Next, the Phidget object needs to be initialized and the program needs to try and connect to the Phidget over the WebService through a call to openRemoteIP() or openRemote().
These calls will tell the program to 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 handle this 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.
For example, we can connect to a PhidgetInterfaceKit in the .m implementation file with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

@implementation PhidgetTest
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
CPhidgetInterfaceKit_create(&ifkit);
CPhidget_openRemoteIP((CPhidgetHandle)ifkit, -1, "192.168.2.163", 5001, NULL);
}
@end

</source>
</font>
</div>

The openRemoteIP() and openRemote() calls can be used with parameters to try and get the first device it can find over the network, and open it based on a serial number.
The API manual provides more information on openRemoteIP() and openRemote().
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.
At the end of your program, don’t forget to call close to free any locks on the Phidget.

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

- (void)applicationWillTerminate:(UIApplication *)application
{
CPhidget_close((CPhidgetHandle)ifkit);
CPhidget_delete((CPhidgetHandle)ifkit);
}

</source>
</font>
</div>

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
We can hook an event handler at loading with the following code:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

CPhidgetInterfaceKit_set_OnSensorChange_Handler(ifkit, gotSensorChange, self);

</source>
</font>
</div>

Next, the callback method needs to be set up before it can be used. For example,

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

int gotSensorChange(CPhidgetInterfaceKitHandle phid, void *context, int ind, int val)
{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
[(id)context performSelectorOnMainThread:@selector(SensorChange:)
withObject:[NSArray arrayWithObjects:[NSNumber numberWithInt:ind], [NSNumberGetting_Started_iOS created: 06/16/11 Page 4
numberWithInt:val], nil] waitUntilDone:NO];
[pool release];
return 0;
}

</source>
</font>
</div>

Above, the SensorChange method is invoked on the main thread. Event data is stored in a NSArray, which in turn is sent as a single argument to the SensorChange method.
The NSAutoreleasePool object is created to clean up released objects on the event thread, and is released at the end of the method.
The SensorChange method is defined as follows:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

- (void)SensorChange:(NSArray *)sensorChangeData
{
int sensorIndex, sensorValue;
sensorIndex = [[sensorChangeData objectAtIndex:0] intValue];
sensorValue = [[sensorChangeData objectAtIndex:1] intValue];
_sensorValueTxt.text = [NSString stringWithFormat:@"Sensor: %d, Value: %d",
sensorIndex, sensorValue]];
}

</source>
</font>
</div>

With this function, the code inside SensorChange 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 and the iOS examples for a list of events and their usage.

===Working directly with the Phidget===

Some values can be read and sent directly to the Phidget, simply use the C API functions such as CPhidgetInterfaceKit_getSensorValue for PhidgetInterfaceKits.

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

int sensorIndex = 0;
int sensorValue;
CPhidgetInterfaceKit_getSensorValue(ifkit, sensorIndex, &sensorValue);
_sensorValueTxt.text = [NSString stringWithFormat:@"Sensor: %d, Value: %d",
sensorIndex, sensorValue]];

</source>
</font>
</div>

These functions can be used inside a polling loop as an alternative to event driven programming.

===Working with multiple Phidgets===

Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another InterfaceKit instance to be defined and initialized.
The new instance 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 an RFID object instead of an InterfaceKit. 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.

Language - Objective C

2011-11-14T15:41:59Z

192.168.3.159: /* Drivers, Libraries and Resources */

Preamble about the language and its general strengths and weaknesses.

==Assessment for use with Phidgets==
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.

==Support==
Cocoa has a complete API and code samples for all Phidgets devices.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

==Restrictions==
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 www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip API Manual]
* [http://www.phidgets.com/documentation/web/NETDoc/Index.html API Reference]
* [http://www.phidgets.com/downloads/examples/Cocoa_2.1.8.20110630.zip Cocoa Sample Code]
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] 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==

The Phidget examples were written in Objective-C and Xcode 3.2.4, and this tutorial assumes their use.
Other versions of Xcode should work as well and would be set up in a similar manner.
In Xcode:
* Generate a new Cocoa project with a descriptive name such as PhidgetTest.
* Add the Phidget21 Framework(Groups & Files -> Frameworks -> Other Frameworks).
* Create a new Objective-C class with a descriptive name. For the purpose of this guide, the class name will be PhidgetInterfaceKit.
A header file(.h) as well as an implementation file(.m) will automatically be created.
* Open the header file for editing
* Add a reference to phidget21.h:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

#import <Phidget21/phidget21.h>

</source>
</font>
</div>

* A text field will be used for the purpose of capturing output. Add a text field outlet in the header file. For example,

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

@interface PhidgetInterfaceKit : NSObject{
IBOutlet NSTextField *sensorValueTxt;
}
@end

</source>
</font>
</div>

* In Groups & Files -> Resources, open up MainMenu.nib to bring up the Interface Builder. Drag a text field from the Library to the Window.
* Now, an instance of the PhidgetInterfaceKit class will need to be created. In the Library, drag an object to the MainMenu.nib Window.
Open up the Identity tab of the Inspector for this object and add the PhidgetInterfaceKit class.
* Connect the PhidgetInterfaceKit class instance to the text field.
The project now has access to Phidgets and we are ready to begin coding.

===Coding For Your Phidget===

A Phidget object will need to be declared. For example, we can declare a PhidgetInterfaceKit in the .m implementation file with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

CPhidgetInterfaceKitHandle ifkit

</source>
</font>
</div>

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

===Connecting to the Phidget===

Next, the Phidget object needs to be initialized and the program needs to try and connect to the Phidget through a call to open().
Open will tell the program to 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 handle this 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.
For example, we can connect to a PhidgetInterfaceKit in the .m implementation file with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

@implementation PhidgetInterfaceKit
- (void)awakeFromNib
{
CPhidgetInterfaceKit_create(&ifkit);
CPhidget_open((CPhidgetHandle)ifkit, -1);
}
@end

</source>
</font>
</div>

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 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.
At the end of your program, don’t forget to call close to free any locks on the Phidget.

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

CPhidget_close((CPhidgetHandle)ifkit);
CPhidget_delete((CPhidgetHandle)ifkit);

</source>
</font>
</div>

===Event Driven Programming===

We recommend the use of event driven programming when working with Phidgets.
We can hook an event handler at loading with the following code:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

CPhidgetInterfaceKit_set_OnSensorChange_Handler(ifkit, gotSensorChange, self);

</source>
</font>
</div>

Next, the callback method needs to be set up before it can be used. For example,

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

int gotSensorChange(CPhidgetInterfaceKitHandle phid, void *context, int ind, int val)
{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
[(id)context performSelectorOnMainThread:@selector(SensorChange:)
withObject:[NSArray arrayWithObjects:[NSNumber numberWithInt:ind], [NSNumber
numberWithInt:val], nil] waitUntilDone:NO];
[pool release];
return 0;
}

</source>
</font>
</div>

Above, the SensorChange method is invoked on the main thread.
Event data is stored in a NSArray, which in turn is sent as a single argument to the SensorChange method.
The NSAutoreleasePool object is created to clean up released objects on the event thread, and is released at the end of the method.

The SensorChange method is defined as follows:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

- (void)SensorChange:(NSArray *)sensorChangeData
{
int sensorIndex, sensorValue;
sensorIndex = [[sensorChangeData objectAtIndex:0] intValue];
sensorValue = [[sensorChangeData objectAtIndex:1] intValue];
[sensorValueTxt setStringValue:[NSString stringWithFormat:@"Sensor: %d, Value:
%d", sensorIndex, sensorValue]];
}

</source>
</font>
</div>

With this function, the code inside SensorChange 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 and the Cocoa examples for a list of events and their usage.

===Working directly with the Phidget===

Some values can be read and sent directly to the Phidget, simply use the C API functions such as CPhidgetInterfaceKit_getSensorValue() for PhidgetInterfaceKits.

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=objc>

int sensorValue;
CPhidgetInterfaceKit_getSensorValue(ifkit, 0, &sensorValue);
[sensorValueTxt setintValue: sensorValue];

</source>
</font>
</div>

These functions can be used inside a polling loop as an alternative to event driven programming.

===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 instance to be defined and initialized.
The new instance 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 an RFID object instead of an InterfaceKit.
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.

Language - C Sharp (.NET Compact Framework)

2011-11-14T15:41:46Z

192.168.3.159: /* Drivers, Libraries and Resources */

Language - C Sharp

2011-11-14T15:41:15Z

192.168.3.159: /* Drivers, Libraries and Resources */

C# is a modern, object-oriented programming language developed by Microsoft.

==Assessment for use with Phidgets==
Since C# supports event-driven programming and is object-oriented, it is capable of using all of the functionality Phidgets has to offer.

Due to the popularity of C#, you can also find plenty of other programmers on the C# section of [http://www.phidgets.com/phorum/viewforum.php?f=22 our forums].
==Support==
C# has a complete API and sample code for all Phidgets devices.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

==Restrictions==
C# as a language has no relevant restrictions in regards to using Phidgets.

==Development Environments and Compilers==

===Mono===
Mono is a free, open-source C# compiler. If you want to program with Phidgets using C# on Linux, Mono is your best option.

You can visit Mono's website [http://www.mono-project.com/Main_Page here].

===Visual Studio 2003===
Visual Studio 2003 requires our .NET 1.1 libraries. Make sure you download the latest version of our [http://www.phidgets.com/drivers.php drivers] and add a reference in your project to Phidget21.NET version 1.1.

Our code samples were designed for use with Visual Studio 2005 or 2008. You can try to build a new project in Visual Studio 2003 using the source code we provide, but we cannot guarantee that it will work.

===Visual Studio 2005===
Visual Studio 2005 requires our .NET 2.0 libraries. Make sure you download the latest version of our [http://www.phidgets.com/drivers.php drivers] and add a reference in your project to Phidget21.NET version 2.0.

When running our sample code, if you're using Visual Studio 2005, open the project file that does '''not''' have "2008" after the project name.

===Visual Studio 2008 and 2010===
Visual Studio 2008 and 2010 require our .NET 2.0 libraries. Make sure you download the latest version of our [http://www.phidgets.com/drivers.php drivers] and add a reference in your project to Phidget21.NET version 2.0. We do not currently provide support for new features in newer versions of the .NET framework.

When running our sample code, if you're using Visual Studio 2008 or 2010, open the project file that has "2008" after the project name.

===Visual Studio Express Editions===

Visual Studio Express is the free version of Visual Studio.
As long as you use the correct version of the .NET framework as mentioned above, Visual Studio Express should work just fine.

==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 www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
* [http://www.phidgets.com/documentation/Phidget21.NET.zip .NET API Manual]
* [http://www.phidgets.com/documentation/web/NETDoc/Index.html .NET API Reference].
The .NET API manual lists calls and events for every type of Phidget and can be used as a reference.
* Example Programs written in C# [[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip Windows]] [[http://www.phidgets.com/downloads/examples/CE_2.1.8.20110615.zip .NET Compact Framework]]
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] 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==

===Setting up a Phidgets Project===
The Phidget examples were written using Visual C# 2005 and this tutorial assumes its use. Newer
versions of Visual Studio Express are freely available for download from Microsoft. Older versions of
Visual Studio work as well and would be set up in a similar manner (Note: you would have to recreate
the user interface in the examples for Visual Studio versions earlier than 2005). In Visual Studio:
* Generate a new C# Windows Application with a descriptive name such as PhidgetTest.
* Launch the Add Reference window (Project | Add Reference).
* Under the .NET tab, select the most recent Phidget21.NET library. If it does not appear in this list, then you can Browse to the Phidget Framework installation directory and add the Phidget21.NET. dll. For earlier versions of Visual Studio, you will want to use the Phidget21.NET1.1.dll instead.
* Place a TextBox on your main form for the purpose of capturing output.
* Hook the form's Load and FormClosing events. Phidget initialization and shutdown will take place
there.
The project now has access to Phidgets and we are ready to begin coding.

===Coding For Your Phidget===
Before you can use the Phidget, you must include a reference in the code to the libraries. Launch the
code editor for your form and add this to your using statements:Getting_Started_CSharp created: 11/10/10 Page 2
using Phidgets;
using Phidgets.Events;
Afterwards, a Phidget object will need to be declared and then initialized. For example, we can
declare a PhidgetInterfaceKit inside our form with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=CSharp>

namespace PhidgetTest
{
public partial class Form1 : Form
{
//The Phidget object declaration
private InterfaceKit ifKit;
public Form1()
{
InitializeComponent();
}
//... Form1_Load and Form1_OnClosing here
}
}
</source>
</font>
</div>

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

===Connecting to the Phidget===

Next, the program needs to try and connect to the Phidget through a call to open(). Open will tell the
program to 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 handle this 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.

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=CSharp>

private void Form1_Load(object sender, EventArgs e)
{
ifKit = new InterfaceKit();
ifKit.open();
ifKit.waitForAttachment(3000);
}
</source>
</font>
</div>
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 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. In C# we can
hook an event handler at loading with the following code:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=CSharp>

ifKit.SensorChange += new SensorChangeEventHandler(ifKit_SensorChange);

</source>
</font>
</div>

The ifKit_SensorChange method is defined as follows:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=CSharp>

void ifKit_SensorChange(object sender, SensorChangeEventArgs e)
{
textBox1.Text = "Index " + e.Index + " Value: " + e.Value;
}

</source>
</font>
</div>

With this function, the code inside ifKit_SensorChange 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.
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 style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=CSharp>

private void Form1_FormClosing(object sender, FormClosingEventArgs e)
{
ifKit.SensorChange -= new SensorChangeEventHandler(ifKit_SensorChange);
//run any events in the message queue
Application.DoEvents();
ifKit.close();
}

</source>
</font>
</div>
Working directly with the Phidget
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. These functions can be used inside a polling loop as an alternative to event driven
programming.
int val = ifKit.sensors[0].Value;

===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 instance to be defined and initialized. The new instance 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 an RFID object
instead of an InterfaceKit. The methods and events available would change but they can be accessed
in a similar manner.


==Common Problems and Solutions/Workarounds==

There are no known issues specific to C# at this time.

Language - AutoIt

2011-11-14T15:40:56Z

192.168.3.159: /* Quick Links */

Language - Applescript

2011-11-14T15:40:43Z

192.168.3.159: /* Quick Links */

Applescript is a scripting language for Mac OSX designed primarily for interfacing between applications.

==Assessment for use with Phidgets==
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.

==Support==
Applescript has a complete API and sample code for all Phidgets devices.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

==Restrictions==
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 www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
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 (Link to API download)
* API Reference (Link to online API reference (if applicable))
* Example Programs written in this language
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] 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==
The Phidget examples were written using AppleScript 2.1.2 under AppleScript Editor 2.3, and this tutorial assumes their use. Other versions and development environments should work as well and would be set up in a similar manner.

*First, open the AppleScript editor to create a new script.
*Coding with Phidgets is made possible by the interaction of Apple Events between AppleScript and • the PhidgetsOSA application. Type the following to interact with PhidgetsOSA:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell application "PhidgetsOSA"
end tell

</source>
</font>
</div>

The project now has access to Phidgets and we are ready to begin coding. For the rest of this document, unless otherwise stated, it will be assumed that all code will be typed inside this tell block.

===Coding For Your Phidget===
A Phidget object will need to be declared. For example, we can declare a PhidgetInterfaceKit:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

set ifkit to make new phidget interfacekit

</source>
</font>
</div>
The object name for any type of Phidget is listed in the PhidgetsOSA dictionary. Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

Next, the Phidget object needs to be initialized and the program needs to try and connect to the Phidget through a call to open.
Open will tell the program to 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 handle this by using event driven programming and tracking the Attach Events and Detach Events, or by specifying the wait parameter.
The wait parameter will block for a certain amount of time until a connection is made to the Phidget. For example, we can connect to a PhidgetInterfaceKit with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell ifkit to open

</source>
</font>
</div>

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.
For more information on connecting across a network, please see the "Working with Phidget WebService" guide on the programming section at www.phidgets.com.
The PhidgetsOSA dictionary lists all of the available modes that open provides.
Examples of the usage of different types of open are listed below:

We can tell the ifkit to block for 5000ms until a connection has been made to the PhidgetInterfaceKit with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell ifkit to open wait 1000 --wait for 5000ms

</source>
</font>
</div>

We can also connect to a PhidgetInterfaceKit over the WebService with a serial number of 99999 on a server with an IP Address of 192.168.3.180 and a port that is opened on 5001 with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell ifkit to open serial number 99999 server address "192.168.3.180" server port 5001

</source>
</font>
</div>

It is also possible to connect using the server id. For example, we can connect to a PhidgetInterfaceKit on a password protected server with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell ifkit to open server id "TestMac" password "pw"

</source>
</font>
</div>

At the end of your script, don’t forget to call close to free any locks on the Phidget.

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell ifkit to close
delete ifkit

</source>
</font>
</div>

Phidgets can also be freed from the [[#PhidgetsOSA Menu Bar|PhidgetsOSA Menu Bar]].

===Event Driven Programming===
We recommend the use of event driven programming when working with Phidgets.
We can hook an event handler at loading with the following code:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell ifkit to make new interfacekit sensor change handler with properties {script file:thisScript}

</source>
</font>
</div>

And after the tell block at end of the script, the callback method is defined as follows:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

using terms from application "PhidgetsOSA"
on interfacekit sensor changed ind to val on ifkit
log "Sensor Index: " & ind & ", Sensor Value: " & val
end interfacekit sensor changed
end using terms from

</source>
</font>
</div>

With this function, the code inside the interfacekit sensor changed handler 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 PhidgetsOSA dictionary and the AppleScript examples for a list of events and their usage.

===Working directly with the Phidget===
Some values can be read and sent directly to the Phidget.
For example, sensor values from the PhidgetInterfaceKit can be read with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

log "The first sensor has a value of: " & first interfacekit sensor's value

</source>
</font>
</div>

These functions can be used inside a polling loop as an alternative to event driven programming.

===Using the same Phidget in more than one Application===
One important thing to remember is that when working with Phidgets, a call to open will reserve the device until closed. This prevents any other instances from retrieving data from the Phidget, including other programs.
If your goal is to use the same Phidget among multiple AppleScripts and/or other applications, there are two approaches.
:1. Implement logic in the script that will use the same Phidget object if the script detects that a Phidget of the same type has already been initialized.
For example,

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

if first phidget interfacekit exists then
set ifkit to the first phidget interfacekit
else
set ifkit to make the phidget interfacekit
open ifkit
end if

</source>
</font>
</div>

:2. The one connection per device limit does not apply when exclusively using the open Phidget Webservice. For more information, please see the "Connecting to the Phidgets" section of this document.

===Working with multiple Phidgets===
Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another InterfaceKit instance to be defined and initialized.
The new instance 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 an RFID object instead of an InterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

===PhidgetsOSA Menu Bar===
[[Image:applescript_bar.jpg]]

The PhidgetsOSA menu bar appears whenever AppleScript accesses the PhidgetsOSA application.
The menu bar is used to monitor the status of any accessed Phidgets.

Additionally, it can be used to free the lock on a Phidget or quit the PhidgetsOSA application.

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

Language - Adobe Director

2011-11-14T15:40:21Z

192.168.3.159: /* Quick Links */

Language - AutoIt

2011-11-14T15:39:50Z

192.168.3.159: /* Drivers, Libraries and Resources */

Language - Applescript

2011-11-14T15:36:34Z

192.168.3.159: /* Drivers, Libraries and Resources */

Applescript is a scripting language for Mac OSX designed primarily for interfacing between applications.

==Assessment for use with Phidgets==
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.

==Support==
Applescript has a complete API and sample code for all Phidgets devices.

For a complete list of our supported languages and their support status, [[Levels of Support|click here]].

==Restrictions==
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 Links==
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 www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
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 (Link to API download)
* API Reference (Link to online API reference (if applicable))
* Example Programs written in this language
* You can find a high level discussion about programming with Phidgets in general on the [[General API]] 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==
The Phidget examples were written using AppleScript 2.1.2 under AppleScript Editor 2.3, and this tutorial assumes their use. Other versions and development environments should work as well and would be set up in a similar manner.

*First, open the AppleScript editor to create a new script.
*Coding with Phidgets is made possible by the interaction of Apple Events between AppleScript and • the PhidgetsOSA application. Type the following to interact with PhidgetsOSA:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell application "PhidgetsOSA"
end tell

</source>
</font>
</div>

The project now has access to Phidgets and we are ready to begin coding. For the rest of this document, unless otherwise stated, it will be assumed that all code will be typed inside this tell block.

===Coding For Your Phidget===
A Phidget object will need to be declared. For example, we can declare a PhidgetInterfaceKit:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

set ifkit to make new phidget interfacekit

</source>
</font>
</div>
The object name for any type of Phidget is listed in the PhidgetsOSA dictionary. Every type of Phidget also inherits functionality from the Phidget base class.

===Connecting to the Phidget===

Next, the Phidget object needs to be initialized and the program needs to try and connect to the Phidget through a call to open.
Open will tell the program to 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 handle this by using event driven programming and tracking the Attach Events and Detach Events, or by specifying the wait parameter.
The wait parameter will block for a certain amount of time until a connection is made to the Phidget. For example, we can connect to a PhidgetInterfaceKit with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell ifkit to open

</source>
</font>
</div>

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.
For more information on connecting across a network, please see the "Working with Phidget WebService" guide on the programming section at www.phidgets.com.
The PhidgetsOSA dictionary lists all of the available modes that open provides.
Examples of the usage of different types of open are listed below:

We can tell the ifkit to block for 5000ms until a connection has been made to the PhidgetInterfaceKit with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell ifkit to open wait 1000 --wait for 5000ms

</source>
</font>
</div>

We can also connect to a PhidgetInterfaceKit over the WebService with a serial number of 99999 on a server with an IP Address of 192.168.3.180 and a port that is opened on 5001 with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell ifkit to open serial number 99999 server address "192.168.3.180" server port 5001

</source>
</font>
</div>

It is also possible to connect using the server id. For example, we can connect to a PhidgetInterfaceKit on a password protected server with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell ifkit to open server id "TestMac" password "pw"

</source>
</font>
</div>

At the end of your script, don’t forget to call close to free any locks on the Phidget.

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell ifkit to close
delete ifkit

</source>
</font>
</div>

Phidgets can also be freed from the [[#PhidgetsOSA Menu Bar|PhidgetsOSA Menu Bar]].

===Event Driven Programming===
We recommend the use of event driven programming when working with Phidgets.
We can hook an event handler at loading with the following code:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

tell ifkit to make new interfacekit sensor change handler with properties {script file:thisScript}

</source>
</font>
</div>

And after the tell block at end of the script, the callback method is defined as follows:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

using terms from application "PhidgetsOSA"
on interfacekit sensor changed ind to val on ifkit
log "Sensor Index: " & ind & ", Sensor Value: " & val
end interfacekit sensor changed
end using terms from

</source>
</font>
</div>

With this function, the code inside the interfacekit sensor changed handler 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 PhidgetsOSA dictionary and the AppleScript examples for a list of events and their usage.

===Working directly with the Phidget===
Some values can be read and sent directly to the Phidget.
For example, sensor values from the PhidgetInterfaceKit can be read with:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

log "The first sensor has a value of: " & first interfacekit sensor's value

</source>
</font>
</div>

These functions can be used inside a polling loop as an alternative to event driven programming.

===Using the same Phidget in more than one Application===
One important thing to remember is that when working with Phidgets, a call to open will reserve the device until closed. This prevents any other instances from retrieving data from the Phidget, including other programs.
If your goal is to use the same Phidget among multiple AppleScripts and/or other applications, there are two approaches.
:1. Implement logic in the script that will use the same Phidget object if the script detects that a Phidget of the same type has already been initialized.
For example,

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=applescript>

if first phidget interfacekit exists then
set ifkit to the first phidget interfacekit
else
set ifkit to make the phidget interfacekit
open ifkit
end if

</source>
</font>
</div>

:2. The one connection per device limit does not apply when exclusively using the open Phidget Webservice. For more information, please see the "Connecting to the Phidgets" section of this document.

===Working with multiple Phidgets===
Multiple Phidgets of the same type can easily be run inside the same program.
In our case, it requires another InterfaceKit instance to be defined and initialized.
The new instance 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 an RFID object instead of an InterfaceKit.
The methods and events available would change but they can be accessed in a similar manner.

===PhidgetsOSA Menu Bar===
[[Image:applescript_bar.jpg]]

The PhidgetsOSA menu bar appears whenever AppleScript accesses the PhidgetsOSA application.
The menu bar is used to monitor the status of any accessed Phidgets.

Additionally, it can be used to free the lock on a Phidget or quit the PhidgetsOSA application.

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

Language - Adobe Director

2011-11-14T15:29:13Z

192.168.3.159: /* Drivers, Libraries and Resources */