Maxim Integrated / Mbed OS Host_Software_MAX32664GWEB_HR_EXTENDED

ME11B Sample Code in Maxim Integrated Team

Dependencies:   BMI160 max32630hsp3 MemoryLCD USBDevice

Fork of Host_Software_MAX32664GWEB_HR_EXTENDED by Seyhmus Cacina

Drivers/USBDevice/USBHID/USBMouseKeyboard.h@0:ac4dea3e2894, 2019-03-18 (annotated)

Committer:
seyhmus.cacina
Date:
Mon Mar 18 10:21:53 2019 +0300
Revision:
0:ac4dea3e2894
ME11B Sample Code First Commit

Who changed what in which revision?

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