Fred Parker / Mbed 2 deprecated Official_mBot

The preloaded firmware shipped on the mBot.

Dependencies:   mbed

Please use the version of this project/repo found at: http://developer.mbed.org/teams/Outrageous-Circuits/code/Official_mBot/

USBDevice/USBHID/USBMouse.h@1:ffd9a51e7d35, 2014-11-25 (annotated)

Committer:
jeffknaggs
Date:
Tue Nov 25 14:49:40 2014 +0000
Revision:
1:ffd9a51e7d35
Parent:
0:865d42c46692 
Initial commit.

Who changed what in which revision?

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