goma yam / USBDevice

USBDevice

Dependents:   QEI_X1_LCD_test3 macnica_test

USBHID/USBMouseKeyboard.h@0:2d8d0b73e1ff, 2013-04-18 (annotated)

Committer:
toucyy
Date:
Thu Apr 18 07:49:37 2013 +0000
Revision:
0:2d8d0b73e1ff
[mbed] converted /QEI_HelloWorld/USBDevice

Who changed what in which revision?

UserRevisionLine numberNew contents of line
toucyy 0:2d8d0b73e1ff 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
toucyy 0:2d8d0b73e1ff 2 *
toucyy 0:2d8d0b73e1ff 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
toucyy 0:2d8d0b73e1ff 4 * and associated documentation files (the "Software"), to deal in the Software without
toucyy 0:2d8d0b73e1ff 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
toucyy 0:2d8d0b73e1ff 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
toucyy 0:2d8d0b73e1ff 7 * Software is furnished to do so, subject to the following conditions:
toucyy 0:2d8d0b73e1ff 8 *
toucyy 0:2d8d0b73e1ff 9 * The above copyright notice and this permission notice shall be included in all copies or
toucyy 0:2d8d0b73e1ff 10 * substantial portions of the Software.
toucyy 0:2d8d0b73e1ff 11 *
toucyy 0:2d8d0b73e1ff 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
toucyy 0:2d8d0b73e1ff 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
toucyy 0:2d8d0b73e1ff 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
toucyy 0:2d8d0b73e1ff 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
toucyy 0:2d8d0b73e1ff 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
toucyy 0:2d8d0b73e1ff 17 */
toucyy 0:2d8d0b73e1ff 18
toucyy 0:2d8d0b73e1ff 19 #ifndef USBMOUSEKEYBOARD_H
toucyy 0:2d8d0b73e1ff 20 #define USBMOUSEKEYBOARD_H
toucyy 0:2d8d0b73e1ff 21
toucyy 0:2d8d0b73e1ff 22 #define REPORT_ID_KEYBOARD 1
toucyy 0:2d8d0b73e1ff 23 #define REPORT_ID_MOUSE 2
toucyy 0:2d8d0b73e1ff 24 #define REPORT_ID_VOLUME 3
toucyy 0:2d8d0b73e1ff 25
toucyy 0:2d8d0b73e1ff 26 #include "USBMouse.h"
toucyy 0:2d8d0b73e1ff 27 #include "USBKeyboard.h"
toucyy 0:2d8d0b73e1ff 28 #include "Stream.h"
toucyy 0:2d8d0b73e1ff 29 #include "USBHID.h"
toucyy 0:2d8d0b73e1ff 30
toucyy 0:2d8d0b73e1ff 31 /**
toucyy 0:2d8d0b73e1ff 32 * USBMouseKeyboard example
toucyy 0:2d8d0b73e1ff 33 * @code
toucyy 0:2d8d0b73e1ff 34 *
toucyy 0:2d8d0b73e1ff 35 * #include "mbed.h"
toucyy 0:2d8d0b73e1ff 36 * #include "USBMouseKeyboard.h"
toucyy 0:2d8d0b73e1ff 37 *
toucyy 0:2d8d0b73e1ff 38 * USBMouseKeyboard key_mouse;
toucyy 0:2d8d0b73e1ff 39 *
toucyy 0:2d8d0b73e1ff 40 * int main(void)
toucyy 0:2d8d0b73e1ff 41 * {
toucyy 0:2d8d0b73e1ff 42 * while(1)
toucyy 0:2d8d0b73e1ff 43 * {
toucyy 0:2d8d0b73e1ff 44 * key_mouse.move(20, 0);
toucyy 0:2d8d0b73e1ff 45 * key_mouse.printf("Hello From MBED\r\n");
toucyy 0:2d8d0b73e1ff 46 * wait(1);
toucyy 0:2d8d0b73e1ff 47 * }
toucyy 0:2d8d0b73e1ff 48 * }
toucyy 0:2d8d0b73e1ff 49 * @endcode
toucyy 0:2d8d0b73e1ff 50 *
toucyy 0:2d8d0b73e1ff 51 *
toucyy 0:2d8d0b73e1ff 52 * @code
toucyy 0:2d8d0b73e1ff 53 *
toucyy 0:2d8d0b73e1ff 54 * #include "mbed.h"
toucyy 0:2d8d0b73e1ff 55 * #include "USBMouseKeyboard.h"
toucyy 0:2d8d0b73e1ff 56 *
toucyy 0:2d8d0b73e1ff 57 * USBMouseKeyboard key_mouse(ABS_MOUSE);
toucyy 0:2d8d0b73e1ff 58 *
toucyy 0:2d8d0b73e1ff 59 * int main(void)
toucyy 0:2d8d0b73e1ff 60 * {
toucyy 0:2d8d0b73e1ff 61 * while(1)
toucyy 0:2d8d0b73e1ff 62 * {
toucyy 0:2d8d0b73e1ff 63 * key_mouse.move(X_MAX_ABS/2, Y_MAX_ABS/2);
toucyy 0:2d8d0b73e1ff 64 * key_mouse.printf("Hello from MBED\r\n");
toucyy 0:2d8d0b73e1ff 65 * wait(1);
toucyy 0:2d8d0b73e1ff 66 * }
toucyy 0:2d8d0b73e1ff 67 * }
toucyy 0:2d8d0b73e1ff 68 * @endcode
toucyy 0:2d8d0b73e1ff 69 */
toucyy 0:2d8d0b73e1ff 70 class USBMouseKeyboard: public USBHID, public Stream
toucyy 0:2d8d0b73e1ff 71 {
toucyy 0:2d8d0b73e1ff 72 public:
toucyy 0:2d8d0b73e1ff 73
toucyy 0:2d8d0b73e1ff 74 /**
toucyy 0:2d8d0b73e1ff 75 * Constructor
toucyy 0:2d8d0b73e1ff 76 *
toucyy 0:2d8d0b73e1ff 77 * @param mouse_type Mouse type: ABS_MOUSE (absolute mouse) or REL_MOUSE (relative mouse) (default: REL_MOUSE)
toucyy 0:2d8d0b73e1ff 78 * @param leds Leds bus: first: NUM_LOCK, second: CAPS_LOCK, third: SCROLL_LOCK
toucyy 0:2d8d0b73e1ff 79 * @param vendor_id Your vendor_id (default: 0x1234)
toucyy 0:2d8d0b73e1ff 80 * @param product_id Your product_id (default: 0x0001)
toucyy 0:2d8d0b73e1ff 81 * @param product_release Your preoduct_release (default: 0x0001)
toucyy 0:2d8d0b73e1ff 82 *
toucyy 0:2d8d0b73e1ff 83 */
toucyy 0:2d8d0b73e1ff 84 USBMouseKeyboard(MOUSE_TYPE mouse_type = REL_MOUSE, uint16_t vendor_id = 0x0021, uint16_t product_id = 0x0011, uint16_t product_release = 0x0001):
toucyy 0:2d8d0b73e1ff 85 USBHID(0, 0, vendor_id, product_id, product_release, false)
toucyy 0:2d8d0b73e1ff 86 {
toucyy 0:2d8d0b73e1ff 87 lock_status = 0;
toucyy 0:2d8d0b73e1ff 88 button = 0;
toucyy 0:2d8d0b73e1ff 89 this->mouse_type = mouse_type;
toucyy 0:2d8d0b73e1ff 90 connect();
toucyy 0:2d8d0b73e1ff 91 };
toucyy 0:2d8d0b73e1ff 92
toucyy 0:2d8d0b73e1ff 93 /**
toucyy 0:2d8d0b73e1ff 94 * Write a state of the mouse
toucyy 0:2d8d0b73e1ff 95 *
toucyy 0:2d8d0b73e1ff 96 * @param x x-axis position
toucyy 0:2d8d0b73e1ff 97 * @param y y-axis position
toucyy 0:2d8d0b73e1ff 98 * @param buttons buttons state (first bit represents MOUSE_LEFT, second bit MOUSE_RIGHT and third bit MOUSE_MIDDLE)
toucyy 0:2d8d0b73e1ff 99 * @param z wheel state (>0 to scroll down, <0 to scroll up)
toucyy 0:2d8d0b73e1ff 100 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 101 */
toucyy 0:2d8d0b73e1ff 102 bool update(int16_t x, int16_t y, uint8_t buttons, int8_t z);
toucyy 0:2d8d0b73e1ff 103
toucyy 0:2d8d0b73e1ff 104
toucyy 0:2d8d0b73e1ff 105 /**
toucyy 0:2d8d0b73e1ff 106 * Move the cursor to (x, y)
toucyy 0:2d8d0b73e1ff 107 *
toucyy 0:2d8d0b73e1ff 108 * @param x x-axis position
toucyy 0:2d8d0b73e1ff 109 * @param y y-axis position
toucyy 0:2d8d0b73e1ff 110 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 111 */
toucyy 0:2d8d0b73e1ff 112 bool move(int16_t x, int16_t y);
toucyy 0:2d8d0b73e1ff 113
toucyy 0:2d8d0b73e1ff 114 /**
toucyy 0:2d8d0b73e1ff 115 * Press one or several buttons
toucyy 0:2d8d0b73e1ff 116 *
toucyy 0:2d8d0b73e1ff 117 * @param button button state (ex: press(MOUSE_LEFT))
toucyy 0:2d8d0b73e1ff 118 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 119 */
toucyy 0:2d8d0b73e1ff 120 bool press(uint8_t button);
toucyy 0:2d8d0b73e1ff 121
toucyy 0:2d8d0b73e1ff 122 /**
toucyy 0:2d8d0b73e1ff 123 * Release one or several buttons
toucyy 0:2d8d0b73e1ff 124 *
toucyy 0:2d8d0b73e1ff 125 * @param button button state (ex: release(MOUSE_LEFT))
toucyy 0:2d8d0b73e1ff 126 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 127 */
toucyy 0:2d8d0b73e1ff 128 bool release(uint8_t button);
toucyy 0:2d8d0b73e1ff 129
toucyy 0:2d8d0b73e1ff 130 /**
toucyy 0:2d8d0b73e1ff 131 * Double click (MOUSE_LEFT)
toucyy 0:2d8d0b73e1ff 132 *
toucyy 0:2d8d0b73e1ff 133 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 134 */
toucyy 0:2d8d0b73e1ff 135 bool doubleClick();
toucyy 0:2d8d0b73e1ff 136
toucyy 0:2d8d0b73e1ff 137 /**
toucyy 0:2d8d0b73e1ff 138 * Click
toucyy 0:2d8d0b73e1ff 139 *
toucyy 0:2d8d0b73e1ff 140 * @param button state of the buttons ( ex: clic(MOUSE_LEFT))
toucyy 0:2d8d0b73e1ff 141 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 142 */
toucyy 0:2d8d0b73e1ff 143 bool click(uint8_t button);
toucyy 0:2d8d0b73e1ff 144
toucyy 0:2d8d0b73e1ff 145 /**
toucyy 0:2d8d0b73e1ff 146 * Scrolling
toucyy 0:2d8d0b73e1ff 147 *
toucyy 0:2d8d0b73e1ff 148 * @param z value of the wheel (>0 to go down, <0 to go up)
toucyy 0:2d8d0b73e1ff 149 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 150 */
toucyy 0:2d8d0b73e1ff 151 bool scroll(int8_t z);
toucyy 0:2d8d0b73e1ff 152
toucyy 0:2d8d0b73e1ff 153 /**
toucyy 0:2d8d0b73e1ff 154 * To send a character defined by a modifier(CTRL, SHIFT, ALT) and the key
toucyy 0:2d8d0b73e1ff 155 *
toucyy 0:2d8d0b73e1ff 156 * @code
toucyy 0:2d8d0b73e1ff 157 * //To send CTRL + s (save)
toucyy 0:2d8d0b73e1ff 158 * keyboard.keyCode('s', KEY_CTRL);
toucyy 0:2d8d0b73e1ff 159 * @endcode
toucyy 0:2d8d0b73e1ff 160 *
toucyy 0:2d8d0b73e1ff 161 * @param modifier bit 0: KEY_CTRL, bit 1: KEY_SHIFT, bit 2: KEY_ALT (default: 0)
toucyy 0:2d8d0b73e1ff 162 * @param key character to send
toucyy 0:2d8d0b73e1ff 163 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 164 */
toucyy 0:2d8d0b73e1ff 165 bool keyCode(uint8_t key, uint8_t modifier = 0);
toucyy 0:2d8d0b73e1ff 166
toucyy 0:2d8d0b73e1ff 167 /**
toucyy 0:2d8d0b73e1ff 168 * Send a character
toucyy 0:2d8d0b73e1ff 169 *
toucyy 0:2d8d0b73e1ff 170 * @param c character to be sent
toucyy 0:2d8d0b73e1ff 171 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 172 */
toucyy 0:2d8d0b73e1ff 173 virtual int _putc(int c);
toucyy 0:2d8d0b73e1ff 174
toucyy 0:2d8d0b73e1ff 175 /**
toucyy 0:2d8d0b73e1ff 176 * Control media keys
toucyy 0:2d8d0b73e1ff 177 *
toucyy 0:2d8d0b73e1ff 178 * @param key media key pressed (KEY_NEXT_TRACK, KEY_PREVIOUS_TRACK, KEY_STOP, KEY_PLAY_PAUSE, KEY_MUTE, KEY_VOLUME_UP, KEY_VOLUME_DOWN)
toucyy 0:2d8d0b73e1ff 179 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 180 */
toucyy 0:2d8d0b73e1ff 181 bool mediaControl(MEDIA_KEY key);
toucyy 0:2d8d0b73e1ff 182
toucyy 0:2d8d0b73e1ff 183 /**
toucyy 0:2d8d0b73e1ff 184 * Read status of lock keys. Useful to switch-on/off leds according to key pressed. Only the first three bits of the result is important:
toucyy 0:2d8d0b73e1ff 185 * - First bit: NUM_LOCK
toucyy 0:2d8d0b73e1ff 186 * - Second bit: CAPS_LOCK
toucyy 0:2d8d0b73e1ff 187 * - Third bit: SCROLL_LOCK
toucyy 0:2d8d0b73e1ff 188 *
toucyy 0:2d8d0b73e1ff 189 * @returns status of lock keys
toucyy 0:2d8d0b73e1ff 190 */
toucyy 0:2d8d0b73e1ff 191 uint8_t lockStatus();
toucyy 0:2d8d0b73e1ff 192
toucyy 0:2d8d0b73e1ff 193 /*
toucyy 0:2d8d0b73e1ff 194 * To define the report descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
toucyy 0:2d8d0b73e1ff 195 *
toucyy 0:2d8d0b73e1ff 196 * @returns pointer to the report descriptor
toucyy 0:2d8d0b73e1ff 197 */
toucyy 0:2d8d0b73e1ff 198 virtual uint8_t * reportDesc();
toucyy 0:2d8d0b73e1ff 199
toucyy 0:2d8d0b73e1ff 200 /*
toucyy 0:2d8d0b73e1ff 201 * Called when a data is received on the OUT endpoint. Useful to switch on LED of LOCK keys
toucyy 0:2d8d0b73e1ff 202 *
toucyy 0:2d8d0b73e1ff 203 * @returns if handle by subclass, return true
toucyy 0:2d8d0b73e1ff 204 */
toucyy 0:2d8d0b73e1ff 205 virtual bool EP1_OUT_callback();
toucyy 0:2d8d0b73e1ff 206
toucyy 0:2d8d0b73e1ff 207
toucyy 0:2d8d0b73e1ff 208 private:
toucyy 0:2d8d0b73e1ff 209 bool mouseWrite(int8_t x, int8_t y, uint8_t buttons, int8_t z);
toucyy 0:2d8d0b73e1ff 210 MOUSE_TYPE mouse_type;
toucyy 0:2d8d0b73e1ff 211 uint8_t button;
toucyy 0:2d8d0b73e1ff 212 bool mouseSend(int8_t x, int8_t y, uint8_t buttons, int8_t z);
toucyy 0:2d8d0b73e1ff 213
toucyy 0:2d8d0b73e1ff 214 uint8_t lock_status;
toucyy 0:2d8d0b73e1ff 215
toucyy 0:2d8d0b73e1ff 216 //dummy otherwise it doesn't compile (we must define all methods of an abstract class)
toucyy 0:2d8d0b73e1ff 217 virtual int _getc() { return -1;}
toucyy 0:2d8d0b73e1ff 218 };
toucyy 0:2d8d0b73e1ff 219
toucyy 0:2d8d0b73e1ff 220 #endif