Language - Max

Get Started

With the Phidgets Max library, it's easy to create Max patches that work with Phidget devices.

Max Libraries

To develop on Max with Phidgets, you'll need the Phidgets Max Library.

Unpack the zip file and copy the appropriate folder:

• For 32-bit Max, copy the x86 folder.
• For 64-bit Max, copy the x64 folder.

The folder you copied needs to be placed in a specific location for Max to reference it. Open Max and navigate to Options -> File Preferences.

The folder that you copied earlier needs to be placed in any of the locations listed in File Preferences. Navigate to one of the locations and paste the folder:

The Phidget Max library can now be referenced.

Development Environment Configuration

Using Our Examples

Instructions

Navigate to the examples folder located within the Phidget22MaxMSP folder you previously unpacked:
From here, select an example that will work with your Phidget and open it in Max. You can run the example by simply pressing the start button. The example is now running. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!

Writing your own Code

Instructions

You should now have working examples and a project that is configured. This teaching section will help you understand how the examples were written so you can start writing your own code. Your main reference for writing Max code will be: The Phidget22 API Manual The Max examples
First, let's explain how to operate the examples. We will take a look at the PhidgetVoltageInput example: For this particular example, the Max object is called PhidgetVoltageInput. Objects/message boxes are connected to the inputs and outputs of this object. Input objects will either cause a property of the device to change or request for a property to be retrieved. Output objects return the retrieved information. All supported functions for Max can be found in the Phidget22 API.
You can click on the getDeviceSerialNumber message box to request the Phidget to retrieve the serial number of the device.
If your example contains a get[DataType] message box (e.g. getVoltage), click on it to cause the associated data to be output with a relevant prefix.
If your example contains start and stop message boxes, you can use them to turn on continuous polling for events. For the PhidgetDigitalOutput example, there are setDutyCycle and setState message boxes that control the output.
Your best resource to program in Max will be our examples. If you aren't familiar with concepts in Phidget programming, see the Phidget Programming Basics.
Step One: Initialize and Open
Initializing and opening the device is done by placing a new object. Other objects handle different Phidgets - a Spatial, a Light Sensor, a Motor Controller, etc. Only the name of the object changes. You can find the name for the object in the device's .maxhelp file (e.g. VoltageInput.maxhelp). If you are unsure what the software object for your device is, go to the API tab on its product page on our website. In the case of a Voltage Input, we name it PhidgetVoltageInput. 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 Max Phidget object is running, it will continuously try to connect to a Phidget, even trying to reconnect if it gets disconnected.
Specifying a Phidget
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 number of specifiers to open a specific Phidget instead. Specifiers can be added to the object in the format: PhidgetExternal {Specifiers} These will be written in the form: specifier=value Available specifiers include: serialnumber - The serial number of the device channel - The channel of the device to open hubport - The hub port the device is plugged into (where applicable) ishubport - Should this channel be opened on a hub port directly, or on a connected VINT device (default) remote - Forces connection to a remote device over a network, ignoring devices on the local machine local - Forces connection to a device plugged into the local machine, ignoring network devices
Example: Opening a VoltageInput with serial number 349428.
Here are some other examples: Open a Digital Input: PhidgetDigitalInput Open channel 1 of a Digital Input Phidget connected to port 2 of a hub with serial number 35569 PhidgetDigitalInput serialnumber=35569 channel=1 hubport=2 Open open hub port 2 as a DigitalInput for a hub with serial number 35569 PhidgetDigitalInput serialnumber=35569 hubport=2 ishubport=1
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, see the Phidget Network Server page). Add a PhidgetNet object and send the message:enableServerDiscovery Then configure the object to connect to a remote server.
Step Two: Wait for Attachment
In Max you do not need a specific waitForAttachment block. However, if your Phidget is not responding, ensure it is plugged in. Send a getAttached message to check.
Step Three: Do Things with the Phidget
Getting or setting values is done through messages linked to the inlet. Use set messages to change values and get messages to read them. Use start and stop to control continuous sampling.
Phidget 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. You can set values on the Phidget by using the set messages, and some properties can be read with get messages. To sample at a fixed rate, use the start and stop messages to start and stop the data flow, respectively.
Outlet data 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 for each set of outlet data is listed on the API page for that class. 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.
Step Four: Close and Delete
In Max you do not need a specific close/delete block.
Special Case: Multiple Phidgets
Multiple Phidgets can be used in a single program by adding additional objects. If using multiple devices of the same type, specify the serial number and channel to ensure the correct device is used.

Max Example Code

• Max Examples

Phidget Programming Basics

To learn more about the structure of the example code, visit our Phidget Programming Basics guide.