Language - C

C++ is a general purpose, cross-platform programming language with a vast user base.

Support

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 C/C++ specifically.

C/C++ is capable of using the complete Phidget API. We also provide example code in C/C++ for all Phidget devices.

C/C++ can be developed with various Windows compilers (including Borland, Cygwin, and MinGW), Mac OSX, and Linux.{{{5}}}

You can compare C/C++ with our other supported languages.

Quick Downloads

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

C/C++ API Documentation:

• C/C++ API Manual Download or (HTML online version)
• General API (more help on functions common to all Phidgets)
• Device Specific APIs (more help on functions specific to your Phidget)

C/C++ Example Code:

• Visual Studio for C/C++ Example Code
• Generic C/C++ Example Code

Libraries and Drivers:

• 32 bit Windows (drivers, with libraries)
• 64 bit Windows (drivers, with libraries)
• Borland C++ Libraries (You also need one of the two Windows drivers above)
• General Linux Libraries ( Linux Library Setup Instructions)
• General Mac OSX Libraries ( Mac OSX 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:

• 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 OSX
• Linux (including PhidgetSBC)

Windows

• 32 bit Windows Installer (drivers, with libraries)
• 64 bit Windows Installer (drivers, with libraries)

C/C++ programs on Windows depend on three 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.
• Phidget21.lib is used by your compiler to link to the dll. Your compiler has to know where this file is. Our installer puts Phidget21.lib into C:\Program Files\Phidgets. Phidget21.lib 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.
• Phidget21.h 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 Phidget21.h into C:\Program Files\Phidgets so you can either point your compiler to that location, or copy and link to it in a directory for your project workspace. We offer some instruction below, by compiler.

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

Visual Studio

If you are using Visual Studio 2005/2008/2010, please start by downloading the Visual C/C++ Examples. These examples were written in Visual Studio 2005, but Visual Studio 2008 / 2010 will easily upgrade them.

• Microsoft Visual C/C++ Examples

If you are using a Visual Studio 2003 or 6.0, please start by downloading the Generic C/C++ examples.

• Generic C/C++ Examples

Note: C++/CLI (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 somewhat limited in functionality - in practice this does not seem to be a problem for most people.

Visual Studio 2005/2008/2010

Use Our 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.

To run the examples, you first download them from above and unpack them into a folder. Then from Visual Studio, to load all projects, go to File > Open > Project / Solution, and open "Visual Studio Phidgets Examples.sln" in the VCpp folder of the examples.

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 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 tries to find the phidget21.h and phidget21.lib in the $(SystemDrive)\Program Files\Phidgets. If you have these files installed in another location, please change the path accordingly. Please see the next section for details.



Once you have the C/C++ examples running, we have a 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.

Next, select Console Application

• Open the project properties window.
• Navigate to Configuration Properties | C/C++
• Add "C:\Program Files\Phidgets" to the additional directories field. This step will find the phidget21.h file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.

• Navigate to Configuration Properties | Linker | Input.
• Edit the additional dependencies and add "C:\Program Files\Phidgets\phidget21.lib". This step will find the phidget21.lib file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.

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:

  #include <phidget21.h>

The same 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.

• Generic C/C++ Examples

Use Our Examples
Download the examples from above 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 Getting Started guide for your device.

Next, a new project will need to be created.

• Generate a new Visual C++ empty project(.NET) with a descriptive name such as PhidgetTest.

To import the example program into your project, please:

• Create a new C++ file by adding a new item to the source files folder.

• An empty C++ file will pop up. Please copy and paste the contents of the example program here.

Next, the project settings needs to be set up.

• Open the project properties window.
• Navigate to Configuration Properties | C/C++
• Add "C:\Program Files\Phidgets" to the additional include directories field. This step will find the phidget21.h file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.

• Navigate to Configuration Properties | Linker | Input
• Add "C:\Program Files\Phidgets\phidget21.lib" to the additional dependencies field. This step will find the phidget21.lib file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.

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.

Once you have the C/C++ examples running, we have a 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 previous section for instructions.

Visual Studio C++ 6.0

Start by downloading the Generic C/C++ Examples. You can import these examples into a Visual Studio C++ 6 project.

• Generic C/C++ Examples

Use Our Examples
Download the examples from above 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 Getting Started guide for your device.

Next, a new project will need to be created.

• Generate a new Win32 Console Application project with a descriptive name such as PhidgetTest.

• Create an empty project.

Next, the project settings needs to be set up.

• Navigate to Project | Settings | C/C++ | Preprocessor.
• Add C:\Program Files\Phidgets to the additional include directories field. This step will find the phidget21.h file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.

• Navigate to Project | Settings | Link | Input | Additional library Path
• Add phidget21.lib to the object/library modules field.
• Add C:\Program Files\Phidgets to the additional library path. This step will find the phidget21.lib file in the corresponding directory. If the file is placed in another location, please adjust the path accordingly.

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

• An empty C++ file will pop up. Please copy and paste the contents of the example program here.

Now, you can run the example. Click on Build | Execute.

Once you have the C/C++ examples running, we have a 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 previous section for instructions.

Borland

In addition to running one of the two Windows Installers above (which you probably already have if you worked through the Getting Started page for your device), you will need these specific libraries for Borland:

• Borland C++ Libraries

Use Our Examples

Needs some content on how to unpack and run the examples in Borland

Write Your Own Code

Needs some additional content on how to create a blank project and link in Borland

To link libraries in Borland C/C++:

Make sure to download the additional Borland-specific libraries in addition to the drivers you already have through the Getting Started page for your device:

• Borland C++ Libraries

To compile and link your program: bcc32 -I"C:\Program Files\Phidgets" -L"C:\Program Files\Phidgets" phidget21bcc.lib example.c

GCC on Windows

When you use gcc on Windows, you will use the general C/C++ examples like you would on Mac or Linux:

• Generic C/C++ Examples

Cygwin

Use Our Examples

Needs some content on how to unpack and run the examples using Cygwin

Write Your Own Code

To compile and link your program: gcc example.c -I"/cygdrive/c/Program Files/Phidgets" -L"/cygdrive/c/Program Files/Phidgets" -lphidget21

MinGW

Use Our Examples

Needs some content on how to unpack and run the examples using MinGW

Write Your Own Code

To compile and link your program: gcc example.c -I"C:\Program Files\Phidgets" -L"C:\Program Files\Phidgets" -lphidget21

Dev C++

When you use Dev C++, you will use the general C/C++ examples:

• Generic C/C++ Examples

Use Our Examples

In order to control Phidgets with Dev-C++, the library file will need to be in a format that Dev-C++ accepts, as described in the following steps. The following steps works with Dev-C++ 4.9.9.2. Download the reimp tool(Please download it here), and type the following command to create libphidget21.a.

  reimp.exe "C:\Program Files\Phidgets\phidget21.lib"

Place libphidget21.a in <Dev-Cpp Install Directory>/lib

Open up your project in Dev-C++, and traverse to Project Options->Parameters->Linker, and enter the following to link to the library:

  -lphidget21

Next, the path to phidget21.h will need to be specified. Traverse to Project Options->Directories->Include Directories, and add the path to the Phidget installation directory:

  C:\Program Files\Phidgets

The 64 bit version of phidget21.lib is not supported on Dev C/C++. Please use the 32 bit version of phidget21.lib.

Write Your Own Code

Need some content on creating a blank project and linking to Phidgets, or reference the information above

Mac OSX

C/C++ has excellent support on Mac OSX 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 getting started guide for your device. Then, the OS - Mac OSX page also describes the different Phidget files, their installed locations, and their roles.

The information we say that we say on the OS - Mac OSX 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:

• 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 OSX, follow the Getting Started page for your specific device

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

  gcc example.c -o example -framework Phidget21 -I/Library/Frameworks/Phidget21.framework/Headers

After using gcc, you will have an executable named example that you can run.

Write Your Own Code

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

  #include <phidget21.h>

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 teaching section to help you follow the provided C/C++ examples. Even more help and references are provided from there.

Linux

C/C++ has excellent 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 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:

• 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 specific device. The source file is usually named similarly to 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 example.c:

  gcc example.c -o example -lphidget21

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

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

     sudo ./example

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 .c source code file, you must include a reference to the library header:

  #include <phidget21.h>

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

First comes our API information. These resources outline the C/C++ Phidget functions:

• C/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 C/C++.

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/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/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 an object with the CPhidgetSpatialHandle type, and then initializing it using the CPhidgetSpatial_create function. The examples show how to do this and other API functions. Other C calls follow a similar syntax - CPhidgetXXX_function, where XXX is the name of your device, and function is an action available from the API for your specific Phidget.

Common Problems and Solutions/Workarounds

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