Brandon Yee / Mbed 2 deprecated Slingshot

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   ADXL345 DebounceIn USBDevice mbed

USBDevice/USBHID/USBMouseKeyboard.h@0:cf17ea89fd09, 2012-10-14 (annotated)

Committer:
Brandon
Date:
Sun Oct 14 18:58:38 2012 +0000
Revision:
0:cf17ea89fd09
lab3

Who changed what in which revision?

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