Language - Max - Revision history

Mparadis: /* Writing your own Code */

2026-03-16T21:52:57Z

Writing your own Code

← Older revision		Revision as of 21:52, 16 March 2026
Line 54:		Line 54:
	\|colspan="2"\|{{hiddenh4\|Step One: Initialize and Open}}		\|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=]]		\|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'''.<br/><br/>'''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.\|\|[[File:MaxMSP_VoltageInput_generic.png\|link=]][[File:MaxMSP_GetVoltage.png\|link=]]
	\|-		\|-
	\|colspan="2"\|{{hiddenh4\|Specifying a Phidget}}		\|colspan="2"\|{{hiddenh4\|Specifying a Phidget}}
	\|-		\|-
	\|colspan="2"\|~~Specifiers~~ can be ~~added~~ to ~~the object in the format:~~		\|colspan="2"\|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.

	'''PhidgetExternal {Specifiers}'''		Specifiers can be added to the object in the format: '''PhidgetExternal {Specifiers}'''

	~~Specifiers use~~:		These will be written in the form: '''specifier=value'''

	'''specifier=value'''

	Available specifiers include:		Available specifiers include:

	* '''serialnumber'''		* '''serialnumber''' - The serial number of the device
	* '''channel'''		* '''channel''' - The channel of the device to open
	* '''hubport'''		* '''hubport''' - The hub port the device is plugged into (where applicable)
	* '''ishubport'''		* '''ishubport''' - Should this channel be opened on a hub port directly, or on a connected VINT device (default)
	* '''remote'''		* '''remote''' - Forces connection to a remote device over a network, ignoring devices on the local machine
	* '''local'''		* '''local''' - Forces connection to a device plugged into the local machine, ignoring network devices
	\|-		\|-
	\| '''Example:''' Opening a VoltageInput with serial number 349428. \|\|[[File:MaxMSP_VoltageInput_specific.png\|link=]]		\| '''Example:''' Opening a VoltageInput with serial number 349428. \|\|[[File:MaxMSP_VoltageInput_specific.png\|link=]]
			\|-
			\|colspan="2"\|Here are some other examples:
			*Open a Digital Input:
			<syntaxhighlight>PhidgetDigitalInput</syntaxhighlight>
			*Open channel 1 of a Digital Input Phidget connected to port 2 of a hub with serial number 35569
			<syntaxhighlight>PhidgetDigitalInput serialnumber=35569 channel=1 hubport=2</syntaxhighlight>
			*Open open hub port 2 as a DigitalInput for a hub with serial number 35569
			<syntaxhighlight>PhidgetDigitalInput serialnumber=35569 hubport=2 ishubport=1</syntaxhighlight>
	\|-		\|-
	\|colspan="2"\|{{hiddenh4\|Using a Phidget Over a Network}}		\|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=]]		\|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'''<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"\|{{hiddenh4\|Step Two: Wait for Attachment}}
Line 89:		Line 95:
	\|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=]]		\|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}}~~		\|colspan="2"\|Phidget data is accessed either by one-time polling or at a fixed rate via on-board timers for some devices.<br/><br/>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.<br/><br/>To sample at a fixed rate, use the start and stop messages to start and stop the data flow, respectively.
	\|-		\|-
	\|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=]]		\|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.<br/><br/>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.\|\|[[File:MaxMSP_Routing.png\|link=]][[File:MaxMSP_Error_Event.png\|link=]]
	\|-		\|-
	\|colspan="2"\|{{hiddenh4\|Step Four: Close and Delete}}		\|colspan="2"\|{{hiddenh4\|Step Four: Close and Delete}}

Mparadis: /* Writing your own Code */

2026-03-16T21:33:45Z

Writing your own Code

← Older revision		Revision as of 21:33, 16 March 2026
Line 50:		Line 50:
	\|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"\|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"\|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].
	\|-		\|-
	\|colspan="2"\|{{hiddenh4\|Step One: Initialize and Open}}		\|colspan="2"\|{{hiddenh4\|Step One: Initialize and Open}}
Line 75:		Line 75:
	* '''local'''		* '''local'''
	\|-		\|-
	\| Example: ~~open~~ a VoltageInput with serial number 349428. \|\|[[File:MaxMSP_VoltageInput_specific.png\|link=]]		\| '''Example:''' Opening a VoltageInput with serial number 349428. \|\|[[File:MaxMSP_VoltageInput_specific.png\|link=]]
	\|-		\|-
	\|colspan="2"\|{{hiddenh4\|Using a Phidget Over a Network}}		\|colspan="2"\|{{hiddenh4\|Using a Phidget Over a Network}}

Mparadis: /* Writing your own Code */

2026-03-16T21:31:17Z

Writing your own Code

← Older revision		Revision as of 21:31, 16 March 2026
Line 42:		Line 42:
	* The Max [https://www.phidgets.com/?view=code_samples&lang=MaxMSP examples]		* 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_Example2.png\|link=https://cdn.phidgets.com/docs/images/d/d9/~~MSP_Example~~.png\|350px]]		\| 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_Example2.png\|link=https://cdn.phidgets.com/docs/images/f/f9/MSP_Example2.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=]]		\|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=]]

Mparadis: /* Writing your own Code */

2026-03-16T21:30:49Z

Writing your own Code

← Older revision		Revision as of 21:30, 16 March 2026
Line 42:		Line 42:
	* The Max [https://www.phidgets.com/?view=code_samples&lang=MaxMSP examples]		* 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]]		\| 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_Example2.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=]]		\|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=]]

Mparadis: /* Using Our Examples */

2026-03-16T21:30:17Z

Using Our Examples

← Older revision		Revision as of 21:30, 16 March 2026
Line 29:		Line 29:
	\| 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]]		\| 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_run2.png\|link=https://cdn.phidgets.com/docs/images/c/c0/~~Max_run~~.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_run2.png\|link=https://cdn.phidgets.com/docs/images/f/f8/Max_run2.png\|350px]]
	\|-		\|-
	\|}		\|}

Mparadis: /* Using Our Examples */

2026-03-16T21:29:33Z

Using Our Examples

← Older revision		Revision as of 21:29, 16 March 2026
Line 29:		Line 29:
	\| 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]]		\| 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]]		\|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_run2.png\|link=https://cdn.phidgets.com/docs/images/c/c0/Max_run.png\|350px]]
	\|-		\|-
	\|}		\|}

Mparadis at 21:27, 16 March 2026

2026-03-16T21:27:41Z

← Older revision		Revision as of 21:27, 16 March 2026
Line 14:		Line 14:
	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 you copied needs to be placed in a specific location for Max to reference it. Open Max and navigate to '''Options -> File Preferences'''.

	[[Image:~~Max_filepreferences~~.png\|link=\|center]]		[[Image:Max_filepreferences2.png\|link=\|center]]

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

	[[Image:~~Max_folder~~.PNG\|link=\|center]]		[[Image:Max_folder2.PNG\|link=\|center]]

	The Phidget Max library can now be referenced.		The Phidget Max library can now be referenced.

Mparadis: /* Max Example Code */

2026-03-16T21:26:15Z

Max Example Code

← Older revision		Revision as of 21:26, 16 March 2026
Line 104:		Line 104:

	== Max Example Code ==		== Max Example Code ==
	*{{SampleCode\|MaxMSP\|Max ~~Example~~}}		*{{SampleCode\|MaxMSP\|Max Examples}}

	==Phidget Programming Basics==		==Phidget Programming Basics==
	{{PhidgetProgrammingBasicsLink}}		{{PhidgetProgrammingBasicsLink}}

Mparadis at 21:25, 16 March 2026

2026-03-16T21:25:57Z

← Older revision		Revision as of 21:25, 16 March 2026
Line 103:		Line 103:
	\|}		\|}

	=== Max Example Code ===		== Max Example Code ==
	*{{SampleCode\|MaxMSP\|Max Example}}		*{{SampleCode\|MaxMSP\|Max Example}}

	===Phidget Programming Basics===		==Phidget Programming Basics==
	{{PhidgetProgrammingBasicsLink}}		{{PhidgetProgrammingBasicsLink}}

Mparadis at 21:25, 16 March 2026

2026-03-16T21:25:31Z

← Older revision		Revision as of 21:25, 16 March 2026
Line 102:		Line 102:
	\|-		\|-
	\|}		\|}

			=== Max Example Code ===
			*{{SampleCode\|MaxMSP\|Max Example}}

			===Phidget Programming Basics===
			{{PhidgetProgrammingBasicsLink}}