Brandon Fosdick > USB-Descriptor-4 > USB::HID::Descriptor::Report

Download:
USB-Descriptor-4.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1   Source  

NAME ^

USB::HID::Descriptor::Report - USB Device Descriptor

SYNOPSIS ^

Methods for generating USB HID Report Descriptor items

DESCRIPTION ^

USB::HID::Descriptor::Report provides a number of convenience methods for generating the items that comprise a HID Report Descriptor.

METHODS ^

tag($tag, $size)

Returns the first byte of an Item corresponding to the tag name $tag and a data size of $size. The data bytes must be appended to the returned byte to create a complete item.

data_size(...)

Determines the size of the data that will be appended to the byte returned by tag. If an array is passed, the data size will be determined by the length of the array. If a single scalar is passed, the scalar's value is used to determine the data size.

item($tag, ...)

Construct a report descriptor item given a tag name and associated data bytes. Returns an array.

item_type($tag)

Returns the item type of the passed tag name ('main', 'global', 'local').

WRAPPERS ^

Wrap calls to item() to make the calling code a bit prettier.

Collection($type);

Retuns a Collection item of the specified type ('application', 'logical' or 'physcial'). Returns an End Collection item for 'end'.

Usage($usage)

Returns a Usage item constructed with the given usage number.

UsagePage($usage)

Returns a Usage Page item constructed with the given usage page number.

AUTHOR ^

Brandon Fosdick, <bfoz at bfoz.net>

BUGS ^

Please report any bugs or feature requests to bug-usb-hid-descriptor-report at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=USB-HID-Descriptor-Report. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc USB::HID::Descriptor::Report

You can also look for information at:

ACKNOWLEDGEMENTS ^

LICENSE AND COPYRIGHT ^

Copyright 2011 Brandon Fosdick.

This program is released under the terms of the BSD License.

syntax highlighting: