Suga koubou
Dependencies: ChaNFSSD mbed ChaNFS
USBDevice/USBHID/USBKeyboard.h@1:efbcfbae4747, 2011-11-10 (annotated)
- Committer:
- okini3939
- Date:
- Thu Nov 10 03:20:42 2011 +0000
- Revision:
- 1:efbcfbae4747
- Parent:
- 0:02c293160df3
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| okini3939 | 0:02c293160df3 | 1 | /* USBKeyboard.h */ |
| okini3939 | 0:02c293160df3 | 2 | /* USB device example: Standard keyboard */ |
| okini3939 | 0:02c293160df3 | 3 | /* Copyright (c) 2011 ARM Limited. All rights reserved. */ |
| okini3939 | 0:02c293160df3 | 4 | |
| okini3939 | 0:02c293160df3 | 5 | #ifndef USBKEYBOARD_H |
| okini3939 | 0:02c293160df3 | 6 | #define USBKEYBOARD_H |
| okini3939 | 0:02c293160df3 | 7 | |
| okini3939 | 0:02c293160df3 | 8 | #include "USBHID.h" |
| okini3939 | 0:02c293160df3 | 9 | #include "Stream.h" |
| okini3939 | 0:02c293160df3 | 10 | |
| okini3939 | 0:02c293160df3 | 11 | /* Modifiers */ |
| okini3939 | 0:02c293160df3 | 12 | enum MODIFIER_KEY |
| okini3939 | 0:02c293160df3 | 13 | { |
| okini3939 | 0:02c293160df3 | 14 | KEY_CTRL = 1, |
| okini3939 | 0:02c293160df3 | 15 | KEY_SHIFT = 2, |
| okini3939 | 0:02c293160df3 | 16 | KEY_ALT = 4, |
| okini3939 | 0:02c293160df3 | 17 | }; |
| okini3939 | 0:02c293160df3 | 18 | |
| okini3939 | 0:02c293160df3 | 19 | |
| okini3939 | 0:02c293160df3 | 20 | enum MEDIA_KEY |
| okini3939 | 0:02c293160df3 | 21 | { |
| okini3939 | 0:02c293160df3 | 22 | KEY_NEXT_TRACK, /*!< next Track Button */ |
| okini3939 | 0:02c293160df3 | 23 | KEY_PREVIOUS_TRACK, /*!< Previous track Button */ |
| okini3939 | 0:02c293160df3 | 24 | KEY_STOP, /*!< Stop Button */ |
| okini3939 | 0:02c293160df3 | 25 | KEY_PLAY_PAUSE, /*!< Play/Pause Button */ |
| okini3939 | 0:02c293160df3 | 26 | KEY_MUTE, /*!< Mute Button */ |
| okini3939 | 0:02c293160df3 | 27 | KEY_VOLUME_UP, /*!< Volume Up Button */ |
| okini3939 | 0:02c293160df3 | 28 | KEY_VOLUME_DOWN, /*!< Volume Down Button */ |
| okini3939 | 0:02c293160df3 | 29 | }; |
| okini3939 | 0:02c293160df3 | 30 | |
| okini3939 | 0:02c293160df3 | 31 | enum FUNCTION_KEY |
| okini3939 | 0:02c293160df3 | 32 | { |
| okini3939 | 0:02c293160df3 | 33 | KEY_F1 = 128, /* F1 key */ |
| okini3939 | 0:02c293160df3 | 34 | KEY_F2, /* F2 key */ |
| okini3939 | 0:02c293160df3 | 35 | KEY_F3, /* F3 key */ |
| okini3939 | 0:02c293160df3 | 36 | KEY_F4, /* F4 key */ |
| okini3939 | 0:02c293160df3 | 37 | KEY_F5, /* F5 key */ |
| okini3939 | 0:02c293160df3 | 38 | KEY_F6, /* F6 key */ |
| okini3939 | 0:02c293160df3 | 39 | KEY_F7, /* F7 key */ |
| okini3939 | 0:02c293160df3 | 40 | KEY_F8, /* F8 key */ |
| okini3939 | 0:02c293160df3 | 41 | KEY_F9, /* F9 key */ |
| okini3939 | 0:02c293160df3 | 42 | KEY_F10, /* F10 key */ |
| okini3939 | 0:02c293160df3 | 43 | KEY_F11, /* F11 key */ |
| okini3939 | 0:02c293160df3 | 44 | KEY_F12, /* F12 key */ |
| okini3939 | 0:02c293160df3 | 45 | KEY_PRINT_SCREEN, /* Print Screen key */ |
| okini3939 | 0:02c293160df3 | 46 | KEY_INSERT, /* Insert key */ |
| okini3939 | 0:02c293160df3 | 47 | KEY_HOME, /* Home key */ |
| okini3939 | 0:02c293160df3 | 48 | KEY_PAGE_UP, /* Page Up key */ |
| okini3939 | 0:02c293160df3 | 49 | KEY_PAGE_DOWN, /* Page Down key */ |
| okini3939 | 0:02c293160df3 | 50 | }; |
| okini3939 | 0:02c293160df3 | 51 | |
| okini3939 | 0:02c293160df3 | 52 | /** |
| okini3939 | 0:02c293160df3 | 53 | * USBKeyboard example |
| okini3939 | 0:02c293160df3 | 54 | * @code |
| okini3939 | 0:02c293160df3 | 55 | * |
| okini3939 | 0:02c293160df3 | 56 | * #include "mbed.h" |
| okini3939 | 0:02c293160df3 | 57 | * #include "USBKeyboard.h" |
| okini3939 | 0:02c293160df3 | 58 | * |
| okini3939 | 0:02c293160df3 | 59 | * USBKeyboard key; |
| okini3939 | 0:02c293160df3 | 60 | * |
| okini3939 | 0:02c293160df3 | 61 | * int main(void) |
| okini3939 | 0:02c293160df3 | 62 | * { |
| okini3939 | 0:02c293160df3 | 63 | * while (1) |
| okini3939 | 0:02c293160df3 | 64 | * { |
| okini3939 | 0:02c293160df3 | 65 | * key.printf("Hello World\r\n"); |
| okini3939 | 0:02c293160df3 | 66 | * wait(1); |
| okini3939 | 0:02c293160df3 | 67 | * } |
| okini3939 | 0:02c293160df3 | 68 | * } |
| okini3939 | 0:02c293160df3 | 69 | * |
| okini3939 | 0:02c293160df3 | 70 | * @endcode |
| okini3939 | 0:02c293160df3 | 71 | */ |
| okini3939 | 0:02c293160df3 | 72 | class USBKeyboard: public USBHID, public Stream |
| okini3939 | 0:02c293160df3 | 73 | { |
| okini3939 | 0:02c293160df3 | 74 | public: |
| okini3939 | 0:02c293160df3 | 75 | |
| okini3939 | 0:02c293160df3 | 76 | /** |
| okini3939 | 0:02c293160df3 | 77 | * Constructor |
| okini3939 | 0:02c293160df3 | 78 | * |
| okini3939 | 0:02c293160df3 | 79 | * @param vendor_id Your vendor_id (default: 0x1234) |
| okini3939 | 0:02c293160df3 | 80 | * @param product_id Your product_id (default: 0x0001) |
| okini3939 | 0:02c293160df3 | 81 | * @param product_release Your preoduct_release (default: 0x0001) |
| okini3939 | 0:02c293160df3 | 82 | * |
| okini3939 | 0:02c293160df3 | 83 | */ |
| okini3939 | 0:02c293160df3 | 84 | USBKeyboard(uint16_t vendor_id = 0x1234, uint16_t product_id = 0x0003, uint16_t product_release = 0x0001): USBHID(0, 0, vendor_id, product_id, product_release){}; |
| okini3939 | 0:02c293160df3 | 85 | |
| okini3939 | 0:02c293160df3 | 86 | /** |
| okini3939 | 0:02c293160df3 | 87 | * To send a character defined by a modifier(CTRL, SHIFT, ALT) and the key |
| okini3939 | 0:02c293160df3 | 88 | * |
| okini3939 | 0:02c293160df3 | 89 | * @code |
| okini3939 | 0:02c293160df3 | 90 | * //To send CTRL + s (save) |
| okini3939 | 0:02c293160df3 | 91 | * keyboard.keyCode('s', KEY_CTRL); |
| okini3939 | 0:02c293160df3 | 92 | * @endcode |
| okini3939 | 0:02c293160df3 | 93 | * |
| okini3939 | 0:02c293160df3 | 94 | * @param modifier bit 0: KEY_CTRL, bit 1: KEY_SHIFT, bit 2: KEY_ALT (default: 0) |
| okini3939 | 0:02c293160df3 | 95 | * @param key character to send |
| okini3939 | 0:02c293160df3 | 96 | * @returns true if there is no error, false otherwise |
| okini3939 | 0:02c293160df3 | 97 | */ |
| okini3939 | 0:02c293160df3 | 98 | bool keyCode(uint8_t key, uint8_t modifier = 0); |
| okini3939 | 0:02c293160df3 | 99 | |
| okini3939 | 0:02c293160df3 | 100 | /** |
| okini3939 | 0:02c293160df3 | 101 | * Send a character |
| okini3939 | 0:02c293160df3 | 102 | * |
| okini3939 | 0:02c293160df3 | 103 | * @param c character to be sent |
| okini3939 | 0:02c293160df3 | 104 | * @returns true if there is no error, false otherwise |
| okini3939 | 0:02c293160df3 | 105 | */ |
| okini3939 | 0:02c293160df3 | 106 | virtual int _putc(int c); |
| okini3939 | 0:02c293160df3 | 107 | |
| okini3939 | 0:02c293160df3 | 108 | /** |
| okini3939 | 0:02c293160df3 | 109 | * Control media keys |
| okini3939 | 0:02c293160df3 | 110 | * |
| okini3939 | 0:02c293160df3 | 111 | * @param key media key pressed (KEY_NEXT_TRACK, KEY_PREVIOUS_TRACK, KEY_STOP, KEY_PLAY_PAUSE, KEY_MUTE, KEY_VOLUME_UP, KEY_VOLUME_DOWN) |
| okini3939 | 0:02c293160df3 | 112 | * @returns true if there is no error, false otherwise |
| okini3939 | 0:02c293160df3 | 113 | */ |
| okini3939 | 0:02c293160df3 | 114 | bool mediaControl(MEDIA_KEY key); |
| okini3939 | 0:02c293160df3 | 115 | |
| okini3939 | 0:02c293160df3 | 116 | /* |
| okini3939 | 0:02c293160df3 | 117 | * To define the report descriptor. Warning: this method has to store the length of the report descriptor in reportLength. |
| okini3939 | 0:02c293160df3 | 118 | * |
| okini3939 | 0:02c293160df3 | 119 | * @returns pointer to the report descriptor |
| okini3939 | 0:02c293160df3 | 120 | */ |
| okini3939 | 0:02c293160df3 | 121 | virtual uint8_t * reportDesc(); |
| okini3939 | 0:02c293160df3 | 122 | |
| okini3939 | 0:02c293160df3 | 123 | private: |
| okini3939 | 0:02c293160df3 | 124 | //dummy otherwise it doesn,t compile (we must define all methods of an abstract class) |
| okini3939 | 0:02c293160df3 | 125 | virtual int _getc() { return -1;} |
| okini3939 | 0:02c293160df3 | 126 | }; |
| okini3939 | 0:02c293160df3 | 127 | |
| okini3939 | 0:02c293160df3 | 128 | #endif |
| okini3939 | 0:02c293160df3 | 129 | |
| okini3939 | 0:02c293160df3 | 130 |