Language - C: Difference between revisions

From Phidgets Support
 
(587 intermediate revisions by 12 users not shown)
Line 1: Line 1:
C/C++ has a complete API and sample code for all Phidgets devices. <br>
{{#seo:|description=Learn how to use Phidget USB devices with C and C++.}}
For a complete list of our supported languages and their support status, [[Levels of Support|click here]].
[[Category:Language]]


C/C++ can be developed with various Windows compilers, Mac OSX, and Linux.
== Get Started ==
With the Phidget22 library, it's easy to create C or C++ applications that work with Phidget devices.


==Development Environments and Compilers==
== 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.


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


==Drivers, Libraries and Resources==
====macOS Considerations====
Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.  
Legacy Phidgets running a HID USB stack require a driver extension (macOS 10.15 and newer) or a kernel extension (macOS 10.14 and earlier). During development, we recommend downloading the appropriate [https://www.phidgets.com/docs/OS_-_macOS#Quick_Downloads package] which will install the extension. When deploying applications, review the README in the [https://cdn.phidgets.com/downloads/phidget22/libraries/macos/Phidget22_macosdevel.zip macOS Development Files] for information about bundling the extension with your application.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
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 Download]
* [http://www.phidgets.com/documentation/web/cdoc/index.html API Manual Online]
* Example 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 32 bit Windows]
**[http://www.phidgets.com/downloads/libraries/phidget21-x64_2.1.8.20110615.zip 64 bit Windows]
**[http://www.phidgets.com/downloads/libraries/phidget21bcc_2.1.8.20110615.zip Borland C++]
**[http://www.phidgets.com/downloads/libraries/libphidget_2.1.8.20111028.tar.gz Linux] ([[OS - Linux | Setup]])
**[http://www.phidgets.com/downloads/libraries/Phidget_2.1.8.20111103.dmg Mac OSX] ([[OS - Mac OSX | Setup]])
* 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.
=====Determining USB Stack=====
To determine which USB stack your device is running, navigate to the product page and then to the specification tab, and look for the ''USB Stack'' specification. If you are using a VINT device, navigate to the product page for the VINT Hub you are using.


==Getting Started (Windows)==
[[Image:Javascript_networkserver_webusb_spec.png|center|600px|link=https://cdn.phidgets.com/docs/images/8/80/Javascript_networkserver_webusb_spec.png]]


The Phidget examples were written using Visual C++ 2005 and this tutorial assumes its use.
====Linux Considerations====
Other environments such as other versions of Visual Studio work as well and would be set up in a similar manner.
Linux restricts access to USB devices to the root user.  
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.
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.
* 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.
=== Library Files ===
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].


===Setting up the Libraries===
== Development Environment Configuration ==


Before you can use the Phidget, you must include a reference to the library header.
=== GCC ===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''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.


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
{{hiddenh4|Windows}}
<font size="3">
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. 
<source lang=cpp>


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


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


Afterwards, the Phidget object will need to be declared and then initialized.  
#Cygwin x64:
For example, we can declare a PhidgetInterfaceKit inside our main function with:
gcc example.c -o example -I"/cygdrive/c/Program Files/Phidgets/Phidget22" -L"/cygdrive/c/Program Files/Phidgets/Phidget22" -lphidget22


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
#MinGW:
<font size="3">
gcc example.c -o example -I"C:/Program Files/Phidgets/Phidget22" -L"C:/Program Files/Phidgets/Phidget22/x86" -lphidget22
<source lang=cpp>
</syntaxhighlight>


  int _tmain(int argc, _TCHAR* argv[])
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>
    CPhidgetInterfaceKitHandle ifKit = 0; //Declare an InterfaceKit handle
example.exe
    CPhidgetInterfaceKit_create(&ifKit);  //Create the InterfaceKit object
</syntaxhighlight>
 
{{hiddenh4|MacOS}}
    //More code goes here
If you don't already have gcc installed, you can get it by installing [https://developer.apple.com/xcode/ Xcode].
    return 0;
  }


</source>
To compile the program, enter the following command in the terminal, substituting "example" for the name of your C file:
</font>
<syntaxhighlight lang=bash>
</div>
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.


The object name for any type of Phidget is listed in the API manual.  
{{hiddenh4|Linux}}
Every type of Phidget also inherits functionality from the Phidget base class.
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 now have the libraries set up for either running the provided examples, or writing your own code, as below.
=== 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>
||
|-
|}


==Developing Code (Windows)==
=== PhidgetSBC Web Interface ===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+'''Instructions'''
|<center>{{#ev:youtube|2hTlVexctqY|rel=0}}</center>
|}


===Running Examples===
== 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.


*[http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API Reference]
[[Image:Language_c_codesample2.png|center|600px|link=]]
*[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]


One good way to start developing your application is to run and modify existing examples.
===Phidget Programming Basics===
{{PhidgetProgrammingBasicsLink}}


===Writing Your Own Code===
==API==
 
[{{SERVER}}/?view=api&lang=C Phidget22 API]
*[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, and closing it.  These steps are outlined at a high-level for all devices and languages on the [[General Phidget Programming]] page.
 
The complete set of functions you have available can be found in the [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API].  More description about parts of the API can be found in our [[General API|API Overview]] general to all devices, or, where the calls are specific to a device, on the [[Device List|Device API]] page.
 
==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 PhidgetInterfaceKit 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 ifKit = 0;
    CPhidgetInterfaceKit_create(&ifKit);
    //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===
 
===Writing Your Own Code===
 
You can use a Phidget in code by essentially by opening it, setting it up, doing things with it, and closing it.  These steps are outlined at a high-level for all devices and languages on the [[General Phidget Programming]] page.
 
The complete set of functions you have available can be found in the [http://www.phidgets.com/documentation/Phidget21_C_Doc.zip C/C++ API].  More description about parts of the API can be found in our [[General API|API Overview]] general to all devices, or, where the calls are specific to a device, on the [[Device List|Device API]] page for 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 using this language.
 
==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.

Latest revision as of 16:07, 20 April 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

Legacy Phidgets running a HID USB stack require a driver extension (macOS 10.15 and newer) or a kernel extension (macOS 10.14 and earlier). During development, we recommend downloading the appropriate package which will install the extension. When deploying applications, review the README in the macOS Development Files for information about bundling the extension with your application.

Determining USB Stack

To determine which USB stack your device is running, navigate to the product page and then to the specification tab, and look for the USB Stack specification. If you are using a VINT device, navigate to the product page for the VINT Hub you are using.

Javascript networkserver webusb spec.png

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