Pierre Provent / USBHost

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.

Dependents:   TEST_USB_Nucleo_F429ZI Essais_USB_Nucleo_F429ZI SID_V3_Nucleo_F429ZI SID_V4_Nucleo_F429ZI_copy

USBHostHID/USBHostMouse.h@0:77ca32e8e04e, 2020-09-25 (annotated)

Committer:
pierreprovent
Date:
Fri Sep 25 10:17:49 2020 +0000
Revision:
0:77ca32e8e04e
Programme acquisition en enregistrement sur clef USB carte Nucleo F429ZI cours ELE118 Cnam

Who changed what in which revision?

UserRevisionLine numberNew contents of line
pierreprovent 0:77ca32e8e04e 1 /* mbed USBHost Library
pierreprovent 0:77ca32e8e04e 2 * Copyright (c) 2006-2013 ARM Limited
pierreprovent 0:77ca32e8e04e 3 *
pierreprovent 0:77ca32e8e04e 4 * Licensed under the Apache License, Version 2.0 (the "License");
pierreprovent 0:77ca32e8e04e 5 * you may not use this file except in compliance with the License.
pierreprovent 0:77ca32e8e04e 6 * You may obtain a copy of the License at
pierreprovent 0:77ca32e8e04e 7 *
pierreprovent 0:77ca32e8e04e 8 * http://www.apache.org/licenses/LICENSE-2.0
pierreprovent 0:77ca32e8e04e 9 *
pierreprovent 0:77ca32e8e04e 10 * Unless required by applicable law or agreed to in writing, software
pierreprovent 0:77ca32e8e04e 11 * distributed under the License is distributed on an "AS IS" BASIS,
pierreprovent 0:77ca32e8e04e 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
pierreprovent 0:77ca32e8e04e 13 * See the License for the specific language governing permissions and
pierreprovent 0:77ca32e8e04e 14 * limitations under the License.
pierreprovent 0:77ca32e8e04e 15 */
pierreprovent 0:77ca32e8e04e 16
pierreprovent 0:77ca32e8e04e 17 #ifndef USBHOSTMOUSE_H
pierreprovent 0:77ca32e8e04e 18 #define USBHOSTMOUSE_H
pierreprovent 0:77ca32e8e04e 19
pierreprovent 0:77ca32e8e04e 20 #include "USBHostConf.h"
pierreprovent 0:77ca32e8e04e 21
pierreprovent 0:77ca32e8e04e 22 #if USBHOST_MOUSE
pierreprovent 0:77ca32e8e04e 23
pierreprovent 0:77ca32e8e04e 24 #include "USBHost.h"
pierreprovent 0:77ca32e8e04e 25
pierreprovent 0:77ca32e8e04e 26 /**
pierreprovent 0:77ca32e8e04e 27 * A class to communicate a USB mouse
pierreprovent 0:77ca32e8e04e 28 */
pierreprovent 0:77ca32e8e04e 29 class USBHostMouse : public IUSBEnumerator
pierreprovent 0:77ca32e8e04e 30 {
pierreprovent 0:77ca32e8e04e 31 public:
pierreprovent 0:77ca32e8e04e 32
pierreprovent 0:77ca32e8e04e 33 /**
pierreprovent 0:77ca32e8e04e 34 * Constructor
pierreprovent 0:77ca32e8e04e 35 */
pierreprovent 0:77ca32e8e04e 36 USBHostMouse();
pierreprovent 0:77ca32e8e04e 37
pierreprovent 0:77ca32e8e04e 38 /**
pierreprovent 0:77ca32e8e04e 39 * Try to connect a mouse device
pierreprovent 0:77ca32e8e04e 40 *
pierreprovent 0:77ca32e8e04e 41 * @return true if connection was successful
pierreprovent 0:77ca32e8e04e 42 */
pierreprovent 0:77ca32e8e04e 43 bool connect();
pierreprovent 0:77ca32e8e04e 44
pierreprovent 0:77ca32e8e04e 45 /**
pierreprovent 0:77ca32e8e04e 46 * Check if a mouse is connected
pierreprovent 0:77ca32e8e04e 47 *
pierreprovent 0:77ca32e8e04e 48 * @returns true if a mouse is connected
pierreprovent 0:77ca32e8e04e 49 */
pierreprovent 0:77ca32e8e04e 50 bool connected();
pierreprovent 0:77ca32e8e04e 51
pierreprovent 0:77ca32e8e04e 52 /**
pierreprovent 0:77ca32e8e04e 53 * Attach a callback called when a mouse event is received
pierreprovent 0:77ca32e8e04e 54 *
pierreprovent 0:77ca32e8e04e 55 * @param ptr function pointer
pierreprovent 0:77ca32e8e04e 56 */
pierreprovent 0:77ca32e8e04e 57 inline void attachEvent(void (*ptr)(uint8_t buttons, int8_t x, int8_t y, int8_t z))
pierreprovent 0:77ca32e8e04e 58 {
pierreprovent 0:77ca32e8e04e 59 if (ptr != NULL) {
pierreprovent 0:77ca32e8e04e 60 onUpdate = ptr;
pierreprovent 0:77ca32e8e04e 61 }
pierreprovent 0:77ca32e8e04e 62 }
pierreprovent 0:77ca32e8e04e 63
pierreprovent 0:77ca32e8e04e 64 /**
pierreprovent 0:77ca32e8e04e 65 * Attach a callback called when the button state changes
pierreprovent 0:77ca32e8e04e 66 *
pierreprovent 0:77ca32e8e04e 67 * @param ptr function pointer
pierreprovent 0:77ca32e8e04e 68 */
pierreprovent 0:77ca32e8e04e 69 inline void attachButtonEvent(void (*ptr)(uint8_t buttons))
pierreprovent 0:77ca32e8e04e 70 {
pierreprovent 0:77ca32e8e04e 71 if (ptr != NULL) {
pierreprovent 0:77ca32e8e04e 72 onButtonUpdate = ptr;
pierreprovent 0:77ca32e8e04e 73 }
pierreprovent 0:77ca32e8e04e 74 }
pierreprovent 0:77ca32e8e04e 75
pierreprovent 0:77ca32e8e04e 76 /**
pierreprovent 0:77ca32e8e04e 77 * Attach a callback called when the X axis value changes
pierreprovent 0:77ca32e8e04e 78 *
pierreprovent 0:77ca32e8e04e 79 * @param ptr function pointer
pierreprovent 0:77ca32e8e04e 80 */
pierreprovent 0:77ca32e8e04e 81 inline void attachXEvent(void (*ptr)(int8_t x))
pierreprovent 0:77ca32e8e04e 82 {
pierreprovent 0:77ca32e8e04e 83 if (ptr != NULL) {
pierreprovent 0:77ca32e8e04e 84 onXUpdate = ptr;
pierreprovent 0:77ca32e8e04e 85 }
pierreprovent 0:77ca32e8e04e 86 }
pierreprovent 0:77ca32e8e04e 87
pierreprovent 0:77ca32e8e04e 88 /**
pierreprovent 0:77ca32e8e04e 89 * Attach a callback called when the Y axis value changes
pierreprovent 0:77ca32e8e04e 90 *
pierreprovent 0:77ca32e8e04e 91 * @param ptr function pointer
pierreprovent 0:77ca32e8e04e 92 */
pierreprovent 0:77ca32e8e04e 93 inline void attachYEvent(void (*ptr)(int8_t y))
pierreprovent 0:77ca32e8e04e 94 {
pierreprovent 0:77ca32e8e04e 95 if (ptr != NULL) {
pierreprovent 0:77ca32e8e04e 96 onYUpdate = ptr;
pierreprovent 0:77ca32e8e04e 97 }
pierreprovent 0:77ca32e8e04e 98 }
pierreprovent 0:77ca32e8e04e 99
pierreprovent 0:77ca32e8e04e 100 /**
pierreprovent 0:77ca32e8e04e 101 * Attach a callback called when the Z axis value changes (scrolling)
pierreprovent 0:77ca32e8e04e 102 *
pierreprovent 0:77ca32e8e04e 103 * @param ptr function pointer
pierreprovent 0:77ca32e8e04e 104 */
pierreprovent 0:77ca32e8e04e 105 inline void attachZEvent(void (*ptr)(int8_t z))
pierreprovent 0:77ca32e8e04e 106 {
pierreprovent 0:77ca32e8e04e 107 if (ptr != NULL) {
pierreprovent 0:77ca32e8e04e 108 onZUpdate = ptr;
pierreprovent 0:77ca32e8e04e 109 }
pierreprovent 0:77ca32e8e04e 110 }
pierreprovent 0:77ca32e8e04e 111
pierreprovent 0:77ca32e8e04e 112 protected:
pierreprovent 0:77ca32e8e04e 113 //From IUSBEnumerator
pierreprovent 0:77ca32e8e04e 114 virtual void setVidPid(uint16_t vid, uint16_t pid);
pierreprovent 0:77ca32e8e04e 115 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
pierreprovent 0:77ca32e8e04e 116 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
pierreprovent 0:77ca32e8e04e 117
pierreprovent 0:77ca32e8e04e 118 private:
pierreprovent 0:77ca32e8e04e 119 USBHost * host;
pierreprovent 0:77ca32e8e04e 120 USBDeviceConnected * dev;
pierreprovent 0:77ca32e8e04e 121 USBEndpoint * int_in;
pierreprovent 0:77ca32e8e04e 122 uint8_t report[64];
pierreprovent 0:77ca32e8e04e 123 bool dev_connected;
pierreprovent 0:77ca32e8e04e 124 bool mouse_device_found;
pierreprovent 0:77ca32e8e04e 125 int mouse_intf;
pierreprovent 0:77ca32e8e04e 126
pierreprovent 0:77ca32e8e04e 127 uint8_t buttons;
pierreprovent 0:77ca32e8e04e 128 int8_t x;
pierreprovent 0:77ca32e8e04e 129 int8_t y;
pierreprovent 0:77ca32e8e04e 130 int8_t z;
pierreprovent 0:77ca32e8e04e 131
pierreprovent 0:77ca32e8e04e 132 void rxHandler();
pierreprovent 0:77ca32e8e04e 133 void (*onUpdate)(uint8_t buttons, int8_t x, int8_t y, int8_t z);
pierreprovent 0:77ca32e8e04e 134 void (*onButtonUpdate)(uint8_t buttons);
pierreprovent 0:77ca32e8e04e 135 void (*onXUpdate)(int8_t x);
pierreprovent 0:77ca32e8e04e 136 void (*onYUpdate)(int8_t y);
pierreprovent 0:77ca32e8e04e 137 void (*onZUpdate)(int8_t z);
pierreprovent 0:77ca32e8e04e 138 int report_id;
pierreprovent 0:77ca32e8e04e 139 void init();
pierreprovent 0:77ca32e8e04e 140 };
pierreprovent 0:77ca32e8e04e 141
pierreprovent 0:77ca32e8e04e 142 #endif
pierreprovent 0:77ca32e8e04e 143
pierreprovent 0:77ca32e8e04e 144 #endif