Yasushi TAUCHI / USBDevice

add keycode2 at USBKeyboard

Dependents:   USBKeyboard_HelloWorld

Fork of USBDevice by Samuel Mokrani

USBHID/USBKeyboard.h@1:4c0daa716c71, 2012-10-05 (annotated)

Committer:
yueee_yt
Date:
Fri Oct 05 11:56:43 2012 +0000
Revision:
1:4c0daa716c71
Parent:
0:140cdf8e2d60 
add keycode2 at USBKeyboard

Who changed what in which revision?

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