Erik - / Mbed 2 deprecated USBFileSystem_RAMDISK_HelloWorld

RAMDisk example for the USBFileSystem

Dependencies:   mbed USBFileSystem

Fork of USBFileSystem_RAMDISK_HelloWorld by Erik -

USBDevice/USBHID/USBMouse.h@1:e1b0157ce547, 2013-07-30 (annotated)

Committer:
Sissors
Date:
Tue Jul 30 18:27:18 2013 +0000
Revision:
1:e1b0157ce547
Memory leaks -_-

Who changed what in which revision?

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