Maxim Integrated / USBDevice

USB device stack

Dependents:   blinky_max32630fthr FTHR_USB_serial FTHR_OLED HSP_RPC_GUI_3_0_1 ... more

Fork of USBDevice by mbed official

USBHID/USBMouseKeyboard.h@69:dad310740b28, 2018-09-11 (annotated)

Committer:
Emre.Eken@IST-LT-36262.maxim-ic.internal
Date:
Tue Sep 11 15:17:01 2018 +0300
Revision:
69:dad310740b28
Parent:
47:a0cd9646ecd1 
makes a variable public instead of protected

Who changed what in which revision?

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