goma yam / USBDevice

USBDevice

Dependents:   QEI_X1_LCD_test3 macnica_test

USBHID/USBKeyboard.h@0:2d8d0b73e1ff, 2013-04-18 (annotated)

Committer:
toucyy
Date:
Thu Apr 18 07:49:37 2013 +0000
Revision:
0:2d8d0b73e1ff
[mbed] converted /QEI_HelloWorld/USBDevice

Who changed what in which revision?

UserRevisionLine numberNew contents of line
toucyy 0:2d8d0b73e1ff 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
toucyy 0:2d8d0b73e1ff 2 *
toucyy 0:2d8d0b73e1ff 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
toucyy 0:2d8d0b73e1ff 4 * and associated documentation files (the "Software"), to deal in the Software without
toucyy 0:2d8d0b73e1ff 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
toucyy 0:2d8d0b73e1ff 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
toucyy 0:2d8d0b73e1ff 7 * Software is furnished to do so, subject to the following conditions:
toucyy 0:2d8d0b73e1ff 8 *
toucyy 0:2d8d0b73e1ff 9 * The above copyright notice and this permission notice shall be included in all copies or
toucyy 0:2d8d0b73e1ff 10 * substantial portions of the Software.
toucyy 0:2d8d0b73e1ff 11 *
toucyy 0:2d8d0b73e1ff 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
toucyy 0:2d8d0b73e1ff 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
toucyy 0:2d8d0b73e1ff 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
toucyy 0:2d8d0b73e1ff 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
toucyy 0:2d8d0b73e1ff 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
toucyy 0:2d8d0b73e1ff 17 */
toucyy 0:2d8d0b73e1ff 18
toucyy 0:2d8d0b73e1ff 19 #ifndef USBKEYBOARD_H
toucyy 0:2d8d0b73e1ff 20 #define USBKEYBOARD_H
toucyy 0:2d8d0b73e1ff 21
toucyy 0:2d8d0b73e1ff 22 #include "USBHID.h"
toucyy 0:2d8d0b73e1ff 23 #include "Stream.h"
toucyy 0:2d8d0b73e1ff 24
toucyy 0:2d8d0b73e1ff 25 /* Modifiers */
toucyy 0:2d8d0b73e1ff 26 enum MODIFIER_KEY
toucyy 0:2d8d0b73e1ff 27 {
toucyy 0:2d8d0b73e1ff 28 KEY_CTRL = 1,
toucyy 0:2d8d0b73e1ff 29 KEY_SHIFT = 2,
toucyy 0:2d8d0b73e1ff 30 KEY_ALT = 4,
toucyy 0:2d8d0b73e1ff 31 };
toucyy 0:2d8d0b73e1ff 32
toucyy 0:2d8d0b73e1ff 33
toucyy 0:2d8d0b73e1ff 34 enum MEDIA_KEY
toucyy 0:2d8d0b73e1ff 35 {
toucyy 0:2d8d0b73e1ff 36 KEY_NEXT_TRACK, /*!< next Track Button */
toucyy 0:2d8d0b73e1ff 37 KEY_PREVIOUS_TRACK, /*!< Previous track Button */
toucyy 0:2d8d0b73e1ff 38 KEY_STOP, /*!< Stop Button */
toucyy 0:2d8d0b73e1ff 39 KEY_PLAY_PAUSE, /*!< Play/Pause Button */
toucyy 0:2d8d0b73e1ff 40 KEY_MUTE, /*!< Mute Button */
toucyy 0:2d8d0b73e1ff 41 KEY_VOLUME_UP, /*!< Volume Up Button */
toucyy 0:2d8d0b73e1ff 42 KEY_VOLUME_DOWN, /*!< Volume Down Button */
toucyy 0:2d8d0b73e1ff 43 };
toucyy 0:2d8d0b73e1ff 44
toucyy 0:2d8d0b73e1ff 45 enum FUNCTION_KEY
toucyy 0:2d8d0b73e1ff 46 {
toucyy 0:2d8d0b73e1ff 47 KEY_F1 = 128, /* F1 key */
toucyy 0:2d8d0b73e1ff 48 KEY_F2, /* F2 key */
toucyy 0:2d8d0b73e1ff 49 KEY_F3, /* F3 key */
toucyy 0:2d8d0b73e1ff 50 KEY_F4, /* F4 key */
toucyy 0:2d8d0b73e1ff 51 KEY_F5, /* F5 key */
toucyy 0:2d8d0b73e1ff 52 KEY_F6, /* F6 key */
toucyy 0:2d8d0b73e1ff 53 KEY_F7, /* F7 key */
toucyy 0:2d8d0b73e1ff 54 KEY_F8, /* F8 key */
toucyy 0:2d8d0b73e1ff 55 KEY_F9, /* F9 key */
toucyy 0:2d8d0b73e1ff 56 KEY_F10, /* F10 key */
toucyy 0:2d8d0b73e1ff 57 KEY_F11, /* F11 key */
toucyy 0:2d8d0b73e1ff 58 KEY_F12, /* F12 key */
toucyy 0:2d8d0b73e1ff 59 KEY_PRINT_SCREEN, /* Print Screen key */
toucyy 0:2d8d0b73e1ff 60 KEY_SCROLL_LOCK, /* Scroll lock */
toucyy 0:2d8d0b73e1ff 61 KEY_CAPS_LOCK, /* caps lock */
toucyy 0:2d8d0b73e1ff 62 KEY_NUM_LOCK, /* num lock */
toucyy 0:2d8d0b73e1ff 63 KEY_INSERT, /* Insert key */
toucyy 0:2d8d0b73e1ff 64 KEY_HOME, /* Home key */
toucyy 0:2d8d0b73e1ff 65 KEY_PAGE_UP, /* Page Up key */
toucyy 0:2d8d0b73e1ff 66 KEY_PAGE_DOWN, /* Page Down key */
toucyy 0:2d8d0b73e1ff 67 };
toucyy 0:2d8d0b73e1ff 68
toucyy 0:2d8d0b73e1ff 69 /**
toucyy 0:2d8d0b73e1ff 70 * USBKeyboard example
toucyy 0:2d8d0b73e1ff 71 * @code
toucyy 0:2d8d0b73e1ff 72 *
toucyy 0:2d8d0b73e1ff 73 * #include "mbed.h"
toucyy 0:2d8d0b73e1ff 74 * #include "USBKeyboard.h"
toucyy 0:2d8d0b73e1ff 75 *
toucyy 0:2d8d0b73e1ff 76 * USBKeyboard key;
toucyy 0:2d8d0b73e1ff 77 *
toucyy 0:2d8d0b73e1ff 78 * int main(void)
toucyy 0:2d8d0b73e1ff 79 * {
toucyy 0:2d8d0b73e1ff 80 * while (1)
toucyy 0:2d8d0b73e1ff 81 * {
toucyy 0:2d8d0b73e1ff 82 * key.printf("Hello World\r\n");
toucyy 0:2d8d0b73e1ff 83 * wait(1);
toucyy 0:2d8d0b73e1ff 84 * }
toucyy 0:2d8d0b73e1ff 85 * }
toucyy 0:2d8d0b73e1ff 86 *
toucyy 0:2d8d0b73e1ff 87 * @endcode
toucyy 0:2d8d0b73e1ff 88 */
toucyy 0:2d8d0b73e1ff 89 class USBKeyboard: public USBHID, public Stream
toucyy 0:2d8d0b73e1ff 90 {
toucyy 0:2d8d0b73e1ff 91 public:
toucyy 0:2d8d0b73e1ff 92
toucyy 0:2d8d0b73e1ff 93 /**
toucyy 0:2d8d0b73e1ff 94 * Constructor
toucyy 0:2d8d0b73e1ff 95 *
toucyy 0:2d8d0b73e1ff 96 *
toucyy 0:2d8d0b73e1ff 97 * @param leds Leds bus: first: NUM_LOCK, second: CAPS_LOCK, third: SCROLL_LOCK
toucyy 0:2d8d0b73e1ff 98 * @param vendor_id Your vendor_id (default: 0x1235)
toucyy 0:2d8d0b73e1ff 99 * @param product_id Your product_id (default: 0x0050)
toucyy 0:2d8d0b73e1ff 100 * @param product_release Your preoduct_release (default: 0x0001)
toucyy 0:2d8d0b73e1ff 101 *
toucyy 0:2d8d0b73e1ff 102 */
toucyy 0:2d8d0b73e1ff 103 USBKeyboard(uint16_t vendor_id = 0x1235, uint16_t product_id = 0x0050, uint16_t product_release = 0x0001):
toucyy 0:2d8d0b73e1ff 104 USBHID(0, 0, vendor_id, product_id, product_release, false){
toucyy 0:2d8d0b73e1ff 105 lock_status = 0;
toucyy 0:2d8d0b73e1ff 106 connect();
toucyy 0:2d8d0b73e1ff 107 };
toucyy 0:2d8d0b73e1ff 108
toucyy 0:2d8d0b73e1ff 109 /**
toucyy 0:2d8d0b73e1ff 110 * To send a character defined by a modifier(CTRL, SHIFT, ALT) and the key
toucyy 0:2d8d0b73e1ff 111 *
toucyy 0:2d8d0b73e1ff 112 * @code
toucyy 0:2d8d0b73e1ff 113 * //To send CTRL + s (save)
toucyy 0:2d8d0b73e1ff 114 * keyboard.keyCode('s', KEY_CTRL);
toucyy 0:2d8d0b73e1ff 115 * @endcode
toucyy 0:2d8d0b73e1ff 116 *
toucyy 0:2d8d0b73e1ff 117 * @param modifier bit 0: KEY_CTRL, bit 1: KEY_SHIFT, bit 2: KEY_ALT (default: 0)
toucyy 0:2d8d0b73e1ff 118 * @param key character to send
toucyy 0:2d8d0b73e1ff 119 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 120 */
toucyy 0:2d8d0b73e1ff 121 bool keyCode(uint8_t key, uint8_t modifier = 0);
toucyy 0:2d8d0b73e1ff 122
toucyy 0:2d8d0b73e1ff 123 /**
toucyy 0:2d8d0b73e1ff 124 * Send a character
toucyy 0:2d8d0b73e1ff 125 *
toucyy 0:2d8d0b73e1ff 126 * @param c character to be sent
toucyy 0:2d8d0b73e1ff 127 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 128 */
toucyy 0:2d8d0b73e1ff 129 virtual int _putc(int c);
toucyy 0:2d8d0b73e1ff 130
toucyy 0:2d8d0b73e1ff 131 /**
toucyy 0:2d8d0b73e1ff 132 * Control media keys
toucyy 0:2d8d0b73e1ff 133 *
toucyy 0:2d8d0b73e1ff 134 * @param key media key pressed (KEY_NEXT_TRACK, KEY_PREVIOUS_TRACK, KEY_STOP, KEY_PLAY_PAUSE, KEY_MUTE, KEY_VOLUME_UP, KEY_VOLUME_DOWN)
toucyy 0:2d8d0b73e1ff 135 * @returns true if there is no error, false otherwise
toucyy 0:2d8d0b73e1ff 136 */
toucyy 0:2d8d0b73e1ff 137 bool mediaControl(MEDIA_KEY key);
toucyy 0:2d8d0b73e1ff 138
toucyy 0:2d8d0b73e1ff 139 /*
toucyy 0:2d8d0b73e1ff 140 * To define the report descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
toucyy 0:2d8d0b73e1ff 141 *
toucyy 0:2d8d0b73e1ff 142 * @returns pointer to the report descriptor
toucyy 0:2d8d0b73e1ff 143 */
toucyy 0:2d8d0b73e1ff 144 virtual uint8_t * reportDesc();
toucyy 0:2d8d0b73e1ff 145
toucyy 0:2d8d0b73e1ff 146 /*
toucyy 0:2d8d0b73e1ff 147 * Called when a data is received on the OUT endpoint. Useful to switch on LED of LOCK keys
toucyy 0:2d8d0b73e1ff 148 *
toucyy 0:2d8d0b73e1ff 149 * @returns if handle by subclass, return true
toucyy 0:2d8d0b73e1ff 150 */
toucyy 0:2d8d0b73e1ff 151 virtual bool EP1_OUT_callback();
toucyy 0:2d8d0b73e1ff 152
toucyy 0:2d8d0b73e1ff 153 /**
toucyy 0:2d8d0b73e1ff 154 * 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:
toucyy 0:2d8d0b73e1ff 155 * - First bit: NUM_LOCK
toucyy 0:2d8d0b73e1ff 156 * - Second bit: CAPS_LOCK
toucyy 0:2d8d0b73e1ff 157 * - Third bit: SCROLL_LOCK
toucyy 0:2d8d0b73e1ff 158 *
toucyy 0:2d8d0b73e1ff 159 * @returns status of lock keys
toucyy 0:2d8d0b73e1ff 160 */
toucyy 0:2d8d0b73e1ff 161 uint8_t lockStatus();
toucyy 0:2d8d0b73e1ff 162
toucyy 0:2d8d0b73e1ff 163 private:
toucyy 0:2d8d0b73e1ff 164 //dummy otherwise it doesn,t compile (we must define all methods of an abstract class)
toucyy 0:2d8d0b73e1ff 165 virtual int _getc() { return -1;};
toucyy 0:2d8d0b73e1ff 166
toucyy 0:2d8d0b73e1ff 167 uint8_t lock_status;
toucyy 0:2d8d0b73e1ff 168 };
toucyy 0:2d8d0b73e1ff 169
toucyy 0:2d8d0b73e1ff 170 #endif