_mu ki / USBDevice

Add follows to keyCode in USBKeyboard.h. KEY_BS, /* BS */ KEY_TAB, /* TAB */ KEY_LF, /* LF */

Dependents:   Clicker

Fork of USBDevice by mbed official

USBHID/USBKeyboard.h@6:96e29f4e3806, 2012-11-15 (annotated)

Committer:
_muki
Date:
Thu Nov 15 14:17:00 2012 +0000
Revision:
6:96e29f4e3806
Parent:
1:80ab0d068708 
USBKeyboard.h??keyCode????????; ;     KEY_BS,         /* BS  */ ;     KEY_TAB,        /* TAB */;     KEY_LF,         /* LF  */

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