Lucas Lim / Mbed 2 deprecated HSP_Temperature_Barometer_CS3237

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

USBDevice_copy/USBHID/USBKeyboard.h@22:5c07298d3383, 2019-08-26 (annotated)

Committer:
lucaslwl
Date:
Mon Aug 26 08:11:41 2019 +0000
Revision:
22:5c07298d3383
add library folder

Who changed what in which revision?

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