Difference between revisions of "Language - Max/MSP"

From Phidgets Support
Jump to: navigation, search
(Max MSP language page now up to date)
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
<metadesc>Communicate over USB with sensors, controllers and relays with Phidgets! Our Max/MSP library supports Windows and MacOS.</metadesc>
 
[[Category:Language]]
 
[[Category:Language]]
{{OSLang|[[File:icon-MaxMSP.png|link=|left|alt=MaxMSP|64x64px]]|Max/MSP, developed by [http://cycling74.com Cycling74] is a visual programming language for creating music and media applications.}}
+
__NOTOC__
__TOC__
+
We provide support for Max/MSP in macOS and Windows. We also provide instructions on how to get your project started. Select your operating system below, and follow the instructions to get your project running with Phidgets.
  
== Introduction ==
+
Once you have set up your development environment to run with Phidgets, we recommend you follow our guide on [[Phidget Programming Basics]]. The guide will showcase the fundamentals of programming with Phidgets.
  
If this is your first time working with a Phidget, we suggest starting with the Getting Started page for your specific device. This can be found in the user guide for your device. That page will walk you through installing drivers and libraries for your operating system, and will then bring you back here to use Max/MSP specifically.
+
==Choose Your Development Environment:==
  
Max/MSP is capable of using most of the {{Phidget22API}}, including events. All the supported functions for Max/MSP will be documented in the {{Phidget22API}}. We also provide example code in Max/MSP for all Phidget devices.
+
{{Language_-_MaxMSP_Dev_Environment_Table}}
 
+
Max/MSP can be developed with Windows and OS X.
+
 
+
'''Only Max/MSP 6 and higher are supported.'''
+
 
+
You can compare Max/MSP with our other supported languages.
+
  
 
== Quick Downloads ==
 
== Quick Downloads ==
 +
If you already know what you're doing and just need the files, you can find them all below.
  
 
=== Documentation ===
 
=== Documentation ===
  
*{{Phidget22API}} (select Max/MSP from the drop-down menu)
+
*{{Phidget22API}} (Select Max/MSP from drop-down menu)
  
 
=== Example Code ===
 
=== Example Code ===
  
 +
*{{SampleCode|MaxMSP|Max/MSP Example}}
  
 +
===Libraries===
  
=== Libraries and Drivers ===
+
{{AllQuickDownloads}}
 
+
{{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(XP/Vista/7)|Windows XP / Vista / 7]]
+
*[[#OS X |OS X]]
+
 
+
== Windows ==
+
 
+
===Description of Library Files===
+
 
+
Max/MSP programs on Windows depend on the following files. The installers in the Quick Downloads section put only the phidget22.dll into your system. You will need to manually put the Phidget[Name].mxe onto your system.
+
 
+
*'''phidget22.dll''' contains the actual Phidget library, which is used at run-time. By default, the installer places it in C:\Windows\System32.
+
 
+
*'''Phidget[Name].mxe''' is the Phidget library for your specific device. [Name] denotes the name of your device. Please make sure the .mxe file corresponds with the device you are using. For example, if you are using a PhidgetDigitalInput, you will need the PhidgetDigitalInput.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 phidget22.dll and manually install it where you want. Refer to the page for your [[Operating_System_Support|operating system]] for details.
+
 
+
===Use Our Examples===
+
 
+
Please start by downloading the [[#Quick_Downloads|Max/MSP Examples and Library]] and unpack them into a folder. These examples were written in Max/MSP 6, but any version above 6 is also supported.
+
 
+
Here, you will find example programs, in .maxhelp format for all the devices. The source file will be named the same as the software object for your device. If you are not sure what the software object for your device is, find your Phidget on our [http://www.phidgets.com webpage], and then check the {{Phidget22API}} documentation for it.
+
 
+
The only thing left to do is to run the examples! Open the .maxhelp file in the Max environment.
+
 
+
Once you have the Max/MSP examples running, we have a [[#Edit 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 .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 → File Preferences.
+
 
+
[[Image: MaxMSP_File_Preferences_PC.png|link=|500px]]
+
 
+
The best way to start writing your patch is to modify an example, and saving it as a .maxpat file.
+
 
+
If you wish to start a new patch. All you need to do is create an object named Phidget[Name] where [Name] is the name of your device. For example, the PhidgetRFID device will have the PhidgetRFID object name. The project now has access to the Phidget function calls and you are ready to begin coding.
+
 
+
The same [[#Edit the Examples|teaching section]] which describes the examples also has further resources for programming your Phidget.
+
 
+
==OS X==
+
 
+
The first step in using Max/MSP on Mac is to install the Phidget library. Compile and install as described on the OS - OS X page, which also describes the different Phidget files, their installed locations, and their roles.
+
 
+
===Use Our Examples===
+
 
+
Please start by downloading the Max/MSP Examples and Library and unpack them into a folder. These examples were written in Max/MSP 6, but any version above 6 is also supported.
+
 
+
Here, you will find example programs, in .maxhelp format for all the devices. The source file will be named the same as the software object for your device. If you are not sure what the software object for your device is, find your Phidget on our [http://www.phidgets.com webpage], and then check the {{Phidget22API}} documentation for it.
+
 
+
The only thing left to do is to run the examples! Open the .maxhelp file in the Max environment.
+
 
+
Once you have the Max/MSP examples running, we have a [[#Edit 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 .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 → File Preferences.
+
 
+
[[Image: MaxMSP_File_Preferences_OSX.png|link=|600px]]
+
 
+
The best way to start writing your patch is to modify an example, and saving it as a .maxpat file.
+
 
+
If you wish to start a new patch. All you need to do is create an object named Phidget[Name] where [Name] is the name of your device. For example, the PhidgetRFID device will have the PhidgetRFID object name. The project now has access to the Phidget function calls and you are ready to begin coding.
+
 
+
The same [[#Edit the Examples|teaching section]] which describes the examples also has further resources for programming your Phidget.
+
 
+
== Edit the Examples ==
+
 
+
By following the instructions for your operating system and compiler above, 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.
+
Your main reference for writing Max/MSP code will be the {{Phidget22API}} Manual:
+
 
+
=== Example Flow ===
+
 
+
First, let's explain how to operate the example.
+
 
+
[[Image: MSP Example.png|link=|500px]]
+
 
+
The above screenshot is what shows up when you open the example for the PhidgetVoltageInput. 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 PhidgetVoltageInput, which is located near the bottom left of the screen. Objects/message boxes are connected to the inputs and outputs of the PhidgetVoltageInput 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 functions for Max/MSP will be documented in the {{Phidget22API}} for your device.
+
 
+
Try it for yourself! Click on the getDeviceSerialNumber message box to request the Phidget to retrieve the serial number of the device. You should see the a message in the Max window denoting the serial number of your device. All devices support the getDeviceSerialNumber message, making it an easy way to determine if the Phidget libraries are correctly set up, and whether the Max/MSP application is connected to your device.
+
 
+
[[Image: MaxMSP_GetSerial.png|link=]]
+
 
+
If your example contains a get[DataType] message box, click on it to cause the associated data to be output with a relevant prefix. [DataType] can denote any data the object may offer, such as Voltage for a voltage input. A list of available messages and their associated outputs is outlined in the {{Phidget22API}} for your device.
+
 
+
[[Image: MaxMSP_GetVoltage.png|link=]]
+
 
+
If your example contains the start message box, you can continuously poll for events. Just press the start message box to start sampling. When an event occurs on a Phidget (i.e. when a sensor detects a change in the measured data), associated data will be output with related prefixes. Press the stop message box to stop sampling.
+
 
+
For the PhidgetDigitalOutput example, there are setDutyCycle and setState message boxes. Changing the numbers will cause the digital output to change. Your example may contain device specific message boxes to click on. Click them to see what they do!
+
 
+
For information regarding calls specific to your device, please see the {{Phidget22API}} for your specific device, which can be found in its user guide.
+
 
+
=== Code Snippets ===
+
 
+
Your best resource to program code in MaxMSP will be our examples.
+
 
+
If you aren't familiar with concepts in Phidget programming, you may find our General Phidget Programming page helpful. It provides a very generic overview of what traditional languages follow when using Phidgets. For setup 'syntax', your main resource will of course be this MaxMSP page, the {{Phidget22API}}, and the examples. But for conceptual details about particular actions - opening a Phidget, for example - the General Phidget Programming page is a more in-depth resource.
+
 
+
Keep in mind when reading these general resources that the Max/MSP libraries may not implement the full {{Phidget22API}} - some function calls and Phidget classes may not be supported.
+
 
+
In general, Phidget objects can be placed inside the patcher, and functions can be called on them using appropriately connected messages. We go over a basic setup for this below.
+
 
+
==== Step One: Initialize and Open ====
+
 
+
This tutorial uses a Phidget Voltage Input, and thus the object we use will be called PhidgetVoltageInput. Initializing and opening the device is be done by placing a new object. Other objects handle different Phidgets - a Spatial, a Temperature Sensor, a Motor Controller, etc. Only the name of the object changes. You can find the name for the object in the .maxhelp file for your device. The help file will be named the same as the software object for your device. If you are not sure what the software object for your device is, find your Phidget on our [http://www.phidgets.com webpage], and then check the API documentation for it.
+
 
+
In the case of a Voltage Input, we name it PhidgetVoltageInput:
+
 
+
[[Image: MaxMSP_VoltageInput_generic.png|link=]]
+
 
+
'''Important:''' a local connection will reserve the device until closed. This prevents any other instances from retrieving data from the Phidget, including other programs. Every Phidget object in Max will automatically try to connect to and reserve a Phidget for itself. As long as a MaxMSP Phidget object is running, it will continuously try to connect to a Phidget, even trying to reconnect if it gets disconnected.
+
 
+
When the instance is created as with the Voltage Input above, normally it will make a connection to the first device of its type it can find. The Phidget object can also be declared with a serial number, among other specifiers, to open a specific Phidget instead. To view a full list of available device specifiers and what they do, see the readme.txt included with the Phidget22 Max/MSP library.
+
 
+
[[Image: MaxMSP VoltageInput specific.png|link=]]
+
 
+
=====Using a Phidget Over a Network=====
+
 
+
To use the Network Server, first the Phidget needs to be plugged in to a computer that has the Network  Server turned on within your local network. (For information on how to do this, see the Phidget Network Server page in the section on how to use the Network Server for your operating system).
+
 
+
Next, in your patch you need a PhidgetNet object. To automatically find local networks, send it a message saying enableServerDiscovery.
+
 
+
[[Image: MaxMSP Enable Server Discovery.png|link=]]
+
 
+
Then, to connect a Phidget over the network, change the object text to specify it is to connect to a Phidget on a remote server, as per the following example.
+
 
+
[[Image: MaxMSP Remote.png|link=]]
+
 
+
==== Step Two: Wait for Attachment (plugging in) of the Phidget ====
+
 
+
Although this is a required step in many of our other languages (and therefore you may be expecting this if coming from another Phidget language), in MaxMSP you do not have to add a specific waitForAttachment block.
+
 
+
Keep in mind, however, that if your Phidget is not responding within your MaxMSP program, it may simply not be plugged in! Send a getAttached message to a Phidget object at any time to see if it's attached.
+
 
+
==== Step Three: Do Things with the Phidget ====
+
 
+
There are two main approaches for retrieving data when working with Phidgets. Data is accessed either by one-time polling or at a fixed rate via on-board timers for some devices.
+
 
+
Getting or setting values directly via polling on the Phidget is done through messages linked to the inlet. The object’s inlet can be wired to send commands to the device, and the outlet used to retrieve the results. Setting values on the Phidget is achieved by using the set messages, and some properties can be read with get messages:
+
 
+
[[Image: MaxMSP_get_and_set.png|link=]]
+
 
+
To sample at a fixed rate, use the start and stop messages to start and stop the data flow, respectively.
+
 
+
[[Image: MaxMSP_Start_Stop.png|link=]]
+
 
+
Data from the outlet of a Phidget object is always given a prefix to allow for routing. For instance, the digital input state state change event data is given the prefix “stateChange”, and the voltage input voltage change event similarly use “voltageChange”. The specific prefixes used for each set of outlet data is listed under the API page for their class in the {{Phidget22API}}.
+
 
+
[[Image: MaxMSP_Routing.png|link=]]
+
 
+
The rightmost outlet on the Phidget object outputs error event data. This will send information on error events such as saturation events. To see which error events may apply to your device, check its API page in the {{Phidget22API}}.
+
 
+
[[Image: MaxMSP_Error_Event.png|link=]]
+
 
+
==== Step Four: Close and Delete ====
+
 
+
Although this is a required step in many of our other languages (and therefore you may be expecting this if coming from another Phidget language), in MaxMSP you do not have to add a specific close and delete block.
+
 
+
====Special Case: Multiple Phidgets====
+
 
+
Multiple Phidgets of the same type can easily be used inside a single program, it only requires another Phidget object placed. If two of the same type of Phidget object are placed, the serial number and channel arguments should always be specified (as well as hub port, if applicable) to ensure that the correct Phidget gets associated with the correct object.
+
 
+
== Further Reading ==
+
 
+
[[Phidget Programming Basics]] - Here you can find the basic concepts to help you get started with making your own programs that use Phidgets.
+
 
+
[[Data Interval/Change Trigger]] - Learn about these two properties that control how much data comes in from your sensors.
+
 
+
[[Using Multiple Phidgets]] - It can be difficult to figure out how to use more than one Phidget in your program. This page will guide you through the steps.
+
 
+
[[Polling vs. Events]] - Your program can gather data in either a polling-driven or event-driven manner. Learn the difference to determine which is best for your application.
+
 
+
[[Logging, Exceptions, and Errors]] - Learn about all the tools you can use to debug your program.
+
 
+
[[Phidget Network Server]] - Phidgets can be controlled and communicated with over your network- either wirelessly or over ethernet.
+
 
+
== Common Problems and Solutions/Workarounds ==
+
 
+
'''Crash: <span style="color:DarkRed">When a patch file is closed in the Max/MSP environment, the program crashes</span>'''
+
 
+
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 only 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.
+

Latest revision as of 18:03, 25 November 2019


We provide support for Max/MSP in macOS and Windows. We also provide instructions on how to get your project started. Select your operating system below, and follow the instructions to get your project running with Phidgets.

Once you have set up your development environment to run with Phidgets, we recommend you follow our guide on Phidget Programming Basics. The guide will showcase the fundamentals of programming with Phidgets.

Choose Your Development Environment:

Max/MSP Development Environments
OS - Windows Windows

MAX6.png MAX6 on.png

OS - macOS macOS

MAX6.png MAX6 on.png

Quick Downloads

If you already know what you're doing and just need the files, you can find them all below.

Documentation

Example Code

Libraries