Aaron Silva / USBDevice

changes

Fork of USBDevice by Maxim Integrated

USBHID/USBMouse.h@67:8e871bbb2647, 2017-03-09 (annotated)

Committer:
asilva14
Date:
Thu Mar 09 23:53:57 2017 +0000
Revision:
67:8e871bbb2647
Parent:
25:7c72828865f3 
commit;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 1:80ab0d068708 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
samux 1:80ab0d068708 2 *
samux 1:80ab0d068708 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 1:80ab0d068708 4 * and associated documentation files (the "Software"), to deal in the Software without
samux 1:80ab0d068708 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
samux 1:80ab0d068708 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
samux 1:80ab0d068708 7 * Software is furnished to do so, subject to the following conditions:
samux 1:80ab0d068708 8 *
samux 1:80ab0d068708 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 1:80ab0d068708 10 * substantial portions of the Software.
samux 1:80ab0d068708 11 *
samux 1:80ab0d068708 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 1:80ab0d068708 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 1:80ab0d068708 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 1:80ab0d068708 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 1:80ab0d068708 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 1:80ab0d068708 17 */
samux 1:80ab0d068708 18
samux 1:80ab0d068708 19 #ifndef USBMOUSE_H
samux 1:80ab0d068708 20 #define USBMOUSE_H
samux 1:80ab0d068708 21
samux 1:80ab0d068708 22 #include "USBHID.h"
samux 1:80ab0d068708 23
samux 1:80ab0d068708 24 #define REPORT_ID_MOUSE 2
samux 1:80ab0d068708 25
samux 1:80ab0d068708 26 /* Common usage */
samux 1:80ab0d068708 27
samux 1:80ab0d068708 28 enum MOUSE_BUTTON
samux 1:80ab0d068708 29 {
samux 1:80ab0d068708 30 MOUSE_LEFT = 1,
samux 1:80ab0d068708 31 MOUSE_RIGHT = 2,
samux 1:80ab0d068708 32 MOUSE_MIDDLE = 4,
samux 1:80ab0d068708 33 };
samux 1:80ab0d068708 34
samux 1:80ab0d068708 35 /* X and Y limits */
samux 1:80ab0d068708 36 /* These values do not directly map to screen pixels */
samux 1:80ab0d068708 37 /* Zero may be interpreted as meaning 'no movement' */
mbed_official 25:7c72828865f3 38 #define X_MIN_ABS (1) /*!< Minimum value on x-axis */
samux 1:80ab0d068708 39 #define Y_MIN_ABS (1) /*!< Minimum value on y-axis */
samux 1:80ab0d068708 40 #define X_MAX_ABS (0x7fff) /*!< Maximum value on x-axis */
samux 1:80ab0d068708 41 #define Y_MAX_ABS (0x7fff) /*!< Maximum value on y-axis */
samux 1:80ab0d068708 42
samux 1:80ab0d068708 43 #define X_MIN_REL (-127) /*!< The maximum value that we can move to the left on the x-axis */
samux 1:80ab0d068708 44 #define Y_MIN_REL (-127) /*!< The maximum value that we can move up on the y-axis */
samux 1:80ab0d068708 45 #define X_MAX_REL (127) /*!< The maximum value that we can move to the right on the x-axis */
samux 1:80ab0d068708 46 #define Y_MAX_REL (127) /*!< The maximum value that we can move down on the y-axis */
samux 1:80ab0d068708 47
samux 1:80ab0d068708 48 enum MOUSE_TYPE
samux 1:80ab0d068708 49 {
samux 1:80ab0d068708 50 ABS_MOUSE,
samux 1:80ab0d068708 51 REL_MOUSE,
samux 1:80ab0d068708 52 };
samux 1:80ab0d068708 53
samux 1:80ab0d068708 54 /**
samux 1:80ab0d068708 55 *
samux 1:80ab0d068708 56 * USBMouse example
samux 1:80ab0d068708 57 * @code
samux 1:80ab0d068708 58 * #include "mbed.h"
samux 1:80ab0d068708 59 * #include "USBMouse.h"
samux 1:80ab0d068708 60 *
samux 1:80ab0d068708 61 * USBMouse mouse;
samux 1:80ab0d068708 62 *
samux 1:80ab0d068708 63 * int main(void)
samux 1:80ab0d068708 64 * {
samux 1:80ab0d068708 65 * while (1)
samux 1:80ab0d068708 66 * {
samux 1:80ab0d068708 67 * mouse.move(20, 0);
samux 1:80ab0d068708 68 * wait(0.5);
samux 1:80ab0d068708 69 * }
samux 1:80ab0d068708 70 * }
samux 1:80ab0d068708 71 *
samux 1:80ab0d068708 72 * @endcode
samux 1:80ab0d068708 73 *
samux 1:80ab0d068708 74 *
samux 1:80ab0d068708 75 * @code
samux 1:80ab0d068708 76 * #include "mbed.h"
samux 1:80ab0d068708 77 * #include "USBMouse.h"
samux 1:80ab0d068708 78 * #include <math.h>
samux 1:80ab0d068708 79 *
samux 1:80ab0d068708 80 * USBMouse mouse(ABS_MOUSE);
samux 1:80ab0d068708 81 *
samux 1:80ab0d068708 82 * int main(void)
samux 1:80ab0d068708 83 * {
samux 1:80ab0d068708 84 * uint16_t x_center = (X_MAX_ABS - X_MIN_ABS)/2;
samux 1:80ab0d068708 85 * uint16_t y_center = (Y_MAX_ABS - Y_MIN_ABS)/2;
samux 1:80ab0d068708 86 * uint16_t x_screen = 0;
samux 1:80ab0d068708 87 * uint16_t y_screen = 0;
mbed_official 25:7c72828865f3 88 *
samux 1:80ab0d068708 89 * uint32_t x_origin = x_center;
samux 1:80ab0d068708 90 * uint32_t y_origin = y_center;
samux 1:80ab0d068708 91 * uint32_t radius = 5000;
samux 1:80ab0d068708 92 * uint32_t angle = 0;
samux 1:80ab0d068708 93 *
samux 1:80ab0d068708 94 * while (1)
samux 1:80ab0d068708 95 * {
samux 1:80ab0d068708 96 * x_screen = x_origin + cos((double)angle*3.14/180.0)*radius;
samux 1:80ab0d068708 97 * y_screen = y_origin + sin((double)angle*3.14/180.0)*radius;
mbed_official 25:7c72828865f3 98 *
samux 1:80ab0d068708 99 * mouse.move(x_screen, y_screen);
samux 1:80ab0d068708 100 * angle += 3;
samux 1:80ab0d068708 101 * wait(0.01);
samux 1:80ab0d068708 102 * }
samux 1:80ab0d068708 103 * }
samux 1:80ab0d068708 104 *
samux 1:80ab0d068708 105 * @endcode
samux 1:80ab0d068708 106 */
samux 1:80ab0d068708 107 class USBMouse: public USBHID
samux 1:80ab0d068708 108 {
samux 1:80ab0d068708 109 public:
mbed_official 25:7c72828865f3 110
samux 1:80ab0d068708 111 /**
samux 1:80ab0d068708 112 * Constructor
samux 1:80ab0d068708 113 *
samux 1:80ab0d068708 114 * @param mouse_type Mouse type: ABS_MOUSE (absolute mouse) or REL_MOUSE (relative mouse) (default: REL_MOUSE)
samux 1:80ab0d068708 115 * @param vendor_id Your vendor_id (default: 0x1234)
samux 1:80ab0d068708 116 * @param product_id Your product_id (default: 0x0001)
samux 1:80ab0d068708 117 * @param product_release Your preoduct_release (default: 0x0001)
samux 1:80ab0d068708 118 *
samux 1:80ab0d068708 119 */
mbed_official 25:7c72828865f3 120 USBMouse(MOUSE_TYPE mouse_type = REL_MOUSE, uint16_t vendor_id = 0x1234, uint16_t product_id = 0x0001, uint16_t product_release = 0x0001):
samux 1:80ab0d068708 121 USBHID(0, 0, vendor_id, product_id, product_release, false)
mbed_official 25:7c72828865f3 122 {
samux 1:80ab0d068708 123 button = 0;
samux 1:80ab0d068708 124 this->mouse_type = mouse_type;
samux 1:80ab0d068708 125 connect();
samux 1:80ab0d068708 126 };
mbed_official 25:7c72828865f3 127
samux 1:80ab0d068708 128 /**
samux 1:80ab0d068708 129 * Write a state of the mouse
samux 1:80ab0d068708 130 *
samux 1:80ab0d068708 131 * @param x x-axis position
samux 1:80ab0d068708 132 * @param y y-axis position
samux 1:80ab0d068708 133 * @param buttons buttons state (first bit represents MOUSE_LEFT, second bit MOUSE_RIGHT and third bit MOUSE_MIDDLE)
samux 1:80ab0d068708 134 * @param z wheel state (>0 to scroll down, <0 to scroll up)
samux 1:80ab0d068708 135 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 136 */
samux 1:80ab0d068708 137 bool update(int16_t x, int16_t y, uint8_t buttons, int8_t z);
mbed_official 25:7c72828865f3 138
mbed_official 25:7c72828865f3 139
samux 1:80ab0d068708 140 /**
samux 1:80ab0d068708 141 * Move the cursor to (x, y)
samux 1:80ab0d068708 142 *
samux 1:80ab0d068708 143 * @param x-axis position
samux 1:80ab0d068708 144 * @param y-axis position
samux 1:80ab0d068708 145 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 146 */
samux 1:80ab0d068708 147 bool move(int16_t x, int16_t y);
mbed_official 25:7c72828865f3 148
samux 1:80ab0d068708 149 /**
samux 1:80ab0d068708 150 * Press one or several buttons
samux 1:80ab0d068708 151 *
samux 1:80ab0d068708 152 * @param button button state (ex: press(MOUSE_LEFT))
samux 1:80ab0d068708 153 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 154 */
samux 1:80ab0d068708 155 bool press(uint8_t button);
mbed_official 25:7c72828865f3 156
samux 1:80ab0d068708 157 /**
samux 1:80ab0d068708 158 * Release one or several buttons
samux 1:80ab0d068708 159 *
samux 1:80ab0d068708 160 * @param button button state (ex: release(MOUSE_LEFT))
samux 1:80ab0d068708 161 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 162 */
samux 1:80ab0d068708 163 bool release(uint8_t button);
mbed_official 25:7c72828865f3 164
samux 1:80ab0d068708 165 /**
samux 1:80ab0d068708 166 * Double click (MOUSE_LEFT)
samux 1:80ab0d068708 167 *
samux 1:80ab0d068708 168 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 169 */
samux 1:80ab0d068708 170 bool doubleClick();
mbed_official 25:7c72828865f3 171
samux 1:80ab0d068708 172 /**
samux 1:80ab0d068708 173 * Click
samux 1:80ab0d068708 174 *
samux 1:80ab0d068708 175 * @param button state of the buttons ( ex: clic(MOUSE_LEFT))
samux 1:80ab0d068708 176 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 177 */
mbed_official 25:7c72828865f3 178 bool click(uint8_t button);
mbed_official 25:7c72828865f3 179
samux 1:80ab0d068708 180 /**
samux 1:80ab0d068708 181 * Scrolling
samux 1:80ab0d068708 182 *
samux 1:80ab0d068708 183 * @param z value of the wheel (>0 to go down, <0 to go up)
samux 1:80ab0d068708 184 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 185 */
samux 1:80ab0d068708 186 bool scroll(int8_t z);
mbed_official 25:7c72828865f3 187
samux 1:80ab0d068708 188 /*
samux 1:80ab0d068708 189 * To define the report descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
samux 1:80ab0d068708 190 *
samux 1:80ab0d068708 191 * @returns pointer to the report descriptor
samux 1:80ab0d068708 192 */
samux 1:80ab0d068708 193 virtual uint8_t * reportDesc();
samux 1:80ab0d068708 194
samux 1:80ab0d068708 195 protected:
samux 1:80ab0d068708 196 /*
samux 1:80ab0d068708 197 * Get configuration descriptor
samux 1:80ab0d068708 198 *
samux 1:80ab0d068708 199 * @returns pointer to the configuration descriptor
samux 1:80ab0d068708 200 */
samux 1:80ab0d068708 201 virtual uint8_t * configurationDesc();
mbed_official 25:7c72828865f3 202
samux 1:80ab0d068708 203 private:
samux 1:80ab0d068708 204 MOUSE_TYPE mouse_type;
samux 1:80ab0d068708 205 uint8_t button;
samux 1:80ab0d068708 206 bool mouseSend(int8_t x, int8_t y, uint8_t buttons, int8_t z);
samux 1:80ab0d068708 207 };
samux 1:80ab0d068708 208
samux 1:80ab0d068708 209 #endif