Advanced Search

Log In | Not a Member?

Contact ADC

Overview

Typedefs

Describes different types of HID collections.

IOHIDElementCollectionType

typedef enum IOHIDElementCollectionType IOHIDElementCollectionType;  

Constants

kIOHIDElementCollectionTypePhysical

Used for a set of data items that represent data points collected at one geometric point.

kIOHIDElementCollectionTypeApplication

Identifies item groups serving different purposes in a single device.

kIOHIDElementCollectionTypeLogical

Used when a set of data items form a composite data structure.

kIOHIDElementCollectionTypeReport

Wraps all the fields in a report.

kIOHIDElementCollectionTypeNamedArray

Contains an array of selector usages.

kIOHIDElementCollectionTypeUsageSwitch

Modifies the meaning of the usage it contains.

kIOHIDElementCollectionTypeUsageModifier

Modifies the meaning of the usage attached to the encompassing collection.

Discussion

Collections identify a relationship between two or more elements.

Abstract data type used as a unique identifier for an element.

typedef uint32_t IOHIDElementCookie;  

Describes different types of HID elements.

IOHIDElementType

typedef enum IOHIDElementType IOHIDElementType;  

Constants

kIOHIDElementTypeInput_Misc

Misc input data field or varying size.

kIOHIDElementTypeInput_Button

One bit input data field.

kIOHIDElementTypeInput_Axis

Input data field used to represent an axis.

kIOHIDElementTypeInput_ScanCodes

Input data field used to represent a scan code or usage selector.

kIOHIDElementTypeOutput

Used to represent an output data field in a report.

kIOHIDElementTypeFeature

Describes input and output elements not intended for consumption by the end user.

kIOHIDElementTypeCollection

Element used to identify a relationship between two or more elements.

Discussion

Used by the IOHIDFamily to identify the type of element processed. Represented by the key kIOHIDElementTypeKey in the dictionary describing the element.

Options for opening a device via IOHIDLib.

IOHIDOptionsType

typedef uint32_t IOHIDOptionsType;  

Constants

kIOHIDOptionsTypeNone

Default option.

kIOHIDOptionsTypeSeizeDevice Used to open exclusive

communication with the device. This will prevent the system and other clients from receiving events from the device.

Options for creating a queue via IOHIDLib.

IOHIDQueueOptionsType

typedef uint32_t IOHIDQueueOptionsType;  

Constants

kIOHIDQueueOptionsTypeNone

Default option.

kIOHIDQueueOptionsTypeEnqueueAll Force the IOHIDQueue

to enqueue all events, relative or absolute, regardless of change.

Describes different type of HID reports.

IOHIDReportType

typedef enum IOHIDReportType IOHIDReportType;  

Constants

kIOHIDReportTypeInput

Input report.

kIOHIDReportTypeOutput

Output report.

kIOHIDReportTypeFeature

Feature report.

Discussion

Used by the IOHIDFamily to identify the type of report being processed.

Enumerations

Describes different types of HID collections.

IOHIDElementCollectionType

enum IOHIDElementCollectionType{ 
    kIOHIDElementCollectionTypePhysical = 0x00, 
    kIOHIDElementCollectionTypeApplication, 
    kIOHIDElementCollectionTypeLogical, 
    kIOHIDElementCollectionTypeReport, 
    kIOHIDElementCollectionTypeNamedArray, 
    kIOHIDElementCollectionTypeUsageSwitch, 
    kIOHIDElementCollectionTypeUsageModifier 
};  

Discussion

Collections identify a relationship between two or more elements.

Describes different types of HID elements.

IOHIDElementType

enum IOHIDElementType { 
    kIOHIDElementTypeInput_Misc = 1, 
    kIOHIDElementTypeInput_Button = 2, 
    kIOHIDElementTypeInput_Axis = 3, 
    kIOHIDElementTypeInput_ScanCodes = 4, 
    kIOHIDElementTypeOutput = 129, 
    kIOHIDElementTypeFeature = 257, 
    kIOHIDElementTypeCollection = 513 
};  

Discussion

Used by the IOHIDFamily to identify the type of element processed. Represented by the key kIOHIDElementTypeKey in the dictionary describing the element.

Options for opening a device via IOHIDLib.

IOHIDOptionsType

enum { 
    kIOHIDOptionsTypeNone = 0x00, 
    kIOHIDOptionsTypeSeizeDevice = 0x01 
};  

Options for creating a queue via IOHIDLib.

IOHIDQueueOptionsType

enum { 
    kIOHIDQueueOptionsTypeNone = 0x00, 
    kIOHIDQueueOptionsTypeEnqueueAll = 0x01 
};  

Describes different type of HID reports.

IOHIDReportType

enum IOHIDReportType{ 
    kIOHIDReportTypeInput = 0, 
    kIOHIDReportTypeOutput, 
    kIOHIDReportTypeFeature, 
    kIOHIDReportTypeCount 
};  

Discussion

Used by the IOHIDFamily to identify the type of report being processed.

#defines

Keys that represent properties of a paticular device.

kIOHIDTransportKey

#define kIOHIDTransportKey "Transport" 

Discussion

Keys that represent properties of a paticular device. Can be added to your matching dictionary when refining searches for HID devices.

Please note:
kIOHIDPrimaryUsageKey and kIOHIDPrimaryUsagePageKey are no longer rich enough to describe a device's capabilities. Take, for example, a device that describes both a keyboard and a mouse in the same descriptor. The previous behavior was to only describe the keyboard behavior with the primary usage and usage page. Needless to say, this would sometimes cause a program interested in mice to skip this device when matching.
Thus we have added 3 additional keys:

• kIOHIDDeviceUsageKey
• kIOHIDDeviceUsagePageKey
• kIOHIDDeviceUsagePairsKey

Keys that represent properties of a particular elements.

kIOHIDElementCookieKey

#define kIOHIDElementCookieKey "ElementCookie" 

Discussion

These keys can also be added to a matching dictionary when searching for elements via copyMatchingElements.

Keys used for matching particular elements.

kIOHIDElementCookieMinKey

#define kIOHIDElementCookieMinKey "ElementCookieMin" 

Discussion

These keys should only be used with a matching dictionary when searching for elements via copyMatchingElements.

The maximum bounds near the midpoint of a logical value in which the value is ignored.

kIOHIDElementCalibrationDeadZoneMinKey

#define kIOHIDElementCalibrationDeadZoneMaxKey "CalibrationDeadZoneMax" 

Discussion

The dead zone property is used to allow for slight differences in the idle value returned by an element.

The minimum bounds near the midpoint of a logical value in which the value is ignored.

#define kIOHIDElementCalibrationDeadZoneMinKey "CalibrationDeadZoneMin" 

Discussion

The dead zone property is used to allow for slight differences in the idle value returned by an element.

The maximum bounds near the midpoint of a logical value in which the value is ignored.

kIOHIDElementCalibrationDeadZoneMaxKey

#define kIOHIDElementCalibrationDeadZoneMaxKey "CalibrationDeadZoneMax" 

Discussion

The dead zone property is used to allow for slight differences in the idle value returned by an element.

The scale or level of detail returned in a calibrated element value.

#define kIOHIDElementCalibrationGranularityKey "CalibrationGranularity" 

Discussion

Values are rounded off such that if granularity=0.1, values after calibration are 0, 0.1, 0.2, 0.3, etc.

The maximum bounds for a calibrated value.

#define kIOHIDElementCalibrationMaxKey "CalibrationMax" 

The minimum bounds for a calibrated value.

#define kIOHIDElementCalibrationMinKey "CalibrationMin" 

The maximum tolerance to be used when calibrating a logical element value.

#define kIOHIDElementCalibrationSaturationMaxKey "CalibrationSaturationMax" 

Discussion

The saturation property is used to allow for slight differences in the minimum and maximum value returned by an element.

The mininum tolerance to be used when calibrating a logical element value.

#define kIOHIDElementCalibrationSaturationMinKey "CalibrationSaturationMin" 

Discussion

The saturation property is used to allow for slight differences in the minimum and maximum value returned by an element.

Keys that represent properties of a particular elements.

HID

#define kIOHIDElementCookieKey "ElementCookie" 

Discussion

These keys can also be added to a matching dictionary when searching for elements via copyMatchingElements.

Keys used for matching particular elements.

HID

#define kIOHIDElementCookieMinKey "ElementCookieMin" 

Discussion

These keys should only be used with a matching dictionary when searching for elements via copyMatchingElements.

Keys that represents an element property.

#define kIOHIDElementKey "Elements" 

Discussion

Property for a HID Device or element dictionary. Elements can be heirarchical, so they can contain other elements.

Keys that represent properties of a paticular device.

HID

#define kIOHIDTransportKey "Transport" 

Discussion

Keys that represent properties of a paticular device. Can be added to your matching dictionary when refining searches for HID devices.

Please note:
kIOHIDPrimaryUsageKey and kIOHIDPrimaryUsagePageKey are no longer rich enough to describe a device's capabilities. Take, for example, a device that describes both a keyboard and a mouse in the same descriptor. The previous behavior was to only describe the keyboard behavior with the primary usage and usage page. Needless to say, this would sometimes cause a program interested in mice to skip this device when matching.
Thus we have added 3 additional keys:

• kIOHIDDeviceUsageKey
• kIOHIDDeviceUsagePageKey
• kIOHIDDeviceUsagePairsKey

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.

Last Updated: 2008-03-13