OS - macOS

On OS X, Phidgets can be either plugged directly into a USB Port or run over a network using the Webservice.

Phidgets are designed to run on OS X 10.4 or newer, and can run on PPC, 32-bit, and 64-bit systems.

Getting Started (Libraries and Drivers)

If this is your first Phidget, we highly recommend working through the Getting Started guide for your specific Phidget device. If you already have the Preference Pane Installed and know how to use it, then you've already followed the guide and are ready to learn more about the workings behind the Preference Pane, the Phidget Webservice, and more - all specific to OS X.

If you are already a pro, and just want the drivers:

• OS X Installer

For special cases where you want to install the Phidget libraries without the installer, please see the Advanced Uses section.

• Phidget21 Libraries
• Software License

Installing

The Phidget installer will install the core Phidget files onto your system.

To install the libraries, follow these steps:

1. Download the Phidget installer for your system:

• OS X Installer

2. Open up the installer, and double click on Phidgets.mpkg to install the libraries.

3. Proceed through the wizard.

4. Once the installation is complete, you are ready to program with Phidgets.

Proceed onto to the next section where the Phidget Preference Pane will be discussed.

Phidget Preference Pane

The Phidget Preference Pane is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.

Once the Phidget libraries are installed using the installer, open up the System Preferences window.

Click on the Phidgets icon in the Other section to bring up the Phidgets Preference Pane.

The general tab shows the list of Phidgets currently physically attached to the computer. You can also view the currently installed Phidget library version. You can double click on a Phidget device to open up an example program for the device.

In the above screenshot, the RFID example was opened. These examples are intended for demonstration and debugging purposes. If you have not yet already, please see the Getting Started guide for your device. It is important to keep in mind that when an example Phidget application is opened from the Phidget Preference Pane, it holds a lock on the Phidget. This prevents any other program from accessing the Phidget. Please ensure that this example application is closed(the Phidget Preference Pane can still be running) when you are running your own applications. 

The next tab is the Web Service tab, which allows you to control Phidgets over a network.

Here, you can start and stop the Webservice. Details are provided in the Webservice section. This screen also tells you whether the Phidget Webservice is currently running.

The next tab is the Labels tab. In this section, you can view the currently assigned labels of any Phidget attached to your computer. It is also possible to set the labels of Phidgets here too.

You can also view the labels of any Phidget connected through the Webservice

The Bonjour tab gives a list of all currently attached Phidgets that are connected to the Webservice. You can also double click on the Phidget to connect to it over the network using one or more computers, and still use the Phidget on the computer it is directly connected to.

The last tab is the PhidgetSBC tab, which displays the complete list of PhidgetSBCs connected to the network. You can double click on the PhidgetSBC to bring up the PhidgetSBC Adminstration Console.

Checking

To confirm the libraries were installed and work correctly, you can check both the hardware and software sides of the interface. It is worth checking the software side first, because if it works then you know the hardware side is also okay.

Software

If you have the Phidgets library installed on your system, you can verify that the software side is working by seeing if the Phidget device is listed in the General tab of the Phidget Preference Pane.

The above screenshot shows that a PhidgetRFID and a PhidgetInterfaceKit are attached to the computer. If the Phidget is plugged into a USB port and you are not able to see that the Phidget is in the list, there may be a hardware issue. Please see the hardware section for more details.

Hardware

You can verify that your computer detects that the Phidget is plugged in through a USB connection by going to the OS X System Profiler. You can access the System Profiler by selecting About This Mac under the Apple icon.

The new window will open up.

Select More Info. The System Profiler will show up. In the USB section, you will be able to find all connected USB devices.

In the above screenshot, The PhidgetInterfaceKit and PhidgetRFID are connected to the USB ports.

If you don't see the the Phidget in the list, then take a look at the troubleshooting section below, as well as the Communications section of our general troubleshooting page.

Troubleshooting

If the examples do not work but USB does work (i.e. your computer can consistently see the device in the hardware), take a moment to check the basics:

• You are using OS X 10.4 or newer.
• No other programs, drivers, or processes are using that USB port in software
• The Phidget libraries are the latest version (visit the getting started section to download them)

• Check the common problems section below, some specific combinations can cause problems

If your problem doesn't seem to be fixed by these steps, make sure that the Phidget is seen consistently by USB (if it is erratic, try our general troubleshooting guide). If you are still having problems after using the troubleshooting guide, please ask us!

Programming Languages

We recommend the following languages for OS X:

• AppleScript
• C/C++
• C#(Using Mono)
• Cocoa
• Flash AS3
• Flex AS3
• LiveCode
• Java
• Max/MSP
• Python
• Ruby

You can also use these languages, but they do not support event driven code, and must use logic code only:

• MATLAB
• Simulink

Webservice

The Phidget Webservice allows you to remotely control a Phidget over a network.

Drivers for the Phidget Webservice on OS X are already included in the Drivers above. If you see the Phidget Preference Pane in System Preferences, then you already have the Webservice drivers installed.

You can connect to a Phidget hosted on another computer if you know the IP address of the host computer. Phidgets optionally supports the use of mDNS, which allows Phidgets to be found and opened on the network by a server id instead of an IP address and port. When using a server id, both the client and server will need to be running an implementation of zero configuration networking. The Phidget Webservice takes advantage of the Bonjour software. It is a tool, developed by Apple to locate devices such as Phidgets, and printers. It allows you to connect to a Phidget over the Webservice while specifying the server id. Alternatively, an IP address and port can be supplied to connect to a Phidget over the Webservice.

This section helps you install, check, and use the Webservice on Windows, but we also have an overview of the Phidget Webservice in general.

Turning the Webservice On and Off

There are two methods that can be used to turn the Webservice on and off. The first method is through the Phidget Preference Pane. In the Webservice tab, you can start or stop the Webservice. You can also choose to have the Webservice start up automatically upon system boot up by selecting the Start Automatically checkbox.

The second method of turning the Webservice on and off is through command line. If you used our installer, the Webservice utility is automatically installed in /usr/bin/phidget21webservice.

You can get command line help with phidgetwebservice21 using the -h option:

 phidgetwebservice21 -h

'phidgetwebservice21' is a Phidget and Dictionary server from Phidgets Inc. See www.phidgets.com for more information.
Usage: phidgetwebservice21 [OPTION]
All parameters are optional. The default parameters are: port=5001, ServerName=(Computer Name) and no password

Options:
  -p      Port
  -n      Server Name
  -P      Password
  -v      Debug mode
  -h      Display this help

To find the defaults used by phidget21webservice, the command line is the fastest way to learn the default server name and IP address of your computer:

• For the default server name, use hostname on the command line.
• For your IP address, use ifconfig -a on the command line.
  • A line in the return text, under your main internet connection (usually eth0) will say something like inet addr:192.168.3.178, which is your IP.

Here are some example usage.

To start the Webservice with default parameters:

 phidgetwebservice21

To start the Webservice with a server name of myServer:

 phidgetwebservice21-n myServer

To stop the Webservice, simply close the command line window or press Control and c at the same time in the command line window.

Using the Webservice

To use a Phidget over the Webservice, you'll want to:

• Have two different computers connected to the same network. We will call the computer that has the Phidget directly connected to the USB port the host. The client will be the computer that runs a Phidget application to connect to the Phidget attached to the host. Please note that If you only have a single computer, you can also connect to the Phidget over the Webservice. The computer will simply act as both a host and client.

• Start the Webservice on the computer that directly connects to the Phidget
• Run your program on the remote computer that will control the Phidget over the network

The easiest way to test these steps on OS X is to set up the Webservice and run the Phidget program on the client. Please follow these steps:

1. On the host, open up the Phidget Preference Pane and traverse to the Web Service tab.

2. Leave all fields the way it is, and click on Start WebService to run the Webservice.

3. You can determine that the Webservice is running by looking at the status on the right side.

4. Ensure that the Phidget is plugged in to the host.

5. On the client's Phidget Preference Pane, open up the Bonjour tab. You will see the Phidget that is plugged into the host as one of the entries listed. Double click it to open the example application.

6. The example application will open up, and you will be able to interact with the Phidget over the Webservice.

7. You can confirm that the Webservice was indeed behind this exchange by killing the Webservice process while still allowing the remote program to run. On the host's Phidget Preference Pane, traverse to the Webservice tab. Hit Stop WebService to terminate the Webservice.

8. Take a look at the example application on the client. Since the application can no longer connect to the Webservice, the attached state of the Phidget is false.

Debugging the Webservice

In addition to enabling logging in your Phidget code, you can get additional debugging information from the Webservice itself. This additional debugging can only be enabled from the command line approach to start the Webservice. Debug information is enabled by specifying the -v option:

 phidgetwebservice21 -v -n "myServer"

The debugging information is shown in command line output.

Advanced Uses

Manual File Installation

The Phidget installer installs the most commonly used files onto your system. However, there may be special cases where you want to install the Phidget libraries without the installers. This section will describe the purpose of each individual file and cover how to manually install and distribute the libraries with your code.

Description of Library files

• phidget21.dll contains the actual Phidget library, which is used at run-time. It is also placed in C:\Windows\System32.
• PhidgetWebService21.exe is used to control Phidgets remotely across a network using the PhidgetWebservce.
• PhidgetWindowsService21.exe is a Windows service that controls PhidgetWebService21.exe.
• phidget21.lib is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts phidget21.lib into C:\Program Files\Phidgets, so you can either point your compiler to that location, or copy and link to it in a directory for your project workspace. phidget21.lib is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler for details. Please note that we provide versions of the phidget21.lib that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the phidget21.lib is placed in C:\Program Files\Phidgets; The 32 bit version of phidget21.lib is placed in C:\Program Files\Phidgets\x86.
• phidget21.h lists all the Phidget API function calls available to your code. Your compiler also has to know where this file is. By default, our installer puts phidget21.h into C:\Program Files\Phidgets so you can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
• phidget21.jar is an archive containing the Phidgets library, used by the Java programming language.
• Phidget21.NET.dll is the Phidgets library for .NET framework 2.0 or greater. Any .NET language can be used, including C# , and Visual Basic .NET.
• Phidget21.NET1.1.dll is the Phidgets library for .NET framework 1.1. Any .NET language can be used, including C# , and Visual Basic .NET.
• Phidget21.NET.XML provides the IntelliSense in-line documentation for the .NET library in Visual Studio.
• Phidget21COM.dll is the Component Object Model(COM) library and provides your project access to the Phidget ActiveX objects. This libraries is used by the AdobeDirector, AutoIT, Delphi, Visual Basic 6.0, Visual Basic for Applications, Visual Basic Script.
• Phidget21Manager.exe is a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.
• Examples folder contain example applications that allows you to quickly see if your Phidget is properly configured.
• x86 folder folder contain the 32 bit versions of phidget21.dll, phidget21.lib, Phidget21COM.dll. These folder will only appear on 64 bit installations and is useful if you want to code against the 32 bit libraries.

Special Cases of Library Install

Regardless of what language you will be using to program Phidgets, you will need the phidget21.dll placed in the C:\WINDOWS\system32 directory. Additional files are needed for the language that you choose. Please refer to the documentation provided by your language to determine what files are needed and the steps needed to install them onto your system.

You can find the phidget21.dll in the link below:

• Phidget21 Libraries (32-Bit and 64-Bit development files without an installer)

PhidgetWebService21.exe is also provided in the link above.

Common Problems and Solutions

None, yet.