peripherals  1.4.2
RoadNarrows Robotics Hardware Peripherals Package
HID Abstract Interfaces

Classes

class  rnr::HIDInput
 Input Human Interface Device Abstract Base Class. More...
 

Macros

#define HID_BTTN_UP   0
 button/key state is up or unpressed More...
 
#define HID_BTTN_DOWN   1
 button/key state is down or pressed More...
 
#define HID_FEAT_INPUT   0x01
 input to host feature More...
 
#define HID_FEAT_OUTPUT   0x02
 output to device feature More...
 

Enumerations

enum  rnr::HIDClass {
  rnr::HIDClassUnknown = 0,
  rnr::HIDClassKeyboardMouse,
  rnr::HIDClassXbox360,
  rnr::HIDClassNumOf
}
 Supported HID classes. More...
 
enum  rnr::HIDFeatType {
  rnr::HIDFeatTypeUnknown = 0,
  rnr::HIDFeatTypeBiState,
  rnr::HIDFeatTypeRange,
  rnr::HIDFeatTypeEnum,
  rnr::HIDFeatTypeNumOf
}
 Feature property types. More...
 

Detailed Description

Human Interface Device abstract interfaces.

Macro Definition Documentation

#define HID_BTTN_DOWN   1

button/key state is down or pressed

Definition at line 53 of file HID.h.

Referenced by rnr::HIDXbox360::getFeatureProp(), testXboxInput(), testXboxLED(), testXboxRumble(), and rnr::HIDXbox360::updown().

#define HID_BTTN_UP   0

button/key state is up or unpressed

Definition at line 52 of file HID.h.

Referenced by rnr::HIDXbox360::getFeatureProp(), and rnr::HIDXbox360::updown().

#define HID_FEAT_INPUT   0x01

input to host feature

Definition at line 55 of file HID.h.

Referenced by rnr::HIDXbox360::getFeatureProp().

#define HID_FEAT_OUTPUT   0x02

output to device feature

Definition at line 56 of file HID.h.

Referenced by rnr::HIDXbox360::getFeatureProp().

Enumeration Type Documentation

Supported HID classes.

Enumerator
HIDClassUnknown 

class is unknown or not initialized

HIDClassKeyboardMouse 

keyboards/mice class

HIDClassXbox360 

Microsoft Xbox360 game console family.

HIDClassNumOf 

number of supported classes (keep last)

Definition at line 71 of file HID.h.

72  {
73  HIDClassUnknown = 0, ///< class is unknown or not initialized
74 
75  HIDClassKeyboardMouse, ///< keyboards/mice class
76  HIDClassXbox360, ///< Microsoft Xbox360 game console family
77 
78  HIDClassNumOf ///< number of supported classes (keep last)
79  } HIDClass;
keyboards/mice class
Definition: HID.h:75
number of supported classes (keep last)
Definition: HID.h:78
class is unknown or not initialized
Definition: HID.h:73
HIDClass
Supported HID classes.
Definition: HID.h:71
Microsoft Xbox360 game console family.
Definition: HID.h:76

Feature property types.

Enumerator
HIDFeatTypeUnknown 

unknown feature property type

HIDFeatTypeBiState 

binary state property type

HIDFeatTypeRange 

range between [min,max] property type

HIDFeatTypeEnum 

discrete enumeration feature property type

HIDFeatTypeNumOf 

number of feature property types(keep last)

Definition at line 85 of file HID.h.

86  {
87  HIDFeatTypeUnknown = 0, ///< unknown feature property type
88 
89  HIDFeatTypeBiState, ///< binary state property type
90  HIDFeatTypeRange, ///< range between [min,max] property type
91  HIDFeatTypeEnum, ///< discrete enumeration feature property type
92 
93  HIDFeatTypeNumOf ///< number of feature property types(keep last)
94  } HIDFeatType;
unknown feature property type
Definition: HID.h:87
range between [min,max] property type
Definition: HID.h:90
binary state property type
Definition: HID.h:89
HIDFeatType
Feature property types.
Definition: HID.h:85
discrete enumeration feature property type
Definition: HID.h:91
number of feature property types(keep last)
Definition: HID.h:93