Language - C

From Phidgets Support
Revision as of 14:53, 19 October 2011 by Mparadis (talk | contribs) (→‎Support)

Preamble about the language and its general strengths and weaknesses.

Assessment for use with Phidgets

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

C/C++ has a complete API and sample code for all Phidgets devices.

For a complete list of our supported languages and their support status, click here

Restrictions

In this section, list any restrictions or limitations that this particular language may impose. For example, incompatibility with certain operating systems.

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.

Drivers, Libraries and Resources

Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website. Visit the drivers section at www.phidgets.com and get the latest:

You will need the Phidget Framework to use and to program with Phidgets. We also recommend that you download the following reference materials:

You may want to have these pages open while working through these instructions.

Getting Started (Windows)

The Phidget examples were written using Visual C++ 2005 and this tutorial assumes its use. 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.

Coding For Your Phidget

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

  #include "phidget21.h"

Afterwards, the Phidget object will need to be declared and then initialized. For example, we can declare a PhidgetInterfaceKit inside our main function with: 

  int _tmain(int argc, _TCHAR* argv[])
  {
     CPhidgetInterfaceKitHandle ifKit = 0; //Declare an InterfaceKit handle
     CPhidgetInterfaceKit_create(&ifKit);  //Create the InterfaceKit object
   
     //More code goes here
     return 0;
  }

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.

Connecting to the Phidget

Next, the program needs to try and connect to the Phidget through an open call. 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. 

  CPhidget_open((CPhidgetHandle)ifKit, -1);
  CPhidget_waitForAttachment((CPhidgetHandle)ifKit, 2500);

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

  CPhidget_close((CPhidgetHandle)ifKit);
  CPhidget_delete((CPhidgetHandle)ifKit);

Event Driven Programming

We recommend the use of event driven programming when working with Phidgets. In C/C++, we hook an event handler with the following code: 

  CPhidgetInterfaceKit_set_OnSensorChange_Handler (ifKit, SensorChangeHandler, NULL);
  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;
  }

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

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. 

  int val;
  for (int i = 0; i < 10; i++) {
     CPhidgetInterfaceKit_getSensorValue(phid, 0, &val);
     printf("Value: %d\n", val);
  }

The functions can be used inside a polling loop as an alternative to event driven programming. Above, a sensor attached to the PhidgetInterfaceKit is read and its value is displayed to screen.

Working with multiple Phidgets

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

The design given in this document can also be followed for almost all Phidgets. 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)

Coding For Your Phidget

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

  #include <phidget21.h>

Afterwards, the Phidget object will need to be declared and then initialized. For example, we can declare a PhidgetInterfaceKit inside our main function with: 

  int main(int argc, char* argv[])
  {
    CPhidgetInterfaceKitHandle ifKit = 0;
    CPhidgetInterfaceKit_create(&ifKit);
    //More code goes here
    return 0;
  }

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.

Connecting to the Phidget

Next, the program needs to try and connect to the Phidget through an open call. 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. 

  CPhidget_open((CPhidgetHandle)ifKit, -1);
  CPhidget_waitForAttachment((CPhidgetHandle)ifKit, 10000);

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

  CPhidget_close((CPhidgetHandle)ifKit);
  CPhidget_delete((CPhidgetHandle)ifKit);

Event Driven Programming

We recommend the use of event driven programming when working with Phidgets. In C/C++, we hook an event handler with the following code: 

  CPhidgetInterfaceKit_set_OnSensorChange_Handler (ifKit, SensorChangeHandler, NULL);
  int SensorChangeHandler(CPhidgetInterfaceKitHandle IFK, void *usrptr, int
  Index, int Value)
  {
    printf("Sensor: %d > Value: %d\n", Index, Value);
    return 0;
  }

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

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. 

  int val;
  for (int i = 0; i < 10; i++) {
    CPhidgetInterfaceKit_getSensorValue(phid, 0, &val);
    printf("Value: %d\n", val);
  }

The functions can be used inside a polling loop as an alternative to event driven programming. Above, a sensor attached to the PhidgetInterfaceKit is read and its value is displayed to screen.

Working with multiple Phidgets

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

The design given in this document can also be followed for almost all Phidgets. 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

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.

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