Logitech Wingman 3D Class Driver for QNX - Reference Manual

Vilas Kumar Chitrakaran

Mon Aug 28 15:21:10 2006

Contents

1 Logitech Wingman 3D Class Driver for QNX Hierarchical Index 1
1.1 Logitech Wingman 3D Class Driver for QNX Class Hierarchy.
2 Logitech Wingman 3D Class Driver for QNX Class Index
2.1 Logitech Wingman 3D Class Driver for QNX Class List.
3 Logitech Wingman 3D Class Driver for QNX File Index
3.1 Logitech Wingman 3D Class Driver for QNX File List.
4 Logitech Wingman 3D Class Driver for QNX Class Documentation
4.1 Wingman3D Class Reference. 4.2 wingman_data Struct Reference. 4.3 wingman_device Struct Reference. 4.4 wingman_report Struct Reference.
5 Logitech Wingman 3D Class Driver for QNX File Documentation
5.1 Wingman3D.hpp File Reference.

Chapter 1

Logitech Wingman 3D Class Driver for QNX Hierarchical Index
1.1 Logitech Wingman 3D Class Driver for QNX Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically: Wingman3D. wingman_data. wingman_device wingman_report.. 14 15
Generated on Mon Aug 28 15:21:for Logitech Wingman 3D Class Driver for QNX by Doxygen

Chapter 2

Logitech Wingman 3D Class Driver for QNX Class Index
2.1 Logitech Wingman 3D Class Driver for QNX Class List
Here are the classes, structs, unions and interfaces with brief descriptions: Wingman3D (The class Wingman3D provides an interface to the following Logitech (Vendor ID: 0x046D) USB HID compliant joysticks: ). wingman_data (A structure for holding wingman joystick data ). wingman_device (A structure for wingman devices (for driver internal use) ). wingman_report (A structure for device reports (for driver internal use) ). 14 15

Chapter 3

Logitech Wingman 3D Class Driver for QNX File Index
3.1 Logitech Wingman 3D Class Driver for QNX File List
Here is a list of all les with brief descriptions: Wingman3D.hpp. 17

Chapter 4

Logitech Wingman 3D Class Driver for QNX Class Documentation
4.1 Wingman3D Class Reference
The class Wingman3D provides an interface to the following Logitech (Vendor ID: 0x046D) USB HID compliant joysticks:.
#include <Wingman3D.hpp>

Public Member Functions

Wingman3D (int devNum=0) Wingman3D () int getX () const int getMaxX () const int getY () const int getMaxY () const int getTwist () const int getMaxTwist () const int getNumButtons () const bool isButtonPressed (int button) const int getSliderValue () const int getMaxSliderValue () const int getHatSwitchStatus () const bool isStatusOk () const char getStatusMessage () const void printDeviceInfo (int verbosity=1) const
Protected Member Functions
wingman_data_t getWingmanData () const wingman_data_t getWingmanMaxData () const
4.1.1 Detailed Description
Wingman Extreme 3D Digital (Product ID: 0xC212) Force3D (Product ID: 0xC283) (no force feedback support) Extreme 3D Pro (Product ID: 0xc215)
To use the joystick please ensure that the USB manager (devu-uhci or devu-ohci) and manager for HID devices (io-hid) are running. Your application will also need to be linked with the HID library libhiddi.so and the library created by this class. You will need to be root to use this class. Here are the commands to start the device managers (as root) :

/sbin/devu-uhci & (or /sbin/devu-ohci &) /sbin/io-hid & mount -Tio-hid devh-usb.so &

Example Program:

//======================================================================== // Wingman3D.t.cpp : Example program for Logitech Wingman HID Joystick // // Author : Vilas Kumar Chitrakaran <cvilas@ces.clemson.edu> // Date : March 2, 2004 // Compiler : GNU GCC 2.95.3qnx-nto // Operating System : QNX Momentics 6.2.1 //======================================================================== #include #include #include #include "Wingman3D.hpp" <stdio.h> <stdlib.h> <unistd.h>
int main() { Wingman3D joystick(0); if( !joystick.isStatusOk() ) { fprintf(stderr, "%s\n", joystick.getStatusMessage()); return EXIT_FAILURE; } sleep(1); joystick.printDeviceInfo(3); while(1) { fprintf(stdout, "\nx: %03d y: %03d z: %03d slide: %03d hat: %03d buttons: ", joystick.getX(), joystick.getY(), joystick.getTwist(), joystick.getSliderValue(), joystick.getHatSwitchStatus()); for(int i = 1; i < joystick.getNumButtons(); i++) if( joystick.isButtonPressed(i) ) fprintf(stdout, "%01d ", i); if( !joystick.isStatusOk() ) return -1; } return EXIT_SUCCESS; }
4.1.2 Constructor & Destructor Documentation
4.1.2.1 Wingman3D::Wingman3D (int

devNum = 0)

The default constructor. Establishes connection with the HID driver.

Parameters:

devNum The address of the joystick device to connect to (default = 0).

Wingman3D::Wingman3D ()

4.1.2.2
The default destructor disconnects from the HID driver and cleans up.
4.1.3 Member Function Documentation
4.1.3.1 Returns: int Wingman3D::getX () const

The X position

4.1.3.2 Returns:
int Wingman3D::getMaxX () const
The maximum output from X axis.

4.1.3.3 Returns:

int Wingman3D::getY () const

The Y position

4.1.3.4 Returns:
int Wingman3D::getMaxY () const
The maximum output from Y axis.

4.1.3.5 Returns:

int Wingman3D::getTwist () const
The twist handle position.

4.1.3.6 Returns:

int Wingman3D::getMaxTwist () const
The maximum output from twist axis.

10 4.1.3.7 Returns:

Logitech Wingman 3D Class Driver for QNX Class Documentation int Wingman3D::getNumButtons () const
The number of programmable buttons available
bool Wingman3D::isButtonPressed (int

4.1.3.8 Returns:

button) const
true if button button is pressed, else false
int Wingman3D::getSliderValue () const

4.1.3.9 Returns:

The slider/throttle position. Range [0 - 255].

int Wingman3D::getMaxSliderValue () const

4.1.3.10 Returns:

The maximum output from slider.
int Wingman3D::getHatSwitchStatus () const

4.1.3.11 Returns:

A value indicating position of the hat switch. Range [1 - 8].
bool Wingman3D::isStatusOk () const

4.1.3.12 Returns:

true if no error, else false.
char Wingman3D::getStatusMessage () const

4.1.3.13 Returns:

A string carrying current status of the device. This string also carries error messages when isStatusOk() returns false.
void Wingman3D::printDeviceInfo (int

4.1.3.14

verbosity = 1) const

verbosity

Print information about the device to stdout. Higher values of information.

4.1.3.15 Returns:

mean more detailed
wingman_data_t Wingman3D::getWingmanData () const [protected]
The whole data structure for device with current joystick data
4.1 Wingman3D Class Reference 4.1.3.16 wingman_data_t Wingman3D::getWingmanMaxData () const

[protected]

Returns:
The whole data structure for device with max limits for joystick data
The documentation for this class was generated from the following le:

Wingman3D.hpp

wingman_data Struct Reference
A structure for holding wingman joystick data.

Public Attributes

bool statusOk
'true' if device status is OK.

char statusMessage [80]

Char buer to hold device status message.

int x

X axis data.

int y

Y axis data.

int twist

Z axis data.

int buttons

Button status data.

int slider

Slider axis data.

int hatSwitch

Hat switch position data.
4.2.1 Detailed Description
4.2.2 Member Data Documentation
4.2.2.1 bool wingman_data::statusOk
4.2.2.2 char wingman_data::statusMessage[80]

4.2 wingman_data Struct Reference 4.2.2.3 int wingman_data::x
4.2.2.4 int wingman_data::y
4.2.2.5 int wingman_data::twist
4.2.2.6 int wingman_data::buttons
4.2.2.7 int wingman_data::slider
4.2.2.8 int wingman_data::hatSwitch
Hat switch position data. The documentation for this struct was generated from the following le:
wingman_device Struct Reference
A structure for wingman devices (for driver internal use).

wingman_data_t data

device current data.

wingman_data_t max_data

max limits on data elds.
wingman_report_t report hidd_device_instance_t device_instance
4.3.1 Detailed Description
4.3.2 Member Data Documentation
4.3.2.1 wingman_data_t wingman_device::data
4.3.2.2 wingman_data_t wingman_device::max_data
4.3.2.3 4.3.2.4 wingman_report_t wingman_device::report hidd_device_instance_t wingman_device::device_instance
The documentation for this struct was generated from the following le:
4.4 wingman_report Struct Reference
wingman_report Struct Reference
A structure for device reports (for driver internal use).
hidd_report_instance creport_instance hidd_report creport _uint16 cbtnbuf _uint32 dev_no
4.4.1 Detailed Description
4.4.2 Member Data Documentation
4.4.2.1 4.4.2.2 4.4.2.3 4.4.2.4 struct hidd_report_instance wingman_report::creport_instance struct hidd_report wingman_report::creport _uint16 wingman_report::cbtnbuf _uint32 wingman_report::dev_no

Chapter 5

Logitech Wingman 3D Class Driver for QNX File Documentation
5.1 Wingman3D.hpp File Reference
#include <sys/hiddi.h>

Classes

struct wingman_data

struct wingman_report

struct wingman_device

class Wingman3D

Typedefs
typedef wingman_data wingman_data_t typedef wingman_report wingman_report_t typedef wingman_device wingman_device_t
5.1.1 Typedef Documentation
5.1.1.1 5.1.1.2 5.1.1.3 typedef struct wingman_data wingman_data_t typedef struct wingman_report wingman_report_t typedef struct wingman_device wingman_device_t

Wingman3D

Wingman3D, 9
hatSwitch wingman_data, 13 isButtonPressed Wingman3D, 10 isStatusOk Wingman3D, 10 max_data wingman_device, 14 printDeviceInfo Wingman3D, 10 report wingman_device, 14 slider wingman_data, 13 statusMessage wingman_data, 12 statusOk wingman_data, 12 twist wingman_data, 13 Wingman3D, 7 Wingman3D, 9 getHatSwitchStatus, 10 getMaxSliderValue, 10 getMaxTwist, 9 getMaxX, 9 getMaxY, 9 getNumButtons, 9 getSliderValue, 10 getStatusMessage, 10 getTwist, 9 getWingmanData, 10 getWingmanMaxData, 10 getX, 9 getY, 9 isButtonPressed, 10 isStatusOk, 10 printDeviceInfo, 10 Wingman3D, 9
buttons wingman_data, 13 cbtnbuf wingman_report, 15 creport wingman_report, 15 creport_instance wingman_report, 15 data wingman_device, 14 dev_no wingman_report, 15 device_instance wingman_device, 14 getHatSwitchStatus Wingman3D, 10 getMaxSliderValue Wingman3D, 10 getMaxTwist Wingman3D, 9 getMaxX Wingman3D, 9 getMaxY Wingman3D, 9 getNumButtons Wingman3D, 9 getSliderValue Wingman3D, 10 getStatusMessage Wingman3D, 10 getTwist Wingman3D, 9 getWingmanData Wingman3D, 10 getWingmanMaxData Wingman3D, 10 getX Wingman3D, 9 getY Wingman3D, 9

Wingman3D.hpp, 17 wingman_data_t, 18 wingman_device_t, 18 wingman_report_t, 18 wingman_data, 12 buttons, 13 hatSwitch, 13 slider, 13 statusMessage, 12 statusOk, 12 twist, 13 x, 12 y, 13 wingman_data_t Wingman3D.hpp, 18 wingman_device, 14 data, 14 device_instance, 14 max_data, 14 report, 14 wingman_device_t Wingman3D.hpp, 18 wingman_report, 15 cbtnbuf, 15 creport, 15 creport_instance, 15 dev_no, 15 wingman_report_t Wingman3D.hpp, 18 x y wingman_data, 12 wingman_data, 13