.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Device::USB::DevConfig 3pm"
.TH Device::USB::DevConfig 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH Device::USB::DevConfig
.IX Header "Device::USB::DevConfig"
This class encapsulates a USB Device Configuration and the methods that
object would support.
.SH NAME
Device::USB::DevConfig \- Access the device configuration returned by libusb.
.SH VERSION
.IX Header "VERSION"
Version 0.38
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Device::USB:DevConfig provides a Perl object for accessing a configuration
of a USB device using the libusb library.
.PP
.Vb 1
\&    use Device::USB;
\&
\&    my $usb = Device::USB\->new();
\&    my $dev = $usb\->find_device( $VENDOR, $PRODUCT );
\&
\&    printf "Device: %04X:%04X\en", $dev\->idVendor(), $dev\->idProduct();
\&    $dev\->open();
\&
\&    my $cfg = $dev\->config()\->[0];
\&    print "Config:", $cfg\->iConfiguration(), ": interface count: ",
\&       $cfg\->nNumInterfaces(), "\en";
.Ve
.PP
See USB specification for an explanation of the attributes of a
configuration.
.SH DESCRIPTION
.IX Header "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.
.SS METHODS
.IX Subsection "METHODS"
There are several accessor methods that return data from the configuration.
Each is named after the field that they return. These accessors include:
.IP wTotalLength 4
.IX Item "wTotalLength"
Returns the total length of the data returned for this configuration.
.IP bNumInterfaces 4
.IX Item "bNumInterfaces"
Returns the number of interfaces supported by this configuration.
.IP interfaces 4
.IX Item "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.
.IP bConfigurationValue 4
.IX Item "bConfigurationValue"
Returns the value passed to SetConfiguration to select this configuration.
.IP iConfiguration 4
.IX Item "iConfiguration"
Returns the index of the string descriptor describing this configuration.
The string can be retrieved using the method
\&\f(CW\*(C`Device::USB::Device::get_string_simple\*(C'\fR.
.IP bmAttributes 4
.IX Item "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.
.IP MaxPower 4
.IX Item "MaxPower"
Returns the Maximum power consumption in mA. This value is not in units of
2mA as in the spec, but in actual mA.
.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
This is an explanation of the diagnostic and error messages this module
can generate.
.SH DEPENDENCIES
.IX Header "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.
.SH AUTHOR
.IX Header "AUTHOR"
G. Wade Johnson (gwadej at cpan dot org)
Paul Archer (paul at paularcher dot org)
.PP
Houston Perl Mongers Group
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-device\-usb@rt.cpan.org\*(C'\fR, 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.
.SH ACKNOWLEDGEMENTS
.IX Header "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.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2006\-2013 Houston Perl Mongers
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.