Language - Max: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
Line 1: Line 1:
<metadesc>Communicate over USB with sensors, controllers and relays with Phidgets! Our Max library supports Windows and MacOS.</metadesc>
{{#seo:|description=Learn how to use Phidget USB devices with Max.}}
[[Category:Language]]
[[Category:Language]]
__NOTOC__
We provide support for Max 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.
==Get Started==
With the Phidgets Max library, it's easy to create Max patches that work with Phidget devices.


==Setup Guide==
==Max Libraries==
To develop on Max with Phidgets, you'll need the [https://www.phidgets.com/downloads/phidget22/libraries/windows/Phidget22MaxMSP.zip Phidgets Max Library].


<div class="phd-deck-sequence">
Unpack the zip file and copy the appropriate folder:
{{PT3_MAX_CHOOSE}}{{PT3_MAX_WIN}}{{PT3_MAX_MAC}}
* For 32-bit Max, copy the '''x86''' folder.
</div>
* 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'''.


== Quick Downloads ==
[[Image:Max_filepreferences.png|link=|center]]
If you already know what you're doing and just need the files, you can find them all below.


=== Documentation ===
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:


*{{Phidget22API}} (Select Max from drop-down menu)
[[Image:Max_folder.PNG|link=|center]]


=== Phidgets Max Libraries ===
The Phidget Max library can now be referenced.


* [https://cdn.phidgets.com/downloads/phidget22/libraries/windows/Phidget22MaxMSP.zip Windows Max Libraries for Phidgets]
==Development Environment Configuration==
* [https://cdn.phidgets.com/downloads/phidget22/libraries/macos/Phidget22MaxMSP.zip MacOS Max Libraries for Phidgets]
===Using Our Examples===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
|-
| Navigate to the '''examples''' folder located within the Phidget22MaxMSP folder you previously unpacked: ||[[Image:Max_examples.PNG|link=https://cdn.phidgets.com/docs/images/a/a0/Max_examples.PNG|350px]]
|-
|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.<br/><br/>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! || [[Image:Max_run.png|link=https://cdn.phidgets.com/docs/images/c/c0/Max_run.png|350px]]
|-
|}


=== Max Example Code ===
=== Writing your own Code ===


*{{SampleCode|MaxMSP|Max Example}}
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
|-
|colspan="2"| 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.<br/>Your main reference for writing Max code will be:<br/><br/>
* The [https://www.phidgets.com/?view=api Phidget22 API] Manual
* The Max [https://www.phidgets.com/?view=code_samples&lang=MaxMSP examples]
|-
| First, let's explain how to operate the examples. We will take a look at the PhidgetVoltageInput example:<br/><br/>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.<br/><br/>All supported functions for Max can be found in the [https://www.phidgets.com/?view=api Phidget22 API].||[[File:MSP_Example.png|link=https://cdn.phidgets.com/docs/images/d/d9/MSP_Example.png|350px]]
|-
|You can click on the '''getDeviceSerialNumber''' message box to request the Phidget to retrieve the serial number of the device.||[[File:MaxMSP_GetSerial.png|link=]][[File:MaxMSP_GetVoltage.png|link=]]
|-
|colspan="2"|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.
|-
|colspan="2"|If your example contains '''start''' and '''stop''' message boxes, you can use them to turn on continuous polling for events. <br/><br/>For the PhidgetDigitalOutput example, there are '''setDutyCycle''' and '''setState''' message boxes that control the output.
|-
|colspan="2"|Your best resource to program in Max will be our examples. If you aren't familiar with concepts in Phidget programming, see the [https://www.phidgets.com/docs/Phidget_Programming_Basics Phidget Programming Basics], although keep in mind that the Max libraries may not fully support all listed methods.
|-
|colspan="2"|{{hiddenh4|Step One: Initialize and Open}}
|-
|Initializing and opening the device is done by placing a new object. In the case of a Voltage Input, we name it '''PhidgetVoltageInput'''.<br/>'''Important:''' a local connection will reserve the device until closed.||[[File:MaxMSP_VoltageInput_generic.png|link=]][[File:MaxMSP_GetVoltage.png|link=]]
|-
|colspan="2"|{{hiddenh4|Specifying a Phidget}}  
|-
|colspan="2"|Specifiers can be added to the object in the format:


===Phidgets Core Libraries===
'''PhidgetExternal {Specifiers}'''


{{AllQuickDownloads}}
Specifiers use:
 
'''specifier=value'''
 
Available specifiers include:
 
* '''serialnumber'''
* '''channel'''
* '''hubport'''
* '''ishubport'''
* '''remote'''
* '''local'''
|-
| Example: open a VoltageInput with serial number 349428. ||[[File:MaxMSP_VoltageInput_specific.png|link=]]
|-
|colspan="2"|{{hiddenh4|Using a Phidget Over a Network}}
|-
|Add a '''PhidgetNet''' object and send the message:'''enableServerDiscovery'''<br/>Then configure the object to connect to a remote server.||[[File:MaxMSP_Enable_Server_Discovery.png|link=]][[File:MaxMSP_Remote.png|link=]]
|-
|colspan="2"|{{hiddenh4|Step Two: Wait for Attachment}}
|-
|colspan="2"|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.
|-
|colspan="2"|{{hiddenh4|Step Three: Do Things with the Phidget}}
|-
|Getting or setting values is done through messages linked to the inlet.<br/>Use '''set''' messages to change values and '''get''' messages to read them.</br>Use '''start''' and '''stop''' to control continuous sampling.||[[File:MaxMSP_get_and_set.png|link=]][[File:MaxMSP_Start_Stop.png|link=]]
|-
|colspan="2"|{{hiddenh4|Step Three: Do Things with the Phidget}}
|-
|Outlet data is given a prefix for routing<br/>(e.g. '''stateChange''', '''voltageChange'''). <br/>The rightmost outlet outputs error event data. ||[[File:MaxMSP_Routing.png|link=]][[File:MaxMSP_Error_Event.png|link=]]
|-
|colspan="2"|{{hiddenh4|Step Four: Close and Delete}}
|-
|colspan="2"|In Max you do not need a specific close/delete block.
|-
|colspan="2"|{{hiddenh4|Special Case: Multiple Phidgets}}
|-
|colspan="2"|Multiple Phidgets can be used in a single program by adding additional objects.<br/>If using multiple devices of the same type, specify the '''serial number''' and '''channel''' to ensure the correct device is used.
|-
|}

Revision as of 21:20, 16 March 2026


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.

Max filepreferences.png

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:

Max folder.PNG

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: Max examples.PNG
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!		 Max run.png

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:

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.		 MSP Example.png
You can click on the getDeviceSerialNumber message box to request the Phidget to retrieve the serial number of the device. MaxMSP GetSerial.pngMaxMSP GetVoltage.png
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, although keep in mind that the Max libraries may not fully support all listed methods.
Step One: Initialize and Open
Initializing and opening the device is done by placing a new object. In the case of a Voltage Input, we name it PhidgetVoltageInput.
Important: a local connection will reserve the device until closed.		 MaxMSP VoltageInput generic.pngMaxMSP GetVoltage.png
Specifying a Phidget
Specifiers can be added to the object in the format:

PhidgetExternal {Specifiers}

Specifiers use:

specifier=value

Available specifiers include:

  • serialnumber
  • channel
  • hubport
  • ishubport
  • remote
  • local
Example: open a VoltageInput with serial number 349428. MaxMSP VoltageInput specific.png
Using a Phidget Over a Network
Add a PhidgetNet object and send the message:enableServerDiscovery
Then configure the object to connect to a remote server.		 MaxMSP Enable Server Discovery.pngMaxMSP Remote.png
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.		 MaxMSP get and set.pngMaxMSP Start Stop.png
Step Three: Do Things with the Phidget
Outlet data is given a prefix for routing
(e.g. stateChange, voltageChange).
The rightmost outlet outputs error event data.		 MaxMSP Routing.pngMaxMSP Error Event.png
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.
Retrieved from "https://www.phidgets.com/docs/index.php?title=Language_-_Max&oldid=35492"