OS - macOS: Difference between revisions
Line 105: | Line 105: | ||
Is there a way to enable debugging like there is on Linux? | Is there a way to enable debugging like there is on Linux? | ||
== | ==Advanced Uses== | ||
===Manual File Installation=== | |||
A reminder of the installer and what it does, and how to do it manually when wanting to distribute our libraries with your code. | |||
====Description of Files==== | |||
All files with the Preference Pane and their default installation locations. | |||
====Special Cases of Library Install==== | |||
Cover how customers can distribute Phidget libraries with their code, refer them mostly to their appropriate language page. | |||
Content copied from the old page: | |||
If you wish to only install the things you need, please refer to your language page for instructions on how to manually install the libraries for your language. | |||
<br/> also explain even more special cases on 64bit systems, if applicable(ie, c. | |||
===Other Advanced Uses=== | |||
Additions to this list should be things we find people request over tech support. Ask Brian for more! | |||
==Phidgets Preference Pane== | ==Phidgets Preference Pane== |
Revision as of 15:26, 2 April 2012
On Mac OS, Phidgets can be either plugged directly into a USB Port or run over a network using the Webservice.
Phidgets are designed to run on Mac OS 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 Mac OS.
If you are already a pro, and just want the drivers:
For special cases where you cannot install the Phidget installer please see the #Advanced Uses section.
Installing
An in-depth description of what the installer does, what the files do, and where they go by default.
This is NOT the place for Manual Installation Instructions, those instructions go in the #Advanced Uses section below.
Phidget Preference Pane
Explain the preference pane, on a concept level.
Advanced uses (modifying, manual installation, etc) go in the advanced section below.
Not the go to option for controlling your device, refer users to the Getting Started guide for their Phidget...again.
It is important to keep in mind that when an example Phidget application is opened from the control panel, it holds a lock on the Phidget. Is this also true on Mac? If so, explain that this prevents any other program from accessing the Phidget. Please ensure that this example application is closed when you are running your own applications.
Checking
Summarize that we will be using code and the device manager to confirm and troubleshoot the installation, if needed.
Software
This should walk you through compiling and running basic code against the libraries as simply as possible. Find an instance that requires no additional programs to run, and that will work with any Phidget, if possible. Recommended HelloWorld and gcc.
The point of this is to give the user tools to identify problems with the library setup that are not due to low level driver conflicts. The process should be described here (with the conclusion being the success of the check), followed by a referral to the Troubleshooting section (and content there) if failure results. See the OS - Linux#Software section for an example.
Hardware
This should show you how to use the "About This Mac" program to make sure the Phidget is attached in hardware, and what to do if not.
Troubleshooting
Make an in-depth point by point section with some of this content plus more:
- Confirm prerequisites
- Walk through ALL known conflicting drivers
- Suggest attributes of unknown conflicting drivers
- Get people to the troubleshooting page if a non-OS problem is suspected
See the Linux Troubleshooting page for a briefer example. It is expected that with driver conflicts, this section will be much larger, with screenshots, etc. If you need to cover troubleshooting a problem with the webservice, you should put the content in the Webservice section below, and link to it.
Programming Languages
We recommend the following languages for OS X:
You can also use these languages, but they do not support event driven code, and must use logic code only:
Webservice
Short description of the webservice on Mac OS (i.e. which files are the drivers, note that it is automatically on, etc)
Drivers for the Phidget Webservice on Mac are already included in the Drivers above.
If you have the Preference Pane installed, you already have the Webservice drivers installed.
Turning the Webservice On and Off
Detailed instructions, both at runtime, and disabling from boot entirely.
Setting Up the Webservice
How to find the port, computer IP, computer bonjour name, etc
Using the Webservice Without Bonjour
Detailed instructions on how to change your code to work with IP addresses
Using the Webservice
A walkthrough in C (using gcc) of how to write (i.e. modify) a remote program and screenshots of it running on localhost (127.0.0.1)
Debugging the Webservice
Examples of common errors in webservice-using code
Is there a way to enable debugging like there is on Linux?
Advanced Uses
Manual File Installation
A reminder of the installer and what it does, and how to do it manually when wanting to distribute our libraries with your code.
Description of Files
All files with the Preference Pane and their default installation locations.
Special Cases of Library Install
Cover how customers can distribute Phidget libraries with their code, refer them mostly to their appropriate language page.
Content copied from the old page:
If you wish to only install the things you need, please refer to your language page for instructions on how to manually install the libraries for your language.
also explain even more special cases on 64bit systems, if applicable(ie, c.
Other Advanced Uses
Additions to this list should be things we find people request over tech support. Ask Brian for more!
Phidgets Preference Pane
Explain the control panel
The examples in the preference pane are as is, and are intended for demonstration purposes. They are not suitable for user applications.
It is important to keep in mind that when an example Phidget application is opened from the 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 Phidgets Preference Pane can still be running) when you are running your own applications.
Common Problems and Solutions
- List relevant problems from "Common Problems and workarounds" doc
- List common problems for this OS from support forums
Limitations
List any limitations associated with running Phidgets with this OS.