Notice: This page contains information for the legacy Phidget21 Library. Phidget21 is out of support. Bugfixes may be considered on a case by case basis. Phidget21 does not support VINT Phidgets, or new USB Phidgets released after 2020. We maintain a selection of legacy devices for sale that are supported in Phidget21. We recommend that new projects be developed against the Phidget22 Library.
|
Language - Ruby
Ruby is an interpreted and object oriented scripting language with simple syntax created by Yukihiro Matsumoto.
Introduction
If this is your first time working with a Phidget, we suggest starting with the Getting Started page for your specific device. This can be found in the user guide for your device. That page will walk you through installing drivers and libraries for your operating system, and will then bring you back here to use Ruby specifically.
Ruby is capable of using the complete Phidget API, including events. We also provide example code in Ruby for all Phidget devices.
Ruby can be developed with Linux and Mac OS X.
You can compare Ruby with our other supported languages.
Quick Downloads
Just need the Ruby documentation, drivers, libraries, and examples? Here they are:
API Documentation
Library and Example Code
Drivers
Getting started with Ruby
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
- Mac OS X
- Linux (including PhidgetSBC)
Windows(2000/XP/Vista/7)
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:
- C# API (This is the complete set of functions you have available for all Phidgets)
- Device Specific APIs - The one for your Phidget can be found in its user guide.
To learn the details behind opening, configuring, using, and closing your Phidget, try the General Phidget Programming page. That page also describes using the Phidget in an event-driven manner and in a traditional manner, both of which are available in C#.
Example Flow
The Hello World example has this general structure so you can follow along. We also have an in-depth general introduction to writing Phidget code (like open, read data, etc), as well as the C# API for specific syntax:
// ----- Event and Other Functions ----- Create any Language-Specific Functions (exception handling) Create General Attach, Detach, and Error Handling Functions:
|
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. | |
// ----- Main Code -----
Close Device Delete Device
|
Creating a Phidget software object in C# is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a |
Code Snippets
Common Problems and Solutions/Workarounds
Here you can put various frequent problems and our recommended solutions.