Maxim Integrated / Mbed OS Host_Software_MAX32664GWEB_HR_EXTENDED

ME11B Sample Code in Maxim Integrated Team

Dependencies:   BMI160 max32630hsp3 MemoryLCD USBDevice

Fork of Host_Software_MAX32664GWEB_HR_EXTENDED by Seyhmus Cacina

Drivers/USBDevice/USBHID/USBMouse.h@0:ac4dea3e2894, 2019-03-18 (annotated)

Committer:
seyhmus.cacina
Date:
Mon Mar 18 10:21:53 2019 +0300
Revision:
0:ac4dea3e2894
ME11B Sample Code First Commit

Who changed what in which revision?

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