Piotr Woźniak / Mbed 2 deprecated KL46Z-Lab2_fullll

blablabla

Dependencies:   MAG3110 MMA8451Q SLCD- TSI USBDevice mbed

USBDevice/USBHID/USBMouse.h@0:339b7abfa147, 2014-04-16 (annotated)

Committer:
Osator
Date:
Wed Apr 16 12:20:00 2014 +0000
Revision:
0:339b7abfa147
blablabla

Who changed what in which revision?

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