Piotr Woźniak / Mbed 2 deprecated KL46Z-Lab2_fullll

blablabla

Dependencies:   MAG3110 MMA8451Q SLCD- TSI USBDevice mbed

USBDevice/USBHID/USBKeyboard.h@0:339b7abfa147, 2014-04-16 (annotated)

Committer:
Osator
Date:
Wed Apr 16 12:20:00 2014 +0000
Revision:
0:339b7abfa147
blablabla

Who changed what in which revision?

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