OS - macOS: Difference between revisions

From Phidgets Support
No edit summary
 
(186 intermediate revisions by 9 users not shown)
Line 1: Line 1:
[[Category:OS]]
[[Category:OS]]
[[File:Icon-Mac-OS.png‎|64x64px|link=]] On Mac OS, Phidgets can be either plugged directly into a USB Port or run over a network using the [[#Webservice|Webservice]].


__TOC__
{{NoticeBox|Note to macOS 11+ Users:|If you're having issues with the regular installer, try installing and running the [https://cdn.phidgets.com/downloads/phidget22/tools/macos/Phidget22ControlPanel.dmg Standalone Control Panel], which uses a driver extension instead of a kernel extension.}}


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)==
{|
|style="vertical-align:middle; width: 60%;"|
==Getting Started with macOS==
Welcome to using Phidgets with macOS!


If this is your first Phidget, we highly recommend working through the Getting Started guide [[Device List|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 ready to go, the first step in creating macOS applications with Phidgets is installing our libraries.
|{{TOC limit|3}}
|}


If you are already a pro, and just want the drivers:
===Install===
To install our libraries, download the installer for your system:
* [https://cdn.phidgets.com/downloads/phidget22/libraries/macos/Phidget22.dmg macOS Installer Download]


*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20120216.dmg Mac OS Installer]
Before installing our libraries, be sure to read our [[Software License]]. If you need to access older versions of the drivers, [https://www.phidgets.com/downloads/phidget22/libraries/macos/ click here].


For special cases where you cannot install the Phidget installer please see the [[#Advanced Uses]] section.
Next, open up the installer, and double click on ''Phidgets.pkg'' to install the libraries:
* [http://www.phidgets.com/Drivers_Info.html#osx Software License]
[[File:OSX Install 1.png|link=|alt=macOS Install|center]]


===Installing===
When prompted, continue with the installation:
[[File:OSX Install 2.png|link=|alt=macOS Install|center]]


An in-depth description of what the installer does, what the files do, and where they go by default.
If you are using OS X 10.13 or newer you will also need to give explicit permission for the driver to function.  You can read about this here[https://developer.apple.com/library/content/technotes/tn2459/_index.html].


This is NOT the place for Manual Installation Instructions, those instructions go in the [[#Advanced Uses]] section below.
The Phidgets libraries are now installed on your machine. Next, let's verify that the Phidget libraries are working properly.


====Phidget Preference Pane====
===Verify===
The best way to verify that your libraries are working properly is to use the Phidget Control Panel. The Phidget Control Panel is a powerful tool that will help you develop your Phidgets applications. Get started by following the instructions below:


Explain the preference pane, on a concept level.


Advanced uses (modifying, manual installation, etc) go in the advanced section below.
Open Finder and navigate to the Phidget Control Panel in the Applications list:
[[File:OSX Finder Apps.png|link=|900px|alt=macOS Finder Apps|center]]


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. 
Double click on the Phidgets icon to bring up the Phidget Control Panel. You can now see all the Phidgets that are plugged into your machine, as well as any Phidgets that are on the network:
[[File:OSX ControlPanel General.png|600px|link=|alt=macOS Control Panel General|center]]


===Checking===


Summarize that we will be using code and the device manager to confirm and troubleshoot the installation, if needed.
Click on the arrow beside a device to expand it so that you can see all available channels. Double click on one of these channels to open up a window that lets you interact with it.
[[File:OSX Control Panel Channel.png ‎|link=|alt=macOS Control Panel Channel|center]]


====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.  If you have to install a compiler or interpreter of some sort on a raw Windows machine to do this, the installed software should be mainstream and free.
The Phidget Control Panel can be used for testing devices, updating firmware, enabling a network server, and more! Visit the [[Phidget Control Panel#macOS|Phidget Control Panel]] page if you want to delve a little deeper.


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.
Your Phidget is now able to communicate with your development machine. The next step is selecting a programming language so you can start to write some code!


====Hardware====
==Programming==
Ready to write some code? Select one of the programming languages below:


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.
{{Programming_Languages_Table}}


====Troubleshooting====


Make an in-depth point by point section with some of this content plus more:


*Confirm prerequisites
==Advanced Information==
*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 [[OS - Linux#Troubleshooting|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.
===Installed Files===
These files were placed onto your system as part of the installation process:
{| class="wikitable"
|-
| align="center" style="background:#f0f0f0;"|'''File'''
| align="center" style="background:#f0f0f0;"|'''Description'''
| align="center" style="background:#f0f0f0;"|'''Location'''
|-
|Phidget22.framework||contains our library, which is used at run-time.||/Library/Frameworks
|-
|Phidget.kext||kernel extension.||/Library/Extensions
|-
|phidgetnetworkserver22||Phidget Network Server||/usr/local/bin
|-
|}


===Developer Tools===
If you're a software developer and want to be able to bundle Phidgets with your application, you'll need our developer tools:


==Programming Languages==
* [https://cdn.phidgets.com/downloads/phidget22/libraries/macos/Phidget22_macosdevel.zip Phidgets macOS Developer Tools]
We recommend the following languages for OS X:
* [[Language - Applescript|AppleScript]]
* [[Language - C/C++|C/C++]]
* [[Language - Cocoa | Cocoa]]
* [[Language - Flash AS3]]
* [[Language - Flex AS3]]
* [[Language - Java | Java]]
* [[Language - Max/MSP|Max/MSP]]
* [[Language - Python | Python]]
* [[Language - Ruby|Ruby]]


You can also use these languages, but they do not support [[General Phidget Programming#Event Driven Code | event driven code]], and must use [[General Phidget Programming#Logic Code | logic code]] only:
You can also use the tools in this package to do a custom minimal install.


*[[Language - MATLAB|MATLAB]]
Please see the included README file for details on how to use these tools.
*[[Language - Simulink|Simulink]]


==Webservice==
===Older Versions===
If you need older versions of the macOS libraries, [{{SERVER}}/downloads/phidget22/libraries/macos/Phidget22/ click here].


Short description of the webservice on Mac OS (i.e. which files are the drivers, note that it is automatically on, etc)
===Standalone Control Panel===
If you just want to install the [[Phidget_Control_Panel#macOS|Phidget Control Panel]] without the rest of our libraries (requires macOS 10.15 and newer):


Drivers for the Phidget Webservice on Mac are already included in the [[#Getting Started (Libraries and Drivers) | Drivers]] above. 
* [https://cdn.phidgets.com/downloads/phidget22/tools/macos/Phidget22ControlPanel.dmg macOS Standalone Control Panel]


If you have the Preference Pane installed, you already have the Webservice drivers installed.
If you intend to write code that uses Phidgets, you should use the main installer mentioned at the beginning of this guide.
 
===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# (or C) 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?
 
==Installing Libraries and Drivers==
 
You can download the current version of the drivers for OS X below:
 
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20110630.dmg OS X Drivers]
Requires Mac OS 10.4 or Higher. Supports ppc, intel 32-bit and intel 64-bit.
 
==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.

Latest revision as of 17:12, 14 May 2024


Notice.png

Note to macOS 11+ Users:

If you're having issues with the regular installer, try installing and running the Standalone Control Panel, which uses a driver extension instead of a kernel extension.


Getting Started with macOS

Welcome to using Phidgets with macOS!

If you are ready to go, the first step in creating macOS applications with Phidgets is installing our libraries.

Install

To install our libraries, download the installer for your system:

Before installing our libraries, be sure to read our Software License. If you need to access older versions of the drivers, click here.

Next, open up the installer, and double click on Phidgets.pkg to install the libraries:

macOS Install

When prompted, continue with the installation:

macOS Install

If you are using OS X 10.13 or newer you will also need to give explicit permission for the driver to function. You can read about this here[1].

The Phidgets libraries are now installed on your machine. Next, let's verify that the Phidget libraries are working properly.

Verify

The best way to verify that your libraries are working properly is to use the Phidget Control Panel. The Phidget Control Panel is a powerful tool that will help you develop your Phidgets applications. Get started by following the instructions below:


Open Finder and navigate to the Phidget Control Panel in the Applications list:

macOS Finder Apps


Double click on the Phidgets icon to bring up the Phidget Control Panel. You can now see all the Phidgets that are plugged into your machine, as well as any Phidgets that are on the network:

macOS Control Panel General


Click on the arrow beside a device to expand it so that you can see all available channels. Double click on one of these channels to open up a window that lets you interact with it.

macOS Control Panel Channel


The Phidget Control Panel can be used for testing devices, updating firmware, enabling a network server, and more! Visit the Phidget Control Panel page if you want to delve a little deeper.

Your Phidget is now able to communicate with your development machine. The next step is selecting a programming language so you can start to write some code!

Programming

Ready to write some code? Select one of the programming languages below:

Core Languages Mobile Languages Other Languages
C Sharp C# Objective C Objective C LabVIEW LabVIEW
C/C++ C/C++ Swift Swift Max/MSP Max/MSP
Python Python Android Android Java
Java Java
Visual Basic .NET Visual Basic .NET
JavaScript JavaScript


Advanced Information

Installed Files

These files were placed onto your system as part of the installation process:

File Description Location
Phidget22.framework contains our library, which is used at run-time. /Library/Frameworks
Phidget.kext kernel extension. /Library/Extensions
phidgetnetworkserver22 Phidget Network Server /usr/local/bin

Developer Tools

If you're a software developer and want to be able to bundle Phidgets with your application, you'll need our developer tools:

You can also use the tools in this package to do a custom minimal install.

Please see the included README file for details on how to use these tools.

Older Versions

If you need older versions of the macOS libraries, click here.

Standalone Control Panel

If you just want to install the Phidget Control Panel without the rest of our libraries (requires macOS 10.15 and newer):

If you intend to write code that uses Phidgets, you should use the main installer mentioned at the beginning of this guide.

Retrieved from "https://www.phidgets.com/docs/index.php?title=OS_-_macOS&oldid=34367"