Language - Java: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
Line 1: Line 1:
[[File:icon-Java.png|64x64px]] Preamble about the language's origin and its main characteristics.
[[File:icon-CSharp.png|64x64px|link=Language - Java]]Java is a modern, object-oriented programming language developed by Oracle.


==Support==
__TOC__
Java has a complete API and code samples for all Phidgets devices.


For a complete list of our supported languages and their support status, [[Levels of Support|click here]].
==Introduction==


* 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.
{{LanguageSupport|Java|the complete Phidget API, including events|all Phidget devices.}}
* 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==
==Quick Downloads==
 
Just need the Java drivers, libraries, and examples?  Here they are:
 
Java API Documentation:
*[http://www.phidgets.com/documentation/JavaDoc.zip C# API Manual Download] or [http://www.phidgets.com/documentation/web/javadoc/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)
 
Java Example Code:
 
*[http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20111220.zip Java Example Code]
 
Libraries and Drivers:
*[http://www.phidgets.com/downloads/libraries/phidget21jar_2.1.8.20111220.zip phidget21.jar]
*[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 OS X | Mac OS X Library Setup Instructions]])
 
==Getting started with Java==
 
If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:
{{ExampleCodeReasons}}
 
Instructions are divided up by operating system. Choose:
*[[#Windows(2000/XP/Vista/7)|Windows 2000 / XP / Vista / 7]]
*[[#Mac OS X |Mac OS X]]
*[[#Linux | Linux]] (including PhidgetSBC)
 
==Windows(2000/XP/Vista/7)==


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.  
===Libraries===
*[http://www.phidgets.com/downloads/libraries/phidget21jar_2.1.8.20111220.zip phidget21.jar]


==Quick Downloads==
===Description===
Java programs on Windows depend on the following files, which the installers above put onto your system:
* <b><code>phidget21.dll</code></b> contains the actual Phidgets library, which is used at run-time.  If you used our installer, it's already correctly placed in <code>C:\Windows\System32</code>.  It can be manually installed - check our [[Manual Installation instructions]].
You will also need one of the following two files, depending on the .NET framework version you are targeting:
* <b><code>phidget21.jar</code></b> is the Phidgets library for Java runtime <i><b>2.0</b></i> or higher. Your compiler has to know where this file is. By default, our installer puts this file into <code>C:\Program Files\Phidgets</code>. So, you can either point your compiler to that location, or copy and link to it in a directory for your project workspace. For more information, please see the section for your specific compiler/environment. If you do not want to use our installer, you can get the file [[#Libraries | here]].
 
Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.
 
===Command line===
 
Please start by downloading the Java Examples.  The full examples were written in NetBeans. But Eclipse will easily open it.
*[http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20111220.zip Java Examples]


''For using Java in Android, please refer to the [[Language - Android Java]] page.''
=====Use Our Examples=====


Before you can run your program, you need to set up the proper environment and get the necessary files off the Phidgets website.
To run the examples, you first download them [[#Command line|from above]] and unpack them into a folder. To load all projects in Visual Studio, go to File | Open | Project, and open <code>AllExamples/AllExamples.sln</code> or <code>AllExamples/AllExamples_vs2008.sln</code> for Visual Studio 2005 and 2008, respectively.
Visit the drivers section at www.phidgets.com and get the latest:
* [http://www.phidgets.com/drivers.php Phidget Framework]
* [http://www.phidgets.com/downloads/libraries/phidget21jar_2.1.8.20110615.zip Phidget21.jar]
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/JavaDoc.zip API Manual]
* [http://www.phidgets.com/documentation/web/javadoc/index.html API Reference]
* [http://www.phidgets.com/downloads/examples/JavaJNI_2.1.8.20110615.zip Java Sample Code]
* 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.
If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.
<br/><br/>[[File:VS2005 Conversion Wizard.PNG]]<br/><br/>


==Getting Started (Windows, Linux, and Mac OS)==
This will load all of the examples available for C#, and then you can set your main project to be the one that matches your device.  If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]].


The Phidget full examples were written using NetBeans and this tutorial assumes its use.  
The only thing left to do is to run the examples! Click on Debug -> Start Debugging. Please note that the projects, by default try to find the <code>Phidget21.NET.dll</code> in the <code>C:\Program Files\Phidgets</code>. If you have it installed in another location, please change the path accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to <code>Phidget21.NET.dll</code>. Please see the [[#Write Your Own Code | next section]] for details.  
Other environments such as Eclipse work as well and would be set up in a similar manner.
<br/><br/>
For Java command line compilers, include the phidget21.jar during compilation.  
[[File:CSharp VS2005 Run.PNG ‎]]
For example, you can use “javac -classpath phidget21.jar MyPhidgetProgram.java” from the Java SDK.
<br/><br/>
In NetBeans, the Phidget .jar library can be added to the project from the project explorer window.  
Once you have the C# examples running, we have a [[#Follow The Examples|teaching section]] below to help you follow them.
Simply right click the “Libraries” item in the project explorer and then select “Add JAR/Folder”.  
Navigate to the location where the phidget21.jar was extracted and then add it to the project.
You are now ready to begin coding with Phidgets.


===Coding For Your Phidget===
=====Write Your Own Code=====


Before you can use the Phidget, you must include a reference in the code to the library. In Java:
When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your compiler / development environment to properly link the Phidget C# libraries. To begin:  


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
* Generate a new Visual C# Windows Applications project with a descriptive name such as PhidgetTest.
<font size="3">
<br/>[[File:CSharp VS2005 New Project.PNG ]]
<source lang=java>


  import com.phidgets.*;
<br/>
  import com.phidgets.event.*;


</source>
* Add a reference to the .NET Phidgets lilbrary.
</font>
<br/>[[File:CSharp VS2005 Add Reference.PNG ]]<br/>
</div>
* Under the .NET tab, select <code>Phidget21.NET.dll</code>.
If you used our installer, these files are installed in <code>C:\Program Files\Phidgets</code>, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.
<br/>[[File:CSharp VS2005 Add Reference 2.PNG ]]<br/><br/>


Now in the main body of code, the Phidget object will need to be declared.
Then, in your code, you will need to include the Phidget library:
For example, we can declare a PhidgetInterfaceKit with:


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<font size="3">
<source lang=java>
<source lang=cpp>
  using Phidgets;
  using Phidgets.Events;
  </source>
</font>
</div>
 
The project now has access to the Phidget21 function calls and you are ready to begin coding.


  static InterfaceKitPhidget ik;
The same [[#Follow The Examples|teaching section]] which describes the examples also has further resources for programming your Phidget.


</source>
===Netbeans===
</font>
</div>


The object name for any type of Phidget is listed in the API manual.  
This section will provide instructions on how to compile using the <code>mcs</code> compiler. Other compilers such as <code>gmcs</code>, <code>smcs</code>, and <code>dmcs</code> all work in the same way. Start by downloading the C# Examples.  
Every type of Phidget also inherits functionality from the Phidget base class.
*[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip C# Examples]
All Phidgets can throw PhidgetExceptions if something unexpected happens during operation.  
Make sure to catch or declare the exception, even in a generic way.  
This is what the main function looks like where we initialize the Phidget object without any constructors:


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
=====Use Our Examples=====
<font size="3">
<source lang=java>


  public static final void main(String args[]) throws Exception
Download the examples [[#MonoDevelop|from above]] and unpack them into a folder. Here, you can find example programs for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. Please only use the simple examples. The full examples uses Windows Forms, which Mono and the Gtk# toolkit are not completely compatible with. Locate the <code>Program.cs</code> file as this contains the example source code. Copy the file into your working directory, and rename it to <code>example.cs</code>.
  {
<br/>
    ik = new InterfaceKitPhidget();
  }


</source>
To compile and build an executable, run:
</font>
<br/>[[File:Mono Windows Compile.PNG]]<br/>
</div>


===Connecting to the Phidget===
If you have the <code>Phidget21.NET.dll</code> installed in another location, please change the path accordingly.


Next, the program needs to try and connect to the Phidget through an open call.  
Afterwards, you will have an executable named <code>example.exe</code> that you can run. Place the <code>Phidget21.NET.dll</code> in the same directory as the executable and type the following to run the program:
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.
<br/>[[File:Mono Windows Run.PNG]]<br/>
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.


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
Once you have the C# examples running, we have a [[#Follow The Examples|teaching section]] below to help you follow them.
<font size="3">
<source lang=java>


  ik.openAny();
=====Write Your Own Code=====
  ik.waitForAttachment();


</source>
When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your compiler / development environment to properly link the Phidget C# libraries. Please see the [[#Use Our Examples 3 | previous section]] for instructions.
</font>
</div>


The parameters can be used to open the first Phidget of a type it can find, open based on its serial number, or even open across the network.
In your code, you will need to include the Phidget library:
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.


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<font size="3">
<source lang=java>
<source lang=cpp>
  using Phidgets;
  using Phidgets.Events;
  </source>
</font>
</div>


  ik.close();
The project now has access to the Phidget21 function calls and you are ready to begin coding.
  ik = null;


</source>
The same [[#Follow The Examples|teaching section]] which describes the examples also has further resources for programming your Phidget.
</font>
</div>


===Event Driven Programming===
===Eclipse===


We recommend the use of event driven programming when working with Phidgets. In Java, we hook
Start by downloading the C# Examples. These examples were written in Visual Studio 2005 and 2008, but are also compatible with MonoDevelop.
an event handler with the following code:
*[http://www.phidgets.com/downloads/examples/CSharp_2.1.8.20110615.zip C# Eamples]


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
=====Use Our Examples=====
<font size="3">
<source lang=java>


  ik.addSensorChangeListener(new SensorChangeListener()
Download the examples [[#MonoDevelop|from above]] and unpack them into a folder. Here, you can find example programs for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the [[Device List | Getting Started guide for your device]]. If you are running under the .NET framework, you can use either the full or simple examples. Otherwise, if you are running under the Mono framework, please only use the simple examples. The full examples uses Windows Forms, which is not completely compatible with Mono's Gtk#.
  {
<br/>
      public void sensorChanged(SensorChangeEvent se)
      {
        //Insert your code here
        System.out.println(se.getValue());
      }
  });


</source>
To run the examples, you first download them from above and unpack them into a folder. To load all projects in MonoDevelop, go to File | Open, and open <code>AllExamples/AllExamples.sln</code>
</font>
</div>


With this method, the code inside sensorChanged will get executed every time the PhidgetInterfaceKit reports a change on one of its analog inputs.
This will load all of the examples available for C#, and then you can set your main project to be the one that matches your device. If you aren't sure what the software example for your device is called, check the software object listed in the Getting Started guide for your device.
The items from the event, such as the index or reported value, can be accessed from the SensorChangeEvent object properties.
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===
<br/>[[File:CSharp MonoDevelop Win Start Up.PNG]]<br/>


Some values can be directly read and set on the Phidget. Simply use the instance’s properties or call member functions such as  getSensorValue(int index) or setOutputState(int index, boolean newVal) for PhidgetInterfaceKits.  
The only thing left to do is to run the examples! Right click the project, and click on <code>Run With</code> and select the target framework. Please note that the projects, by default try to find the <code>Phidget21.NET.dll</code> in the <code>C\Program Files\Phidgets</code>. If you have it installed in another location, please change the path accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to <code>Phidget21.NET.dll</code>. Please see the next section for details.  
These methods can be used inside a polling loop as an alternative to event driven programming.


===Working With Multiple Phidgets===
<br/><br/>[[File:CSharp MonoDevelop Win Run As.PNG]]<br/><br/>


Multiple Phidgets of the same type can easily be run inside the same program.
Once you have the C# examples running, we have a [[#Follow The Examples|teaching section]] below to help you follow them.
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===
=====Write Your Own Code=====


The design given in this document can also be followed for almost all Phidgets.
When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your compiler / development environment to properly link the Phidget C# libraries. To begin:
For example, if you were using a PhidgetRFID instead of an PhidgetInterfaceKit, you would declare an RFID object instead of an InterfaceKit object.
The methods and events available would change but they can be accessed in a similar manner.  


===Compiling a .jar File===
* Create a new C# empty project with a descriptive name such as PhidgetTest.
<br/>[[File:CSharp MonoDevelop Win New Project.PNG]]<br/>
* Add a reference to the .NET library.
<br/>[[File:CSharp MonoDevelop Win Reference.PNG ]]<br/>
* Select <code>Phidget21.NET.dll</code>. If you used our installer, by default, this file is placed in <code>C:\Program Files\Phidgets</code>. If it is in another location, please change the path accordingly.
<br/>[[File:CSharp MonoDevelop Win Reference 2.PNG ]]<br/>


Finally, when the project is completed it is recommend to compile the project as a .jar.
Then, in your code, you will need to include the Phidget library:
This will reduce the number of extra flies created into a single package that is easier to manage.
In NetBeans a .jar file is automatically created during compilation.
Under the command line, you can use the jar utility from the Java SDK to package the .class files.
For example: “jar -cf MyProgram.jar *.class”. You will also need to provide a Manifest file for the jar program to indicate the program entry point via the Main-Class and the Class-Path which will point to the phidget21.jar.
Simply create a file, for example MyProgram.mf, and enter the following lines:


<div style="background-color: #f3f3f3; border-color: #1c9edb; border-width:1px; border-style: dashed;">
<font size="3">
<font size="3">
<source lang=cpp>
  using Phidgets;
  using Phidgets.Events;
  </source>
</font>
</div>
The project now has access to the Phidget21 function calls and you are ready to begin coding.
The same [[#Follow The Examples|teaching section]] which describes the examples also has further resources for programming your Phidget.
==Mac OS X==
C# has excellent support on Mac OS X through the Mono framework.
The first step in using C# on Mac is to install the Phidget libraries.  Compile and install them as explained on the [[Device List|getting started guide for your device]].  Then, the [[OS - Mac OS X]] page also describes the different Phidget files, their installed locations, and their roles....
==Linux==
C# has support on Linux through the Mono framework. 


  Manifest-Version: 1.0
The first step in using C# on Linux is to install the Phidget libraries. Compile and install them as explained on the main [[OS - Linux | Linux page]].  That Linux page also describes the different Phidget files, their installed locations, and their roles.
  Class-Path: phidget21.jar
Main-Class: MyProgram


==Follow The Examples==


</font>
By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want.  This teaching section has resources for you to learn from the examples and write your own.


Please note that the manifest file must end with a new line or a carriage return.  
Next, comes our API information. These resources outline the C# Phidget functions:
Now run the jar utility to package the files. For example: “jar –cfm MyProgram.jar MyProgram.mf *.class”.


==Building your Project==
{{UsingAPhidgetInCodeGeneral|both of which are available in C#|[http://www.phidgets.com/documentation/Phidget21.NET.zip C# API]}}
Describe the different ways a project could be built using this language.


==Manual Install==
===Example Flow===
<b>Windows</b>
<br/>
Files needed: phidget21.dll, phidget21.jar
<br/>
Place phidget21.dll into C:\WINDOWS\system32.
phidget21.jar can be placed anywhere as long as the path to them are specified with your compiler


{{ExamplePseudocode|In C#, you can name these '''event''' functions whatever you like.  You will then pass them as function pointers to the Phidget library below in the Main Code section.  This hooks them into the actual events when they occur. <br>
In the example code, the event functions common to all Phidgets are called things like '''AttachHandler()''' and '''DetachHandler()''', etc.<br><br>
Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit.
Other functions are given in the examples to show you more detail on using your Phidget.  For example, '''DeviceInitialize()''' will show what needs to be set up for your Phidget before using it.
|Creating a Phidget software object in C# is specific to the Phidget.  For a Phidget Spatial, for example, this would involve creating a <code>Spatial</code> object.  The examples show how to do this and other API functions.<br><br>
The object provides device specific methods and properties which are available from the API for your specific Phidget.|
[http://www.phidgets.com/documentation/Phidget21.NET.zip C# API]}}


==Common Problems and Solutions/Workarounds==
==Common Problems and Solutions/Workarounds==
Here you can put various frequent problems and our recommended solutions.
Here you can put various frequent problems and our recommended solutions.

Revision as of 17:53, 17 January 2012

Icon-CSharp.pngJava is a modern, object-oriented programming language developed by Oracle.

Introduction

Template:LanguageSupport

Quick Downloads

Just need the Java drivers, libraries, and examples? Here they are:

Java API Documentation:

Java Example Code:

Libraries and Drivers:

Getting started with Java

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:

  • Make sure your libraries are properly linked
  • Go from source code to a test application as quickly as possible
  • Ensure your Phidget is hooked up properly

Instructions are divided up by operating system. Choose:

Windows(2000/XP/Vista/7)

Libraries

Description

Java programs on Windows depend on the following files, which the installers above put onto your system:

  • phidget21.dll contains the actual Phidgets library, which is used at run-time. If you used our installer, it's already correctly placed in C:\Windows\System32. It can be manually installed - check our Manual Installation instructions.

You will also need one of the following two files, depending on the .NET framework version you are targeting:

  • phidget21.jar is the Phidgets library for Java runtime 2.0 or higher. Your compiler has to know where this file is. By default, our installer puts this file into C:\Program Files\Phidgets. So, you can either point your compiler to that location, or copy and link to it in a directory for your project workspace. For more information, please see the section for your specific compiler/environment. If you do not want to use our installer, you can get the file here.

Running the examples and writing your own code can be fairly compiler-specific, so we include instructions for each compiler below.

Command line

Please start by downloading the Java Examples. The full examples were written in NetBeans. But Eclipse will easily open it.

Use Our Examples

To run the examples, you first download them from above and unpack them into a folder. To load all projects in Visual Studio, go to File | Open | Project, and open AllExamples/AllExamples.sln or AllExamples/AllExamples_vs2008.sln for Visual Studio 2005 and 2008, respectively.

If you are opening the Phidget examples in Visual Studio 2010, you will need to go through the Visual Studio Conversion Wizard to convert the 2005 or 2008 project.

VS2005 Conversion Wizard.PNG

This will load all of the examples available for C#, and then you can set your main project to be the one that matches your device. If you aren't sure what the software example for your device is called, check the software object listed in the Getting Started guide for your device.

The only thing left to do is to run the examples! Click on Debug -> Start Debugging. Please note that the projects, by default try to find the Phidget21.NET.dll in the C:\Program Files\Phidgets. If you have it installed in another location, please change the path accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to Phidget21.NET.dll. Please see the next section for details.

CSharp VS2005 Run.PNG

Once you have the C# examples running, we have a teaching section below to help you follow them.

Write Your Own Code

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your compiler / development environment to properly link the Phidget C# libraries. To begin:

  • Generate a new Visual C# Windows Applications project with a descriptive name such as PhidgetTest.


CSharp VS2005 New Project.PNG


  • Add a reference to the .NET Phidgets lilbrary.


CSharp VS2005 Add Reference.PNG

  • Under the .NET tab, select Phidget21.NET.dll.

If you used our installer, these files are installed in C:\Program Files\Phidgets, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.
CSharp VS2005 Add Reference 2.PNG

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

  using Phidgets;
  using Phidgets.Events;

The project now has access to the Phidget21 function calls and you are ready to begin coding.

The same teaching section which describes the examples also has further resources for programming your Phidget.

Netbeans

This section will provide instructions on how to compile using the mcs compiler. Other compilers such as gmcs, smcs, and dmcs all work in the same way. Start by downloading the C# Examples.

Use Our Examples

Download the examples from above and unpack them into a folder. Here, you can find example programs for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the Getting Started guide for your device. Please only use the simple examples. The full examples uses Windows Forms, which Mono and the Gtk# toolkit are not completely compatible with. Locate the Program.cs file as this contains the example source code. Copy the file into your working directory, and rename it to example.cs.

To compile and build an executable, run:
File:Mono Windows Compile.PNG

If you have the Phidget21.NET.dll installed in another location, please change the path accordingly.

Afterwards, you will have an executable named example.exe that you can run. Place the Phidget21.NET.dll in the same directory as the executable and type the following to run the program:
File:Mono Windows Run.PNG

Once you have the C# examples running, we have a teaching section below to help you follow them.

Write Your Own Code

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your compiler / development environment to properly link the Phidget C# libraries. Please see the previous section for instructions.

In your code, you will need to include the Phidget library: 

  using Phidgets;
  using Phidgets.Events;

The project now has access to the Phidget21 function calls and you are ready to begin coding.

The same teaching section which describes the examples also has further resources for programming your Phidget.

Eclipse

Start by downloading the C# Examples. These examples were written in Visual Studio 2005 and 2008, but are also compatible with MonoDevelop.

Use Our Examples

Download the examples from above and unpack them into a folder. Here, you can find example programs for all the devices. If you aren't sure what the software example for your device is called, check the software object listed in the Getting Started guide for your device. If you are running under the .NET framework, you can use either the full or simple examples. Otherwise, if you are running under the Mono framework, please only use the simple examples. The full examples uses Windows Forms, which is not completely compatible with Mono's Gtk#.

To run the examples, you first download them from above and unpack them into a folder. To load all projects in MonoDevelop, go to File | Open, and open AllExamples/AllExamples.sln

This will load all of the examples available for C#, and then you can set your main project to be the one that matches your device. If you aren't sure what the software example for your device is called, check the software object listed in the Getting Started guide for your device.


CSharp MonoDevelop Win Start Up.PNG

The only thing left to do is to run the examples! Right click the project, and click on Run With and select the target framework. Please note that the projects, by default try to find the Phidget21.NET.dll in the C\Program Files\Phidgets. If you have it installed in another location, please change the path accordingly. If you are receiving an error message regarding that the namespace Phidgets cannot be found, please re-add the reference to Phidget21.NET.dll. Please see the next section for details.



CSharp MonoDevelop Win Run As.PNG

Once you have the C# examples running, we have a teaching section below to help you follow them.

Write Your Own Code

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your compiler / development environment to properly link the Phidget C# libraries. To begin:

  • Create a new C# empty project with a descriptive name such as PhidgetTest.


CSharp MonoDevelop Win New Project.PNG

  • Add a reference to the .NET library.


CSharp MonoDevelop Win Reference.PNG

  • Select Phidget21.NET.dll. If you used our installer, by default, this file is placed in C:\Program Files\Phidgets. If it is in another location, please change the path accordingly.


CSharp MonoDevelop Win Reference 2.PNG

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

  using Phidgets;
  using Phidgets.Events;

The project now has access to the Phidget21 function calls and you are ready to begin coding.

The same teaching section which describes the examples also has further resources for programming your Phidget.

Mac OS X

C# has excellent support on Mac OS X through the Mono framework.

The first step in using C# on Mac is to install the Phidget libraries. Compile and install them as explained on the getting started guide for your device. Then, the OS - Mac OS X page also describes the different Phidget files, their installed locations, and their roles....

Linux

C# has support on Linux through the Mono framework.

The first step in using C# on Linux is to install the Phidget libraries. Compile and install them as explained on the main Linux page. That Linux page also describes the different Phidget files, their installed locations, and their roles.

Follow The Examples

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the C# Phidget functions:

Template:UsingAPhidgetInCodeGeneral

Example Flow

Template:ExamplePseudocode

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_-_Java&oldid=13006"