Class HIDDesc<Page>

constructor

• new HIDDesc<Page>(): HIDDesc<Page>

• Type Parameters

  • Page extends UsagePages

  Returns HIDDesc<Page>

desc

Collection

• Collection(collectionType): HIDDesc<Page>

• A Collection item identifies a relationship between two or more data (Input, Output, or Feature.)

  Parameters

  • collectionType: CollectionType

  Returns HIDDesc<Page>

Delimiter

• Delimiter(open): HIDDesc<Page>

• Defines the beginning or end of a set of local items (true = open set, false = close set).

  Parameters

  • open: boolean

  Returns HIDDesc<Page>

EndCollection

• EndCollection(): HIDDesc<Page>

• Returns HIDDesc<Page>

Feature

• Feature(desc): HIDDesc<Page>

• Feature items describe device configuration information that can be sent to the device.

  Parameters

  • desc: FieldDesc

  Returns HIDDesc<Page>

Input

• Input(desc): HIDDesc<Page>

• An Input item describes information about the data provided by one or more physical controls. An application can use this information to interpret the data provided by the device. All data fields defined in a single item share an identical data format

  Parameters

  • desc: FieldDesc

  Returns HIDDesc<Page>

LogicalMaximum

• LogicalMaximum(max): HIDDesc<Page>

• Extent value in logical units. This is the maximum value that a variable or array item will report.

  Parameters

  • max: number

  Returns HIDDesc<Page>

LogicalMinimum

• LogicalMinimum(min): HIDDesc<Page>

• Extent value in logical units. This is the minimum value that a variable or array item will report. For example, a mouse reporting x position values from 0 to 128 would have a Logical Minimum of 0 and a Logical Maximum of 128.

  Parameters

  • min: number

  Returns HIDDesc<Page>

Output

• Output(desc): HIDDesc<Page>

• The Output item is used to define an output data field in a report. This item is similar to an Input item except it describes data sent to the device—for example, LED states.

  Parameters

  • desc: FieldDesc

  Returns HIDDesc<Page>

PhysicalMaximum

• PhysicalMaximum(max): HIDDesc<Page>

• Maximum value for the physical extent of a variable item.

  Parameters

  • max: number

  Returns HIDDesc<Page>

PhysicalMinimum

• PhysicalMinimum(min): HIDDesc<Page>

• Minimum value for the physical extent of a variable item. This represents the Logical Minimum with units applied to it.

  Parameters

  • min: number

  Returns HIDDesc<Page>

Pop

• Pop(): HIDDesc<Page>

• Replaces the item state table with the top structure from the stack.

  Returns HIDDesc<Page>

Push

• Push(): HIDDesc<Page>

• Places a copy of the global item state table on the stack.

  Returns HIDDesc<Page>

ReportCount

• ReportCount(count): HIDDesc<Page>

• Unsigned integer specifying the number of data fields for the item; determines how many fields are included in the report for this particular item (and consequently how many bits are added to the report).

  Parameters

  • count: number

  Returns HIDDesc<Page>

ReportID

• ReportID(id): HIDDesc<Page>

• Unsigned value that specifies the Report ID. If a Report ID tag is used anywhere in Report descriptor, all data reports for the device are preceded by a single byte ID field. All items succeeding the first Report ID tag but preceding a second Report ID tag are included in a report prefixed by a 1-byte ID. All items succeeding the second but preceding a third Report ID tag are included in a second report prefixed by a second ID, and so on. This Report ID value indicates the prefix added to a particular report. For example, a Report descriptor could define a 3-byte report with a Report ID of 01. This device would generate a 4-byte data report in which the first byte is 01. The device may also generate other reports, each with a unique ID. This allows the host to distinguish different types of reports arriving over a single interrupt in pipe. And allows the device to distinguish different types of reports arriving over a single interrupt out pipe. Report ID zero is reserved and should not be used.

  Parameters

  • id: number

  Returns HIDDesc<Page>

ReportSize

• ReportSize(size): HIDDesc<Page>

• Unsigned integer specifying the size of the report fields in bits. This allows the parser to build an item map for the report handler to use

  Parameters

  • size: number

  Returns HIDDesc<Page>

Unit

• Unit(unit): HIDDesc<Page>

• Unit values.

  Parameters

  • unit: Unit

  Returns HIDDesc<Page>

UnitExponent

• UnitExponent(exp): HIDDesc<Page>

• Value of the unit exponent in base.

  Parameters

  • exp: number

  Returns HIDDesc<Page>

Usage

• Usage<PageDesc>(page): HIDDesc<Page>

• Usage index for an item usage; represents a suggested usage for the item or collection. In the case where an item represents multiple controls, a Usage tag may suggest a usage for every variable or element in an array.

  Type Parameters

  • PageDesc extends number

  Parameters

  • page: PageDesc

  Returns HIDDesc<Page>

UsageMaximum

• UsageMaximum(min): HIDDesc<Page>

• Defines the ending usage associated with an array or bitmap.

  Parameters

  • min: number

  Returns HIDDesc<Page>

UsageMinimum

• UsageMinimum(min): HIDDesc<Page>

• Defines the starting usage associated with an array or bitmap.

  Parameters

  • min: number

  Returns HIDDesc<Page>

UsagePage

• UsagePage<Page>(page): HIDDesc<Page>

• Unsigned integer specifying the current Usage Page. Since a usage are 32 bit values, Usage Page items can be used to conserve space in a report descriptor by setting the high order 16 bits of a subsequent usages. Any usage that follows which is defines 16 bits or less is interpreted as a Usage ID and concatenated with the Usage Page to form a 32 bit Usage.

  Type Parameters

  • Page extends UsagePages

  Parameters

  • page: Page

  Returns HIDDesc<Page>