Dylan Saada / Mbed 2 deprecated telemetre2

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

USBHost/USBHostHID/USBHostKeyboard.h@0:6ce9c65992e5, 2015-04-15 (annotated)

Committer:
dylancachan
Date:
Wed Apr 15 06:23:18 2015 +0000
Revision:
0:6ce9c65992e5
telemetre

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dylancachan 0:6ce9c65992e5 1 /* mbed USBHost Library
dylancachan 0:6ce9c65992e5 2 * Copyright (c) 2006-2013 ARM Limited
dylancachan 0:6ce9c65992e5 3 *
dylancachan 0:6ce9c65992e5 4 * Licensed under the Apache License, Version 2.0 (the "License");
dylancachan 0:6ce9c65992e5 5 * you may not use this file except in compliance with the License.
dylancachan 0:6ce9c65992e5 6 * You may obtain a copy of the License at
dylancachan 0:6ce9c65992e5 7 *
dylancachan 0:6ce9c65992e5 8 * http://www.apache.org/licenses/LICENSE-2.0
dylancachan 0:6ce9c65992e5 9 *
dylancachan 0:6ce9c65992e5 10 * Unless required by applicable law or agreed to in writing, software
dylancachan 0:6ce9c65992e5 11 * distributed under the License is distributed on an "AS IS" BASIS,
dylancachan 0:6ce9c65992e5 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
dylancachan 0:6ce9c65992e5 13 * See the License for the specific language governing permissions and
dylancachan 0:6ce9c65992e5 14 * limitations under the License.
dylancachan 0:6ce9c65992e5 15 */
dylancachan 0:6ce9c65992e5 16
dylancachan 0:6ce9c65992e5 17 #ifndef USBHOSTKEYBOARD_H
dylancachan 0:6ce9c65992e5 18 #define USBHOSTKEYBOARD_H
dylancachan 0:6ce9c65992e5 19
dylancachan 0:6ce9c65992e5 20 #include "USBHostConf.h"
dylancachan 0:6ce9c65992e5 21
dylancachan 0:6ce9c65992e5 22 #if USBHOST_KEYBOARD
dylancachan 0:6ce9c65992e5 23
dylancachan 0:6ce9c65992e5 24 #include "USBHost.h"
dylancachan 0:6ce9c65992e5 25
dylancachan 0:6ce9c65992e5 26 /**
dylancachan 0:6ce9c65992e5 27 * A class to communicate a USB keyboard
dylancachan 0:6ce9c65992e5 28 */
dylancachan 0:6ce9c65992e5 29 class USBHostKeyboard : public IUSBEnumerator {
dylancachan 0:6ce9c65992e5 30 public:
dylancachan 0:6ce9c65992e5 31
dylancachan 0:6ce9c65992e5 32 /**
dylancachan 0:6ce9c65992e5 33 * Constructor
dylancachan 0:6ce9c65992e5 34 */
dylancachan 0:6ce9c65992e5 35 USBHostKeyboard();
dylancachan 0:6ce9c65992e5 36
dylancachan 0:6ce9c65992e5 37 /**
dylancachan 0:6ce9c65992e5 38 * Try to connect a keyboard device
dylancachan 0:6ce9c65992e5 39 *
dylancachan 0:6ce9c65992e5 40 * @return true if connection was successful
dylancachan 0:6ce9c65992e5 41 */
dylancachan 0:6ce9c65992e5 42 bool connect();
dylancachan 0:6ce9c65992e5 43
dylancachan 0:6ce9c65992e5 44 /**
dylancachan 0:6ce9c65992e5 45 * Check if a keyboard is connected
dylancachan 0:6ce9c65992e5 46 *
dylancachan 0:6ce9c65992e5 47 * @returns true if a keyboard is connected
dylancachan 0:6ce9c65992e5 48 */
dylancachan 0:6ce9c65992e5 49 bool connected();
dylancachan 0:6ce9c65992e5 50
dylancachan 0:6ce9c65992e5 51 /**
dylancachan 0:6ce9c65992e5 52 * Attach a callback called when a keyboard event is received
dylancachan 0:6ce9c65992e5 53 *
dylancachan 0:6ce9c65992e5 54 * @param ptr function pointer
dylancachan 0:6ce9c65992e5 55 */
dylancachan 0:6ce9c65992e5 56 inline void attach(void (*ptr)(uint8_t key)) {
dylancachan 0:6ce9c65992e5 57 if (ptr != NULL) {
dylancachan 0:6ce9c65992e5 58 onKey = ptr;
dylancachan 0:6ce9c65992e5 59 }
dylancachan 0:6ce9c65992e5 60 }
dylancachan 0:6ce9c65992e5 61
dylancachan 0:6ce9c65992e5 62 /**
dylancachan 0:6ce9c65992e5 63 * Attach a callback called when a keyboard event is received
dylancachan 0:6ce9c65992e5 64 *
dylancachan 0:6ce9c65992e5 65 * @param ptr function pointer
dylancachan 0:6ce9c65992e5 66 */
dylancachan 0:6ce9c65992e5 67 inline void attach(void (*ptr)(uint8_t keyCode, uint8_t modifier)) {
dylancachan 0:6ce9c65992e5 68 if (ptr != NULL) {
dylancachan 0:6ce9c65992e5 69 onKeyCode = ptr;
dylancachan 0:6ce9c65992e5 70 }
dylancachan 0:6ce9c65992e5 71 }
dylancachan 0:6ce9c65992e5 72
dylancachan 0:6ce9c65992e5 73 protected:
dylancachan 0:6ce9c65992e5 74 //From IUSBEnumerator
dylancachan 0:6ce9c65992e5 75 virtual void setVidPid(uint16_t vid, uint16_t pid);
dylancachan 0:6ce9c65992e5 76 virtual bool parseInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol); //Must return true if the interface should be parsed
dylancachan 0:6ce9c65992e5 77 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
dylancachan 0:6ce9c65992e5 78
dylancachan 0:6ce9c65992e5 79 private:
dylancachan 0:6ce9c65992e5 80 USBHost * host;
dylancachan 0:6ce9c65992e5 81 USBDeviceConnected * dev;
dylancachan 0:6ce9c65992e5 82 USBEndpoint * int_in;
dylancachan 0:6ce9c65992e5 83 uint8_t report[9];
dylancachan 0:6ce9c65992e5 84 int keyboard_intf;
dylancachan 0:6ce9c65992e5 85 bool keyboard_device_found;
dylancachan 0:6ce9c65992e5 86
dylancachan 0:6ce9c65992e5 87 bool dev_connected;
dylancachan 0:6ce9c65992e5 88
dylancachan 0:6ce9c65992e5 89 void rxHandler();
dylancachan 0:6ce9c65992e5 90
dylancachan 0:6ce9c65992e5 91 void (*onKey)(uint8_t key);
dylancachan 0:6ce9c65992e5 92 void (*onKeyCode)(uint8_t key, uint8_t modifier);
dylancachan 0:6ce9c65992e5 93
dylancachan 0:6ce9c65992e5 94 int report_id;
dylancachan 0:6ce9c65992e5 95
dylancachan 0:6ce9c65992e5 96 void init();
dylancachan 0:6ce9c65992e5 97
dylancachan 0:6ce9c65992e5 98 };
dylancachan 0:6ce9c65992e5 99
dylancachan 0:6ce9c65992e5 100 #endif
dylancachan 0:6ce9c65992e5 101
dylancachan 0:6ce9c65992e5 102 #endif