Chris Majoros / USBDevice

USB/HID stack for the loststone project

Dependents:   loststone

Fork of USBDevice by mbed official

USBHID/USBMouse.h@11:7c95a42cf9f6, 2013-03-14 (annotated)

Committer:
xxann5
Date:
Thu Mar 14 13:53:16 2013 +0000
Revision:
11:7c95a42cf9f6
Parent:
8:4f27799a971d 
pulled and merged with the main dev repo.

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,
xxann5 8:4f27799a971d 33 MOUSE_FORWORD = 8,
xxann5 8:4f27799a971d 34 MOUSE_BACK = 16
samux 1:80ab0d068708 35 };
samux 1:80ab0d068708 36
samux 1:80ab0d068708 37 /* X and Y limits */
samux 1:80ab0d068708 38 /* These values do not directly map to screen pixels */
samux 1:80ab0d068708 39 /* Zero may be interpreted as meaning 'no movement' */
samux 1:80ab0d068708 40 #define X_MIN_ABS (1) /*!< Minimum value on x-axis */
samux 1:80ab0d068708 41 #define Y_MIN_ABS (1) /*!< Minimum value on y-axis */
samux 1:80ab0d068708 42 #define X_MAX_ABS (0x7fff) /*!< Maximum value on x-axis */
samux 1:80ab0d068708 43 #define Y_MAX_ABS (0x7fff) /*!< Maximum value on y-axis */
samux 1:80ab0d068708 44
samux 1:80ab0d068708 45 #define X_MIN_REL (-127) /*!< The maximum value that we can move to the left on the x-axis */
samux 1:80ab0d068708 46 #define Y_MIN_REL (-127) /*!< The maximum value that we can move up on the y-axis */
samux 1:80ab0d068708 47 #define X_MAX_REL (127) /*!< The maximum value that we can move to the right on the x-axis */
samux 1:80ab0d068708 48 #define Y_MAX_REL (127) /*!< The maximum value that we can move down on the y-axis */
samux 1:80ab0d068708 49
samux 1:80ab0d068708 50 enum MOUSE_TYPE
samux 1:80ab0d068708 51 {
samux 1:80ab0d068708 52 ABS_MOUSE,
samux 1:80ab0d068708 53 REL_MOUSE,
samux 1:80ab0d068708 54 };
samux 1:80ab0d068708 55
samux 1:80ab0d068708 56 /**
samux 1:80ab0d068708 57 *
samux 1:80ab0d068708 58 * USBMouse example
samux 1:80ab0d068708 59 * @code
samux 1:80ab0d068708 60 * #include "mbed.h"
samux 1:80ab0d068708 61 * #include "USBMouse.h"
samux 1:80ab0d068708 62 *
samux 1:80ab0d068708 63 * USBMouse mouse;
samux 1:80ab0d068708 64 *
samux 1:80ab0d068708 65 * int main(void)
samux 1:80ab0d068708 66 * {
samux 1:80ab0d068708 67 * while (1)
samux 1:80ab0d068708 68 * {
samux 1:80ab0d068708 69 * mouse.move(20, 0);
samux 1:80ab0d068708 70 * wait(0.5);
samux 1:80ab0d068708 71 * }
samux 1:80ab0d068708 72 * }
samux 1:80ab0d068708 73 *
samux 1:80ab0d068708 74 * @endcode
samux 1:80ab0d068708 75 *
samux 1:80ab0d068708 76 *
samux 1:80ab0d068708 77 * @code
samux 1:80ab0d068708 78 * #include "mbed.h"
samux 1:80ab0d068708 79 * #include "USBMouse.h"
samux 1:80ab0d068708 80 * #include <math.h>
samux 1:80ab0d068708 81 *
samux 1:80ab0d068708 82 * USBMouse mouse(ABS_MOUSE);
samux 1:80ab0d068708 83 *
samux 1:80ab0d068708 84 * int main(void)
samux 1:80ab0d068708 85 * {
samux 1:80ab0d068708 86 * uint16_t x_center = (X_MAX_ABS - X_MIN_ABS)/2;
samux 1:80ab0d068708 87 * uint16_t y_center = (Y_MAX_ABS - Y_MIN_ABS)/2;
samux 1:80ab0d068708 88 * uint16_t x_screen = 0;
samux 1:80ab0d068708 89 * uint16_t y_screen = 0;
samux 1:80ab0d068708 90 *
samux 1:80ab0d068708 91 * uint32_t x_origin = x_center;
samux 1:80ab0d068708 92 * uint32_t y_origin = y_center;
samux 1:80ab0d068708 93 * uint32_t radius = 5000;
samux 1:80ab0d068708 94 * uint32_t angle = 0;
samux 1:80ab0d068708 95 *
samux 1:80ab0d068708 96 * while (1)
samux 1:80ab0d068708 97 * {
samux 1:80ab0d068708 98 * x_screen = x_origin + cos((double)angle*3.14/180.0)*radius;
samux 1:80ab0d068708 99 * y_screen = y_origin + sin((double)angle*3.14/180.0)*radius;
samux 1:80ab0d068708 100 *
samux 1:80ab0d068708 101 * mouse.move(x_screen, y_screen);
samux 1:80ab0d068708 102 * angle += 3;
samux 1:80ab0d068708 103 * wait(0.01);
samux 1:80ab0d068708 104 * }
samux 1:80ab0d068708 105 * }
samux 1:80ab0d068708 106 *
samux 1:80ab0d068708 107 * @endcode
samux 1:80ab0d068708 108 */
samux 1:80ab0d068708 109 class USBMouse: public USBHID
samux 1:80ab0d068708 110 {
samux 1:80ab0d068708 111 public:
samux 1:80ab0d068708 112
samux 1:80ab0d068708 113 /**
samux 1:80ab0d068708 114 * Constructor
samux 1:80ab0d068708 115 *
samux 1:80ab0d068708 116 * @param mouse_type Mouse type: ABS_MOUSE (absolute mouse) or REL_MOUSE (relative mouse) (default: REL_MOUSE)
samux 1:80ab0d068708 117 * @param vendor_id Your vendor_id (default: 0x1234)
samux 1:80ab0d068708 118 * @param product_id Your product_id (default: 0x0001)
samux 1:80ab0d068708 119 * @param product_release Your preoduct_release (default: 0x0001)
samux 1:80ab0d068708 120 *
samux 1:80ab0d068708 121 */
samux 1:80ab0d068708 122 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 123 USBHID(0, 0, vendor_id, product_id, product_release, false)
samux 1:80ab0d068708 124 {
samux 1:80ab0d068708 125 button = 0;
samux 1:80ab0d068708 126 this->mouse_type = mouse_type;
samux 1:80ab0d068708 127 connect();
samux 1:80ab0d068708 128 };
samux 1:80ab0d068708 129
samux 1:80ab0d068708 130 /**
samux 1:80ab0d068708 131 * Write a state of the mouse
samux 1:80ab0d068708 132 *
samux 1:80ab0d068708 133 * @param x x-axis position
samux 1:80ab0d068708 134 * @param y y-axis position
samux 1:80ab0d068708 135 * @param buttons buttons state (first bit represents MOUSE_LEFT, second bit MOUSE_RIGHT and third bit MOUSE_MIDDLE)
samux 1:80ab0d068708 136 * @param z wheel state (>0 to scroll down, <0 to scroll up)
samux 1:80ab0d068708 137 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 138 */
xxann5 8:4f27799a971d 139 bool update(int16_t x, int16_t y, uint8_t buttons, int8_t z, int8_t h);
samux 1:80ab0d068708 140
samux 1:80ab0d068708 141
samux 1:80ab0d068708 142 /**
samux 1:80ab0d068708 143 * Move the cursor to (x, y)
samux 1:80ab0d068708 144 *
samux 1:80ab0d068708 145 * @param x-axis position
samux 1:80ab0d068708 146 * @param y-axis position
samux 1:80ab0d068708 147 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 148 */
samux 1:80ab0d068708 149 bool move(int16_t x, int16_t y);
samux 1:80ab0d068708 150
samux 1:80ab0d068708 151 /**
samux 1:80ab0d068708 152 * Press one or several buttons
samux 1:80ab0d068708 153 *
samux 1:80ab0d068708 154 * @param button button state (ex: press(MOUSE_LEFT))
samux 1:80ab0d068708 155 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 156 */
samux 1:80ab0d068708 157 bool press(uint8_t button);
samux 1:80ab0d068708 158
samux 1:80ab0d068708 159 /**
samux 1:80ab0d068708 160 * Release one or several buttons
samux 1:80ab0d068708 161 *
samux 1:80ab0d068708 162 * @param button button state (ex: release(MOUSE_LEFT))
samux 1:80ab0d068708 163 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 164 */
samux 1:80ab0d068708 165 bool release(uint8_t button);
samux 1:80ab0d068708 166
samux 1:80ab0d068708 167 /**
samux 1:80ab0d068708 168 * Double click (MOUSE_LEFT)
samux 1:80ab0d068708 169 *
samux 1:80ab0d068708 170 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 171 */
samux 1:80ab0d068708 172 bool doubleClick();
samux 1:80ab0d068708 173
samux 1:80ab0d068708 174 /**
samux 1:80ab0d068708 175 * Click
samux 1:80ab0d068708 176 *
samux 1:80ab0d068708 177 * @param button state of the buttons ( ex: clic(MOUSE_LEFT))
samux 1:80ab0d068708 178 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 179 */
samux 1:80ab0d068708 180 bool click(uint8_t button);
samux 1:80ab0d068708 181
samux 1:80ab0d068708 182 /**
samux 1:80ab0d068708 183 * Scrolling
samux 1:80ab0d068708 184 *
samux 1:80ab0d068708 185 * @param z value of the wheel (>0 to go down, <0 to go up)
samux 1:80ab0d068708 186 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 187 */
xxann5 8:4f27799a971d 188 bool scroll(int8_t z, int8_t h);
samux 1:80ab0d068708 189
samux 1:80ab0d068708 190 /*
samux 1:80ab0d068708 191 * To define the report descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
samux 1:80ab0d068708 192 *
samux 1:80ab0d068708 193 * @returns pointer to the report descriptor
samux 1:80ab0d068708 194 */
samux 1:80ab0d068708 195 virtual uint8_t * reportDesc();
samux 1:80ab0d068708 196
samux 1:80ab0d068708 197 protected:
samux 1:80ab0d068708 198 /*
samux 1:80ab0d068708 199 * Get configuration descriptor
samux 1:80ab0d068708 200 *
samux 1:80ab0d068708 201 * @returns pointer to the configuration descriptor
samux 1:80ab0d068708 202 */
samux 1:80ab0d068708 203 virtual uint8_t * configurationDesc();
samux 1:80ab0d068708 204
samux 1:80ab0d068708 205 private:
samux 1:80ab0d068708 206 MOUSE_TYPE mouse_type;
samux 1:80ab0d068708 207 uint8_t button;
xxann5 8:4f27799a971d 208 bool mouseSend(int16_t x, int16_t y, uint8_t buttons, int8_t z, int8_t h);
samux 1:80ab0d068708 209 };
samux 1:80ab0d068708 210
samux 1:80ab0d068708 211 #endif