Samuel Mokrani
USBDevice stack
Dependents: erg USBSerial_HelloWorld Slingshot SuperScanner ... more
USBHID/USBMouse.h@0:140cdf8e2d60, 2012-05-30 (annotated)
- Committer:
- samux
- Date:
- Wed May 30 18:28:11 2012 +0000
- Revision:
- 0:140cdf8e2d60
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| samux | 0:140cdf8e2d60 | 1 | /* Copyright (c) 2010-2011 mbed.org, MIT License |
| samux | 0:140cdf8e2d60 | 2 | * |
| samux | 0:140cdf8e2d60 | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
| samux | 0:140cdf8e2d60 | 4 | * and associated documentation files (the "Software"), to deal in the Software without |
| samux | 0:140cdf8e2d60 | 5 | * restriction, including without limitation the rights to use, copy, modify, merge, publish, |
| samux | 0:140cdf8e2d60 | 6 | * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the |
| samux | 0:140cdf8e2d60 | 7 | * Software is furnished to do so, subject to the following conditions: |
| samux | 0:140cdf8e2d60 | 8 | * |
| samux | 0:140cdf8e2d60 | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
| samux | 0:140cdf8e2d60 | 10 | * substantial portions of the Software. |
| samux | 0:140cdf8e2d60 | 11 | * |
| samux | 0:140cdf8e2d60 | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
| samux | 0:140cdf8e2d60 | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
| samux | 0:140cdf8e2d60 | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
| samux | 0:140cdf8e2d60 | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| samux | 0:140cdf8e2d60 | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| samux | 0:140cdf8e2d60 | 17 | */ |
| samux | 0:140cdf8e2d60 | 18 | |
| samux | 0:140cdf8e2d60 | 19 | #ifndef USBMOUSE_H |
| samux | 0:140cdf8e2d60 | 20 | #define USBMOUSE_H |
| samux | 0:140cdf8e2d60 | 21 | |
| samux | 0:140cdf8e2d60 | 22 | #include "USBHID.h" |
| samux | 0:140cdf8e2d60 | 23 | |
| samux | 0:140cdf8e2d60 | 24 | #define REPORT_ID_MOUSE 2 |
| samux | 0:140cdf8e2d60 | 25 | |
| samux | 0:140cdf8e2d60 | 26 | /* Common usage */ |
| samux | 0:140cdf8e2d60 | 27 | |
| samux | 0:140cdf8e2d60 | 28 | enum MOUSE_BUTTON |
| samux | 0:140cdf8e2d60 | 29 | { |
| samux | 0:140cdf8e2d60 | 30 | MOUSE_LEFT = 1, |
| samux | 0:140cdf8e2d60 | 31 | MOUSE_RIGHT = 2, |
| samux | 0:140cdf8e2d60 | 32 | MOUSE_MIDDLE = 4, |
| samux | 0:140cdf8e2d60 | 33 | }; |
| samux | 0:140cdf8e2d60 | 34 | |
| samux | 0:140cdf8e2d60 | 35 | /* X and Y limits */ |
| samux | 0:140cdf8e2d60 | 36 | /* These values do not directly map to screen pixels */ |
| samux | 0:140cdf8e2d60 | 37 | /* Zero may be interpreted as meaning 'no movement' */ |
| samux | 0:140cdf8e2d60 | 38 | #define X_MIN_ABS (1) /*!< Minimum value on x-axis */ |
| samux | 0:140cdf8e2d60 | 39 | #define Y_MIN_ABS (1) /*!< Minimum value on y-axis */ |
| samux | 0:140cdf8e2d60 | 40 | #define X_MAX_ABS (0x7fff) /*!< Maximum value on x-axis */ |
| samux | 0:140cdf8e2d60 | 41 | #define Y_MAX_ABS (0x7fff) /*!< Maximum value on y-axis */ |
| samux | 0:140cdf8e2d60 | 42 | |
| samux | 0:140cdf8e2d60 | 43 | #define X_MIN_REL (-127) /*!< The maximum value that we can move to the left on the x-axis */ |
| samux | 0:140cdf8e2d60 | 44 | #define Y_MIN_REL (-127) /*!< The maximum value that we can move up on the y-axis */ |
| samux | 0:140cdf8e2d60 | 45 | #define X_MAX_REL (127) /*!< The maximum value that we can move to the right on the x-axis */ |
| samux | 0:140cdf8e2d60 | 46 | #define Y_MAX_REL (127) /*!< The maximum value that we can move down on the y-axis */ |
| samux | 0:140cdf8e2d60 | 47 | |
| samux | 0:140cdf8e2d60 | 48 | enum MOUSE_TYPE |
| samux | 0:140cdf8e2d60 | 49 | { |
| samux | 0:140cdf8e2d60 | 50 | ABS_MOUSE, |
| samux | 0:140cdf8e2d60 | 51 | REL_MOUSE, |
| samux | 0:140cdf8e2d60 | 52 | }; |
| samux | 0:140cdf8e2d60 | 53 | |
| samux | 0:140cdf8e2d60 | 54 | /** |
| samux | 0:140cdf8e2d60 | 55 | * |
| samux | 0:140cdf8e2d60 | 56 | * USBMouse example |
| samux | 0:140cdf8e2d60 | 57 | * @code |
| samux | 0:140cdf8e2d60 | 58 | * #include "mbed.h" |
| samux | 0:140cdf8e2d60 | 59 | * #include "USBMouse.h" |
| samux | 0:140cdf8e2d60 | 60 | * |
| samux | 0:140cdf8e2d60 | 61 | * USBMouse mouse; |
| samux | 0:140cdf8e2d60 | 62 | * |
| samux | 0:140cdf8e2d60 | 63 | * int main(void) |
| samux | 0:140cdf8e2d60 | 64 | * { |
| samux | 0:140cdf8e2d60 | 65 | * while (1) |
| samux | 0:140cdf8e2d60 | 66 | * { |
| samux | 0:140cdf8e2d60 | 67 | * mouse.move(20, 0); |
| samux | 0:140cdf8e2d60 | 68 | * wait(0.5); |
| samux | 0:140cdf8e2d60 | 69 | * } |
| samux | 0:140cdf8e2d60 | 70 | * } |
| samux | 0:140cdf8e2d60 | 71 | * |
| samux | 0:140cdf8e2d60 | 72 | * @endcode |
| samux | 0:140cdf8e2d60 | 73 | * |
| samux | 0:140cdf8e2d60 | 74 | * |
| samux | 0:140cdf8e2d60 | 75 | * @code |
| samux | 0:140cdf8e2d60 | 76 | * #include "mbed.h" |
| samux | 0:140cdf8e2d60 | 77 | * #include "USBMouse.h" |
| samux | 0:140cdf8e2d60 | 78 | * #include <math.h> |
| samux | 0:140cdf8e2d60 | 79 | * |
| samux | 0:140cdf8e2d60 | 80 | * USBMouse mouse(ABS_MOUSE); |
| samux | 0:140cdf8e2d60 | 81 | * |
| samux | 0:140cdf8e2d60 | 82 | * int main(void) |
| samux | 0:140cdf8e2d60 | 83 | * { |
| samux | 0:140cdf8e2d60 | 84 | * uint16_t x_center = (X_MAX_ABS - X_MIN_ABS)/2; |
| samux | 0:140cdf8e2d60 | 85 | * uint16_t y_center = (Y_MAX_ABS - Y_MIN_ABS)/2; |
| samux | 0:140cdf8e2d60 | 86 | * uint16_t x_screen = 0; |
| samux | 0:140cdf8e2d60 | 87 | * uint16_t y_screen = 0; |
| samux | 0:140cdf8e2d60 | 88 | * |
| samux | 0:140cdf8e2d60 | 89 | * uint32_t x_origin = x_center; |
| samux | 0:140cdf8e2d60 | 90 | * uint32_t y_origin = y_center; |
| samux | 0:140cdf8e2d60 | 91 | * uint32_t radius = 5000; |
| samux | 0:140cdf8e2d60 | 92 | * uint32_t angle = 0; |
| samux | 0:140cdf8e2d60 | 93 | * |
| samux | 0:140cdf8e2d60 | 94 | * while (1) |
| samux | 0:140cdf8e2d60 | 95 | * { |
| samux | 0:140cdf8e2d60 | 96 | * x_screen = x_origin + cos((double)angle*3.14/180.0)*radius; |
| samux | 0:140cdf8e2d60 | 97 | * y_screen = y_origin + sin((double)angle*3.14/180.0)*radius; |
| samux | 0:140cdf8e2d60 | 98 | * |
| samux | 0:140cdf8e2d60 | 99 | * mouse.move(x_screen, y_screen); |
| samux | 0:140cdf8e2d60 | 100 | * angle += 3; |
| samux | 0:140cdf8e2d60 | 101 | * wait(0.01); |
| samux | 0:140cdf8e2d60 | 102 | * } |
| samux | 0:140cdf8e2d60 | 103 | * } |
| samux | 0:140cdf8e2d60 | 104 | * |
| samux | 0:140cdf8e2d60 | 105 | * @endcode |
| samux | 0:140cdf8e2d60 | 106 | */ |
| samux | 0:140cdf8e2d60 | 107 | class USBMouse: public USBHID |
| samux | 0:140cdf8e2d60 | 108 | { |
| samux | 0:140cdf8e2d60 | 109 | public: |
| samux | 0:140cdf8e2d60 | 110 | |
| samux | 0:140cdf8e2d60 | 111 | /** |
| samux | 0:140cdf8e2d60 | 112 | * Constructor |
| samux | 0:140cdf8e2d60 | 113 | * |
| samux | 0:140cdf8e2d60 | 114 | * @param mouse_type Mouse type: ABS_MOUSE (absolute mouse) or REL_MOUSE (relative mouse) (default: REL_MOUSE) |
| samux | 0:140cdf8e2d60 | 115 | * @param vendor_id Your vendor_id (default: 0x1234) |
| samux | 0:140cdf8e2d60 | 116 | * @param product_id Your product_id (default: 0x0001) |
| samux | 0:140cdf8e2d60 | 117 | * @param product_release Your preoduct_release (default: 0x0001) |
| samux | 0:140cdf8e2d60 | 118 | * |
| samux | 0:140cdf8e2d60 | 119 | */ |
| samux | 0:140cdf8e2d60 | 120 | USBMouse(MOUSE_TYPE mouse_type = REL_MOUSE, uint16_t vendor_id = 0x1234, uint16_t product_id = 0x0001, uint16_t product_release = 0x0001): |
| samux | 0:140cdf8e2d60 | 121 | USBHID(0, 0, vendor_id, product_id, product_release, false) |
| samux | 0:140cdf8e2d60 | 122 | { |
| samux | 0:140cdf8e2d60 | 123 | button = 0; |
| samux | 0:140cdf8e2d60 | 124 | this->mouse_type = mouse_type; |
| samux | 0:140cdf8e2d60 | 125 | connect(); |
| samux | 0:140cdf8e2d60 | 126 | }; |
| samux | 0:140cdf8e2d60 | 127 | |
| samux | 0:140cdf8e2d60 | 128 | /** |
| samux | 0:140cdf8e2d60 | 129 | * Write a state of the mouse |
| samux | 0:140cdf8e2d60 | 130 | * |
| samux | 0:140cdf8e2d60 | 131 | * @param x x-axis position |
| samux | 0:140cdf8e2d60 | 132 | * @param y y-axis position |
| samux | 0:140cdf8e2d60 | 133 | * @param buttons buttons state (first bit represents MOUSE_LEFT, second bit MOUSE_RIGHT and third bit MOUSE_MIDDLE) |
| samux | 0:140cdf8e2d60 | 134 | * @param z wheel state (>0 to scroll down, <0 to scroll up) |
| samux | 0:140cdf8e2d60 | 135 | * @returns true if there is no error, false otherwise |
| samux | 0:140cdf8e2d60 | 136 | */ |
| samux | 0:140cdf8e2d60 | 137 | bool update(int16_t x, int16_t y, uint8_t buttons, int8_t z); |
| samux | 0:140cdf8e2d60 | 138 | |
| samux | 0:140cdf8e2d60 | 139 | |
| samux | 0:140cdf8e2d60 | 140 | /** |
| samux | 0:140cdf8e2d60 | 141 | * Move the cursor to (x, y) |
| samux | 0:140cdf8e2d60 | 142 | * |
| samux | 0:140cdf8e2d60 | 143 | * @param x-axis position |
| samux | 0:140cdf8e2d60 | 144 | * @param y-axis position |
| samux | 0:140cdf8e2d60 | 145 | * @returns true if there is no error, false otherwise |
| samux | 0:140cdf8e2d60 | 146 | */ |
| samux | 0:140cdf8e2d60 | 147 | bool move(int16_t x, int16_t y); |
| samux | 0:140cdf8e2d60 | 148 | |
| samux | 0:140cdf8e2d60 | 149 | /** |
| samux | 0:140cdf8e2d60 | 150 | * Press one or several buttons |
| samux | 0:140cdf8e2d60 | 151 | * |
| samux | 0:140cdf8e2d60 | 152 | * @param button button state (ex: press(MOUSE_LEFT)) |
| samux | 0:140cdf8e2d60 | 153 | * @returns true if there is no error, false otherwise |
| samux | 0:140cdf8e2d60 | 154 | */ |
| samux | 0:140cdf8e2d60 | 155 | bool press(uint8_t button); |
| samux | 0:140cdf8e2d60 | 156 | |
| samux | 0:140cdf8e2d60 | 157 | /** |
| samux | 0:140cdf8e2d60 | 158 | * Release one or several buttons |
| samux | 0:140cdf8e2d60 | 159 | * |
| samux | 0:140cdf8e2d60 | 160 | * @param button button state (ex: release(MOUSE_LEFT)) |
| samux | 0:140cdf8e2d60 | 161 | * @returns true if there is no error, false otherwise |
| samux | 0:140cdf8e2d60 | 162 | */ |
| samux | 0:140cdf8e2d60 | 163 | bool release(uint8_t button); |
| samux | 0:140cdf8e2d60 | 164 | |
| samux | 0:140cdf8e2d60 | 165 | /** |
| samux | 0:140cdf8e2d60 | 166 | * Double click (MOUSE_LEFT) |
| samux | 0:140cdf8e2d60 | 167 | * |
| samux | 0:140cdf8e2d60 | 168 | * @returns true if there is no error, false otherwise |
| samux | 0:140cdf8e2d60 | 169 | */ |
| samux | 0:140cdf8e2d60 | 170 | bool doubleClick(); |
| samux | 0:140cdf8e2d60 | 171 | |
| samux | 0:140cdf8e2d60 | 172 | /** |
| samux | 0:140cdf8e2d60 | 173 | * Click |
| samux | 0:140cdf8e2d60 | 174 | * |
| samux | 0:140cdf8e2d60 | 175 | * @param button state of the buttons ( ex: clic(MOUSE_LEFT)) |
| samux | 0:140cdf8e2d60 | 176 | * @returns true if there is no error, false otherwise |
| samux | 0:140cdf8e2d60 | 177 | */ |
| samux | 0:140cdf8e2d60 | 178 | bool click(uint8_t button); |
| samux | 0:140cdf8e2d60 | 179 | |
| samux | 0:140cdf8e2d60 | 180 | /** |
| samux | 0:140cdf8e2d60 | 181 | * Scrolling |
| samux | 0:140cdf8e2d60 | 182 | * |
| samux | 0:140cdf8e2d60 | 183 | * @param z value of the wheel (>0 to go down, <0 to go up) |
| samux | 0:140cdf8e2d60 | 184 | * @returns true if there is no error, false otherwise |
| samux | 0:140cdf8e2d60 | 185 | */ |
| samux | 0:140cdf8e2d60 | 186 | bool scroll(int8_t z); |
| samux | 0:140cdf8e2d60 | 187 | |
| samux | 0:140cdf8e2d60 | 188 | /* |
| samux | 0:140cdf8e2d60 | 189 | * To define the report descriptor. Warning: this method has to store the length of the report descriptor in reportLength. |
| samux | 0:140cdf8e2d60 | 190 | * |
| samux | 0:140cdf8e2d60 | 191 | * @returns pointer to the report descriptor |
| samux | 0:140cdf8e2d60 | 192 | */ |
| samux | 0:140cdf8e2d60 | 193 | virtual uint8_t * reportDesc(); |
| samux | 0:140cdf8e2d60 | 194 | |
| samux | 0:140cdf8e2d60 | 195 | protected: |
| samux | 0:140cdf8e2d60 | 196 | /* |
| samux | 0:140cdf8e2d60 | 197 | * Get configuration descriptor |
| samux | 0:140cdf8e2d60 | 198 | * |
| samux | 0:140cdf8e2d60 | 199 | * @returns pointer to the configuration descriptor |
| samux | 0:140cdf8e2d60 | 200 | */ |
| samux | 0:140cdf8e2d60 | 201 | virtual uint8_t * configurationDesc(); |
| samux | 0:140cdf8e2d60 | 202 | |
| samux | 0:140cdf8e2d60 | 203 | private: |
| samux | 0:140cdf8e2d60 | 204 | MOUSE_TYPE mouse_type; |
| samux | 0:140cdf8e2d60 | 205 | uint8_t button; |
| samux | 0:140cdf8e2d60 | 206 | bool mouseSend(int8_t x, int8_t y, uint8_t buttons, int8_t z); |
| samux | 0:140cdf8e2d60 | 207 | }; |
| samux | 0:140cdf8e2d60 | 208 | |
| samux | 0:140cdf8e2d60 | 209 | #endif |