1 /* mbed USBHost Library
2 * Copyright (c) 2006-2013 ARM Limited
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef USBHOSTMOUSE_H
18 #define USBHOSTMOUSE_H
20 #include "USBHostConf.h"
27 * A class to communicate a USB mouse
29 class USBHostMouse : public IUSBEnumerator {
38 * Try to connect a mouse device
40 * @return true if connection was successful
45 * Check if a mouse is connected
47 * @returns true if a mouse is connected
52 * Attach a callback called when a mouse event is received
54 * @param ptr function pointer
56 inline void attachEvent(void (*ptr)(uint8_t buttons, int8_t x, int8_t y, int8_t z)) {
63 * Attach a callback called when the button state changes
65 * @param ptr function pointer
67 inline void attachButtonEvent(void (*ptr)(uint8_t buttons)) {
74 * Attach a callback called when the X axis value changes
76 * @param ptr function pointer
78 inline void attachXEvent(void (*ptr)(int8_t x)) {
85 * Attach a callback called when the Y axis value changes
87 * @param ptr function pointer
89 inline void attachYEvent(void (*ptr)(int8_t y)) {
96 * Attach a callback called when the Z axis value changes (scrolling)
98 * @param ptr function pointer
100 inline void attachZEvent(void (*ptr)(int8_t z)) {
107 //From IUSBEnumerator
108 virtual void setVidPid(uint16_t vid, uint16_t pid);
109 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
110 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
114 USBDeviceConnected * dev;
115 USBEndpoint * int_in;
119 bool mouse_device_found;
128 void (*onUpdate)(uint8_t buttons, int8_t x, int8_t y, int8_t z);
129 void (*onButtonUpdate)(uint8_t buttons);
130 void (*onXUpdate)(int8_t x);
131 void (*onYUpdate)(int8_t y);
132 void (*onZUpdate)(int8_t z);