Angel David Yaguana Hernandez / USBDevice2

library

Dependents:   USB_CDC_MSD_Hello

USBHID/USBKeyboard.h@0:d5bb9a9c3e24, 2012-08-24 (annotated)

Committer:
sherckuith
Date:
Fri Aug 24 02:01:51 2012 +0000
Revision:
0:d5bb9a9c3e24
[mbed] converted /USB_CDC_MSD_Hello/USBDevice

Who changed what in which revision?

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