ON Semiconductor / mbed-os

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.

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

features/unsupported/USBDevice/USBHID/USBMouseKeyboard.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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