View source for Language - Max

[[Category:Language]]
{{OSLang|[[File:icon-MaxMSP.png|link=|alt=MaxMSP|64x64px]]|Max/MSP, developed by [http://cycling74.com Cycling74] is a visual programming language for creating music and media applications.}}
__TOC__

==Introduction==

{{LanguageSupport|Max/MSP|most of the Phidget API, including events. All the supported functions for Max/MSP will be documented in the {{Code|.help}} files|all Phidget devices.| Windows and OS X|

Only Max/MSP 4.5 or higher is supported.}}

==Quick Downloads==
{{QuickDownloads|Max/MSP|
* [http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip {{Code|.help}} file(Windows - same file as Max/MSP Examples and Libraries)]
* [http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip {{Code|.help}} file(OS X - same file as Max/MSP Examples and Libraries)]|
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip|(Windows - same file as Max/MSP Documentation and Libraries)}}
{{ExampleQuickDownloads|http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip|(OS X - same file as Max/MSP Documentation and Libraries)}}|{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip|Max/MSP|(Windows - same file as Max/MSP Documentation and Examples)}}
{{ExtraLibraryQuickDownloads|http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip|Max/MSP|(OS X - same file as Max/MSP Documentation and Examples)}}
{{WindowsQuickDownloads}}
{{MacQuickDownloads}}
}}

==Getting started with Max/MSP==

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}

Instructions are divided up by operating system. Choose:
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#OS X |OS X]]

==Windows (2000/XP/Vista/7)==
  
===Description of Library Files===
Max/MSP programs on Windows depend on the following files. The installers in the [[#Libraries and Drivers | Quick Downloads]] section put only the {{Code|phidget21.dll}} into your system. You will need to manually put the {{Code|PhidgetXXX.mxe}} onto your system. 
* <b><code>phidget21.dll</code></b> contains the actual Phidget library, which is used at run-time. By default, the installer places it in <code>C:\Windows\System32</code>.
* <b><code>PhidgetXXX.mxe</code></b> is the Phidget library for your specific device. XXX denotes the name of your device, Please make sure the <code>.mxe</code> file corresponds with the device you are using. For example, if you are using the PhidgetInterfaceKit, you will need the {{Code|PhidgetInterfaceKit.mxe}}. It is to be placed in the same directory as your Max/MSP application or anywhere in the Max/MSP search path.

If you do not want to use our installer, you can download the {{Code|[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip phidget21.dll]}} and manually install it where you want; refer to our [[OS_-_Windows#Manual_File_Installation|Manual Installation Instructions]].

===Use Our Examples===

Please start by downloading the [http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip  Max/MSP Examples and Library] and unpack them into a folder.  These examples were written in Max/MSP 4.6, but any version above 4.5 are also supported.

Here, you will find example programs, in {{code | .help}} format for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]].

The only thing left to do is to run the examples! Open the {{code| .help}} file in the Max environment.

Once you have the Max/MSP examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

===Write Your Own Code===

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure the Max/MSP environment to properly link the Phidget Max/MSP libraries. To begin: 

Place the {{Code|.mxe}} in the same directory as the patcher, or anywhere in the Max/MSP search path. You can verify the search path locations by navigating to Options &rarr; File Preferences. 

[[File:MaxMSP Path.PNG|link=|alt=Search Path]]

The best way to start writing your patch is to modify an example, and saving it as a {{Code|.pat}} file.

If you wish to start a new patch. All you need to do is create an object named PhidgetXXX where XXX is the name of your device. For example, the [[Product - 1023 1 - PhidgetRFID | PhidgetRFID device]] will have the {{Code|PhidgetRFID}} object name. 
The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

==OS X==

Max/MSP has excellent support on OS X.

The first step in using Max/MSP on Mac is to install the Phidget library.  Compile and install them as explained on the [[Device List|getting started guide for your device]].  Then, the [[OS - OS X]] page also describes the different Phidget files, their installed locations, and their roles....

===Use Our Examples===

Please start by downloading the [http://www.phidgets.com/downloads/examples/MaxMSP_2.1.8.20120507.zip  Max/MSP Examples and Library] and unpack them into a folder.  These examples were written in Max/MSP 4.6, but any version above 4.5 are also supported.

Here, you will find example programs, in {{code | .help}} format for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]].

The only thing left to do is to run the examples! Open the {{code| .help}} file in the Max environment.

Once you have the Max/MSP examples running, we have a [[#Follow the Examples|teaching]] section below to help you follow them.

===Write Your Own Code===

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure the Max/MSP environment to properly link the Phidget Max/MSP libraries. To begin: 

Place the {{Code|.mxe}} in the same directory as the patcher, or anywhere in the Max/MSP search path. You can verify the search path locations by navigating to Options &rarr; File Preferences. 

[[File:MaxMSP MacPath.PNG|link=|alt=Search Path]]

The best way to start writing your patch is to modify an example, and saving it as a {{Code|.pat}} file.

If you wish to start a new patch. All you need to do is create an object named PhidgetXXX where XXX is the name of your device. For example, the [[Product - 1023 1 - PhidgetRFID | PhidgetRFID device]] will have the {{Code|PhidgetRFID}} object name. 
The project now has access to the Phidget function calls and you are ready to begin coding.

The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.

==Follow the Examples==

By following the instructions for your operating system, you probably now have a working example and want to understand it better so you can change it to do what you want.  This teaching section has resources for you to learn from the examples and write your own.

First, let's explain how to operate the example. 

[[File:MaxMSP Example.PNG|link=|alt=Example]]

The above screenshot is what shows up when you open the example for the PhidgetInterfaceKit. If you are using a different device, your example patch will be different, but the idea is the same.

For this particular example, the Max object is called {{Code|PhidgetInterfaceKit}}, which is located in the center of the screen. Objects/message boxes are connected to the inputs and outputs of the PhidgetInterfaceKit object. The input objects will either cause a property of the device to change or request for a property to be retrieved. The output objects return the retrieved information. All the supported features of the device are shown in the {{Code|.help}} file. 

Try it for yourself! Click on the {{Code | getSerial}} message box to request the Phidget to retrieve the serial number of the device. You should see the last output object of {{Code|route}} changed to the serial number of your device. All devices support the {{Code|getSerial}} object, and is the easiest way to determine if the Phidget libraries are correctly set up, and whether the Max/MSP application is connected to your device.

[[File:MaxMSP getSerial.PNG|link=|alt=getSerial]]

If your example contains the {{Code|read}} message box, click on it. This will return device specific values to the screen.

[[File:MaxMSP read.PNG|link=|alt=Read Data]]

If your example contains the {{Code|start}} message box, you can continuously poll for events. Set the sample rate input for the {{Code|setSampleRate}} object. Then, press the {{Code|start}} message box to start sampling. When a noteworthy event occurs on a Phidget(i.e., when an analog sensor senses a change in the environment), the value will be displayed onto the screen. Press the {{Code|stop}} message box to stop sampling.

For the PhidgetInterfaceKit example, there also a {{Code|setoutput}} message box. Clicking on the check boxes will cause the digital outputs of the PhidgetInterfaceKit device to change. Your example may contain device specific message boxes/objects to click on. See for yourself what they do!

For information regarding calls specific to your device, please see the [[Device List | API for your specific device]]. Please note that some device functionality are not supported in Max/MSP; the {{Code|.help}} example shows the complete list of functionality supported under Max/MSP.

==Code Snippets==


openRemote object

multiple phidgets

==Common Problems and Solutions/Workarounds==

{{ProblemSolution|Crash|When a patch file is closed in the Max/MSP environment, the program crashes}}

If in your Max/MSP environment, you have more patches(of the same Phidget object) than you have of the actual hardware device, the Max/MSP environment may crash. This is due to the fact that a single Phidget Max/MSP object <i>only</i> corresponds to a single Phidget device hardware. For example, your Max/MSP environment may experience unexpected behavior while you have one PhidgetInterfaceKit device connected to the computer, but you have a two seperate patches opened with a single PhidgetInterfaceKit Max object in each one.

Likely Fix: Please ensure that you do not use more patches(of the same Phidget object) than you have of the actual Phidget device.