Language - C: Difference between revisions

Latest revision as of 15:34, 18 September 2017

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

Introduction

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, including events. We also provide example code in C/C++ for all Phidget devices.

C/C++ can be developed with Windows XP/Vista/7/8(environments include Visual Studio, Borland, Cygwin, and MinGW), Windows CE, OS X, and Linux.

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

Quick Downloads

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

Documentation

Example Code

Libraries and Drivers

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
OS X
Linux (including PhidgetSBC)

Windows (XP/Vista/7/8)

Description of Library Files

C/C++ programs on Windows depend on three files, which the installers in Quick Downloads put onto your system:

phidget21.dll contains the actual Phidget library, which is used at run-time. By default, it is placed in C:\Windows\System32.
phidget21.lib is used by your compiler to link to the dll. Your compiler has to know where this file is, by default our installer puts phidget21.lib 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. 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 for details. Please note that we provide versions of the phidget21.lib that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the phidget21.lib is placed in C:\Program Files\Phidgets; The 32 bit version of phidget21.lib is placed in C:\Program Files\Phidgets\x86.
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.

If you do not want to use our installer, you can download all three files and manually install them where you want; refer to our Manual Installation Instructions.

Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for Visual Studio 2005/2008/2010, Visual Studio 2003, Visual Studio 6, Borland, Cygwin/MinGW, and Dev C++.

Visual Studio

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 Phidget .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 Microsoft Visual Studio for more information.

Visual Studio 2005/2008/2010

Use Our Examples

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

Since the examples were written in Visual Studio 2005, if you are opening the examples in Visual Studio 2008/2010, you will need to go through the Visual Studio Conversion Wizard to open and convert the 2005 project.

Conversion Wizard

This will load all of the examples available for C/C++. The easiest way to confirm that your environment is set up properly will be to compile and run the HelloWorld C/C++ example.

Start by setting the HelloWorld project as your start up project.

Start Up Project

To run the example, click on Debug → Start Debugging. Please note that the projects, by default try 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 to the file's location accordingly. Please see the Write Your Own Code section for details.

Run

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:

HelloWorld Output

If you have a 64-bit computer (and operating system) then you may also need to adjust the platform. You can do this by selecting x64 from the following drop down menu:

If x64 is not a selectable option then go into the Configuration Manager and create it by selecting New... and copying the settings from Win32. You should now be able to select x64 and run the code normally.

After confirming that the HelloWorld example is working, you can proceed to run the example 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, find your Phidget on our webpage, and then check the API documentation for it.

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 development environment to properly link the Phidget C/C++ library. To begin:

1. Generate a new Visual C++: Win32 Console Application project with a descriptive name such as PhidgetTest.

New Project

2. Next, select Console Application.

New Project

3. Open the project properties window.

4. Navigate to Configuration Properties → C/C++.

5. 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 to the file's location accordingly.

Header File

6. Navigate to Configuration Properties → Linker → Input.

7. 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 to the file's location accordingly.

Library File

8. The project now has access to the Phidget function calls and you are ready to begin coding.

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

  #include <phidget21.h>

The same teaching section which describes the examples also has further resources for programming your Phidget.

Visual Studio 2003

Use Our Examples

1. Start by downloading the examples. You can import these examples into a Visual Studio 2003 C++ project. Afterwards, unpack them into a folder. Here, you can find example programs for all the devices. You will need this example source code to be copied into your C++ project later on. The easiest way to confirm that your environment is set up properly will be to compile and run the HelloWorld C/C++ example.

2. A new project will need to be created. Generate a new Visual C++ empty project(.NET) with a descriptive name such as HelloWorld.

New Project

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

New File

4. An empty C++ file will pop up. Please copy and paste the contents of the HelloWorld.c program into here.

Source Code

5. Next, the project setting needs to be set up. Open the project properties window.

6. Navigate to Configuration Properties → C/C++.

7. 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 to the file's location accordingly.

Header File

8. Navigate to Configuration Properties → Linker → Input.

9. 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 to the file's location accordingly.

Library File

10. Now, you can run the example. Click on Debug → Start Without Debugging.

Run

11. This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:

HelloWorld Output

After confirming that the HelloWorld example is working, you can proceed to run the example 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, find your Phidget on our webpage, and then check the API documentation for it.

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 development environment to properly link the Phidget C/C++ library. Please see the Use Our Examples section for instructions.

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

  #include <phidget21.h>

Visual Studio C++ 6.0

Use Our Examples

1. Download the examples and unpack them into a folder. Here, you can find example programs for all the devices. You will need this example source code to be copied into your C++ project later on. The easiest way to confirm that your environment is set up properly will be to compile and run the HelloWorld C/C++ example.

2. Next, a new project will need to be created. Generate a new Win32 Console Application project with a descriptive name such as HelloWorld.

New Project

3. Create an empty project.

New Project

4. Next, the project settings needs to be set up. Navigate to Project → Settings → C/C++ → Preprocessor.

5. 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 to the file's location accordingly.

Header File

6. Navigate to Project → Settings → Link → Input → Additional library Path.

7. Add phidget21.lib to the object/library modules field.

8. 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 to the file's location accordingly.

Library File

The project now has access to the Phidget function calls and you are ready to begin coding.

To import the example program into your project, please:

9. Create a new C++ file by navigating to File → New → Files → C++ Source File and enter a descriptive name such as HelloWorld.

New File

10. An empty C++ file will pop up. Please copy and paste the contents of the HelloWorld.c program here.

Source Code

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

Run

12. This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:

HelloWorld Output

After confirming that the HelloWorld example is working, you can proceed to run the example 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, find your Phidget on our webpage, and then check the API documentation for it.

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 development environment to properly link the Phidget C/C++ library. Please see the Use Our Examples section for instructions.

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 shown in the 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 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 Installers above (which you probably already have if you worked through the Getting Started page for your device), you will need the Borland C++ Libraries. phidget21bcc.lib is typically placed in C:\Program Files\Phidgets, but you are free to place it in any directory you wish.

After installing the Phidget C/C++ library, you're ready to download the examples and run the examples.

Afterwards, unpack the examples. The easiest way to confirm that your environment is set up properly will be to compile and run the HelloWorld C/C++ example. Locate the HelloWorld.c file and type the following to compile the file and link the Phidget C/C++ library:

To compile, link the Phidget C/C++ library and build a binary executable, enter the following in a command line prompt in the directory with HelloWorld.c:

  bcc32 -eHelloWorld -I"C:\Program Files\Phidgets" -L"C:\Program Files\Phidgets" phidget21bcc.lib HelloWorld.c

It is assumed that phidget21bcc.lib and phidget21.h are placed in C:\Program Files\Phidgets. If the files are placed in another location, please adjust the paths to both of the file's location accordingly.

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

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:

HelloWorld Output

After confirming that the HelloWorld example is working, you can proceed to run the example 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, find your Phidget on our webpage, and then check the API documentation for it.

Write Your Own Code

When writing your code from scratch, you start it as you would any C/C++ code with Borland. 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.

GCC on Windows

Cygwin/MinGW

Use Our Examples

Download the examples and unpack them into a folder. Afterwards, unpack the examples. The easiest way to confirm that your environment is set up properly will be to compile and run the HelloWorld C/C++ example. Locate the HelloWorld.c file and type the following to compile the file and link the Phidget C/C++ library in a command line prompt:

Cygwin

  gcc example.c -o HelloWorld -I"/cygdrive/c/Program Files/Phidgets" -L"/cygdrive/c/Program Files/Phidgets" -lphidget21

MinGW

  gcc example.c -o HelloWorld -I"C:\Program Files\Phidgets" -L"C:\Program Files\Phidgets" -lphidget21

After using gcc, you will have an executable named HelloWorld that you can run. It is assumed that phidget21.h and phidget21.lib are placed in C:\Program Files\Phidgets. If the files are placed in another location, please adjust the paths to the file's location accordingly.

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

This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:

HelloWorld Output

After confirming that the HelloWorld example is working, you can proceed to run the example 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, find your Phidget on our webpage, and then check the API documentation for it.

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 .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 shown in the 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 teaching section to help you follow the provided C/C++ examples and which has resources such as the API reference.

Dev C++

Use Our Examples

1. Download the examples and unpack them into a folder. Here, you can find example programs for all the devices. 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, find your Phidget on our webpage, and then check the API documentation for it. You will need this example source code to be copied into your Dev C++ project later on. The easiest way to confirm that your environment is set up properly will be to compile and run the HelloWorld C/C++ example.

2. In order to control Phidgets with Dev C++, we will use the reimp tool to convert the phidget21.lib to a format that Dev C++ accepts. Download the reimp tool. Reimp is part of MinGW, a minimal UNIX emulator for Windows, and it is specifically within the mingw-utils package. You can check MinGW's release notes to ensure Reimp is in the version you are using.

3. Open up command line and traverse to the directory containing the reimp tool. Type the following command to create libphidget21.a.

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

The command above assumes that the phidget21.lib is in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly. Please note that the 64 bit version of phidget21.lib is not supported on Dev C/C++. Please use the 32 bit version of phidget21.lib.

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

5. Next, a new project will need to be created. Generate a new console application with a descriptive name such as PhidgetTest. Please select C as the project type.

New Project

6. Next, the project settings needs to be set up. Navigate to Project Options → Directories → Include Directories.

7. Add a new path to C:\Program Files\Phidgets. This step will find the phidget21.h file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.

Header File

8. Navigate to Project Options → Parameters → Linker.

9. Add -lphidget21 to the field. This step will find the libphidget21.a file in <Dev-Cpp Install Directory>/lib.

Library File

10. To import the HelloWorld program into your project, please open up main.c in the editor.

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

Source Code

12. Now, you can run the example. Click on Execute → Compile & Run.

Run

13. This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:

HelloWorld Output

After confirming that the HelloWorld example is working, you can proceed to run the example 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, find your Phidget on our webpage, and then check the API documentation for it.

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 development environment to properly link the Phidget C/C++ library. Please see the Use Our Examples section for instructions.

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.

Code::Blocks

Use Our Examples

The process for getting Phidgets working in Code::Blocks is much the same as Dev-C++. You will need to download the reimp tool that is linked there and use it on the phidget21.lib file as instructed. After the .a file has been created you can stick it in your /Phidgets folder with the rest of the Phidget library files.

Now that that has been done, open one of the example files that you would like to run, for example InterfaceKit-simple.c. Under the Settings menu, choose "Compiler and debugger..."

Go to the "Search directories" tab and add a new entry. Choose your Phidgets installation directory.

Under the "Linker settings" tab add a new entry and type in "phidget21".

You can now compile and run the example.

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 development environment to properly link the Phidget C/C++ library. Please see the Use Our Examples section for instructions.

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.

OS X

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

The first step in using C/C++ on Mac is to install the Phidget C/C++ library. Compile and install them as explained on the Getting Started guide for your device, which you can find in its user guide. Then, the OS - OS X page also describes the different Phidget files, their installed locations, and their roles.

Use Our Examples

After installing the main Phidget library for OS X as above, you're ready to download the examples. Afterwards, unzip the file. 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.

To compile, link the Phidget C/C++ library, and build an executable binary on OS X, do (for example, depending on the Headers location):

  gcc example.c -o example -F/Library/Frameworks -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 shown in the 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 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 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 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, find your Phidget on our webpage, and then check the API documentation for it. You can also use the HelloWorld program, which a basic program that can run with any Phidget. Then, compile the code under your platform and run it. When compiling, you need to link to the Phidget 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.

Windows CE

Description of Library Files

C/C++ programs on Windows CE depend on the following files, which the Windows CE installer puts onto your system:

phidget21.dll contains the actual Phidget library, which is used at run-time. It is placed in \Windows.
PhidgetWebService21.exe is used to control Phidgets remotely across a network using the PhidgetWebService. It can be placed anywhere on the system.
phidget21.lib is used by your compiler to link to the dll. Your compiler has to know where this file is.
phidget21.h lists all the Phidget API function calls available to your code. Your compiler also has to know where this file is.
phidget.dll is the Phidgets kernel driver. It is placed in \Windows.

Visual Studio 2005/2008/2010

Use Our Examples

Currently, we have no example code for C/C++ on Windows CE. However, set up is very much the same as what it would be with Visual Studio 2005/2008/2010 in Windows. The phidget21.h and phidget21.lib can be downloaded here.

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 development environment to properly link the Phidget C/C++ library. To begin:

1. Generate a new Visual C++: Win32 Smart Device project with a descriptive name such as PhidgetTest.

New Project

2. Select Next.

New Project

3. Select the SDK(s) that you want to code against and elect Next.

SDKs

4. Create a console application and select Next.

Create Console Application

3. Open the project properties window.

4. Navigate to Configuration Properties → C/C++.

5. 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 to the file's location accordingly.

Header File

6. Navigate to Configuration Properties → Linker → Input.

7. 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 to the file's location accordingly.

Library File

8. The project now has access to the Phidget function calls and you are ready to begin coding.

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

  #include <phidget21.h>

The same teaching section which describes the examples also has further resources for programming your Phidget.

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.

Your main reference for writing C code will be our C/C++ API information, with syntax for all of our 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.

Code Snippets

When programming in C/C++, you're in luck. All of our code snippet examples on our General Phidget Programming page are in both C++ and Java. Therefore, we do not include any here, because that page is much more in-depth, and you won't have to have two pages open at once. So head over there, and start writing code!

C++ Events

If you want to use C++ style, object-oriented events you can do that as well. The following examples show you how to do this:

Main
Header

Common Problems and Solutions/Workarounds

Issue: I am using a non US-English version of Windows, and the Visual C/C++ examples run into a linker error

Affected Operating Systems: Windows

The example projects, by default finds the phidget21.h and phidget21.lib in ${SystemDrive}\Program Files\Phidgets. If you are using a non US-English version of Windows, the Phidget drivers may be installed into a different location. To resolve, you will have to modify the paths to these two files. For instructions, please see your environment/compiler section.

@@ Line 1: / Line 1: @@
-Preamble about the language and its general strengths and weaknesses.
+[[Category:Language]]
+{{OSLang|[[File:icon-C++.png|link=|alt=C/C++|64x64px]]|C++ is a general purpose, cross-platform programming language with a vast user base.}}
+__TOC__
-==Assessment for use with Phidgets==
+==Introduction==
-Our honest opinion on how well this language is suited to controlling Phidgets. If it is a poor choice, suggest and link similar (better) languages.
-==Support==
+{{LanguageSupport|C/C++|the complete Phidget API, including events|all Phidget devices.|Windows XP/Vista/7/8(environments include [[#Visual Studio | Visual Studio]], [[#Borland | Borland]], [[#Cygwin/MinGW | Cygwin, and MinGW]]), [[#Windows CE | Windows CE]], [[#OS X | OS X]], and [[#Linux | Linux]]|}}
-We provide [[Levels of Support|full support]] to C and C++.
-==Restrictions==
+==Quick Downloads==
-In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.
+{{QuickDownloads|C/C++|
+{{APIQuickDownloads|{{SERVER}}/documentation/Phidget21_C_Doc.zip}}
+{{ExtraAPIQuickDownloads|{{SERVER}}/documentation/web/cdoc/index.html|HTML Version of}}|
+*[{{SERVER}}/downloads/phidget21/examples/c/VCpp.zip Visual Studio 2005/2008/2010 Projects]
+*[{{SERVER}}/downloads/phidget21/examples/c/phidget21-c-examples.tar.gz All other compilers]|
+{{ExtraLibraryQuickDownloads|{{SERVER}}/downloads/phidget21/libraries/windows/phidget21bcc.zip|Borland(Windows)|}}
+{{WindowsQuickDownloads}}
+{{MacQuickDownloads}}
+{{LinuxQuickDownloads}}
+}}
-==Development Environments and Compilers==
+==Getting started with C/C++==
-Describe each major compiler and notable differences or important information. (eg. framework versions) If there are known issues/workarounds mention them and link to the corresponding issue at the bottom of the page.
+If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
+{{ExampleCodeReasons}}
-==Drivers, Libraries and Resources==
+Instructions are divided up by operating system. Choose:
-Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
+*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
-Visit the drivers section at www.phidgets.com and get the latest:
+*[[#OS X |OS X]]
-* [http://www.phidgets.com/drivers.php Phidget Framework]
+*[[#Linux | Linux]] (including PhidgetSBC)
-You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:
-* [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip API Manual]
-* [http://www.phidgets.com/documentation/web/cdoc/index.html API Reference]
-* Sample Code:
-**[http://www.phidgets.com/downloads/examples/VCpp_2.1.8.20110615.zip Windows]
-**[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20110615.tar.gz Linux/MacOS]
-* Phidget21 Library:
-**[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip x86]
-**[http://www.phidgets.com/downloads/libraries/phidget21-x64_2.1.8.20110615.zip x64]
-**[http://www.phidgets.com/downloads/libraries/phidget21bcc_2.1.8.20110615.zip Borland C++]
-* You can find a high level discussion about programming with Phidgets in general on the [[General API]] page.
-* The [[Device Functionality]] page explains the general operational information for your device.
-You may want to have these pages open while working through these instructions.
+==Windows (XP/Vista/7/8)==
-==Getting Started (Windows)==
+===Description of Library Files===
+C/C++ programs on Windows depend on three files, which the installers in [[#Libraries and Drivers|Quick Downloads]] put onto your system:
+* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time.  By default, it is placed in {{Code|C:\Windows\System32}}.
+* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll.  Your compiler has to know where this file is, by default our installer puts {{Code|phidget21.lib}} into {{Code|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. {{Code|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 for details. Please note that we provide versions of the {{Code|phidget21.lib}} that are specifically optimized for 32-bit or 64-bit systems. If you are using a 64 bit versions of Windows, the {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets}}; The 32 bit version of {{Code|phidget21.lib}} is placed in {{Code|C:\Program Files\Phidgets\x86}}.
+* <b>{{Code|phidget21.h}}</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}} into {{Code|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.
-The Phidget examples were written using Visual C++ 2005 and this tutorial assumes its use.
+If you do not want to use our installer, you can download all three [{{SERVER}}/downloads/phidget21/libraries/windows/Phidget-x86.zip files] and manually install them where you want; refer to our [[OS_-_Windows#Manual_File_Installation | Manual Installation Instructions]].
-Other environments such as other versions of Visual Studio work as well and would be set up in a similar manner.
-Borland C also requires the phidget21bcc.lib file provided at the Phidgets website.
-Consult your compiler documentation for specific details on how to link to external libraries.
-In Visual C++ 2005:
-* Generate a new C/C++ console project with a descriptive name such as PhidgetTest.
-* Copy phidget21.h and phidget21.lib from the VC/VC++/Borland examples and add them to your project directory.
-* Open the project properties window.
-* Navigate to Configuration Properties | Linker | Input.
-* Edit the additional dependencies and add “phidget21.lib”.
-The project now has access to the Phidget21 function calls and we are ready to begin coding.
+Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for [[#Visual Studio 2005/2008/2010 | Visual Studio 2005/2008/2010]], [[#Visual Studio 2003 | Visual Studio 2003]], [[#Visual Studio C++ 6.0 | Visual Studio 6]], [[#Borland| Borland]], [[#Cygwin/MinGW | Cygwin/MinGW]], and [[#Dev C++ | Dev C++]].
-===Coding For Your Phidget===
+===Visual Studio===
-Before you can use the Phidget, you must include a reference to the library header.
+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 Phidget .NET library, instead of the C API normally used from C/C++.  We have no documentation for using C++/CLI.
-<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
+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.
-<font size="3">
-<source lang=cpp>
-  #include "phidget21.h"
-</source>
+====Visual Studio 2005/2008/2010====
-</font>
+=====Use Our Examples=====
+To run the examples, you first download the [{{SERVER}}/downloads/phidget21/examples/c/VCpp.zip examples] and unpack them into a folder.  To load all projects in Visual Studio, go to File &rarr; Open &rarr; Project &rarr; Solution, and open {{Code|Visual Studio Phidgets Examples.sln}} in the {{Code|VCpp}} folder of the examples.
+Since the examples were written in Visual Studio 2005, if you are opening the examples in Visual Studio 2008/2010, you will need to go through the Visual Studio Conversion Wizard to open and convert the 2005 project.
+[[File:VS2005 Conversion Wizard.PNG|link=|alt=Conversion Wizard]]
+This will load all of the examples available for C/C++. The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example.
+Start by setting the {{Code|HelloWorld}} project as your start up project.
+[[File:VS2005 StartUp Project.PNG|link=|alt=Start Up Project]]
+To run the example, click on Debug &rarr; Start Debugging. Please note that the projects, by default try to find the {{Code|phidget21.h}} and {{Code|phidget21.lib}} in the {{Code|$(SystemDrive)\Program Files\Phidgets}}. If you have these files installed in another location, please change the path to the file's location accordingly. Please see the [[#Write Your Own Code | Write Your Own Code]] section for details.
+[[File:VS2005 Run.PNG|link=|alt=Run]]
+This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:
+[[File:VS2005 HelloWorld Output.PNG|link=|alt=HelloWorld Output]]
+If you have a 64-bit computer (and operating system) then you may also need to adjust the platform.  You can do this by selecting x64 from the following drop down menu:
+[[File:platform.png|link=]]
+If x64 is not a selectable option then go into the Configuration Manager and create it by selecting New... and copying the settings from Win32.  You should now be able to select x64 and run the code normally.
+[[File:newplatform.png|link=]]
+After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. {{FindYourDevice}}
+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 development environment to properly link the Phidget C/C++ library. To begin:
+. Generate a new Visual C++: Win32 Console Application project with a descriptive name such as PhidgetTest.
+[[File:VS2005 New Project.PNG|link=|alt=New Project]]
+. Next, select Console Application.
+[[File:VS2005 New Project 2.PNG|link=|alt=New Project]]
+. Open the project properties window.
+. Navigate to Configuration Properties &rarr; C/C++.
+. Add {{Code|"C:\Program Files\Phidgets"}} to the additional directories field. This step will find the {{Code|phidget21.h}} file in the corresponding directory. If the file is placed in another location, please adjust the path  to the file's location accordingly.
+[[File:VS2005 Header.PNG|link=|alt=Header File]]
+. Navigate to Configuration Properties &rarr; Linker &rarr; Input.
+. Edit the additional dependencies and add {{Code|"C:\Program  Files\Phidgets\phidget21.lib"}}. This step will find the {{Code|phidget21.lib}} file in the corresponding directory. If the file is placed in another location, please adjust the path  to the file's location accordingly.
+[[File:VS2005 Library.PNG|link=|alt=Library File]]
+. The project now has access to the Phidget function calls and you are ready to begin coding.
+Then, in your code, you will need to include the Phidget C/C++ library:
+<div class="source">
+<syntaxhighlight lang=cpp>
+  #include <phidget21.h>
+</syntaxhighlight>
 </div>
-Afterwards, the Phidget object will need to be declared and then initialized.
-For example, we can declare a PhidgetInterfaceKit inside our main function with:
-<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
+The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.
-<font size="3">
-<source lang=cpp>
+====Visual Studio 2003====
+=====Use Our Examples=====
+. Start by downloading the [{{SERVER}}/downloads/phidget21/examples/c/phidget21-c-examples.tar.gz examples]. You can import these examples into a Visual Studio 2003 C++ project. Afterwards, unpack them into a folder. Here, you can find example programs for all the devices. You will need this example source code to be copied into your C++ project later on. The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example.
+. A new project will need to be created. Generate a new Visual C++ empty project(.NET) with a descriptive name such as HelloWorld.
+[[File:VS2003 New Project.PNG|link=|alt=New Project]]
+. Create a new C++ file by adding a new item to the source files folder.
+[[File:VS2003 New File.PNG|link=|alt=New File]]
+[[File:VS2003 New File 2.PNG|link=|alt=New File]]
+. An empty C++ file will pop up. Please copy and paste the contents of the {{Code|HelloWorld.c}} program into here.
+[[File:VS2003 Source.PNG|link=|alt=Source Code]]
+. Next, the project setting needs to be set up. Open the project properties window.
+. Navigate to Configuration Properties &rarr; C/C++.
+. Add {{Code|"C:\Program Files\Phidgets"}} to the additional include directories field. This step will find the {{Code|phidget21.h}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.
+[[File:VS2003 Header.PNG|link=|alt=Header File]]
+. Navigate to Configuration Properties &rarr; Linker &rarr; Input.
+. Add {{Code|"C:\Program  Files\Phidgets\phidget21.lib"}} to the additional dependencies field. This step will find the {{Code|phidget21.lib}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.
+[[File:VS2003 Library.PNG|link=|alt=Library File]]
+. Now, you can run the example. Click on Debug &rarr; Start Without Debugging.
-  int _tmain(int argc, _TCHAR* argv[])
+[[File:VS2003 Run.PNG|link=|alt=Run]]
-  {
-     CPhidgetInterfaceKitHandle ifKit = 0; //Declare an InterfaceKit handle
+. This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:
-     CPhidgetInterfaceKit_create(&ifKit);  //Create the InterfaceKit object
+[[File:VS2003 HelloWorld Output.PNG|link=|alt=HelloWorld Output]]
-     //More code goes here
-     return 0;
+After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. {{FindYourDevice}}
-   }
+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  development environment to properly link the Phidget C/C++ library. Please see the [[#Use Our Examples 2 | Use Our Examples]] section for instructions.
+Then, in your code, you will need to include the Phidget C/C++ library:
+<div class="source">
+<syntaxhighlight lang=cpp>
+   #include <phidget21.h>
-</source>
+</syntaxhighlight>
-</font>
 </div>
-The object name for any type of Phidget is listed in the API manual.
+====Visual Studio C++ 6.0====
-Every type of Phidget also inherits functionality from the Phidget base class.
+=====Use Our Examples=====
+. Download the [{{SERVER}}/downloads/phidget21/examples/c/phidget21-c-examples.tar.gz examples] and unpack them into a folder. Here, you can find example programs for all the devices. You will need this example source code to be copied into your C++ project later on. The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example.
+. Next, a new project will need to be created. Generate a new Win32 Console Application project with a descriptive name such as HelloWorld.
-===Connecting to the Phidget===
+[[File:VS6 New Project.PNG|link=|alt=New Project]]
-Next, the program needs to try and connect to the Phidget through an open call.
+. Create an empty project.
-The open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
-This means that simply calling open does not guarantee you can use the Phidget immediately.
-We can handle this by using event driven programming and tracking the AttachEvents and DetachEvents, or by calling waitForAttachment.
-WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.
-<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
+[[File:VS6 New Project 2.PNG|link=|alt=New Project]]
-<font size="3">
-<source lang=cpp>
-  CPhidget_open((CPhidgetHandle)ifKit, -1);
+. Next, the project settings needs to be set up. Navigate to Project &rarr; Settings &rarr; C/C++ &rarr; Preprocessor.
-  CPhidget_waitForAttachment((CPhidgetHandle)ifKit, 2500);
-</source>
+. Add {{Code|C:\Program Files\Phidgets}} to the additional include directories field. This step will find the {{Code|phidget21.h}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.
-</font>
+[[File:VS6 Header.PNG|link=|alt=Header File]]
+. Navigate to Project &rarr; Settings &rarr; Link &rarr; Input &rarr; Additional library Path.
+. Add {{Code|phidget21.lib}} to the object/library modules field.
+. Add {{Code|C:\Program  Files\Phidgets}} to the additional library path. This step will find the {{Code|phidget21.lib}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.
+[[File:VS6 Library.PNG|link=|alt=Library File]]
+The project now has access to the Phidget 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 &rarr; New &rarr; Files &rarr; C++ Source File and enter a descriptive name such as HelloWorld.
+[[File:VS6 New File.PNG|link=|alt=New File]]
+. An empty C++ file will pop up. Please copy and paste the contents of the {{Code|HelloWorld.c}} program here.
+[[File:VS6 Source.PNG|link=|alt=Source Code]]
+. Now, you can run the example. Click on Build &rarr; Execute.
+[[File:VS6 Run.PNG|link=|alt=Run]]
+. This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:
+[[File:VS6 HelloWorld Output.PNG|link=|alt=HelloWorld Output]]
+After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. {{FindYourDevice}}
+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 development environment to properly link the Phidget C/C++ library. Please see the [[#Use Our Examples 3 | Use Our Examples]] section for instructions.
+In your '''{{Code|.c}}''' source code file, you must include a reference to the library header:
+<div class="source">
+<syntaxhighlight lang=cpp>
+  #include <phidget21.h>
+</syntaxhighlight>
 </div>
-The different types of open can be used with parameters to try and get the first device it can find, open based on its serial number, or even open across the network.
+Then, you would compile your completed C/C++ code the same way as shown in the [[#Use Our Examples 3 | Use Our Examples]] section.
-The API manual lists all of the available modes that open provides.
-One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
+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.
-This prevents any other instances from retrieving data from the Phidget, including other programs.
-The one connection per device limit does not apply when exclusively using the Phidget Webservice.
+===Borland===
-At the end of your program, don’t forget to call close to free any locks on the Phidget.
+====Use Our Examples====
-<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
+In addition to running one of the two [[#Libraries and Drivers:| Windows Installers]] above (which you probably already have if you worked through the ''Getting Started'' page for your device), you will need the [{{SERVER}}/downloads/phidget21/libraries/windows/phidget21bcc.zip Borland C++ Libraries]. {{Code|phidget21bcc.lib}} is typically placed in {{Code|C:\Program Files\Phidgets}}, but you are free to place it in any directory you wish.
-<font size="3">
-<source lang=cpp>
-  CPhidget_close((CPhidgetHandle)ifKit);
+After installing the Phidget C/C++ library, you're ready to download the [{{SERVER}}/downloads/phidget21/examples/c/phidget21-c-examples.tar.gz examples] and run the examples.
-  CPhidget_delete((CPhidgetHandle)ifKit);
-</source>
+Afterwards, unpack the examples. The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example. Locate the {{Code|HelloWorld.c}} file and type the following to compile the file and link the Phidget C/C++ library:
-</font>
+To compile, link the Phidget C/C++ library and build a binary executable, enter the following in a command line prompt in the directory with {{Code|HelloWorld.c}}:
+<div class="source">
+<syntaxhighlight lang=bash>
+  bcc32 -eHelloWorld -I"C:\Program Files\Phidgets" -L"C:\Program Files\Phidgets" phidget21bcc.lib HelloWorld.c
+</syntaxhighlight>
 </div>
-===Event Driven Programming===
+It is assumed that {{Code|phidget21bcc.lib}} and {{Code|phidget21.h}} are placed in {{Code|C:\Program Files\Phidgets}}. If the files are placed in another location, please adjust the paths to both of the file's location accordingly.
+In this case, {{Code|HelloWorld.c}} would be the '''.c''' file specific to your device.  After using {{Code|bcc32}}, you will have an executable named {{Code|HelloWorld}} that you can run.
+This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:
+[[File:Borland HelloWorld Output.PNG|link=|alt=HelloWorld Output]]
+After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. {{FindYourDevice}}
+====Write Your Own Code====
-We recommend the use of event driven programming when working with Phidgets.
+When writing your code from scratch, you start it as you would any C/C++ code with Borland. In your '''{{Code|.c}}''' source code file, you must include a reference to the library header:
-In C/C++, we hook an event handler with the following code:
-<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
+<div class="source">
-<font size="3">
+<syntaxhighlight lang=cpp>
-<source lang=cpp>
-   CPhidgetInterfaceKit_set_OnSensorChange_Handler (ifKit, SensorChangeHandler, NULL);
+   #include <phidget21.h>
-  int __stdcall SensorChangeHandler(CPhidgetInterfaceKitHandle IFK, void *usrptr, int Index, int Value)
-  {
-      printf("Sensor: %d > Value: %d\n", Index, Value);
-      //Insert your code hereGetting_Started_VisualC created: 02/27/09 Page 3
-      return 0;
-  }
-</source>
+</syntaxhighlight>
-</font>
 </div>
-With this function, the code inside SensorChangedHandler will get executed every time the InterfaceKit reports a change on one of its analog inputs.
+Then, you would compile your completed C/C++ code the same way as the examples [[#Use Our Examples 4 |above]].
-Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
-Please refer to the API manual for a full list of events and their usage.
-===Working directly with the Phidget===
+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.
-Some values can be read and sent directly to the Phidget.
+===GCC on Windows===
-Simply use the C API functions such as CPhidgetInterfaceKit_getSensorValue() or CPhidgetInterfaceKit_setOutState() for InterfaceKits.
-<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
+====Cygwin/MinGW====
-<font size="3">
-<source lang=cpp>
-  int val;
+=====Use Our Examples=====
-  for (int i = 0; i < 10; i++) {
-     CPhidgetInterfaceKit_getSensorValue(phid, 0, &val);
-     printf("Value: %d\n", val);
-  }
-</source>
+Download the [{{SERVER}}/downloads/phidget21/examples/c/phidget21-c-examples.tar.gz examples] and unpack them into a folder. Afterwards, unpack the examples. The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example. Locate the {{Code|HelloWorld.c}} file and type the following to compile the file and link the Phidget C/C++ library in a command line prompt:
-</font>
+<b>Cygwin</b>
+<div class="source">
+<syntaxhighlight lang=bash>
+  gcc example.c -o HelloWorld -I"/cygdrive/c/Program Files/Phidgets" -L"/cygdrive/c/Program Files/Phidgets" -lphidget21
+</syntaxhighlight>
 </div>
-The functions can be used inside a polling loop as an alternative to event driven programming.
+<b>MinGW</b>
-Above, a sensor attached to the PhidgetInterfaceKit is read and its value is displayed to screen.
+<div class="source">
+<syntaxhighlight lang=bash>
+  gcc example.c -o HelloWorld -I"C:\Program Files\Phidgets" -L"C:\Program Files\Phidgets" -lphidget21
+</syntaxhighlight>
+</div>
-===Working with multiple Phidgets===
+After using gcc, you will have an executable named {{Code|HelloWorld}} that you can run.
+It is assumed that {{Code|phidget21.h}} and {{Code|phidget21.lib}} are placed in {{Code|C:\Program Files\Phidgets}}. If the files are placed in another location, please adjust the paths to the file's location accordingly.
-Multiple Phidgets of the same type can easily be run inside the same program.
+After using {{Code|gcc}}, you will have an executable named {{Code|HelloWorld}} that you can run.
-In our case, it  requires another PhidgetInterfaceKit instance to be defined and initialized.
-The new instance can then be set up, opened and used in the same process as the previous one.
-If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.
-===Other Phidgets===
+This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:
-The design given in this document can also be followed for almost all Phidgets.
+[[File:C MinGW HelloWorld Output.PNG|link=|alt=HelloWorld Output]]
-For example, if you were using a PhidgetRFID instead of an Interfacekit, you would call CPhidgetRFID_create instead of CPhidgetInterfaceKit_create.
-The functions and events available would change but they can be accessed in a similar manner.
-==Getting Started (MacOS/Linux)==
+After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. {{FindYourDevice}}
-===Coding For Your Phidget===
+=====Write Your Own Code=====
-Before you can use the Phidget, you must include a reference to the library header.
+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}}''' 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;">
+<div class="source">
-<font size="3">
+<syntaxhighlight lang=cpp>
-<source lang=cpp>
    #include <phidget21.h>
-</source>
+</syntaxhighlight>
-</font>
 </div>
-Afterwards, the Phidget object will need to be declared and then initialized. For example, we can declare a PhidgetInterfaceKit inside our main function with:
+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.
-<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
+===Dev C++===
-<font size="3">
-<source lang=cpp>
-  int main(int argc, char* argv[])
+=====Use Our Examples=====
-  {
-    CPhidgetInterfaceKitHandle ifKit = 0;
-    CPhidgetInterfaceKit_create(&ifKit);
-    //More code goes here
-    return 0;
-  }
-</source>
+. Download the [{{SERVER}}/downloads/phidget21/examples/c/phidget21-c-examples.tar.gz examples] and unpack them into a folder. Here, you can find example programs for all the devices. {{FindYourDevice}}  You will need this example source code to be copied into your Dev C++ project later on. The easiest way to confirm that your environment is set up properly will be to compile and run the {{Code|HelloWorld}} C/C++ example.
-</font>
+. In order to control Phidgets with Dev C++, we will use the {{Code|reimp}} tool to convert the {{Code|phidget21.lib}} to a format that Dev C++ accepts. Download the [http://sourceforge.net/projects/mingw/ reimp tool].  Reimp is part of MinGW, a minimal UNIX emulator for Windows, and it is specifically within the mingw-utils package.  You can check MinGW's release notes to ensure Reimp is in the version you are using.
+. Open up command line and traverse to the directory containing the reimp tool. Type the following command to create {{Code|libphidget21.a}}.
+<div class="source">
+<syntaxhighlight lang=bash>
+  reimp.exe "C:\Program Files\Phidgets\phidget21.lib"
+</syntaxhighlight>
 </div>
+The command above assumes that the {{Code|phidget21.lib}} is in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly. Please note that the 64 bit version of {{Code|phidget21.lib}} is not supported on Dev C/C++. Please use the 32 bit version of {{Code|phidget21.lib}}.
+. Place {{Code|libphidget21.a}} in {{Code|<Dev-Cpp Install Directory>/lib}}.
+. Next, a new project will need to be created. Generate a new console application with a descriptive name such as PhidgetTest. Please select C as the project type.
+[[File:DevC New Project.PNG|link=|alt=New Project]]
+. Next, the project settings needs to be set up. Navigate to Project Options &rarr; Directories &rarr; Include Directories.
+. Add a new path to {{Code|C:\Program Files\Phidgets}}. This step will find the {{Code|phidget21.h}} file in the corresponding directory. If the file is placed in another location, please adjust the path to the file's location accordingly.
+[[File:DevC Header.PNG|link=|alt=Header File]]
+. Navigate to Project Options &rarr; Parameters &rarr; Linker.
+. Add {{Code|-lphidget21}} to the field. This step will find the {{Code|libphidget21.a}} file in {{Code|<Dev-Cpp Install Directory>/lib}}.
+[[File:DevC Library.PNG|link=|alt=Library File]]
+. To import the {{Code|HelloWorld}} program into your project, please open up {{Code|main.c}} in the editor.
+. An empty C file will pop up. Please copy and paste the contents of the example program.
-The object name for any type of Phidget is listed in the API manual. Every type of Phidget also inherits functionality from the Phidget base class.
+[[File:DevC Source.PNG|link=|alt=Source Code]]
-===Connecting to the Phidget===
+. Now, you can run the example. Click on Execute &rarr; Compile & Run.
-Next, the program needs to try and connect to the Phidget through an open call.
+[[File:DevC Run.PNG|link=|alt=Run]]
-The open will tell the program to continuously try to connect to a Phidget, based on the parameters given, even trying to reconnect if it gets disconnected.
-This means that simply calling open does not guarantee you can use the Phidget immediately.
-We can handle this by using event driven programming and tracking the AttachEvents and DetachEvents, or by calling waitForAttachment.
-WaitForAttachment will block indefinitely until a connection is made to the Phidget, or an optional timeout is exceeded.
-<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
+. This program will detect for devices that are attached/detached on the computer. Go ahead, and attach or detach your devices! Here is an example output:
-<font size="3">
-<source lang=cpp>
-  CPhidget_open((CPhidgetHandle)ifKit, -1);
+[[File:DevC HelloWorld Output.PNG|link=|alt=HelloWorld Output]]
-  CPhidget_waitForAttachment((CPhidgetHandle)ifKit, 10000);
-</source>
+After confirming that the {{Code|HelloWorld}} example is working, you can proceed to run the example for your device. {{FindYourDevice}}
-</font>
+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 development environment to properly link the Phidget C/C++ library. Please see the [[#Use Our Examples 6 | Use Our Examples]] section for instructions.
+In your '''{{Code|.c}}''' source code file, you must include a reference to the library header:
+<div class="source">
+<syntaxhighlight lang=cpp>
+  #include <phidget21.h>
+</syntaxhighlight>
 </div>
-The different types of open can be used with parameters to try and get the first device it can find, open based on its serial number, or even open across the network.
+Then, you would compile your completed C/C++ code the same way as the [[#Use Our Examples 6 | examples]] above.
-The API manual lists all of the available modes that open provides.
-One important thing to remember is that when working with Phidgets, a local connection will reserve the device until closed.
-This prevents any other instances from retrieving data from the Phidget, including other programs.
-The one connection per device limit does not apply when exclusively using the Phidget Webservice.
-At the end of your program, don’t forget to call close to free any locks on the Phidget.
-<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
+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.
-<font size="3">
-<source lang=cpp>
-  CPhidget_close((CPhidgetHandle)ifKit);
-  CPhidget_delete((CPhidgetHandle)ifKit);
-</source>
+===Code::Blocks===
-</font>
+=====Use Our Examples=====
+The process for getting Phidgets working in Code::Blocks is much the same as [[#Dev C++|Dev-C++]].  You will need to download the reimp tool that is linked there and use it on the phidget21.lib file as instructed.  After the .a file has been created you can stick it in your /Phidgets folder with the rest of the Phidget library files.
+Now that that has been done, open one of the example files that you would like to run, for example InterfaceKit-simple.c.  Under the Settings menu, choose "Compiler and debugger..."
+[[File:compilersettings.png|link=|916px]]
+Go to the "Search directories" tab and add a new entry.  Choose your Phidgets installation directory.
+[[File:searchdirectories.png|link=|500px]]
+Under the "Linker settings" tab add a new entry and type in "phidget21".
+[[File:linkersettings.png|link=|500px]]
+You can now compile and run the example.
+=====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 development environment to properly link the Phidget C/C++ library. Please see the [[#Use Our Examples 6 | Use Our Examples]] section for instructions.
+In your '''{{Code|.c}}''' source code file, you must include a reference to the library header:
+<div class="source">
+<syntaxhighlight lang=cpp>
+  #include <phidget21.h>
+</syntaxhighlight>
 </div>
-===Event Driven Programming===
+Then, you would compile your completed C/C++ code the same way as the [[#Use Our Examples 6 | examples]] above.
-We recommend the use of event driven programming when working with Phidgets. In C/C++, we hook an event handler with the following code:
+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.
-<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
+==OS X==
-<font size="3">
-<source lang=cpp>
-  CPhidgetInterfaceKit_set_OnSensorChange_Handler (ifKit, SensorChangeHandler, NULL);
+C/C++ has excellent support on OS X through the gcc compiler.
-  int SensorChangeHandler(CPhidgetInterfaceKitHandle IFK, void *usrptr, int
-  Index, int Value)
-  {
-    printf("Sensor: %d > Value: %d\n", Index, Value);
-    return 0;
-  }
-</source>
+The first step in using C/C++ on Mac is to install the Phidget C/C++ library.  Compile and install them as explained on the Getting Started guide for your device, which you can find in its [[:Category:UserGuide|user guide]].  Then, the [[OS - OS X#Description of Library files|OS - OS X]] page also describes the different Phidget files, their installed locations, and their roles.
-</font>
+===Use Our Examples===
+After installing the main Phidget library for OS X as above, you're ready to download the [{{SERVER}}/downloads/phidget21/examples/c/phidget21-c-examples.tar.gz examples]. Afterwards, unzip the file. 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.
+To compile, link the Phidget C/C++ library, and build an executable binary on OS X, do (for example, depending on the Headers location):
+<div class="source">
+<syntaxhighlight lang=bash>
+  gcc example.c -o example -F/Library/Frameworks -framework Phidget21 -I/Library/Frameworks/Phidget21.framework/Headers
+</syntaxhighlight>
 </div>
-With this function, the code inside SensorChangedHandler will get executed every time the InterfaceKit reports a change on one of its analog inputs.
-Some events such as Attach and Detach belong to the base Phidget object and thus are common to all types of Phidgets.
-Please refer to the API manual for a full list of events and their usage.
-===Working directly with the Phidget===
+After using gcc, you will have an executable named {{Code|example}} that you can run.
-Some values can be read and sent directly to the Phidget. Simply use the C API functions such as CPhidgetInterfaceKit_getSensorValue() or CPhidgetInterfaceKit_setOutState() for InterfaceKits.
+===Write Your Own Code===
-<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
+When writing your code from scratch, you must include a reference to the library header:
-<font size="3">
-<source lang=cpp>
-  int val;
+<div class="source">
-  for (int i = 0; i < 10; i++) {
+<syntaxhighlight lang=cpp>
-    CPhidgetInterfaceKit_getSensorValue(phid, 0, &val);
-    printf("Value: %d\n", val);
+   #include <phidget21.h>
-   }
-</source>
+</syntaxhighlight>
-</font>
 </div>
-The functions can be used inside a polling loop as an alternative to event driven programming.
+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.
-Above, a sensor attached to the PhidgetInterfaceKit is read and its value is displayed to screen.
+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.
-===Working with multiple Phidgets===
+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.
-Multiple Phidgets of the same type can easily be run inside the same program. In our case, it requires another PhidgetInterfaceKit instance to be defined and initialized.
+===Use Our Examples===
-The new instance can then be set up, opened and used in the same process as the previous one.
-If the application needs to distinguish between the devices, open can be called with the serial number of a specific Phidget.
-===Other Phidgets===
+After installing the Phidget libraries for Linux as above, you're ready to download and run the examples:
+*[{{SERVER}}/downloads/phidget21/examples/c/phidget21-c-examples.tar.gz Generic C/C++ Examples]
-The design given in this document can also be followed for almost all Phidgets.
+To run the example code, you'll need to download and unpack the examples, and then find the source code for your device.  {{FindYourDevice}}  You can also use the HelloWorld program, which a basic program that can run with any Phidget.  Then, compile the code under your platform and run it.  When compiling, you need to link to the Phidget library.
-For example, if you were using a PhidgetRFID instead of an Interfacekit, you would call CPhidgetRFID_create instead of CPhidgetInterfaceKit_create.
-The functions and events available would change but they can be accessed in a similar manner.
-===Compiling Your Program===
+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}}:
-Compiling and linking against the Phidgets Library can be done in the following ways:
+<div class="source">
+<syntaxhighlight lang=bash>
+  gcc example.c -o example -lphidget21
+</syntaxhighlight>
+</div>
-*To build on Linux:
+In this case, {{Code|example.c}} would be the '''.c''' file specific to your device.  After using gcc, you will have an executable named {{Code|example}} that you can run.
-:gcc example.c -o example -lphidget21
-*To build on MacOS:
-:gcc example.c -o example -framework Phidget21 -
-:I/Library/Frameworks/Phidget21.framework/Headers
-==Building your Project==
+On Linux, if you have not set up [[OS_-_Linux#Setting_udev_Rules | your udev rules for USB access]], you will need to run the program '''as root''':
-Describe the different ways a project could be built using this language.
+<div class="source">
+<syntaxhighlight lang=bash>
+  sudo ./example
+</syntaxhighlight>
+</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}}''' source code file, you must include a reference to the library header:
+<div class="source">
+<syntaxhighlight lang=cpp>
+  #include <phidget21.h>
+</syntaxhighlight>
+</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.
+==Windows CE==
+===Description of Library Files===
+C/C++ programs on Windows CE depend on the following files, which the Windows CE installer puts onto your system:
+* <b>{{Code|phidget21.dll}}</b> contains the actual Phidget library, which is used at run-time.  It is placed in {{Code|\Windows}}.
+* <b>{{Code|PhidgetWebService21.exe}}</b> is used to control Phidgets remotely across a network using the [[#WebService | PhidgetWebService]]. It can be placed anywhere on the system.
+* <b>{{Code|phidget21.lib}}</b> is used by your compiler to link to the dll.  Your compiler has to know where this file is.
+* <b>{{Code|phidget21.h}}</b> lists all the Phidget API function calls available to your code.  Your compiler also has to know where this file is.
+* <b>{{Code|phidget.dll}}</b> is the Phidgets kernel driver. It is placed in {{Code|\Windows}}.
+===Visual Studio 2005/2008/2010===
+=====Use Our Examples=====
+Currently, we have no example code for C/C++ on Windows CE. However, set up is very much the same as what it would be with [[#Visual Studio 2005/2008/2010 |Visual Studio 2005/2008/2010]] in Windows. The {{Code|phidget21.h}} and {{Code|phidget21.lib}} can be downloaded [{{SERVER}}/downloads/phidget21/libraries/windows/Phidget21-windevel.zip here].
+=====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 development environment to properly link the Phidget C/C++ library. To begin:
+. Generate a new Visual C++: Win32 Smart Device project with a descriptive name such as PhidgetTest.
+[[File:WinCE VS C NewProject 1.PNG|link=|alt=New Project]]
+. Select {{Code|Next}}.
+[[File:WinCE VS C NewProject 2.PNG|link=|alt=New Project]]
+. Select the SDK(s) that you want to code against and elect {{Code|Next}}.
+[[File:WinCE VS C NewProject 3.PNG|link=|alt=SDKs]]
+. Create a console application and select {{Code|Next}}.
+[[File:WinCE VS C NewProject 4.PNG|link=|alt=Create Console Application]]
+. Open the project properties window.
+. Navigate to Configuration Properties &rarr; C/C++.
+. Add {{Code|"C:\Program Files\Phidgets"}} to the additional directories field. This step will find the {{Code|phidget21.h}} file in the corresponding directory. If the file is placed in another location, please adjust the path  to the file's location accordingly.
+[[File:VS2005 Header.PNG|link=|alt=Header File]]
+. Navigate to Configuration Properties &rarr; Linker &rarr; Input.
+. Edit the additional dependencies and add {{Code|"C:\Program  Files\Phidgets\phidget21.lib"}}. This step will find the {{Code|phidget21.lib}} file in the corresponding directory. If the file is placed in another location, please adjust the path  to the file's location accordingly.
+[[File:VS2005 Library.PNG|link=|alt=Library File]]
+. The project now has access to the Phidget function calls and you are ready to begin coding.
+Then, in your code, you will need to include the Phidget C/C++ library:
+<div class="source">
+<syntaxhighlight lang=cpp>
+  #include <phidget21.h>
+</syntaxhighlight>
+</div>
+The same [[#Follow the Examples|teaching]] section which describes the examples also has further resources for programming your Phidget.
+==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.
+Your main reference for writing C code will be our C/C++ API information, with syntax for all of our functions:
+{{UsingAPhidgetInCodeGeneral|both of which are available in C/C++|[{{SERVER}}/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}} type, and then initializing it using the {{Code|CPhidgetSpatial_create function}}.  The examples show how to do this and other API functions.<br><br>
+Other C calls follow a similar syntax - {{Code|CPhidgetXXX_function}}, where XXX is the name of your device, and function is an action available from the API for your specific Phidget.|
+[{{SERVER}}/documentation/Phidget21_C_Doc.zip C/C++ API]}}
+===Code Snippets===
+When programming in C/C++, you're in luck.  All of our code snippet examples on our [[General Phidget Programming]] page are in both C++ and Java.  Therefore, we do not include any here, because that page is much more in-depth, and you won't have to have two pages open at once.  So head over there, and start writing code!
+===C++ Events===
+If you want to use C++ style, object-oriented events you can do that as well.  The following examples show you how to do this:
+*[{{SERVER}}/docs21/images/0/05/Simple.cpp Main]
+*[{{SERVER}}/docs21/images/1/11/Simple.h Header]
 ==Common Problems and Solutions/Workarounds==
-Here you can put various frequent problems and our recommended solutions.
+===Issue: I am using a non US-English version of Windows, and the Visual C/C++ examples run into a linker error===
+Affected Operating Systems: '''Windows'''
+The example projects, by default finds the {{Code|phidget21.h}} and {{Code|phidget21.lib}} in ${SystemDrive}\Program Files\Phidgets. If you are using a non US-English version of Windows, the Phidget drivers may be installed into a different location. To resolve, you will have to modify the paths to these two files. For instructions, please see your environment/compiler section.

Language - C: Difference between revisions

Latest revision as of 15:34, 18 September 2017

Introduction

Quick Downloads

Documentation

Example Code

Libraries and Drivers

Getting started with C/C++

Windows (XP/Vista/7/8)

Description of Library Files

Visual Studio

Visual Studio 2005/2008/2010

Use Our Examples

Write Your Own Code

Visual Studio 2003

Use Our Examples

Write Your Own Code

Visual Studio C++ 6.0

Use Our Examples

Write Your Own Code

Borland

Use Our Examples

Write Your Own Code

GCC on Windows

Cygwin/MinGW

Use Our Examples

Write Your Own Code

Dev C++

Use Our Examples

Write Your Own Code

Code::Blocks

Use Our Examples

Write Your Own Code

OS X

Use Our Examples

Write Your Own Code

Linux

Use Our Examples

Write Your Own Code

Windows CE

Description of Library Files

Visual Studio 2005/2008/2010

Use Our Examples

Write Your Own Code

Follow the Examples

Example Flow

Code Snippets

C++ Events

Common Problems and Solutions/Workarounds

Issue: I am using a non US-English version of Windows, and the Visual C/C++ examples run into a linker error

Navigation menu