Language - C: Difference between revisions

From Phidgets Support
 
(559 intermediate revisions by 12 users not shown)
Line 1: Line 1:
__TOC__
{{#seo:|description=Learn how to use Phidget USB devices with C and C++.}}
[[Category:Language]]


==Support==
== Get Started ==
With the Phidget22 library, it's easy to create C or C++ applications that work with Phidget devices.


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]].
== C Libraries ==
If you've installed the Phidget drivers for [[OS - Windows|Windows]], [[OS - macOS|MacOS]], or [[OS - Linux|Linux]], then you already have the files you need for your C project.  


'''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.
==== Windows Considerations ====
When adding directories for your project dependencies, add
<syntaxhighlight>
C:/Program Files/Phidgets/Phidget22
</syntaxhighlight>
And for the linker, you can add
<syntaxhighlight>
C:/Program Files/Phidgets/Phidget22/phidget22.lib}}    #(for 64-bit systems)
C:/Program Files/Phidgets/Phidget22/x86/phidget22.lib}} #(for 32-bit systems)
</syntaxhighlight>


C/C++ can be developed with various Windows compilers (including Borland), Mac OSX, and Linux.
==== MacOS Considerations ====
The Phidget framework will be found in
<syntaxhighlight>
/Library/Frameworks
</syntaxhighlight>
And the headers can be found in
<syntaxhighlight>
/Library/Frameworks/Phidget22.framework/Headers
</syntaxhighlight>


==Quick Downloads==
====Linux Considerations====
Linux restricts access to USB devices to the root user.


Just need the C/C++ drivers, libraries, and examples?  Here they are:
To run your C application as a regular user, you'll need to [{{SERVER}}/docs/OS_-_Linux#Setting_udev_Rules set up udev rules] on your system.


C/C++ API Documentation:
=== Library Files ===
*[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)]
If you would like to manually manage the Phidget22 library files, you can download them [https://cdn.phidgets.com/downloads/phidget22/libraries/windows/Phidget22-windevel.zip here].
*[[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:
== Development Environment Configuration ==
*[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:
=== GCC ===
*[http://www.phidgets.com/downloads/libraries/phidget21-x86_2.1.8.20110615.zip 32 bit Windows (drivers, with libraries)]
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
*[http://www.phidgets.com/downloads/libraries/phidget21-x64_2.1.8.20110615.zip 64 bit Windows (drivers, with libraries)]
|+ '''Instructions'''
*[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]])
The most common tool for C development is GCC, whether used in the command line or through an IDE. GCC is packaged with many other IDEs and packages, so you may already have it installed.
*[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)==
{{hiddenh4|Windows}}
We recommend installing [https://www.cygwin.com/ Cygwin] or [https://sourceforge.net/projects/mingw/ MinGW], ensuring you select all gcc packages when prompted by the installer. 


===Running the Examples===
To compile your code, go to the folder where your code is and open the command prompt by typing 'cmd' in the address bar.


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:
The specific command you will use depends on your compiler of choice:
<syntaxhighlight lang=bash>
#Cygwin x86:
gcc example.c -o example -I"/cygdrive/c/Program Files/Phidgets/Phidget22"-L"/cygdrive/c/Program Files/Phidgets/Phidget22/x86" -lphidget22


*[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Reference]
#Cygwin x64:
*[http://www.phidgets.com/downloads/examples/VCpp_2.1.8.20111028.zip Microsoft Visual C/C++ Examples]
gcc example.c -o example -I"/cygdrive/c/Program Files/Phidgets/Phidget22" -L"/cygdrive/c/Program Files/Phidgets/Phidget22" -lphidget22
*[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:
#MinGW:
* Make sure your libraries are properly linked
gcc example.c -o example -I"C:/Program Files/Phidgets/Phidget22" -L"C:/Program Files/Phidgets/Phidget22/x86" -lphidget22
* Go from source code to a test application as quickly as possible
</syntaxhighlight>


The Phidget examples were written using Visual C++ 2005. They also work well in other, similar environments such as Visual Studio.
After running the commands above for either Cygwin or MinGW, an executable file called example.exe will be created. Enter the following command to run the program:
<syntaxhighlight lang=bash>
example.exe
</syntaxhighlight>
{{hiddenh4|MacOS}}
If you don't already have gcc installed, you can get it by installing [https://developer.apple.com/xcode/ Xcode].


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.
To compile the program, enter the following command in the terminal, substituting "example" for the name of your C file:
<syntaxhighlight lang=bash>
gcc example.c -o example -F /Library/Frameworks -framework Phidget22 -I /Library/Frameworks/Phidget22.framework/Headers
</syntaxhighlight>
Finally, run the program by entering the following command in the terminal:
<syntaxhighlight lang=bash>
./example
</syntaxhighlight>
Success! The project is now running with Phidgets.


===Following the Examples===
{{hiddenh4|Linux}}
On Linux, gcc is installed through the package manager:
<syntaxhighlight lang=bash>
apt-get install gcc
</syntaxhighlight>
To compile the program, enter the following command in the terminal, substituting "example" for the name of your C file:
<syntaxhighlight lang=bash>
gcc example.c -o example -lphidget22
</syntaxhighlight>
After compiling, you can run the program by entering the following command in the terminal:
<syntaxhighlight lang=bash>
./example
</syntaxhighlight>
Success! The project is now running with Phidgets.
|-
|}


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.
=== Visual Studio ===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
| If you want to jump right into a pre-configured project, you can download one on our [https://www.phidgets.com/?view=code_samples&lang=C Code Sample Generator] page. || [[Image:Language_C_VSProject.jpg|center|link=https://cdn.phidgets.com/docs/images/f/f1/Language_C_VSProject.jpg|350px]]
|-
| To configure a new project, follow these steps. ||
|-
| First, create a new Win32 Console Application: || [[Image:Language_C_VS_step1.jpg|center|link=https://cdn.phidgets.com/docs/images/a/a1/Language_C_VS_step1.jpg|350px]]
|-
| If you are using a 64-bit machine, select x64, otherwise, select x86: || [[Image:Language_C_VS_step2.jpg|center|link=https://cdn.phidgets.com/docs/images/6/6b/Language_C_VS_step2.jpg|350px]]
|-
| Next, right click on the source folder and click New Item: || [[Image:Language_C_VS_step3.jpg|center|link=https://cdn.phidgets.com/docs/images/e/e1/Language_C_VS_step3.jpg|350px]]
|-
| Give the source file a name and click Add: || [[Image:Language_C_VS_step4.jpg|center|link=https://cdn.phidgets.com/docs/images/e/e5/Language_C_VS_step4.jpg|350px]]
|-
| Right click your project and access its properties: || [[Image:Language_C_VS_step5.jpg|center|link=https://cdn.phidgets.com/docs/images/1/1e/Language_C_VS_step5.jpg|350px]]
|-
| Go to Configuration Properties -> C/C++ -> General and add this to the additional include directories:
<syntaxhighlight>
C:\Program Files\Phidgets\Phidget22
</syntaxhighlight>
|| [[Image:Language_C_VS_step6.jpg|center|link=https://cdn.phidgets.com/docs/images/d/d3/Language_C_VS_step6.jpg|350px]]
|-
| Go to Configuration Properties -> Linker -> Input and add the appropriate line to additional dependencies:
<syntaxhighlight>
C:\Program Files\Phidgets\Phidget22\phidget22.lib #(for 64-bit systems)
C:\Program Files\Phidgets\Phidget22\x86\phidget22.lib #(for 32-bit systems)
</syntaxhighlight>
|| [[Image:Language_C_VS_step7.jpg|center|link=https://cdn.phidgets.com/docs/images/0/09/Language_C_VS_step7.jpg|350px]]
|-
| Lastly, include the Phidget library at the beginning of your program:
<syntaxhighlight lang=bash>
#include < phidget22.h >
</syntaxhighlight>
||
|-
|}


The examples for each device all have this general structure so you can follow along:
=== PhidgetSBC Web Interface ===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+'''Instructions'''
|<center>{{#ev:youtube|2hTlVexctqY|rel=0}}</center>
|}


{{ExamplePseudocode}}
== Example Code ==
Navigate to our [https://www.phidgets.com/?view=code_samples&lang=C Code Sample Generator] to view and download code samples that are tailored to your specific device.


==Writing Your Own Code (Windows)==
[[Image:Language_c_codesample2.png|center|600px|link=]]


*[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Reference]
===Phidget Programming Basics===
*[[General API]] (more help on functions common to all Phidgets)
{{PhidgetProgrammingBasicsLink}}
*[[Device List | Device Specific APIs]] (more help on functions specific to your Phidget)


You can use a Phidget in code by essentially by:
==API==
# Opening it,
[{{SERVER}}/?view=api&lang=C Phidget22 API]
# 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 with writing 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 libraries as you would any project on your specific compiler.
 
==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]
 
{{Template:UsingAPhidgetInCodeGeneral|both of which are available in C/C++|[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API]}}
 
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.

Latest revision as of 20:03, 12 March 2026


Get Started

With the Phidget22 library, it's easy to create C or C++ applications that work with Phidget devices.

C Libraries

If you've installed the Phidget drivers for Windows, MacOS, or Linux, then you already have the files you need for your C project.

Windows Considerations

When adding directories for your project dependencies, add 

C:/Program Files/Phidgets/Phidget22

And for the linker, you can add 

C:/Program Files/Phidgets/Phidget22/phidget22.lib}}     #(for 64-bit systems)
C:/Program Files/Phidgets/Phidget22/x86/phidget22.lib}} #(for 32-bit systems)

MacOS Considerations

The Phidget framework will be found in 

/Library/Frameworks

And the headers can be found in 

/Library/Frameworks/Phidget22.framework/Headers

Linux Considerations

Linux restricts access to USB devices to the root user.

To run your C application as a regular user, you'll need to set up udev rules on your system.

Library Files

If you would like to manually manage the Phidget22 library files, you can download them here.

Development Environment Configuration

GCC

Instructions

The most common tool for C development is GCC, whether used in the command line or through an IDE. GCC is packaged with many other IDEs and packages, so you may already have it installed.

Windows

We recommend installing Cygwin or MinGW, ensuring you select all gcc packages when prompted by the installer.

To compile your code, go to the folder where your code is and open the command prompt by typing 'cmd' in the address bar.

The specific command you will use depends on your compiler of choice: 

#Cygwin x86:
gcc example.c -o example -I"/cygdrive/c/Program Files/Phidgets/Phidget22"-L"/cygdrive/c/Program Files/Phidgets/Phidget22/x86" -lphidget22

#Cygwin x64:
gcc example.c -o example -I"/cygdrive/c/Program Files/Phidgets/Phidget22" -L"/cygdrive/c/Program Files/Phidgets/Phidget22" -lphidget22

#MinGW:
gcc example.c -o example -I"C:/Program Files/Phidgets/Phidget22" -L"C:/Program Files/Phidgets/Phidget22/x86" -lphidget22

After running the commands above for either Cygwin or MinGW, an executable file called example.exe will be created. Enter the following command to run the program: 

example.exe
MacOS

If you don't already have gcc installed, you can get it by installing Xcode.

To compile the program, enter the following command in the terminal, substituting "example" for the name of your C file: 

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

Finally, run the program by entering the following command in the terminal: 

./example

Success! The project is now running with Phidgets.

Linux

On Linux, gcc is installed through the package manager: 

apt-get install gcc

To compile the program, enter the following command in the terminal, substituting "example" for the name of your C file: 

gcc example.c -o example -lphidget22

After compiling, you can run the program by entering the following command in the terminal: 

./example

Success! The project is now running with Phidgets.

Visual Studio

Instructions
If you want to jump right into a pre-configured project, you can download one on our Code Sample Generator page.
Language C VSProject.jpg
To configure a new project, follow these steps.
First, create a new Win32 Console Application:
Language C VS step1.jpg
If you are using a 64-bit machine, select x64, otherwise, select x86:
Language C VS step2.jpg
Next, right click on the source folder and click New Item:
Language C VS step3.jpg
Give the source file a name and click Add:
Language C VS step4.jpg
Right click your project and access its properties:
Language C VS step5.jpg
Go to Configuration Properties -> C/C++ -> General and add this to the additional include directories: 
C:\Program Files\Phidgets\Phidget22
Language C VS step6.jpg
Go to Configuration Properties -> Linker -> Input and add the appropriate line to additional dependencies: 
C:\Program Files\Phidgets\Phidget22\phidget22.lib #(for 64-bit systems)
C:\Program Files\Phidgets\Phidget22\x86\phidget22.lib #(for 32-bit systems)
Language C VS step7.jpg
Lastly, include the Phidget library at the beginning of your program: 
#include < phidget22.h >

PhidgetSBC Web Interface

Instructions

Example Code

Navigate to our Code Sample Generator to view and download code samples that are tailored to your specific device.

Language c codesample2.png

Phidget Programming Basics

To learn more about the structure of the example code, visit our Phidget Programming Basics guide.

API

Phidget22 API

Retrieved from "https://www.phidgets.com/docs/index.php?title=Language_-_C&oldid=35464"