OS - macOS: Difference between revisions

From Phidgets Support
mNo edit summary
No edit summary
 
(38 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[Category:OS]]
[[Category:OS]]
__TOC__


==Quick Downloads==
{{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.}}
Already know what you're doing? Here you go:
*[{{SERVER}}/downloads/phidget22/libraries/macos/Phidget22.dmg macOS Installer Download]
*[[Software License]]


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


{|
|style="vertical-align:middle; width: 60%;"|
==Getting Started with macOS==
==Getting Started with macOS==
Welcome to using Phidgets with macOS. If you haven't already, check out the [[:Category:UserGuide|user guide]] for your device. If you are ready to go, the first step in creating macOS applications with Phidgets is installing the Phidget libraries!
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.
|{{TOC limit|3}}
|}


===Install===
===Install===
To install our libraries, download the installer for your system:
* [https://cdn.phidgets.com/downloads/phidget22/libraries/macos/Phidget22.dmg macOS Installer Download]


To install the core Phidget files onto your system, follow these steps:
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].
 
 
1. Download the Phidget installer for your system:
*[{{SERVER}}/downloads/phidget22/libraries/macos/Phidget22.dmg macOS installer download]
 
 
2. Open up the installer, and double click on {{Code|Phidgets.pkg}} to install the libraries.


Next, open up the installer, and double click on ''Phidgets.pkg'' to install the libraries:
[[File:OSX Install 1.png|link=|alt=macOS Install|center]]
[[File:OSX Install 1.png|link=|alt=macOS Install|center]]


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


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


Success! You have finished installing the Phidgets software on your machine. Before you begin coding, let's verify that your Phidget is able to communicate with your machine.
The Phidgets libraries are now installed on your machine. Next, let's verify that the Phidget libraries are working properly.


===Verify===
===Verify===
The best way to verify that your libraries are installed and your Phidget is working 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:
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:




1. Open Finder and navigate to the Phidget Control Panel in the Applications list.
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]]
 


[[File:OSX Finder Apps.png|link=|900px|alt=macOS Finder Apps|center]]
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]]


2. 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|link=|alt=macOS Control Panel General|center]]


3. 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.
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]]
[[File:OSX Control Panel Channel.png ‎|link=|alt=macOS Control Panel Channel|center]]




Line 50: Line 49:
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!
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!


''If you do not see your device in the Phidget Control Panel, visit the [[General Troubleshooting|general troubleshooting page]].''
==Programming==
 
===Programming===
Ready to write some code? Select one of the programming languages below:
Ready to write some code? Select one of the programming languages below:


''Great choices for beginners:''
{{Programming_Languages_Table}}
* [[Language - C/C++|C/C++]]
* [[Language - C Sharp|C#]]
* [[Language - Python | Python]]
* [[Language - Java | Java]]
''Also supported:''
* [[Language - Objective C | Objective-C]]
* [[Language - JavaScript | JavaScript]]
* [[Language - Swift | Swift]]
* [[Language - Max/MSP|Max/MSP]]


==Phidget Network Server==
The Phidget Network Server is an extremely useful feature of Phidgets that allows you to remotely control Phidgets over your network. If you haven't already, check out the [[Phidget Network Server]] page for a complete overview.


===Try it out!===
In order to try the Phidget Network Server out, you will need a host computer, and a client computer:
*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.
If you only have one computer, don't worry, your machine can act as both a host and a client.


==Advanced Information==


Next, follow these steps:
===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
|-
|}


1. Open the Phidget Control Panel on the host computer. Do this by double-clicking on the [[File:Ph.jpg|link=]] icon in your applications folder. Navigate to the Network Server tab, you will see the following:
===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:macos_networkserver.png|link=|center]]
* [https://cdn.phidgets.com/downloads/phidget22/libraries/macos/Phidget22_macosdevel.zip Phidgets macOS Developer Tools]


From here, you can start or stop the Network Server. You can also decide when the Network Server will start.
You can also use the tools in this package to do a custom minimal install.  


[[File:macos_networkserver_run.png|link=|center]]
Please see the included README file for details on how to use these tools.
 
2. Check the automatic start box and enter a server name. By enabling automatic startup, the Network Server will run immediately after macOS boots, so you won't have to manually start it again. You can verify the Network Server is running by looking at the label beside the start/stop button.
 
Now that you have the Network Server running on your host computer, the next step will be accessing the Phidgets connected to your host computer from your client computer. Follow the steps below:
 
 
Now that you have the Network Server running on your host computer, the next step will be accessing the Phidgets connected to your host computer from your client computer. Follow the steps below:
 
 
1. Open the Phidget Control Panel on your client computer. You will see something like this:
 
 
[[File:macos_controlpanel_remote.png|link=|center]]


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


As you can see from the image above, remote Phidgets are listed under the following heading:
===Standalone Control Panel===
*Remote Server: Servername
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):


* [https://cdn.phidgets.com/downloads/phidget22/tools/macos/Phidget22ControlPanel.dmg macOS Standalone Control Panel]


2. You now have access to the Phidgets that are connected to your host computer. Try double-clicking one of them to bring up an example:
If you intend to write code that uses Phidgets, you should use the main installer mentioned at the beginning of this guide.
 
 
[[File:macos_controlpanel_remoteexample.png|link=|center]]
 
 
Note the label in the example indicating a remote connection. This means the example is using the Network Server in order to communicate with the Phidget.
 
===What's next?===
Now that you have seen the Network Server in action, you may be interested in implementing an application that takes advantage of all it's features. Luckily, every programming language we support comes with example code on how to do this! Jump to [[#Programming|programming languages]] above.
 
For more information about the Network Server tab on the Phidget Control Panel, visit the Visit the [[Phidget Control Panel#Windows|Phidget Control Panel]] page.
 
==Advanced Information==
These files that were placed onto your system as part of the installation process:
*{{Code|Phidget22.framework}} contains the actual Phidget library, which is used at run-time.  It is placed into {{Code|/Library/Frameworks}}.
*{{Code|Phidget.kext}} is the kernel extension.  It is placed into {{Code|/System/Library/Extensions}}.
*{{Code|phidgetnetworkserver22}} is the Phidget Network Server.  It is placed into {{Code|/usr/local/bin}}.

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.