Class BLEHIDMouse
BLEHIDMouse Class
Description
A class used for creating and managing a BLE HID Mouse.
Syntax
class BLEHIDMouse
Members
Public Constructors |
|
|---|---|
BLEHIDMouse::BLEHIDMouse |
Constructs a BLEHIDMouse object |
Public Methods |
|
BLEHIDMouse::setReportID |
Set HID report ID for the HID Mouse |
BLEHIDMouse::mouseReport |
Send a HID Mouse report |
BLEHIDMouse::mousePress |
Send a HID Mouse report indicating buttons pressed |
BLEHIDMouse::mouseRelease |
Send a HID Mouse report indicating buttons release |
BLEHIDMouse:: mouseReleaseAll |
Send a HID Mouse report indicating no button Pressed |
BLEHIDMouse::mouseMove |
Send a HID Mouse report indicating mouse movement |
BLEHIDMouse::mouseScroll |
Send a HID Mouse report indicating mouse scroll wheel movement |
BLEHIDMouse::BLEHIDMouse
Description
Constructs a BLEHIDMouse object.
Syntax
BLEHIDMouse(void);
Parameters
NA
Returns
NA
Example Code
Example: BLEHIDMouse
Note
“BLEHIDMouse.h” must be included to use the class function.
BLEHIDMouse::setReportID
Description
Set HID report ID for the HID Mouse.
Syntax
void setReportID (uint8_t reportID);
Parameters
reportID: The report ID for the HID mouse device, corresponding to the HID report descriptor.
Returns
NA
Example Code
NA
Note
“BLEHIDMouse.h” must be included to use the class function.
BLEHIDMouse::mouseReport
Description
Send a HID Mouse report.
Syntax
void mouseReport (hid_mouse_report_t* report);
void mouseReport (uint8_t buttons, int8_t x, int8_t y, int8_t scroll);
Parameters
report: pointer to mouse report structure containing data on mouse inputs.
buttons: bitmap indicating state of each button.
1 (pressed)
0 (released)
x: mouse x-axis movement in integer.
-127 to 127.
y: mouse y-axis movement in integer.
-127 to 127.
scroll: mouse scroll wheel movement in integer.
-127 to 127.
Returns
NA
Example Code
NA
Note
“BLEHIDMouse.h” must be included to use the class function.
BLEHIDMouse::mousePress
Description
Send a HID Mouse report indicating buttons pressed.
Syntax
void mousePress (uint8_t buttons);
Parameters
buttons: bitmap indicating buttons pressed.
1 (pressed)
Returns
NA
Example Code
Example: BLEHIDMouse
Note
“BLEHIDMouse.h” must be included to use the class function.
BLEHIDMouse::mouseRelease
Description
Send a HID Mouse report indicating buttons released.
Syntax
void mouseRelease (uint8_t buttons);
Parameters
buttons: bitmap indicating buttons released.
1 (pressed)
Returns
NA
Example Code
Example: BLEHIDMouse
Note
“BLEHIDMouse.h” must be included to use the class function.
BLEHIDMouse::mouseReleaseAll
Description
Send a HID Mouse report indicating no buttons pressed.
Syntax
void mouseReleaseAll(void);
Parameters
NA
Returns
NA
Example Code
NA
Note
“BLEHIDMouse.h” must be included to use the class function.
BLEHIDMouse::mouseMove
Description
Send a HID Mouse report indicating mouse movement.
Syntax
void mouseMove (int8_t x, int8_t y);
Parameters
x: mouse x-axis movement in integer.
-127 to 127.
y: mouse y-axis movement in integer.
-127 to 127.
Returns
NA
Example Code
Example: BLEHIDMouse
Note
“BLEHIDMouse.h” must be included to use the class function.
BLEHIDMouse::mouseScroll
Description
Send a HID Mouse report indicating mouse scroll wheel movement.
Syntax
void mouseScroll (int8_t scroll);
Parameters
scroll: mouse scroll wheel movement in integer.
-127 to 127.
Returns
NA
Example Code
Example: BLEHIDMouse
Note
“BLEHIDMouse.h” must be included to use the class function.