Piotr Woźniak / Mbed 2 deprecated KL46Z-Lab2_fullll

blablabla

Dependencies:   MAG3110 MMA8451Q SLCD- TSI USBDevice mbed

USBDevice/USBHID/USBMouseKeyboard.h@0:339b7abfa147, 2014-04-16 (annotated)

Committer:
Osator
Date:
Wed Apr 16 12:20:00 2014 +0000
Revision:
0:339b7abfa147
blablabla

Who changed what in which revision?

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