Language - Max/MSP

Max/MSP, developed by Cycling74 is a visual programming language for creating music and media applications.

Introduction

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.

Max/MSP is capable of using the complete Phidget API, including events. We also provide example code in Max/MSP for all Phidget devices.

Max/MSP can be developed with Windows and Mac OS X..{{{5}}}

You can compare Max/MSP with our other supported languages.

Only Max/MSP 4.5 or higher is supported.

Quick Downloads

Just need the Max/MSP drivers, libraries, and examples? Here they are:

API Documentation:
Should we include the next 2 links?

• General API (more help on functions common to all Phidgets)
• Device Specific APIs (more help on functions specific to your Phidget)

Max/MSP Library and Example Code:

• Windows
• Mac OS X

Libraries and Drivers:

• 32 bit Windows (drivers, with libraries)
• 64 bit Windows (drivers, with libraries)
• General Linux Libraries ( Linux Library Setup Instructions)
• General Mac OSX Libraries ( Mac OS X Library Setup Instructions)

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:

• Make sure your libraries are properly linked
• Go from source code to a test application as quickly as possible
• Ensure your Phidget is hooked up properly

Instructions are divided up by operating system. Choose:

• Windows 2000 / XP / Vista / 7
• Mac OS X

Windows(2000/XP/Vista/7)

Libraries

• Windows Library and Examples
• Mac OS X Library and Examples

Description

Max/MSP programs on Windows depend on the following files, which the installers above put onto your system:

• phidget21.dll contains the actual Phidgets library, which is used at run-time. If you used our installer, it's already correctly placed in C:\Windows\System32. It can be manually installed - check our Manual Installation instructions.

You will also need one of the following two files, depending on the .NET framework version you are targeting:

• Phidget<Device Name>.mxe is the Phidgets library for your specific device. Please make sure the .mxe file corresponds with the device you are using. For example, if you are using the PhidgetInterfaceKit, you will need the PhidgetInterfaceKit.mxe It is to be placed in the same directory as your .help file

Use Our Examples

Please start by downloading the Max/MSP Examples. These examples were written in Visual Studio 2005 and 2008, but Visual Studio 2010 will easily upgrade them.

• Max/MSP Examples

To run the examples, you first download them from above and unpack them into a folder. Here, you will find example programs, in .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 Getting Started guide for your device.

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

The above screenshot is for the PhidgetInterfaceKit. Now, it is time to explain how to operate the Phidget. If you are using a different device, your example program will be different, but the idea is the same.

The Max object is called PhidgetInterfaceKit, which is found in the center of the screen. Other objects are connected to the inputs and outputs of the PhidgetInterfaceKit object. The input objects will either cause 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 .help file.

Try it for yourself! Click on the getSerial message box to send a message to the PhidgetInterfaceKit object. You should see the last output object of route changed to the serial number of your device. All devices support the getSerial object, and is the easiest way to determine if your device is hooked up and the Phidget libraries correctly installed onto your computer.

If your example contains the read object, click on it. This will return all the device specific values to the screen.

If your example contains the start object, you can also continuously poll for events. Set the sample rate input for the setSampleRate object. Then, press the start object. Upon events triggering, certain values will be continuously returned to the screen. Press the stop object to stop the sampling.

For the PhidgetInterfaceKit example, there is also a setoutput object. Clicking on the check boxes will cause the digital outputs of the PhidgetInterfaceKit device to change. Your example may contain device specific objects to click on. See for yourself what they do!

Once you have the Max/MSP examples running, we have a teaching section below to help you follow them.

If you want to register the .help files into the Max/MSP environment so that the .help file opens up if you alt + click on the Phidget object, please follow these steps:

• Navigate to the <Max/MSP install directory>\max-help folder in Windows Explorer.
• Place all the Phidget .help files in this folder.
• In the Max/MSP environment, create a new patcher. Create a new object box named Phidgetxxx where xxx is the name of your device.
• Alt click on the object, and the .help file will appear.

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 your compiler / development environment to properly link the Phidget LiveCode libraries. To begin:

In addition to placing the .mxe file in the same directory as the patcher, you can also place the .mxe anywhere in the Max/MSP class path. You can verify the class paths by navigating to Options | File Preferences.

• Generate a new Visual C# Windows Applications project with a descriptive name such as PhidgetTest.

• Add a reference to the .NET Phidgets library.

• Under the .NET tab, select Phidget21.NET.dll.

If you used our installer, these files are installed in C:\Program Files\Phidgets, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.

Then, in your code, you will need to include the Phidget library:

  using Phidgets;
  using Phidgets.Events;

The project now has access to the Phidget21 function calls and you are ready to begin coding.

The same teaching section which describes the examples also has further resources for programming your Phidget.

Mac OS X

Max/MSP has excellent support on Mac OS X.

The first step in using C# on Mac is to install the Phidget libraries. Compile and install them as explained on the getting started guide for your device. Then, the OS - Mac OS X page also describes the different Phidget files, their installed locations, and their roles....

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

Next, comes our API information. These resources outline the Max/MSP Phidget functions:

• C# API (This is the complete set of functions you have available for all Phidgets)
• Device Specific APIs - The one for your Phidget can be found in its user guide.

To learn the details behind opening, configuring, using, and closing your Phidget, try the General Phidget Programming page. That page also describes using the Phidget in an event-driven manner and in a traditional manner, both of which are available in Max/MSP.

Example Flow

The Hello World example has this general structure so you can follow along. We also have an in-depth general introduction to writing Phidget code (like open, read data, etc), as well as the C# API for specific syntax:

// ----- Event and Other Functions ----- Create any Language-Specific Functions (exception handling) Create General Attach, Detach, and Error Handling Functions: On attach: Print Hello Message On detach: Print Goodbye Message		In C#, you can name these event functions whatever you like. You will then pass them as function pointers to the Phidget library below in the Main Code section. This hooks them into the actual events when they occur. In the example code, the event functions common to all Phidgets are called things like AttachHandler() and DetachHandler(), etc. Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit. Other functions are given in the examples to show you more detail on using your Phidget. For example, DeviceInitialize() will show what needs to be set up for your Phidget before using it.
// ----- Main Code ----- Create Manager Software Object Hook Event Functions created above to Device Open Device Wait for 'Enter' key character input Handle on-going attach and detach events Print Hello and Goodbye messages Exit upon input Close Device Delete Device		Creating a Phidget software object in C# is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a Spatial object. The examples show how to do this and other API functions. The object provides device specific methods and properties which are available from the API for your specific Phidget.

Common Problems and Solutions/Workarounds

Here you can put various frequent problems and our recommended solutions.