OS - iOS
- 1 Getting Started (Libraries and Drivers)
- 2 Programming Languages
- 3 WebService
- 4 Advanced Uses
- 5 Common Problems and Solutions
- 6 Appendix
Phidgets are designed to run on devices with an iOS version of 3.0 or later. It is strongly recommended that your device have the latest iOS version installed. As iOS devices do not have USB ports, the Phidgets will have to be connected on a computer with USB ports, and the iOS device will be able to interact with the Phidget over the WebService. If you are looking for a compact and an inexpensive way to host Phidgets over a network, take a look at our Single Board Computer.
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 are already a pro, and just want the iOS drivers:
iOS code is developed on an OS X machine, and so getting your Phidget to work locally on the OS X machine first will help you distinguish any issues from network ones later. The OS X machine will need the Phidget drivers installed, please see the OS X page for more information.
You will also need to iOS drivers to code your program against. The "installation" of the Phidget iOS libraries is simply linking and distributing the libraries with your project. As the most common platform to do this is through Xcode, we provide brief instructions on how to easily follow along with our already-linked examples later.
To install the libraries, follow these steps on the development computer:
1. Download the Phidget drivers for iOS.
2. Unzip the file, and you will find three things:
- Libraries for the iOS device and iOS simulator.
- Example Xcode project for the PhidgetInterfaceKit and PhidgetManager.
- Skeleton Xcode project - contains the minimal project settings already filled in for Phidgets development.
Feel free to browse around within the folders to get a sense of what will be going on the iOS side. We describe how to link and use these library files later on the Write your own iOS code section of the iOS Cocoa Touch page. For now, having found them means you can copy and install them to any project directory you want.
First, though, it will be useful to check to make sure Phidgets work with your iOS system.
When you run a Phidgets iOS example, you transfer and link the libraries and code all at the same time. This should just work with our examples, but if problems arise this section gives more detail on pinpointing the source of the problem. We recommend starting with running the software examples right away - if the software works, you know the hardware works too.
The easiest way to see whether your libraries are set up correctly within our examples or your own project is just to download them to the iOS device and run them. Detailed instructions for this (including choosing the right
HelloWorld project to run) are on the Language - iOS page. That page will be your next step - but if the examples do not run using the instructions, return here to debug your hardware.
If you are having problems running the examples, you should check the hardware of the host computer.
When using the WebService to control a Phidget, the problem may be with the USB connection on the remote computer. Make sure both the server-side of (a) the webservice and (b) the USB connection are working by using the instructions on the OS X page
If the examples do not work but USB does work (i.e. your remote computer or iOS device can consistently see the device in the hardware), take a moment to check the basics:
- No other programs, drivers, or processes are using the Phidget on the host computer.
- You have copied and linked the Phidget iOS libraries (as described on the Language - iOS page)
- The Phidget libraries are the latest version (visit the getting started section to download them)
- Ensure that the webservice drivers and the iOS libraries are both the latest version
- Ensure that you have the most up to date iOS version installed for your device.
- 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 in hardware (if it is erratic, try our general troubleshooting guide). If you are still having problems after using the troubleshooting guide, please ask us!
iOS programs are written in Objective C using the Cocoa Touch framework. You can read on within this page to learn how to use iOS with the Webservice, or you can jump ahead right now to the iOS page and start writing code!
The Phidget WebService allows you to remotely control a Phidget over a network.
This section helps you use the WebService on iOS, but we also have an overview of the Phidget WebService in general.
Currently, iOS devices cannot host the WebService, but they can use data streaming from another computer over the WebService.
Setting Up the WebService
Using an iOS device, your network-controlled Phidget system will probably look something like this:
1. Start the WebService on the host computer
- How to do this on Windows
- How to do this on Mac OS
- How to do this on Linux
- How to do this on the Phidget Single Board Computer
2. Download and unzip the iOS Examples anywhere on the development computer.
3. Open up the
HelloWorld.xcodeproj into Xcode. Select either an iOS device or iOS simulator as the destination. For more information, please see the Use Our Examples section of the iOS language page.
4. In Xcode, hit the
Run button to transfer the application to the device or simulator as well as run it.
Using the WebService
After performing the steps above, you will be using the WebService already. Plugging in the Phidget to the host computer will give you a screen like this:
The above screenshot shows that a number of Phidgets are attached to the USB ports of computer connected to the network. Go ahead and detach the Phidgets from the USB port of the host computer, and see what happens.
Debugging the WebService
Since an iOS device can only be a user and not a host of the WebService, you should use debugging server side. Refer to the webservice sections for each operating system:
In addition, if you are having webservice problems, you will probably find the webservice section of our General Troubleshooting Guide helpful as well.
Description of Library files
iphoneos/libPhidget21.acontains the actual Phidget library, which is used at run-time. This library is used when you are testing the example on the actual iOS device.
iphonesimulator/libPhidget21.acontains the actual Phidget library, which is used at run-time. This library is used when you are testing the example an iOS simulator.
phidget21.hlists all the Phidget API function calls available to your code. Your compiler also has to know where this file is.
SkeletonProjectis a Xcode project containing the bare minimum project settings already filled in to code with the Phidget library.
Common Problems and Solutions
Description of Installer files
Here is the list of files and their description for each file the installer puts onto your system.
phidget21.dllcontains the actual Phidget library, which is used at run-time. It is also placed in
PhidgetWebService21.exeis used to control Phidgets remotely across a network using the PhidgetWebservce.
PhidgetWindowsService21.exeis a Windows service that controls
phidget21.libis used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts
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.libis 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.libthat are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the
phidget21.libis placed in
C:\Program Files\Phidgets; The 32 bit version of
phidget21.libis placed in
phidget21.hlists 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
C:\Program Files\Phidgetsso you can either point your compiler to that location, or copy and link to it in a directory for your project workspace.
phidget21.jaris an archive containing the Phidgets library, used by the Java programming language.
Phidget21.NET.dllis 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.dllis the Phidgets library for .NET framework 1.1. Any .NET language can be used, including C# , and Visual Basic .NET.
Phidget21.NET.XMLprovides the IntelliSense in-line documentation for the .NET library in Visual Studio.
Phidget21COM.dllis 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.exeis a tool to quickly determine whether your system is able to control Phidgets, and also act as a debugging tool.
Examplesfolder contain example applications that allows you to quickly see if your Phidget is properly configured.
x86 folderfolder contain the 32 bit versions of
Phidget21COM.dll. These folder will only appear on 64 bit installations and is useful if you want to code against the 32 bit libraries.