OS - macOS: Difference between revisions

From Phidgets Support
No edit summary
 
(140 intermediate revisions by 9 users not shown)
Line 1: Line 1:
[[Category:OS]]
[[Category:OS]]
[[File:Icon-Mac-OS.png‎|64x64px|link=]] On OS X, 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 '''OS X 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 OS X.
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 OS X 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 want to install the Phidget libraries without the installer, please see the [[#Advanced Uses | Advanced Uses]] section.
Next, open up the installer, and double click on ''Phidgets.pkg'' to install the libraries:
*[http://www.phidgets.com/downloads/libraries/Phidget21-windevel_2.1.8.20110615.zip Phidget21 Libraries]
[[File:OSX Install 1.png|link=|alt=macOS Install|center]]
*[http://www.phidgets.com/Drivers_Info.html#windows Software License]


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


The Phidget installer will install the core Phidget files onto your system.
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].


To install the libraries, follow these steps:
The Phidgets libraries are now installed on your machine. Next, let's verify that the Phidget libraries are working properly.


1. Download the Phidget installer for your system:
===Verify===
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20120216.dmg OS X Installer]
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:


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


[[File:OSX Install 1.png|link=|alt=OS X Install]]
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]]


3. Proceed through the wizard.


[[File:OSX Install 2.png|link=|alt=OS X Install]]
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]]


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


Proceed onto to the [[#Phidget Preference Pane | next]] section where the Phidget Preference Pane will be discussed.
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]]


====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.  
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.


Once the Phidget libraries are installed using the installer, open up the {{Code|System Preferences}} window.
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!


[[File:OSX System Preferences.png|link=|alt=OS X System Preferences]]
==Programming==
Ready to write some code? Select one of the programming languages below:


Click on the {{Code|Phidgets}} icon in the {{Code|Other}} section to bring up the Phidgets Preference Pane.
{{Programming_Languages_Table}}


[[File:OSX PreferencePane General.png|link=|alt=OS X PreferencePane General]]


The {{Code|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.


[[File:OSX PreferencePane Example.png|link=|alt=OS X PreferencePane Example]]
==Advanced Information==


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 [[Device List|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. 
===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
|-
|}


The next tab is the {{Code|Web Service}} tab, which allows you to control Phidgets over a network.
===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:


[[File:OSX PreferencePane Webservice Stopped.png|link=|alt=OS X PreferencePane Webservice Stopped]]
* [https://cdn.phidgets.com/downloads/phidget22/libraries/macos/Phidget22_macosdevel.zip Phidgets macOS Developer Tools]


Here, you can start and stop the Webservice. Details are provided in the [[#Webservice | Webservice]] section. This screen also tells you whether the Phidget Webservice is currently running.  
You can also use the tools in this package to do a custom minimal install.  


The next tab is the {{Code|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.
Please see the included README file for details on how to use these tools.


[[File:OSX PreferencePane Labels Local.png|link=|alt=OS X PreferencePane Webservice Labels Local]]
===Older Versions===
If you need older versions of the macOS libraries, [{{SERVER}}/downloads/phidget22/libraries/macos/Phidget22/ click here].


You can also view the labels of any Phidget connected through the Webservice
===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):


[[File:OSX PreferencePane Labels Remote.png|link=|alt=OS X PreferencePane Webservice Labels Remote]]
* [https://cdn.phidgets.com/downloads/phidget22/tools/macos/Phidget22ControlPanel.dmg macOS Standalone Control Panel]


The {{Code|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.
If you intend to write code that uses Phidgets, you should use the main installer mentioned at the beginning of this guide.
 
[[File:OSX PreferencePane Bonjour.png|link=|alt=OS X PreferencePane Bonjour]]
 
The last tab is the {{Code|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.
 
[[File:OSX PreferencePane PhidgetSBC.png|link=|alt=OS X PreferencePane PhidgetSBC]]
 
===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.
 
[[File:OSX PreferencePane General.png ‎|link=|alt=OS X Preference Pane General]]
 
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 {{Code|About This Mac}} under the Apple icon.
 
[[File:OSX About This Mac.png‎|link=|alt=OS X About This Mac]]
 
The new window will open up.
 
[[File:OSX More Info.png|link=|alt=OS X More Info]]
 
Select {{Code|More Info}}. The System Profiler will show up. In the USB section, you will be able to find all connected USB devices.
 
[[File:OSX USB Devices.png ‎|link=|alt=OS X Attached 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|troubleshooting]] section below, as well as the '''Communications''' section of our [[General Troubleshooting#Communications Troubleshooting|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|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 (Libraries and Drivers)| getting started section]] to download them)
 
* 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 (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==
We recommend the following languages for OS X:
* [[Language - Applescript|AppleScript]]
* [[Language - C/C++|C/C++]]
* [[Language - C#|C#(Using Mono)]]
* [[Language - Cocoa | Cocoa]]
* [[Language - Flash AS3 | Flash AS3]]
* [[Language - Flex AS3 | Flex AS3]]
* [[Language - LiveCode | LiveCode]]
* [[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:
 
*[[Language - MATLAB|MATLAB]]
*[[Language - Simulink|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 [[#Getting Started (Libraries and Drivers) | 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 [http://www.apple.com/support/bonjour/ 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 {{Code|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 {{Code|Start Automatically}} checkbox.
 
[[File:OSX PreferencePane Webservice Stopped.png|link=|alt=OS X PreferencePane WebService]]
 
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 {{Code|/usr/bin/phidget21webservice}}.
 
You can get command line help with {{Code|phidgetwebservice21}} using the -h option:
 
<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21 -h
</syntaxhighlight>
 
<syntaxhighlight lang=text>
'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
</syntaxhighlight>
</div>
 
To find the defaults used by {{Code|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 {{Code|hostname}} on the command line.
*For your IP address, use {{Code|ifconfig -a}} on the command line.
**A line in the return text, under your main internet connection (usually {{Code|eth0}}) will say something like {{Code|inet addr:192.168.3.178}}, which is your IP.
 
Here are some example usage.
 
To start the Webservice with default parameters:
<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21
</syntaxhighlight>
</div>
 
To start the Webservice with a server name of {{Code|myServer}}:
<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21-n myServer
</syntaxhighlight>
</div>
 
To stop the Webservice, simply close the command line window or press {{Code|Control}} and {{Code|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 {{Code|Web Service}} tab.
 
[[File:OSX PreferencePane Webservice Stopped.png |link=|alt=OS X Preference Pane Webservice]]
 
2. Leave all fields the way it is, and click on {{Code|Start WebService}} to run the Webservice.
 
3. You can determine that the Webservice is running by looking at the status on the right side.
 
[[File:OSX PreferencePane Webservice Running.png|link=|alt=OS X PreferencePane Webservice Running]]
 
4. Ensure that the Phidget is plugged in to the host.
 
5. On the client's Phidget Preference Pane, open up the {{Code|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.
 
[[File:OSX PreferencePane Bonjour.png ‎‎ |link=|alt=OS X PreferencePane Bonjour.png ‎]]
 
6. The example application will open up, and you will be able to interact with the Phidget over the Webservice.
 
[[File:OSX PreferencePane Example.png ‎ |link=|alt=OS X PreferencePane Example]]
 
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 {{Code|Webservice}} tab. Hit {{Code|Stop WebService}} to terminate the Webservice.
 
[[File:OSX PreferencePane Webservice Running.png|link=|alt=OS X PreferencePane Webservice Running]]
 
8. Take a look at the example application on the client. Since the application can no longer connect to the Webservice, there is nothing attached.
 
[[File:OSX PreferencePane Example Stopped.png |link=|alt=OS X PreferencePane Example Stopped]]
 
===Debugging the Webservice===
 
In addition to enabling [[General Phidget Programming#Logging|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 {{Code|-v}} option:
 
<div class="source">
<syntaxhighlight lang=bash>
phidgetwebservice21 -v -n "myServer"
</syntaxhighlight>
</div>
 
The debugging information will be shown as output in the command line console.
 
==Advanced Uses==
 
===Description of Library files===
 
This section will explain the files that were placed onto your system as part of the installation process.
 
* <b>{{Code|Phidget21.framework}}</b> contains the actual Phidget library, which is used at run-time.  It is placed into {{Code|/Library/Frameworks}}.
* <b>{{Code|Phidget.kext}}</b> is the kernel extension.  It is placed into {{Code|/System/Library/Extensions}}.
* <b>{{Code|libphidget21.jnilib}}</b> is the JNI library for Java.  It is placed into {{Code|/Library/Java/Extensions}}.
* <b>{{Code|Phidgets.prefpane}}</b> is the Phidgets Preference Pane.  It is placed into {{Code|/Library/PreferencePanes}}.
* <b>{{Code|phidgetwebservice21}}</b> is the Phidget Webservice.  It is placed into {{Code|/usr/bin}}.
* <b>{{Code|PhidgetsOSA.app}}</b> is the the Phidgets agent for AppleScript.  It is placed into {{Code|/Library/ScriptingAdditions}}.
 
==Common Problems and Solutions==
 
None, yet.

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"