Language - C: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
Line 31: Line 31:
==Getting Started (Windows)==
==Getting Started (Windows)==


===Running the Examples===
===Run The Examples===


A good way to learn to use Phidgets is to run and modify existing examples.  You can find the C/C++ API and example code here:
A good way to learn to use Phidgets is to run and modify existing examples.  You can find the C/C++ API and example code here:
Line 47: Line 47:
Specific setup for many other compilers is covered below.  Often, you can just import the example as an existing project, but if you are having trouble it might help to read the '''Writing Your Own Code''' section below for your specific compiler.
Specific setup for many other compilers is covered below.  Often, you can just import the example as an existing project, but if you are having trouble it might help to read the '''Writing Your Own Code''' section below for your specific compiler.


===Following the Examples===
===Follow The Examples===
 
You can learn about the flow within the examples by reading about [[General Phidget Programming]], which will walk you through the concepts in each example, regardless of your device or language.
 
The examples for each device all have this general structure so you can follow along:


{{ExamplePseudocode}}
{{ExamplePseudocode}}


==Writing Your Own Code (Windows)==
==Write Your Own Code (Windows)==


{{UsingAPhidgetInCodeGeneral|both of which are available in C/C++|[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API]}}
{{UsingAPhidgetInCodeGeneral|both of which are available in C/C++|[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API]}}
Line 100: Line 96:
*[http://www.phidgets.com/downloads/libraries/phidget21bcc_2.1.8.20110615.zip Borland C++ Libraries]
*[http://www.phidgets.com/downloads/libraries/phidget21bcc_2.1.8.20110615.zip Borland C++ Libraries]


===Creating Your Project===
===Create and Build Your Project===


With the libraries linked properly in your compiler, you can consult the following resources for help with writing code:
With the libraries linked properly in your compiler, you can consult the following resources for help with writing code:
Line 113: Line 109:
==Getting Started (MacOS/Linux)==
==Getting Started (MacOS/Linux)==


===Running Examples===
===Run The Examples===


One good way to start developing your application is to run and modify existing examples.  You can find the C/C++ API and example code here:
One good way to start developing your application is to run and modify existing examples.  You can find the C/C++ API and example code here:
Line 124: Line 120:
* Go from source code to a test application as quickly as possible
* Go from source code to a test application as quickly as possible


Compiling and linking against the Phidgets Library for the example code can be done in the following ways, during compile:
Compiling and linking against the Phidgets Library for the example code can be done in the following ways:


To build on Linux:
To build on Linux:
Line 146: Line 142:
</div>
</div>


===Follow The Examples===
{{ExamplePsuedocode}}


===Setting up the Libraries===
===Setting up the Libraries===
Line 161: Line 160:
</div>
</div>


Afterwards, the Phidget object will need to be declared and then initialized. For example, we can declare a software object to use a [[Product - 1018 - PhidgetInterfaceKit 8/8/8 | Phidget Interface Kit]] inside our main function with:
This assumes that the compiled libraries has been set up properly.
* To set them up on Mac OSX, follow the ''Getting Started'' page for [[Device List | your specific device]]
* To set them up on Linux, compile and install them as explained on the main [[OS - Linux | Linux page]]


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
==Write Your Own Code (Mac OSX/Linux==
<font size="3">
<source lang=cpp>


  int main(int argc, char* argv[])
{{UsingAPhidgetInCodeGeneral|both of which are available in C/C++|[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API]}}
  {
    CPhidgetInterfaceKitHandle device = 0;
    CPhidgetInterfaceKit_create(&device);
    //More code goes here
    return 0;
  }


</source>
===Create and Build Your Project===
</font>
</div>


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.
With the libraries linked properly in your compiler, you can consult the following resources for help with writing code:
*[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Manual Download] or [http://www.phidgets.com/documentation/web/cdoc/index.html (HTML online version)]
*[[General API]] (more help on functions common to all Phidgets)
*[[Device List | Device Specific APIs]] (more help on functions specific to your Phidget)


==Developing Code (Mac OSX/Linux)==
* The page with [[General Phidget Programming | general programming concepts]] for Phidgets




===Writing Your Own Code===
Compiling and linking against the Phidgets Library for the example code can be done in the following ways:


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


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


Compiling and linking against the Phidgets Library can be done in the following ways:
To build on MacOS (for example, depending on the Headers location):
 
*To build on Linux:
:gcc example.c -o example -lphidget21
*To build on MacOS:
:gcc example.c -o example -framework Phidget21 -
:I/Library/Frameworks/Phidget21.framework/Headers


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



Revision as of 18:49, 14 November 2011

Support

C/C++ has a complete API and sample code for all Phidgets devices. You can also view a complete list of the status for our supported languages.

If this is your first time working with a Phidget, we suggest starting with the Getting Started page for your specific 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++ can be developed with various Windows compilers (including Borland), Mac OSX, and Linux.

Quick Downloads

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

C/C++ API Documentation:

C/C++ Example Code:

Libraries and Drivers:

Getting Started (Windows)

Run The Examples

A good way to learn to use Phidgets is to run and modify existing examples. You can find the C/C++ API and example code here:

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

  • Make sure your libraries are properly linked
  • Go from source code to a test application as quickly as possible

The Phidget examples were written using Visual C++ 2005. They also work well in other, similar environments such as Visual Studio.

Specific setup for many other compilers is covered below. Often, you can just import the example as an existing project, but if you are having trouble it might help to read the Writing Your Own Code section below for your specific compiler.

Follow The Examples

Template:ExamplePseudocode

Write Your Own Code (Windows)

Template:UsingAPhidgetInCodeGeneral


Template:ContentNeeded

General Windows Library Setup

In addition to actually creating code to drive your Phidget, you will also need to properly link the Phidget C/C++ libraries, which are included with the drivers above. Most compilers provide their own documentation on how to link external libraries. (Note that for Borland, you'll need a different library, which you can find in the Borland section below).

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

  #include "phidget21.h"

Visual C++ 2005 Library Setup

To link 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 you are ready to begin coding.

Borland C/C++ Library Setup

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:

Create and Build Your Project

With the libraries linked properly in your compiler, you can consult the following resources for help with writing code:

Build and compile your project with the properly linked libraries as you would any project on your specific compiler.

Getting Started (MacOS/Linux)

Run The Examples

One good way to start developing your application is to run and modify existing examples. You can find the C/C++ API and example code here:

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. This will allow you to:

  • Make sure your libraries are properly linked, as above
  • Go from source code to a test application as quickly as possible

Compiling and linking against the Phidgets Library for the example code can be done in the following ways:

To build on Linux:

  gcc example.c -o example -lphidget21

To build on MacOS (for example, depending on the Headers location):

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

Follow The Examples

Template:ExamplePsuedocode

Setting up the Libraries

Before you can use the Phidget, you must include a reference to the library header.

  #include <phidget21.h>

This assumes that the compiled libraries has been set up properly.

  • To set them up on Mac OSX, follow the Getting Started page for your specific device
  • To set them up on Linux, compile and install them as explained on the main Linux page

Write Your Own Code (Mac OSX/Linux

Template:UsingAPhidgetInCodeGeneral

Create and Build Your Project

With the libraries linked properly in your compiler, you can consult the following resources for help with writing code:


Compiling and linking against the Phidgets Library for the example code can be done in the following ways:

To build on Linux:

  gcc example.c -o example -lphidget21

To build on MacOS (for example, depending on the Headers location):

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

Building your Project

Describe the different ways a project could be built and packaged using this language.

Development Environments and Compilers

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.

Template:ContentNeeded

Common Problems and Solutions/Workarounds

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