|
|
| (551 intermediate revisions by 12 users not shown) |
| Line 1: |
Line 1: |
| __TOC__
| | __NOTOC__ |
| | [[Category:Language]] |
| | We provide support for the C language in all major operating systems. We also provide instructions on how to get your project started in a number of common development environments. Select your operating system and preferred development environment below, and follow the instructions to get your project running with Phidgets. |
|
| |
|
| ==Support==
| | If you do not know which development environment you want to use, or your development environment of choice is not listed, we recommend starting with GCC as the simplest path to getting your code running. |
|
| |
|
| 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 [[Software Overview#Language Support | supported languages]].
| | Once you have set up your development environment to run with Phidgets, we recommend you follow our guide on [[Phidget Programming Basics]]. The guide will showcase the fundamentals of programming with Phidgets, with examples in C. |
|
| |
|
| '''If this is your first time''' working with a Phidget, we suggest starting with the ''Getting Started'' page for your [[Device List | 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.
| | ==Choose Your Development Environment:== |
|
| |
|
| C/C++ can be developed with various Windows compilers (including Borland), Mac OSX, and Linux.
| | {{Language_-_C_Dev_Environment_Table}} |
|
| |
|
| ==Quick Downloads== | | == Quick Downloads == |
|
| |
|
| Just need the C/C++ drivers, libraries, and examples? Here they are:
| | If you already know what you're doing and just need the files, you can find them all below. |
|
| |
|
| C/C++ API Documentation:
| | === Documentation === |
| *[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Manual Download] or [http://www.phidgets.com/documentation/web/cdoc/index.html (HTML online version)]
| |
| *[[General API]] (more help on functions common to all Phidgets)
| |
| *[[Device List | Device Specific APIs]] (more help on functions specific to your Phidget)
| |
|
| |
|
| C/C++ Example Code:
| | *{{Phidget22API}} (select C from the drop-down menu) |
| *[http://www.phidgets.com/downloads/examples/VCpp_2.1.8.20110615.zip C/C++ Example Code for Windows] | |
| *[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20110615.tar.gz C/C++ Example Code for Linux/MacOS]
| |
|
| |
|
| Libraries and Drivers:
| | === Example Code === |
| *[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip 32 bit Windows (drivers, with libraries)]
| |
| *[http://www.phidgets.com/downloads/libraries/phidget21-x64_2.1.8.20110615.zip 64 bit Windows (drivers, with libraries)]
| |
| *[http://www.phidgets.com/downloads/libraries/phidget21bcc_2.1.8.20110615.zip Borland C++ Libraries] (You also need one of the two Windows drivers above)
| |
| *[http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20111028.tar.gz General Linux Libraries] ([[OS - Linux | Linux Library Setup Instructions]])
| |
| *[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20111103.dmg General Mac OSX Libraries] ([[OS - Mac OSX | Mac OSX Library Setup Instructions]])
| |
|
| |
|
| ==Getting Started (Windows)==
| | *{{SampleCode|C|C Examples}} |
|
| |
|
| ===Running Examples=== | | ===Libraries=== |
|
| |
|
| 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:
| | {{AllQuickDownloads}} |
| | |
| *[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Reference]
| |
| *[http://www.phidgets.com/downloads/examples/VCpp_2.1.8.20111028.zip Microsoft Visual C/C++ Examples]
| |
| *[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz Standard C/C++ Examples]
| |
| | |
| 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 common 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 Developing Code section below for your specific compiler.
| |
| | |
| ===Following 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.
| |
| | |
| The examples for each device all have this general structure so you can follow along:
| |
| | |
| {{ExamplePseudocode}} | |
| | |
| ==Writing Your Own Code (Windows)==
| |
| | |
| *[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Reference]
| |
| *[[General API]] (more help on functions common to all Phidgets)
| |
| *[[Device List | Device Specific APIs]] (more help on functions specific to your Phidget)
| |
| | |
| You can use a Phidget in code by essentially by:
| |
| # Opening it,
| |
| # Setting it up,
| |
| # Doing things with it (like reading data), and
| |
| # Closing it.
| |
| | |
| These steps are generally outlined for all devices and languages on the [[General Phidget Programming]] page, and demonstrated in the examples above. The [[General Phidget Programming]] page also introduces using the Phidget in an event-driven manner and in a traditional manner, both of which are available in C/C++.
| |
| | |
| The ''complete'' set of functions you have available for all Phidgets can be found in the [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API].
| |
| | |
| If you are looking for more information about a particular function, we provide that as well. You can find more description on any function either in:
| |
| # Our [[General API|API Overview]] which describes the set of calls common to all Phidgets, or
| |
| # The [[Device List|Device API]] page for calls available only on your specific Phidget.
| |
| | |
| {{ContentNeeded|These Windows sections below need additional information}}
| |
| | |
| ===General Windows Library Setup===
| |
| | |
| *[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip 32 bit Windows (drivers, with libraries)]
| |
| *[http://www.phidgets.com/downloads/libraries/phidget21-x64_2.1.8.20110615.zip 64 bit Windows (drivers, with libraries)]
| |
| | |
| 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:
| |
| | |
| <div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
| |
| <font size="3">
| |
| <source lang=cpp>
| |
| | |
| #include "phidget21.h"
| |
| | |
| </source>
| |
| </font>
| |
| </div>
| |
| | |
| ===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 [[Device List | for your device]]:
| |
| *[http://www.phidgets.com/downloads/libraries/phidget21bcc_2.1.8.20110615.zip Borland C++ Libraries]
| |
| | |
| ===Creating Your Project===
| |
| | |
| With the libraries linked properly in your compiler, you can consult the following resources for help designing your code:
| |
| | |
| C/C++ API Documentation:
| |
| *[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Manual Download] or [http://www.phidgets.com/documentation/web/cdoc/index.html (HTML online version)]
| |
| *[[General API]] (more help on functions common to all Phidgets)
| |
| *[[Device List | Device Specific APIs]] (more help on functions specific to your Phidget)
| |
| | |
| * The page with [[General Phidget Programming | general programming concepts]] for Phidgets
| |
| | |
| Build and compile your project with the properly linked
| |
| | |
| ==Getting Started (MacOS/Linux)==
| |
| | |
| ===Setting up the Libraries===
| |
| | |
| Before you can use the Phidget, you must include a reference to the library header.
| |
| | |
| <div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
| |
| <font size="3">
| |
| <source lang=cpp>
| |
| | |
| #include <phidget21.h>
| |
| | |
| </source>
| |
| </font>
| |
| </div>
| |
| | |
| 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:
| |
| | |
| <div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
| |
| <font size="3">
| |
| <source lang=cpp>
| |
| | |
| int main(int argc, char* argv[])
| |
| {
| |
| CPhidgetInterfaceKitHandle device = 0;
| |
| CPhidgetInterfaceKit_create(&device);
| |
| //More code goes here
| |
| return 0;
| |
| }
| |
| | |
| </source>
| |
| </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.
| |
| | |
| ==Developing Code (Mac OSX/Linux)==
| |
| | |
| ===Running 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:
| |
| | |
| *[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Reference]
| |
| *[http://www.phidgets.com/downloads/examples/VCpp_2.1.8.20111028.zip Microsoft Visual C/C++ Examples]
| |
| *[http://www.phidgets.com/downloads/examples/phidget21-c-examples_2.1.8.20111028.tar.gz Standard C/C++ Examples]
| |
| | |
| To run the example code, you'll need to find the source code ''for your specific device''. Then, compile the code under your platform and run it. 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
| |
| | |
| ===Writing Your Own Code===
| |
| | |
| *[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Reference]
| |
| | |
| You can use a Phidget in code by essentially by:
| |
| # Opening it,
| |
| # Setting it up,
| |
| # Doing things with it (like reading data), and
| |
| # Closing it.
| |
| | |
| These steps are generally outlined for all devices and languages on the [[General Phidget Programming]] page. The [[General Phidget Programming]] page also introduces using the Phidget in an event-driven manner or in a traditional manner, both of which are available in C/C++.
| |
| | |
| The ''complete'' set of functions you have available for all Phidgets can be found in the [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API].
| |
| | |
| If you are looking for more information about a particular function, we provide that as well. You can find more description on any function either in:
| |
| # Our [[General API|API Overview]] which describes the set of calls common to all Phidgets, or
| |
| # The [[Device List|Device API]] page for calls available only on your specific Phidget.
| |
| | |
| ===Compiling Your Program===
| |
| | |
| Compiling and linking against the Phidgets Library can be done in the following ways:
| |
| | |
| *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
| |
| | |
| ==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.
| |
| | |
| {{ContentNeeded|This section may or may not be covered in the different compilers section in the Getting Started (Windows) section above. If it can be covered by a combination of the Getting Started section above, and the Common Problems section below, delete this section...}}
| |
| | |
| ==Common Problems and Solutions/Workarounds==
| |
| | |
| Here you can put various frequent problems and our recommended solutions.
| |
Windows
macOS
Linux
Phidget SBC Linux
