Chris Styles
HID_devices/USBMouse.h@0:e98d1c2b16c6, 2011-10-20 (annotated)
- Committer:
- chris
- Date:
- Thu Oct 20 14:07:30 2011 +0000
- Revision:
- 0:e98d1c2b16c6
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| chris | 0:e98d1c2b16c6 | 1 | /* USBMouse.h */ |
| chris | 0:e98d1c2b16c6 | 2 | /* USB device example: relative mouse */ |
| chris | 0:e98d1c2b16c6 | 3 | /* Copyright (c) 2011 ARM Limited. All rights reserved. */ |
| chris | 0:e98d1c2b16c6 | 4 | |
| chris | 0:e98d1c2b16c6 | 5 | #ifndef _RELATIVE_MOUSE_ |
| chris | 0:e98d1c2b16c6 | 6 | #define _RELATIVE_MOUSE_ |
| chris | 0:e98d1c2b16c6 | 7 | |
| chris | 0:e98d1c2b16c6 | 8 | #include "GenericMouse.h" |
| chris | 0:e98d1c2b16c6 | 9 | #include "USBHID.h" |
| chris | 0:e98d1c2b16c6 | 10 | |
| chris | 0:e98d1c2b16c6 | 11 | /** USB device: a relative mouse |
| chris | 0:e98d1c2b16c6 | 12 | * |
| chris | 0:e98d1c2b16c6 | 13 | * Warning: you can only instantiate one instance of a USB device: USBMouse, USBKeyboard, USBAbsMouse, USBMouseKeyboard, or USBAbsMouseKeyboard. |
| chris | 0:e98d1c2b16c6 | 14 | * |
| chris | 0:e98d1c2b16c6 | 15 | * Example: |
| chris | 0:e98d1c2b16c6 | 16 | * @code |
| chris | 0:e98d1c2b16c6 | 17 | * #include "mbed.h" |
| chris | 0:e98d1c2b16c6 | 18 | * #include "USBMouse.h" |
| chris | 0:e98d1c2b16c6 | 19 | * |
| chris | 0:e98d1c2b16c6 | 20 | * USBMouse mouse; |
| chris | 0:e98d1c2b16c6 | 21 | * |
| chris | 0:e98d1c2b16c6 | 22 | * #define STEP (2) |
| chris | 0:e98d1c2b16c6 | 23 | * #define SIZE (100) |
| chris | 0:e98d1c2b16c6 | 24 | * |
| chris | 0:e98d1c2b16c6 | 25 | * int main(void) |
| chris | 0:e98d1c2b16c6 | 26 | * { |
| chris | 0:e98d1c2b16c6 | 27 | * int32_t a; |
| chris | 0:e98d1c2b16c6 | 28 | * |
| chris | 0:e98d1c2b16c6 | 29 | * while (1) |
| chris | 0:e98d1c2b16c6 | 30 | * { |
| chris | 0:e98d1c2b16c6 | 31 | * for (a=0; a<SIZE; a++) |
| chris | 0:e98d1c2b16c6 | 32 | * { |
| chris | 0:e98d1c2b16c6 | 33 | * mouse.move(STEP,0); |
| chris | 0:e98d1c2b16c6 | 34 | * } |
| chris | 0:e98d1c2b16c6 | 35 | * |
| chris | 0:e98d1c2b16c6 | 36 | * for (a=0; a<SIZE; a++) |
| chris | 0:e98d1c2b16c6 | 37 | * { |
| chris | 0:e98d1c2b16c6 | 38 | * mouse.move(0,STEP); |
| chris | 0:e98d1c2b16c6 | 39 | * } |
| chris | 0:e98d1c2b16c6 | 40 | * |
| chris | 0:e98d1c2b16c6 | 41 | * for (a=0; a<SIZE; a++) |
| chris | 0:e98d1c2b16c6 | 42 | * { |
| chris | 0:e98d1c2b16c6 | 43 | * mouse.move(-STEP,0); |
| chris | 0:e98d1c2b16c6 | 44 | * } |
| chris | 0:e98d1c2b16c6 | 45 | * |
| chris | 0:e98d1c2b16c6 | 46 | * for (a=0; a<SIZE; a++) |
| chris | 0:e98d1c2b16c6 | 47 | * { |
| chris | 0:e98d1c2b16c6 | 48 | * mouse.move(0,-STEP); |
| chris | 0:e98d1c2b16c6 | 49 | * } |
| chris | 0:e98d1c2b16c6 | 50 | * } |
| chris | 0:e98d1c2b16c6 | 51 | * } |
| chris | 0:e98d1c2b16c6 | 52 | * |
| chris | 0:e98d1c2b16c6 | 53 | * @endcode |
| chris | 0:e98d1c2b16c6 | 54 | */ |
| chris | 0:e98d1c2b16c6 | 55 | class USBMouse: public GenericMouse, public USBHID |
| chris | 0:e98d1c2b16c6 | 56 | { |
| chris | 0:e98d1c2b16c6 | 57 | public: |
| chris | 0:e98d1c2b16c6 | 58 | |
| chris | 0:e98d1c2b16c6 | 59 | /** |
| chris | 0:e98d1c2b16c6 | 60 | * Constructor for a USBMouse (relative mouse) |
| chris | 0:e98d1c2b16c6 | 61 | */ |
| chris | 0:e98d1c2b16c6 | 62 | USBMouse(){}; |
| chris | 0:e98d1c2b16c6 | 63 | |
| chris | 0:e98d1c2b16c6 | 64 | /** |
| chris | 0:e98d1c2b16c6 | 65 | * Write a state of the mouse |
| chris | 0:e98d1c2b16c6 | 66 | * |
| chris | 0:e98d1c2b16c6 | 67 | * @param x x relative position |
| chris | 0:e98d1c2b16c6 | 68 | * @param y y relative position |
| chris | 0:e98d1c2b16c6 | 69 | * @param buttons buttons state (first bit represents MOUSE_LEFT, second bit MOUSE_RIGHT and third bit MOUSE_MIDDLE) |
| chris | 0:e98d1c2b16c6 | 70 | * @param z wheel state (>0 to scroll down, <0 to scroll up) |
| chris | 0:e98d1c2b16c6 | 71 | * @return true if there is no error, false otherwise |
| chris | 0:e98d1c2b16c6 | 72 | */ |
| chris | 0:e98d1c2b16c6 | 73 | virtual bool update(int16_t x, int16_t y, uint8_t buttons, int8_t z); |
| chris | 0:e98d1c2b16c6 | 74 | |
| chris | 0:e98d1c2b16c6 | 75 | virtual uint8_t * ReportDesc(); |
| chris | 0:e98d1c2b16c6 | 76 | |
| chris | 0:e98d1c2b16c6 | 77 | private: |
| chris | 0:e98d1c2b16c6 | 78 | bool mouseSend(int8_t x, int8_t y, uint8_t buttons, int8_t z); |
| chris | 0:e98d1c2b16c6 | 79 | }; |
| chris | 0:e98d1c2b16c6 | 80 | |
| chris | 0:e98d1c2b16c6 | 81 | #endif |