|
|
| (92 intermediate revisions by 8 users not shown) |
| Line 1: |
Line 1: |
| [[Category:OS]] | | [[Category:OS]] |
| [[File:Icon-iOS.png|64x64px|link=OS - iOS]]iOS is a mobile OS used on iOS devices including the iPad, iPhone, and iPod touch.
| | {| |
| | |style="vertical-align:middle; width: 60%;"| |
| | ==Getting Started with iOS== |
| | Welcome to using Phidgets with iOS! |
|
| |
|
| __TOC__
| | If you haven't already, check out the [[:Category:UserGuide|user guide]] for your device. If you are ready to go, the first step to creating an iOS application with Phidgets is downloading the Phidget libraries on your macOS development machine! |
| | |{{TOC limit|3}} |
| | |} |
| | ==Download== |
| | The Phidget libraries for iOS development are available here: |
| | *[https://cdn.phidgets.com/downloads/phidget22/libraries/ios/Phidget22_iOS.zip iOS Libraries] |
|
| |
|
| Phidgets are designed to run on devices with an iOS version of 3.0 or later. It is strontly 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 cheaper-than-a-tablet way to host Phidgets over a network, take a look at our [[1072 0 - PhidgetSBC2|Single Board Computer]].
| | Download and unpack the libraries. You will need to reference these files from your Xcode project in order to use Phidgets. This step is covered in detail after you select your programming language below. If you need to access older versions of the libraries, [https://www.phidgets.com/downloads/phidget22/libraries/ios/ click here]. |
|
| |
|
| ==Getting Started (Libraries and Drivers)== | | ==Network Server== |
| | Phidgets cannot be connected directly to iOS devices, therefore, in order to use Phidgets with your iOS device, you must have a host computer that is running the Phidget Network Server. |
|
| |
|
| If this is your first Phidget, we highly recommend working through the Getting Started guide [[Device List|for your specific Phidget device]].
| | [[Image:iOS-connection.jpg|link=]] |
|
| |
|
| iOS code is developed on an external OS X machine, and so getting your Phidget to work locally on that platform first will help you distinguish any issues from network ones later.
| | *Host computer: the computer that is physically connected to the Phidgets via USB and is running the Phidget Network Server. |
| | *Client computer: a computer running a Phidgets application that accesses Phidgets connected to the host computer. When developing for iOS, your iOS device acts as the client. |
|
| |
|
| If you are already a pro, and just want the drivers:
| |
|
| |
|
| *[http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip iOS Drivers] | | The next step is to install the Phidget libraries on your host computer, and get the Phidget Network Server up and running. Start by following the ''Getting Started'' guide, and continue with the ''Network Server'' guide. When you are done, come back and finish this guide! |
| | *[[OS - Windows#Phidget Network Server| Windows]] |
| | *[[OS - OS X#Phidget Network Server| macOS]] |
| | *[[OS - Linux#Phidget Network Server| Linux]] |
| | *[[OS - Phidget SBC#Phidget Network Server| Phidget Single Board Computer]] |
|
| |
|
| ===Installing=== | | ==Programming== |
| | Now that you have everything set up, all you have to do is code! Select from one of the following programming languages to get started: |
|
| |
|
| The 'installation' of the Phidget iOS libraries is simply linking and distributing the libraries with your code. 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.
| | * [[Language - Objective C#iOS|Objective C]] |
| | | * [[Language - Swift#iOS|Swift]] |
| To install the libraries, follow these steps:
| |
| | |
| 1. Download the Phidget [http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip drivers for iOS].
| |
| | |
| 2. Unzip the file, and you will find three things:
| |
| | |
| # Libraries for the iOS device and iOS simulator
| |
| # Example code for the PhidgetInterfaceKit and PhidgetManager
| |
| # Skeleton 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 [[Language - iOS#Write Your Own Code | 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.
| |
| | |
| ===Checking===
| |
| | |
| 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.
| |
| | |
| ====Software====
| |
| | |
| 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 {{Code|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.
| |
| | |
| ====Hardware====
| |
| | |
| If you are having problems running the examples, you should check the hardware of the host computer.
| |
| | |
| When using the [[#Webservice|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 - OS X|OS X page]]
| |
| | |
| ====Troubleshooting====
| |
| | |
| If the examples '''do not''' work but USB '''does''' work (i.e. your remote computer or Android device can consistently see the device in the [[#Hardware|hardware]]), take a moment to check the basics:
| |
| * No other programs, drivers, or processes are using the 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 (Libraries and Drivers)| getting started section]] to download them)
| |
| * Ensure that the webservice drivers and the iOS libraries are both the latest version
| |
| * Check the [[#Common Problems and Solutions|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|hardware]] (if it is erratic, try our [[General Troubleshooting|general troubleshooting guide]]). If you are still having problems after using the troubleshooting guide, please [[Contact Information|ask us]]!
| |
| | |
| ==Programming Languages==
| |
| | |
| iOS programs are written in [[Language - iOS|Cocoa Touch and Objective C]] using the Phidgets library.
| |
| | |
| ==Webservice==
| |
| | |
| The Phidget Webservice allows you to remotely control a Phidget over a network.<br>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:
| |
| | |
| [[Image:webservice_general_pctoios.png|600px|link=|alt=]]
| |
| | |
| To begin,
| |
| | |
| 1. Start the Webservice on the host computer
| |
| * How to do this [[OS - Windows#Webservice|on Windows]] | |
| * How to do this [[OS - OS X#Webservice|on Mac OS]]
| |
| * How to do this [[OS - Linux#Webservice|On Linux]]
| |
| * How to do this [[OS - Phidget SBC#Webservice|On the Phidget Single Board Computer]]
| |
| | |
| 2. Download the [http://www.phidgets.com/downloads/libraries/Phidget-iPhone_2.1.8.20120216.zip iOS Examples].
| |
| | |
| 3. Open up the {{Code|HelloWorld.xcodeproj}} into Xcode. Select either a iOS device or iOS simulator as the destination.
| |
| | |
| 4. Hit the {{Code|Run}} button to enable to device or simulator to run the program.
| |
| | |
| ===Using the Webservice===
| |
| | |
| After performing the steps above, you will be using the Webservice already. Plugging in the Phidget to the host computer will probably give you a screen like this:
| |
| | |
| [[File:iOS Webservice Example HelloWorld Output.png|link=|alt=HelloWorld Output]]
| |
| | |
| 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 computer, and see what happens.
| |
| | |
| ===Debugging the Webservice===
| |
| | |
| As currently an Android 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:
| |
| * [[OS - Windows#Webservice|Windows]]
| |
| * [[OS - OS X#Webservice|Mac OS]]
| |
| * [[OS - Linux#Webservice|Linux]]
| |
| * [[OS - Phidget SBC#Webservice|Phidget Single Board Computer]]
| |
| In addition, if you are having webservice problems, you will probably find the webservice section of our [[General Troubleshooting#Webservice Troubleshooting|General Troubleshooting Guide]] helpful as well.
| |
| | |
| ==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====
| |
| | |
| * <b>{{Code|iphoneos/libPhidget21.a}}</b> contains 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.
| |
| * <b>{{Code|iphonesimulator/libPhidget21.a}}</b> contains the actual Phidget library, which is used at run-time. This library is used when you are testing the example an iOS simulator.
| |
| * <b>{{Code|phidget21.h}}</b> lists all the Phidget API function calls available to your code. Your compiler also has to know where this file is.
| |
| * <b>{{Code|SkeletonProject}}</b> is a Xcode project containing the bare minimum project settings already filled in to code with the Phidget library.
| |
| | |
| ====Special Cases of Library Install====
| |
| | |
| Regardless of what language you will be using to program Phidgets, you will need the {{Code|phidget21.dll}} placed in the {{Code|C:\WINDOWS\system32}} directory. Additional files are needed for the language that you choose. Please refer to the documentation provided by your [[Device List|language]] to determine what files are needed and the steps needed to install them onto your system.
| |
| | |
| You can find the {{Code|phidget21.dll}} in the link below:
| |
| | |
| *[http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20110615.zip Phidget21 Libraries] (32-Bit and 64-Bit development files without an installer)
| |
| | |
| PhidgetWebService21.exe is also provided in the link above.
| |
| | |
| ===Windows in a Virtual Machine===
| |
| | |
| Phidgets can also be used inside a virtual machine. Instructions for VMWare and VirtualBox are provided. Virtual PC is not supported as USB Phidgets requires a virtual platform that supports HID USB Devices. Since Virtual PC does not support HID USB devices, Phidgets may not be used.
| |
| | |
| As always, please ensure that you have the latest Phidget [[#Getting Started (Libraries and Drivers) | drivers]] installed on the virtual machine and that you are using the latest version of your virtual software.
| |
| | |
| <b>VMWare:</b>
| |
| | |
| To enable USB Phidgets, select Virtual Machine -> Removable Devices -> and select the Phidget Input Device -> Connect.
| |
| | |
| <b>VirtualBox</b>
| |
| | |
| To enable USB Phidgets, VirtualBox Guest Additions(Devices -> Install Guest Additions) may need to be installed. Afterwards, click on Devices -> USB Devices and select the Phidget device to enable. The state should go from Busy to Captured. VirtualBox may bring up a new hardware wizard in the host operating system, which has to be installed. Please note that Phidgets with USB hubs(i.e, [[Product - 1019 1 - PhidgetInterfaceKit 8/8/8 w/6 Port Hub|1019]]), are undetectable; Fortunately, Phidgets that are attached to such Phidgets are detectable.
| |
| | |
| ==Common Problems and Solutions==
| |
| | |
| ===Issue: A corrupt installation fails on uninstall or repair===
| |
| Affected Operating Systems: '''Windows'''
| |
| | |
| Solution: If the normal uninstall fails, or for whatever reason, you can choose to remove the Phidgets framework manually.
| |
| Please perform the following:
| |
| # Shut down any programs using the Phidget libraries, including the webservice and the Phidget Control Panel.
| |
| # Delete C:\Program Files\Phidgets\
| |
| # Remove the Phidgets key from the Registry [-HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services PhidgetWebservice21].
| |
| | |
| In most cases this is enough to get the installer working again. If you need to remove all traces of
| |
| the Phidgets libraries manually, perform the following additional steps:
| |
| | |
| # Unregister the COM library: regsvr32 /u “C:\Program Files\Phidgets\Phidget21COM.dll”
| |
| # Remove Phidget21.NET and Policy.2.1.Phidget21.NET from C:\Windows\Assembly\
| |
| # Delete ‘C:\Documents and Settings\All Users\Application Data\Phidgets’ (WindowsXP) or ‘C:\Users\All Users\Phidgets’ (Vista).
| |
| # Delete C:\Windows\system32\phidget21.dll
| |
| # Delete Phidgets from the start menu
| |
| # Search for and remove keys mentioning Phidgets from the registry in the following locations:
| |
| :* [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\]
| |
| :* [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Products\]
| |
| :* [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders\Phidgets Inc]
| |
| :* [HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run\Phidget21Manager]
| |
| :* [HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Installer\Assemblies\Global\]
| |
| | |
| :9. Reboot
| |
| | |
| '''NOTE:''' You can go through the registry and purge any other keys mentioning Phidgets if you still
| |
| have problems, but at this point you should be able to reinstall under most cases. There will also be
| |
| keys relating to the installer, the .NET library and the COM library, but they should not interfere with
| |
| anything.
| |
| | |
| ===Issue: Event data is sporadic/slow/clumped over the webservice===
| |
| Affected Operating Systems: '''Windows'''
| |
| | |
| Windows implements 200ms delayed ACKs for network traffic. When traffic is one-way only - as it is with event data, the data will all arrive in clumps every 200ms because of delayed ACKs.
| |
| | |
| This can be a great drawback for application which rely on low latency event data over the network. (source: http://support.microsoft.com/kb/214397)
| |
| | |
| This delayed ACK behavior can be disabled in windows to decrease event latency as documented here: http://support.microsoft.com/kb/328890
| |
| | |
| In the future, the Phidgets library may implement this differently, but so far we have been unable to match the performance achieved by disabling delayed ACK.
| |
| {{CreativeCommons}}
| |
