debian man page for device::usb::devconfig

Device::USB::DevConfig(3pm)				User Contributed Perl Documentation			       Device::USB::DevConfig(3pm)

Device::USB::DevConfig
       This class encapsulates a USB Device Configuration and the methods that object would support.

NAME
       Device::USB::DevConfig - Access the device configuration returned by libusb.

VERSION
       Version 0.12

SYNOPSIS
       Device::USB:DevConfig provides a Perl object for accessing a configuration of a USB device using the libusb library.

	   use Device::USB;

	   my $usb = Device::USB->new();
	   my $dev = $usb->find_device( $VENDOR, $PRODUCT );

	   printf "Device: %04X:%04X
", $dev->idVendor(), $dev->idProduct();
	   $dev->open();

	   my $cfg = $dev->config()->[0];
	   print "Config:", $cfg->iConfiguration(), ": interface count: ",
	      $cfg->nNumInterfaces(), "
";

       See USB specification for an explanation of the attributes of a configuration.

DESCRIPTION
       This module defines a Perl object that represents the data associated with a USB device's configuration. The object provides read-only
       access to the important data associated with the configuration.

   METHODS
       There are several accessor methods that return data from the configuration.  Each is named after the field that they return. These
       accessors include:

       wTotalLength
	   Returns the total length of the data returned for this configuration.

       bNumInterfaces
	   Returns the number of interfaces supported by this configuration.

       interfaces
	   Returns a list of lists of interface objects associated with this configuration. Each of the inner lists is a set of alternate versions
	   of that interface.

       bConfigurationValue
	   Returns the value passed to SetConfiguration to select this configuration.

       iConfiguration
	   Returns the index of the string descriptor describing this configuration.  The string can be retrieved using the method
	   "Device::USB::Device::get_string_simple".

       bmAttributes
	   Returns a bitmap listing the attributes. The bits a number starting with the LSB as 0. Bit 6 is 1 if the device is self-powered. Bit 5
	   is 1 if the device supports Remote Wakeup.

       MaxPower
	   Returns the Maximum power consumption in mA. This value is not in units of 2mA as in the spec, but in actual mA.

DIAGNOSTICS
       This is an explanation of the diagnostic and error messages this module can generate.

DEPENDENCIES
       This module depends on the Carp, Inline and Inline::C modules, as well as the strict and warnings pragmas. Obviously, libusb must be
       available since that is the entire reason for the module's existence.

AUTHOR
       G. Wade Johnson (wade at anomaly dot org) Paul Archer (paul at paularcher dot org)

       Houston Perl Mongers Group

BUGS
       Please report any bugs or feature requests to "bug-device-usb@rt.cpan.org", or through the web interface at
       <http://rt.cpan.org/NoAuth/ReportBug.html?Device::USB>.	I will be notified, and then you'll automatically be notified of progress on your
       bug as I make changes.

ACKNOWLEDGEMENTS
       Thanks go to various members of the Houston Perl Mongers group for input on the module. But thanks mostly go to Paul Archer who proposed
       the project and helped with the development.

COPYRIGHT &; LICENSE
       Copyright 2006 Houston Perl Mongers

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2008-06-02					       Device::USB::DevConfig(3pm)