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/USBKeyboard.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 USBKEYBOARD_H
seyhmus.cacina 0:ac4dea3e2894 20 #define USBKEYBOARD_H
seyhmus.cacina 0:ac4dea3e2894 21
seyhmus.cacina 0:ac4dea3e2894 22 #include "USBHID.h"
seyhmus.cacina 0:ac4dea3e2894 23 #include "Stream.h"
seyhmus.cacina 0:ac4dea3e2894 24
seyhmus.cacina 0:ac4dea3e2894 25 /* Modifiers */
seyhmus.cacina 0:ac4dea3e2894 26 enum MODIFIER_KEY {
seyhmus.cacina 0:ac4dea3e2894 27 KEY_CTRL = 1,
seyhmus.cacina 0:ac4dea3e2894 28 KEY_SHIFT = 2,
seyhmus.cacina 0:ac4dea3e2894 29 KEY_ALT = 4,
seyhmus.cacina 0:ac4dea3e2894 30 };
seyhmus.cacina 0:ac4dea3e2894 31
seyhmus.cacina 0:ac4dea3e2894 32
seyhmus.cacina 0:ac4dea3e2894 33 enum MEDIA_KEY {
seyhmus.cacina 0:ac4dea3e2894 34 KEY_NEXT_TRACK, /*!< next Track Button */
seyhmus.cacina 0:ac4dea3e2894 35 KEY_PREVIOUS_TRACK, /*!< Previous track Button */
seyhmus.cacina 0:ac4dea3e2894 36 KEY_STOP, /*!< Stop Button */
seyhmus.cacina 0:ac4dea3e2894 37 KEY_PLAY_PAUSE, /*!< Play/Pause Button */
seyhmus.cacina 0:ac4dea3e2894 38 KEY_MUTE, /*!< Mute Button */
seyhmus.cacina 0:ac4dea3e2894 39 KEY_VOLUME_UP, /*!< Volume Up Button */
seyhmus.cacina 0:ac4dea3e2894 40 KEY_VOLUME_DOWN, /*!< Volume Down Button */
seyhmus.cacina 0:ac4dea3e2894 41 };
seyhmus.cacina 0:ac4dea3e2894 42
seyhmus.cacina 0:ac4dea3e2894 43 enum FUNCTION_KEY {
seyhmus.cacina 0:ac4dea3e2894 44 KEY_F1 = 128, /* F1 key */
seyhmus.cacina 0:ac4dea3e2894 45 KEY_F2, /* F2 key */
seyhmus.cacina 0:ac4dea3e2894 46 KEY_F3, /* F3 key */
seyhmus.cacina 0:ac4dea3e2894 47 KEY_F4, /* F4 key */
seyhmus.cacina 0:ac4dea3e2894 48 KEY_F5, /* F5 key */
seyhmus.cacina 0:ac4dea3e2894 49 KEY_F6, /* F6 key */
seyhmus.cacina 0:ac4dea3e2894 50 KEY_F7, /* F7 key */
seyhmus.cacina 0:ac4dea3e2894 51 KEY_F8, /* F8 key */
seyhmus.cacina 0:ac4dea3e2894 52 KEY_F9, /* F9 key */
seyhmus.cacina 0:ac4dea3e2894 53 KEY_F10, /* F10 key */
seyhmus.cacina 0:ac4dea3e2894 54 KEY_F11, /* F11 key */
seyhmus.cacina 0:ac4dea3e2894 55 KEY_F12, /* F12 key */
seyhmus.cacina 0:ac4dea3e2894 56
seyhmus.cacina 0:ac4dea3e2894 57 KEY_PRINT_SCREEN, /* Print Screen key */
seyhmus.cacina 0:ac4dea3e2894 58 KEY_SCROLL_LOCK, /* Scroll lock */
seyhmus.cacina 0:ac4dea3e2894 59 KEY_CAPS_LOCK, /* caps lock */
seyhmus.cacina 0:ac4dea3e2894 60 KEY_NUM_LOCK, /* num lock */
seyhmus.cacina 0:ac4dea3e2894 61 KEY_INSERT, /* Insert key */
seyhmus.cacina 0:ac4dea3e2894 62 KEY_HOME, /* Home key */
seyhmus.cacina 0:ac4dea3e2894 63 KEY_PAGE_UP, /* Page Up key */
seyhmus.cacina 0:ac4dea3e2894 64 KEY_PAGE_DOWN, /* Page Down key */
seyhmus.cacina 0:ac4dea3e2894 65
seyhmus.cacina 0:ac4dea3e2894 66 RIGHT_ARROW, /* Right arrow */
seyhmus.cacina 0:ac4dea3e2894 67 LEFT_ARROW, /* Left arrow */
seyhmus.cacina 0:ac4dea3e2894 68 DOWN_ARROW, /* Down arrow */
seyhmus.cacina 0:ac4dea3e2894 69 UP_ARROW, /* Up arrow */
seyhmus.cacina 0:ac4dea3e2894 70 };
seyhmus.cacina 0:ac4dea3e2894 71
seyhmus.cacina 0:ac4dea3e2894 72 /**
seyhmus.cacina 0:ac4dea3e2894 73 * USBKeyboard example
seyhmus.cacina 0:ac4dea3e2894 74 * @code
seyhmus.cacina 0:ac4dea3e2894 75 *
seyhmus.cacina 0:ac4dea3e2894 76 * #include "mbed.h"
seyhmus.cacina 0:ac4dea3e2894 77 * #include "USBKeyboard.h"
seyhmus.cacina 0:ac4dea3e2894 78 *
seyhmus.cacina 0:ac4dea3e2894 79 * USBKeyboard key;
seyhmus.cacina 0:ac4dea3e2894 80 *
seyhmus.cacina 0:ac4dea3e2894 81 * int main(void)
seyhmus.cacina 0:ac4dea3e2894 82 * {
seyhmus.cacina 0:ac4dea3e2894 83 * while (1)
seyhmus.cacina 0:ac4dea3e2894 84 * {
seyhmus.cacina 0:ac4dea3e2894 85 * key.printf("Hello World\r\n");
seyhmus.cacina 0:ac4dea3e2894 86 * wait(1);
seyhmus.cacina 0:ac4dea3e2894 87 * }
seyhmus.cacina 0:ac4dea3e2894 88 * }
seyhmus.cacina 0:ac4dea3e2894 89 *
seyhmus.cacina 0:ac4dea3e2894 90 * @endcode
seyhmus.cacina 0:ac4dea3e2894 91 */
seyhmus.cacina 0:ac4dea3e2894 92 class USBKeyboard: public USBHID, public Stream {
seyhmus.cacina 0:ac4dea3e2894 93 public:
seyhmus.cacina 0:ac4dea3e2894 94
seyhmus.cacina 0:ac4dea3e2894 95 /**
seyhmus.cacina 0:ac4dea3e2894 96 * Constructor
seyhmus.cacina 0:ac4dea3e2894 97 *
seyhmus.cacina 0:ac4dea3e2894 98 *
seyhmus.cacina 0:ac4dea3e2894 99 * @param leds Leds bus: first: NUM_LOCK, second: CAPS_LOCK, third: SCROLL_LOCK
seyhmus.cacina 0:ac4dea3e2894 100 * @param vendor_id Your vendor_id (default: 0x1235)
seyhmus.cacina 0:ac4dea3e2894 101 * @param product_id Your product_id (default: 0x0050)
seyhmus.cacina 0:ac4dea3e2894 102 * @param product_release Your preoduct_release (default: 0x0001)
seyhmus.cacina 0:ac4dea3e2894 103 *
seyhmus.cacina 0:ac4dea3e2894 104 */
seyhmus.cacina 0:ac4dea3e2894 105 USBKeyboard(uint16_t vendor_id = 0x1235, uint16_t product_id = 0x0050, uint16_t product_release = 0x0001):
seyhmus.cacina 0:ac4dea3e2894 106 USBHID(0, 0, vendor_id, product_id, product_release, false) {
seyhmus.cacina 0:ac4dea3e2894 107 lock_status = 0;
seyhmus.cacina 0:ac4dea3e2894 108 connect();
seyhmus.cacina 0:ac4dea3e2894 109 };
seyhmus.cacina 0:ac4dea3e2894 110
seyhmus.cacina 0:ac4dea3e2894 111 /**
seyhmus.cacina 0:ac4dea3e2894 112 * To send a character defined by a modifier(CTRL, SHIFT, ALT) and the key
seyhmus.cacina 0:ac4dea3e2894 113 *
seyhmus.cacina 0:ac4dea3e2894 114 * @code
seyhmus.cacina 0:ac4dea3e2894 115 * //To send CTRL + s (save)
seyhmus.cacina 0:ac4dea3e2894 116 * keyboard.keyCode('s', KEY_CTRL);
seyhmus.cacina 0:ac4dea3e2894 117 * @endcode
seyhmus.cacina 0:ac4dea3e2894 118 *
seyhmus.cacina 0:ac4dea3e2894 119 * @param modifier bit 0: KEY_CTRL, bit 1: KEY_SHIFT, bit 2: KEY_ALT (default: 0)
seyhmus.cacina 0:ac4dea3e2894 120 * @param key character to send
seyhmus.cacina 0:ac4dea3e2894 121 * @returns true if there is no error, false otherwise
seyhmus.cacina 0:ac4dea3e2894 122 */
seyhmus.cacina 0:ac4dea3e2894 123 bool keyCode(uint8_t key, uint8_t modifier = 0);
seyhmus.cacina 0:ac4dea3e2894 124
seyhmus.cacina 0:ac4dea3e2894 125 /**
seyhmus.cacina 0:ac4dea3e2894 126 * Send a character
seyhmus.cacina 0:ac4dea3e2894 127 *
seyhmus.cacina 0:ac4dea3e2894 128 * @param c character to be sent
seyhmus.cacina 0:ac4dea3e2894 129 * @returns true if there is no error, false otherwise
seyhmus.cacina 0:ac4dea3e2894 130 */
seyhmus.cacina 0:ac4dea3e2894 131 virtual int _putc(int c);
seyhmus.cacina 0:ac4dea3e2894 132
seyhmus.cacina 0:ac4dea3e2894 133 /**
seyhmus.cacina 0:ac4dea3e2894 134 * Control media keys
seyhmus.cacina 0:ac4dea3e2894 135 *
seyhmus.cacina 0:ac4dea3e2894 136 * @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 137 * @returns true if there is no error, false otherwise
seyhmus.cacina 0:ac4dea3e2894 138 */
seyhmus.cacina 0:ac4dea3e2894 139 bool mediaControl(MEDIA_KEY key);
seyhmus.cacina 0:ac4dea3e2894 140
seyhmus.cacina 0:ac4dea3e2894 141 /*
seyhmus.cacina 0:ac4dea3e2894 142 * To define the report descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
seyhmus.cacina 0:ac4dea3e2894 143 *
seyhmus.cacina 0:ac4dea3e2894 144 * @returns pointer to the report descriptor
seyhmus.cacina 0:ac4dea3e2894 145 */
seyhmus.cacina 0:ac4dea3e2894 146 virtual uint8_t * reportDesc();
seyhmus.cacina 0:ac4dea3e2894 147
seyhmus.cacina 0:ac4dea3e2894 148 /*
seyhmus.cacina 0:ac4dea3e2894 149 * Called when a data is received on the OUT endpoint. Useful to switch on LED of LOCK keys
seyhmus.cacina 0:ac4dea3e2894 150 *
seyhmus.cacina 0:ac4dea3e2894 151 * @returns if handle by subclass, return true
seyhmus.cacina 0:ac4dea3e2894 152 */
seyhmus.cacina 0:ac4dea3e2894 153 virtual bool EPINT_OUT_callback();
seyhmus.cacina 0:ac4dea3e2894 154
seyhmus.cacina 0:ac4dea3e2894 155 /**
seyhmus.cacina 0:ac4dea3e2894 156 * 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 157 * - First bit: NUM_LOCK
seyhmus.cacina 0:ac4dea3e2894 158 * - Second bit: CAPS_LOCK
seyhmus.cacina 0:ac4dea3e2894 159 * - Third bit: SCROLL_LOCK
seyhmus.cacina 0:ac4dea3e2894 160 *
seyhmus.cacina 0:ac4dea3e2894 161 * @returns status of lock keys
seyhmus.cacina 0:ac4dea3e2894 162 */
seyhmus.cacina 0:ac4dea3e2894 163 uint8_t lockStatus();
seyhmus.cacina 0:ac4dea3e2894 164
seyhmus.cacina 0:ac4dea3e2894 165 protected:
seyhmus.cacina 0:ac4dea3e2894 166 /*
seyhmus.cacina 0:ac4dea3e2894 167 * Get configuration descriptor
seyhmus.cacina 0:ac4dea3e2894 168 *
seyhmus.cacina 0:ac4dea3e2894 169 * @returns pointer to the configuration descriptor
seyhmus.cacina 0:ac4dea3e2894 170 */
seyhmus.cacina 0:ac4dea3e2894 171 virtual uint8_t * configurationDesc();
seyhmus.cacina 0:ac4dea3e2894 172
seyhmus.cacina 0:ac4dea3e2894 173 private:
seyhmus.cacina 0:ac4dea3e2894 174 //dummy otherwise it doesn,t compile (we must define all methods of an abstract class)
seyhmus.cacina 0:ac4dea3e2894 175 virtual int _getc() {
seyhmus.cacina 0:ac4dea3e2894 176 return -1;
seyhmus.cacina 0:ac4dea3e2894 177 };
seyhmus.cacina 0:ac4dea3e2894 178
seyhmus.cacina 0:ac4dea3e2894 179 uint8_t lock_status;
seyhmus.cacina 0:ac4dea3e2894 180
seyhmus.cacina 0:ac4dea3e2894 181 };
seyhmus.cacina 0:ac4dea3e2894 182
seyhmus.cacina 0:ac4dea3e2894 183 #endif