2012-04-02T21:06:10Z

192.168.2.198: /* Description of Library files */

2012-01-30T22:06:26Z

192.168.2.198: /* Quick Downloads */

[[File:icon-C++.png|64x64px]] C++ is a general purpose, cross-platform programming language with a vast user base.

__TOC__

==Introduction==

{{LanguageSupport|C/C++|the complete Phidget API, including events|all Phidget devices.|various Windows compilers (including Borland, Cygwin, and MinGW), Mac OS X, and Linux}}

==Quick Downloads==

Just need the C/C++ drivers, libraries, and examples? Here they are:

===C/C++ API Documentation:===
*[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Manual Download] or [http://www.phidgets.com/documentation/web/cdoc/index.html (HTML online version)]
*[[General API]] (more help on functions common to all Phidgets)
*[[Device List | Device Specific APIs]] (more help on functions specific to your Phidget)

===C/C++ Example Code:===
*[http://www.phidgets.com/downloads/examples/VCpp_2.1.8.20110615.zip Visual Studio for C/C++ Example Code:] Written in Visual Studio 2005, and Visual Studio 2008/2010 will easily upgrade them.
*[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20110615.tar.gz Generic C/C++ Example Code:] For Mac OS X, Linux, and other IDEs(i.e., Visual Studio 6 and 2003)

===Libraries and Drivers:===
*[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip 32 bit Windows (drivers, with libraries)]
*[http://www.phidgets.com/downloads/libraries/phidget21-x64_2.1.8.20110615.zip 64 bit Windows (drivers, with libraries)]
*[http://www.phidgets.com/downloads/libraries/phidget21bcc_2.1.8.20110615.zip Borland C++ Libraries] (You also need one of the two Windows drivers [[#Libraries_and_Drivers:|above]])
*[http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20111028.tar.gz General Linux Libraries] ([[OS - Linux | Linux Library Setup Instructions]])
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20111103.dmg General Mac OSX Libraries] ([[OS - Mac OS X | Mac OS X Library Setup Instructions]])

==Getting started with C/C++==

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(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#Mac OS X |Mac OS X]]
*[[#Linux | Linux]] (including PhidgetSBC)

==Windows(2000/XP/Vista/7)==

===Description===
C/C++ programs on Windows depend on three files, which the installers [[#Libraries_and_Drivers:|above]] put onto your system:
* <b><code>phidget21.dll</code></b> contains the actual Phidgets library, which is used at run-time. If you used our installer, it's already correctly placed in <code>C:\Windows\System32</code>. It can be manually installed - check our [[Manual Installation instructions]].
* <b><code>phidget21.lib</code></b> is used by your compiler to link to the dll. Your compiler has to know where this file is. Our installer puts <code>phidget21.lib</code> into <code>C:\Program Files\Phidgets</code>, so you can either point your compiler to that location, or copy and link to it in a directory for your project workspace. <code>phidget21.lib</code> is written to be compatible with most compilers - but your specific compiler may need a different format. Check our documentation for your specific compiler below for details. Please note that for 64 bit versions of Windows, we provide a version of the <code>phidget21.lib</code> that is specifically optimized for 64 bit systems. The 32 bit version of <code>phidget21.lib</code> will also work for 64 bit systems. If you used our 64 bit installer, the 64 bit version of <code>phidget21.lib</code> is placed in <code>C:\Program Files\Phidgets</code>; The 32 bit version of <code>phidget21.lib</code> is placed in <code>C:\Program Files\Phidgets\x86</code>. If you do not want to use our installer, you can get the file [[#Libraries | here]].
* <b><code>phidget21.h</code></b> lists all the Phidget API function calls available to your code. Your compiler also has to know where this file is. By default, our installer puts <code>phidget21.h</code> into <code>C:\Program Files\Phidgets</code> so you can either point your compiler to that location, or copy and link to it in a directory for your project workspace. If you do not want to use our installer, you can get the file [[#Libraries | here]].

Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.

===Visual Studio===

'''Note:''' C++/CLI (which used to be called Managed C++) is very different from mainstream C/C++. If you must use C++/CLI, consider calling the .NET library, instead of the C API normally used from C/C++. We have no documentation for using C++/CLI.

Microsoft makes free versions of Visual Studio available known as Express Editions. The Express editions are suitable for most applications, but are limited in features for more complex applications. Please see [http://www.microsoft.com/visualstudio Microsoft Visual Studio] for more information.

====Visual Studio 2005/2008/2010====

=====Use Our Examples=====

To run the examples, you first [http://www.phidgets.com/downloads/examples/VCpp_2.1.8.20110615.zip download] them and unpack them into a folder. To load all projects in Visual Studio, go to File → Open → Project → Solution, and open <code>Visual Studio Phidgets Examples.sln</code> in the VCpp folder of the examples.

If you are opening the Phidget examples in Visual Studio 2008/2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 project.
<br/><br/>[[File:VS2005 Conversion Wizard.PNG]]<br/><br/>

This will load all of the examples available for C/C++, and then you can set your main project to be the one that matches your device. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]].

The only thing left to do is to run the examples! Click on Debug → Start Debugging. Please note that the projects, by default try to find the <code>phidget21.h</code> and <code>phidget21.lib</code> in the <code>$(SystemDrive)\Program Files\Phidgets</code>. If you have these files installed in another location, please change the path accordingly. Please see the [[#Write Your Own Code | Write Your Own Code section]] for details.
<br/><br/>
[[File:VS2005 Run.PNG]]
<br/><br/>
Once you have the C/C++ examples running, we have a [[#Follow 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 your compiler / development environment to properly link the Phidget C/C++ libraries. To begin:

* Generate a new Visual C++: Win32 Console Application project with a descriptive name such as PhidgetTest.
<br/>[[File:VS2005 New Project.PNG]]
<br/><br/>Next, select Console Application<br/><br/>
[[File:VS2005 New Project 2.PNG]]
<br/><br/>

* Open the project properties window.
* Navigate to Configuration Properties → C/C++.
* Add <code>"C:\Program Files\Phidgets"</code> to the additional directories field. This step will find the <code>phidget21.h</code> file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.
<br/>[[File:VS2005 Header.PNG]]
<br/><br/>
* Navigate to Configuration Properties → Linker → Input.
* Edit the additional dependencies and add <code>"C:\Program Files\Phidgets\phidget21.lib"</code>. This step will find the <code>phidget21.lib</code> file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.
<br/>[[File:VS2005 Library.PNG]]
<br/><br/>
The project now has access to the Phidget21 function calls and you are ready to begin coding.

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

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=cpp>

#include <phidget21.h>

</source>
</font>
</div>

The same [[#Follow The Examples|teaching section]] which describes the examples also has further resources for programming your Phidget.

====Visual Studio 2003====

Start by downloading the Generic C/C++ Examples. You can import these examples into a Visual Studio 2003 C++ project.
*[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz Generic C/C++ Examples]

=====Use Our Examples=====
<br/>
[[#Visual Studio 2003|Download]] the examples and unpack them into a folder. Here, you can find example programs 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 [[Device List | Getting Started guide for your device]]. You will need this example source code to be copied into your C++ project later on.

Next, a new project will need to be created.
* Generate a new Visual C++ empty project(.NET) with a descriptive name such as PhidgetTest.
<br/>[[File:VS2003 New Project.PNG]]<br/><br/>

To import the example program into your project, please:
* Create a new C++ file by adding a new item to the source files folder.
<br/>[[File:VS2003 New File.PNG]]<br/>
<br/>[[File:VS2003 New File 2.PNG]]<br/><br/>
* An empty C++ file will pop up. Please copy and paste the contents of the example program into here.
<br/>[[File:VS2003 Source.PNG]]<br/><br/>

Next, the project setting needs to be set up.
* Open the project properties window.
* Navigate to Configuration Properties → C/C++.
* Add <code>"C:\Program Files\Phidgets"</code> to the additional include directories field. This step will find the <code>phidget21.h</code> file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.
<br/>[[File:VS2003 Header.PNG]]<br/><br/>
* Navigate to Configuration Properties → Linker → Input.
* Add <code>"C:\Program Files\Phidgets\phidget21.lib"</code> to the additional dependencies field. This step will find the <code>phidget21.lib</code> file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.
<br/>[[File:VS2003 Library.PNG]]<br/><br/>
The project now has access to the Phidget21 function calls and you are ready to begin coding.

Now, you can run the example. Click on Debug → Start Without Debugging.
<br/><br/>[[File:VS2003 Run.PNG]]<br/><br/>

Once you have the C/C++ examples running, we have a [[#Follow 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 your compiler / development environment to properly link the Phidget C/C++ libraries. Please see the [[#Use Our Examples 2 | Use Our Examples section]] for instructions.

====Visual Studio C++ 6.0====

=====Use Our Examples=====
<br/>
[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20110615.tar.gz Download] the generic examples and unpack them into a folder. Here, you can find example programs 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 [[Device List | Getting Started guide for your device]]. You will need this example source code to be copied into your C++ project later on.

Next, a new project will need to be created.
* Generate a new Win32 Console Application project with a descriptive name such as PhidgetTest.
<br/>[[File:VS6 New Project.PNG]]<br/><br/>
* Create an empty project.
<br/>[[File:VS6 New Project 2.PNG]]<br/><br/>

Next, the project settings needs to be set up.
* Navigate to Project → Settings → C/C++ → Preprocessor.
* Add <code>C:\Program Files\Phidgets</code> to the additional include directories field. This step will find the <code>phidget21.h</code> file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.
<br/>[[File:VS6 Header.PNG]]<br/><br/>
* Navigate to Project → Settings → Link → Input → Additional library Path.
* Add <code>phidget21.lib</code> to the object/library modules field.
* Add <code>C:\Program Files\Phidgets</code> to the additional library path. This step will find the <code>phidget21.lib</code> file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.
<br/>[[File:VS6 Library.PNG]]<br/><br/>
The project now has access to the Phidget21 function calls and you are ready to begin coding.

To import the example program into your project, please:
* Create a new C++ file by navigating to File → New → Files → C++ Source File and enter a descriptive name such as Example
<br/>[[File:VS6 New File.PNG]]<br/><br/>
* An empty C++ file will pop up. Please copy and paste the contents of the example program here.
<br/>[[File:VS6 Source.PNG]]<br/><br/>
Now, you can run the example. Click on Build → Execute.
<br/><br/>[[File:VS6 Run.PNG]]<br/><br/>

Once you have the C/C++ examples running, we have a [[#Follow 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 your compiler / development environment to properly link the Phidget C/C++ libraries. Please see the [[#Use Our Examples 3 | Use Our Examples section]] for instructions.

In your '''<code>.c</code>''' source code file, you must include a reference to the library header:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=cpp>

#include <phidget21.h>

</source>
</font>
</div>

Then, you would compile your completed C/C++ code the same way as shown in the [[#Use Our Examples 3 | Use Our Examples section]].

To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Follow The Examples|teaching section]] to help you follow the provided C/C++ examples and which has resources such as the API reference.

===Borland===

====Use Our Examples====

In addition to running one of the two [[#Windows | Windows Installers above]] (which you probably already have if you worked through the ''Getting Started'' page [[Device List | for your device]]), you will need the [http://www.phidgets.com/downloads/libraries/phidget21bcc_2.1.8.20110615.zip Borland C++ Libraries]. <code>phidget21bcc.lib</code> is typically placed in <code>C:\Program Files\Phidgets</code>, but you are free to place it in any directory you wish.

After installing the Phidget libraries, you're ready to [http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz download] and run the examples:<br/>

To run the example code, you'll need to download and unpack the examples, and then find the source code ''for your specific device''. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. Then, compile the code and run it. When compiling, you need to link to the Phidget21 library.
To compile, link the Phidget libraries and build a binary executable, enter the following in a command line prompt in the directory with <code>example.c</code>:
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=bash>
bcc32 -eexample -I"C:\Program Files\Phidgets" -L"C:\Program Files\Phidgets" phidget21bcc.lib example.c
</source>
</font>
</div>
In this case, <code>example.c</code> would be the '''.c''' file specific to your device. After using <code>bcc32</code>, you will have an executable named <code>example</code> that you can run.
It is assumed that <code>phidget21bcc.lib</code> and <code>phidget21.h</code> are placed in <code>C:\Program Files\Phidgets</code>. If the files are placed in another location, please adjust the paths accordingly.

====Write Your Own Code====

When writing your code from scratch, you start it as you would any C/C++ code with Borland. In your '''<code>.c</code>''' source code file, you must include a reference to the library header:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=cpp>

#include <phidget21.h>

</source>
</font>
</div>

Then, you would compile your completed C/C++ code the same way as the examples [[#Use Our Examples 4 |above]].

To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Follow The Examples|teaching section]] to help you follow the provided C/C++ examples and which has resources such as the API reference.

===GCC on Windows===

When you use gcc on Windows, you will use the general C/C++ examples:

*[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz Generic C/C++ Examples]

====Cygwin/MinGW====

=====Use Our Examples=====

[[#GCC on Windows|Download]] the examples and unpack them into a folder. <br/>

To run the example code, you'll need to download and unpack the examples, and then find the source code ''for your specific device''. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. Then, compile the code and run it. When compiling, you need to link to the phidget21 library.
To compile, link the Phidget libraries and build a binary executable, enter the following in a command line prompt in the directory with <code>example.c</code>:
<br/><b>Cygwin</b><br/>
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=bash>
gcc example.c -o example -I"/cygdrive/c/Program Files/Phidgets" -L"/cygdrive/c/Program Files/Phidgets" -lphidget21
</source>
</font>
</div>

<b>MinGW</b><br/>
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=bash>
gcc example.c -o example -I"C:\Program Files\Phidgets" -L"C:\Program Files\Phidgets" -lphidget21
</source>
</font>
</div>

In this case, <code>example.c</code> would be the '''.c''' file specific to your device. After using gcc, you will have an executable named <code>example</code> that you can run.
It is assumed that <code>phidget21.h</code> and <code>phidget21.lib</code> are placed in <code>C:\Program Files\Phidgets</code>. If the files are placed in another location, please adjust the paths accordingly.

=====Write Your Own Code=====

When writing your code from scratch, you start it as you would any C/C++ code with Cygwin/MinGW in your favourite text editor. In your '''<code>.c</code>''' source code file, you must include a reference to the library header:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=cpp>

#include <phidget21.h>

</source>
</font>
</div>

Then, you would compile your completed C/C++ code the same way as shown in the [[#Use Our Examples 5| Use Our Examples section]] above.

To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Follow The Examples|teaching section]] to help you follow the provided C/C++ examples and which has resources such as the API reference.

===Dev C++===

Start by downloading the Generic C/C++ Examples. You can import these examples into a Dev C++ project.
*[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz Generic C/C++ Examples]

=====Use Our Examples=====

[[#Dev C++|Download]] the examples and unpack them into a folder. Here, you can find example programs 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 [[Device List | Getting Started guide for your device]]. You will need this example source code to be copied into your Dev C++ project later on.
<br/>

In order to control Phidgets with Dev C++, the <code>phidget21.lib</code> file will need to be converted to a format that Dev C++ accepts, as described in the following steps:
* [http://www.phidgets.com Download the reimp tool]
* Open up command line and traverse to the directory containing the reimp tool. Type the following command to create <code>libphidget21.a</code>
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=bash>
reimp.exe "C:\Program Files\Phidgets\phidget21.lib"
</source>
</font>
</div>
The command above assumes that the <code>phidget21.lib</code> is in the corresponding directory. If the file is placed in another location, please adjust the path accordingly. Please note that the 64 bit version of <code>phidget21.lib</code> is not supported on Dev C/C++. Please use the 32 bit version of <code>phidget21.lib</code>.
* Place <code>libphidget21.a</code> in <code><Dev-Cpp Install Directory>/lib</code>.

Next, a new project will need to be created. The following steps are written under Dev-C++ 4.9.9.2.
* Generate a new console application with a descriptive name such as PhidgetTest. Please select C as the project type.
<br/>[[File:DevC New Project.PNG]]<br/><br/>

Next, the project settings needs to be set up.
* Navigate to Project Options → Directories → Include Directories.
* Add a new path to <code>C:\Program Files\Phidgets</code>. This step will find the <code>phidget21.h</code> file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.
<br/>[[File:DevC Header.PNG]]<br/><br/>
* Navigate to Project Options → Parameters → Linker.
* Add <code>-lphidget21</code> to the field. This step will find the <code>libphidget21.a</code> file in <code><Dev-Cpp Install Directory>/lib</code>.
<br/>[[File:DevC Library.PNG]]<br/><br/>
The project now has access to the Phidget21 function calls and you are ready to begin coding.

To import the example program into your project, please:
* Open up <code>main.c</code> in the editor.
* An empty C file will pop up. Please copy and paste the contents of the example program here.
<br/>[[File:DevC Source.PNG]]<br/><br/>
Now, you can run the example. Click on Execute → Compile & Run.
<br/><br/>[[File:DevC Run.PNG]]<br/><br/>

Once you have the C/C++ examples running, we have a [[#Follow 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 your compiler / development environment to properly link the Phidget C/C++ libraries. Please see the [[#Use Our Examples 5 | Use Our Examples section]] for instructions.

In your '''<code>.c</code>''' source code file, you must include a reference to the library header:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=cpp>

#include <phidget21.h>

</source>
</font>
</div>

Then, you would compile your completed C/C++ code the same way as the examples above.

To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Follow The Examples|teaching section]] to help you follow the provided C/C++ examples and which has resources such as the API reference.

==Mac OS X==

C/C++ has excellent support on Mac OS X through the gcc compiler.

The first step in using C/C++ on Mac is to install the Phidget libraries. Compile and install them as explained on the [[Device List|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.

{{ContentNeeded|The information we say that we say on the OS - Mac OS X page (i.e. the different files, locations, and roles) should actually be added there}}

===Use Our Examples===

After installing the Phidget libraries for Linux as above, you're ready to run the examples:
*[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz Generic C/C++ Examples]

To run the example code, you'll need to find the source code ''for your specific device''. Then, compile the code under your platform and run it.

The examples assume that the compiled libraries have been set up properly. To set them up on Mac OS X, follow the ''Getting Started'' page for [[Device List | your specific device]]

To compile, link the Phidget libraries, and build an executable binary on Mac OS X, do (for example, depending on the Headers location):

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=bash>
gcc example.c -o example -framework Phidget21 -I/Library/Frameworks/Phidget21.framework/Headers
</source>
</font>
</div>

After using gcc, you will have an executable named <code>example</code> that you can run.

===Write Your Own Code===

When writing your code from scratch, you must include a reference to the library header:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=cpp>

#include <phidget21.h>

</source>
</font>
</div>

Then, you would compile your completed C/C++ code the same way as shown in the [[#Use Our Examples 7|Use Our Example section]] above.

To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Follow The Examples|teaching section]] to help you follow the provided C/C++ examples. Even more help and references are provided from there.

==Linux==

C/C++ has support on Linux through the gcc compiler.

The first step in using C/C++ on Linux is to install the Phidget libraries. Compile and install them as explained on the main [[OS - Linux | Linux page]]. That Linux page also describes the different Phidget files, their installed locations, and their roles.

===Use Our Examples===

After installing the Phidget libraries for Linux as above, you're ready to download and run the examples:
*[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz Generic C/C++ Examples]

To run the example code, you'll need to download and unpack the examples, and then find the source code for your device. 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, it can be found in the Software/API section on the [[#Device List|product page for your device]]. Then, compile the code under your platform and run it. When compiling, you need to link to the phidget21 library.

To compile, link the Phidget libraries and build a binary executable on Linux, do the following in a terminal in the directory with <code>example.c</code>:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=bash>
gcc example.c -o example -lphidget21
</source>
</font>
</div>

In this case, <code>example.c</code> would be the '''.c''' file specific to your device. After using gcc, you will have an executable named <code>example</code> that you can run.

On Linux, if you have not set up [[OS - Linux | your udev rules for USB access]], you will need to run the program '''as root''':

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=bash>

sudo ./example

</source>
</font>
</div>

===Write Your Own Code===

When writing your code from scratch, you start it as you would any C/C++ code on Linux, such as within a text editor like Emacs, Vi, Gedit, or Kate. In your '''<code>.c</code>''' source code file, you must include a reference to the library header:

<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<source lang=cpp>

#include <phidget21.h>

</source>
</font>
</div>

Then, you would compile your completed C/C++ code the same way as the examples above.

To learn how to write your own code for your Phidget, and to learn more about our API, we have a [[#Follow The Examples|teaching section]] to help you follow the provided C/C++ examples and which has resources such as the API reference.

==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 C/C++ API information, with syntax for all of our functions:

{{UsingAPhidgetInCodeGeneral|both of which are available in C/C++|[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API]}}

===Example Flow===

{{ExamplePseudocode|In C/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. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
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.
|Creating a Phidget software object in C is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating an object with the <code>CPhidgetSpatialHandle</code> type, and then initializing it using the <code>CPhidgetSpatial_create</code> function. The examples show how to do this and other API functions.<br><br>
Other C calls follow a similar syntax - <code>CPhidgetXXX_function</code>, where XXX is the name of your device, and function is an action available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API]}}

==Common Problems and Solutions/Workarounds==

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

Language - Max

2012-01-25T22:41:59Z

192.168.2.198: /* Use Our Examples */

[[File:icon-MaxMSP.png|64x64px]] Max/MSP, developed by [http://cycling74.com Cycling74] is a visual programming language for creating music and media applications.

__TOC__

==Introduction==

{{LanguageSupport|Max/MSP|the complete Phidget API, including events|all Phidget devices.| Windows and Mac OS X.}}

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 List | Device Specific APIs]] (more help on functions specific to your Phidget)

Max/MSP Library and Example Code:

*[http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip Windows]
*[http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip Mac OS X]

Libraries and Drivers:
*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20111220.exe 32 bit Windows (drivers, with libraries)]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20111220.exe 64 bit Windows (drivers, with libraries)]
*[http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20111028.tar.gz General Linux Libraries] ([[OS - Linux | Linux Library Setup Instructions]])
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20111103.dmg General Mac OSX Libraries] ([[OS - Mac OS X | 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:
{{ExampleCodeReasons}}

Instructions are divided up by operating system. Choose:
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#Mac OS X |Mac OS X]]

==Windows(2000/XP/Vista/7)==

===Libraries===
*[http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip Windows Library and Examples]
*[http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip 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:
* <b><code>phidget21.dll</code></b> contains the actual Phidgets library, which is used at run-time. If you used our installer, it's already correctly placed in <code>C:\Windows\System32</code>. 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:
* <b><code>PhidgetXXX.mxo</code></b> is the Phidgets library for your specific device. XXX denotes the name of your device, Please make sure the <code>.mxe</code> file corresponds with the device you are using. For example, if you are using the PhidgetInterfaceKit, you will need the {{Code|PhidgetInterfaceKit.mxe}} It is to be placed in the same directory as your {{Code|.help}} file or anywhere in the Max/MSP class path.

===Use Our Examples===

Please start by downloading the Max/MSP Examples. These examples were written in Max/MSP 4.6, but are also supported on other versions.
*[http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip Max/MSP Examples]

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

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

[[File:MaxMSP Example.PNG ‎]]

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

The Max object is called PhidgetInterfaceKit, which can be seen 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 {{Code|.help}} file.

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

[[File:MaxMSP getSerial.PNG]]

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

[[File:MaxMSP read.PNG]]

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

For the PhidgetInterfaceKit example, there is also a {{Code|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 [[#Follow 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 LiveCode libraries. To begin:

In addition to placing the {{Code|.mxe}} file in the same directory as the patcher, you can also place the {{Code|.mxe}} anywhere in the Max/MSP class path. You can verify the class paths by navigating to Options | File Preferences.
<br/>[[File:MaxMSP Path.PNG]]

The best way to start writing your patch is to modify the examples, and saving as a {{Code|.pat}} file.

However, if you wish to start a new patch. All you need to do is create an object named PhidgetXXX where XXX is the name of your device. For example, the [[Product - 1023 1 - PhidgetRFID | PhidgetRFID device]] will have the {{Code|PhidgetRFID}} object name.
The project now has access to the Phidget21 function calls and you are ready to begin coding.

The same [[#Follow The Examples|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 [[Device List|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:

{{UsingAPhidgetInCodeGeneral|both of which are available in Max/MSP|[http://www.phidgets.com/documentation/Phidget21.NET.zip C# API]}}

===Example Flow===

{{ExamplePseudocode|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. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
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.
|Creating a Phidget software object in C# is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a <code>Spatial</code> object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip C# API]}}

==Code Snippets==

==Common Problems and Solutions/Workarounds==

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

Language - Max

2012-01-25T22:40:02Z

192.168.2.198: /* Use Our Examples */

[[File:icon-MaxMSP.png|64x64px]] Max/MSP, developed by [http://cycling74.com Cycling74] is a visual programming language for creating music and media applications.

__TOC__

==Introduction==

{{LanguageSupport|Max/MSP|the complete Phidget API, including events|all Phidget devices.| Windows and Mac OS X.}}

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 List | Device Specific APIs]] (more help on functions specific to your Phidget)

Max/MSP Library and Example Code:

*[http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip Windows]
*[http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip Mac OS X]

Libraries and Drivers:
*[http://www.phidgets.com/downloads/libraries/Phidget-x86_2.1.8.20111220.exe 32 bit Windows (drivers, with libraries)]
*[http://www.phidgets.com/downloads/libraries/Phidget-x64_2.1.8.20111220.exe 64 bit Windows (drivers, with libraries)]
*[http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20111028.tar.gz General Linux Libraries] ([[OS - Linux | Linux Library Setup Instructions]])
*[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20111103.dmg General Mac OSX Libraries] ([[OS - Mac OS X | 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:
{{ExampleCodeReasons}}

Instructions are divided up by operating system. Choose:
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#Mac OS X |Mac OS X]]

==Windows(2000/XP/Vista/7)==

===Libraries===
*[http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip Windows Library and Examples]
*[http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip 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:
* <b><code>phidget21.dll</code></b> contains the actual Phidgets library, which is used at run-time. If you used our installer, it's already correctly placed in <code>C:\Windows\System32</code>. 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:
* <b><code>PhidgetXXX.mxo</code></b> is the Phidgets library for your specific device. XXX denotes the name of your device, Please make sure the <code>.mxe</code> file corresponds with the device you are using. For example, if you are using the PhidgetInterfaceKit, you will need the {{Code|PhidgetInterfaceKit.mxe}} It is to be placed in the same directory as your {{Code|.help}} file or anywhere in the Max/MSP class path.

===Use Our Examples===

Please start by downloading the Max/MSP Examples. These examples were written in Max/MSP 4.6, but are also supported on other versions.
*[http://www.phidgets.com/downloads/examples/WinMaxMSP_2.1.8.20120123.zip Max/MSP Examples]

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

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

[[File:MaxMSP Example.PNG ‎]]

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

The Max object is called PhidgetInterfaceKit, which can be seen 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 {{Code|.help}} file.

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

[[File:MaxMSP getSerial.PNG]]

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

[[File:MaxMSP read.PNG]]

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

For the PhidgetInterfaceKit example, there is also a {{Code|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 [[#Follow 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 LiveCode libraries. To begin:

In addition to placing the {{Code|.mxe}} file in the same directory as the patcher, you can also place the {{Code|.mxe}} anywhere in the Max/MSP class path. You can verify the class paths by navigating to Options | File Preferences.
<br/>[[File:MaxMSP Path.PNG]]

The best way to start writing your patch is to modify the examples, and saving as a {{Code|.pat}} file.

However, if you wish to start a new patch. All you need to do is create an object named PhidgetXXX where XXX is the name of your device. For example, the [[Product - 1023 1 - PhidgetRFID | PhidgetRFID device]] will have the {{Code|PhidgetRFID}} object name.
The project now has access to the Phidget21 function calls and you are ready to begin coding.

The same [[#Follow The Examples|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 [[Device List|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:

{{UsingAPhidgetInCodeGeneral|both of which are available in Max/MSP|[http://www.phidgets.com/documentation/Phidget21.NET.zip C# API]}}

===Example Flow===

{{ExamplePseudocode|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. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
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.
|Creating a Phidget software object in C# is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a <code>Spatial</code> object. The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip C# API]}}

==Code Snippets==

==Common Problems and Solutions/Workarounds==

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