Gene Smith / Mbed 2 deprecated pH-v12

This program operates a pH meter and requires an Excel spreadsheet template available at www.kissinstrments.com

Dependencies:   mbed

USBDevice/USBHID/USBMouseKeyboard.h@0:f6b418db17d2, 2016-07-22 (annotated)

Committer:
KISScientific
Date:
Fri Jul 22 00:03:25 2016 +0000
Revision:
0:f6b418db17d2
pH-V12 version 1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
KISScientific 0:f6b418db17d2 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
KISScientific 0:f6b418db17d2 2 *
KISScientific 0:f6b418db17d2 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
KISScientific 0:f6b418db17d2 4 * and associated documentation files (the "Software"), to deal in the Software without
KISScientific 0:f6b418db17d2 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
KISScientific 0:f6b418db17d2 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
KISScientific 0:f6b418db17d2 7 * Software is furnished to do so, subject to the following conditions:
KISScientific 0:f6b418db17d2 8 *
KISScientific 0:f6b418db17d2 9 * The above copyright notice and this permission notice shall be included in all copies or
KISScientific 0:f6b418db17d2 10 * substantial portions of the Software.
KISScientific 0:f6b418db17d2 11 *
KISScientific 0:f6b418db17d2 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
KISScientific 0:f6b418db17d2 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
KISScientific 0:f6b418db17d2 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
KISScientific 0:f6b418db17d2 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
KISScientific 0:f6b418db17d2 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
KISScientific 0:f6b418db17d2 17 */
KISScientific 0:f6b418db17d2 18
KISScientific 0:f6b418db17d2 19 #ifndef USBMOUSEKEYBOARD_H
KISScientific 0:f6b418db17d2 20 #define USBMOUSEKEYBOARD_H
KISScientific 0:f6b418db17d2 21
KISScientific 0:f6b418db17d2 22 #define REPORT_ID_KEYBOARD 1
KISScientific 0:f6b418db17d2 23 #define REPORT_ID_MOUSE 2
KISScientific 0:f6b418db17d2 24 #define REPORT_ID_VOLUME 3
KISScientific 0:f6b418db17d2 25
KISScientific 0:f6b418db17d2 26 #include "USBMouse.h"
KISScientific 0:f6b418db17d2 27 #include "USBKeyboard.h"
KISScientific 0:f6b418db17d2 28 #include "Stream.h"
KISScientific 0:f6b418db17d2 29 #include "USBHID.h"
KISScientific 0:f6b418db17d2 30
KISScientific 0:f6b418db17d2 31 /**
KISScientific 0:f6b418db17d2 32 * USBMouseKeyboard example
KISScientific 0:f6b418db17d2 33 * @code
KISScientific 0:f6b418db17d2 34 *
KISScientific 0:f6b418db17d2 35 * #include "mbed.h"
KISScientific 0:f6b418db17d2 36 * #include "USBMouseKeyboard.h"
KISScientific 0:f6b418db17d2 37 *
KISScientific 0:f6b418db17d2 38 * USBMouseKeyboard key_mouse;
KISScientific 0:f6b418db17d2 39 *
KISScientific 0:f6b418db17d2 40 * int main(void)
KISScientific 0:f6b418db17d2 41 * {
KISScientific 0:f6b418db17d2 42 * while(1)
KISScientific 0:f6b418db17d2 43 * {
KISScientific 0:f6b418db17d2 44 * key_mouse.move(20, 0);
KISScientific 0:f6b418db17d2 45 * key_mouse.printf("Hello From MBED\r\n");
KISScientific 0:f6b418db17d2 46 * wait(1);
KISScientific 0:f6b418db17d2 47 * }
KISScientific 0:f6b418db17d2 48 * }
KISScientific 0:f6b418db17d2 49 * @endcode
KISScientific 0:f6b418db17d2 50 *
KISScientific 0:f6b418db17d2 51 *
KISScientific 0:f6b418db17d2 52 * @code
KISScientific 0:f6b418db17d2 53 *
KISScientific 0:f6b418db17d2 54 * #include "mbed.h"
KISScientific 0:f6b418db17d2 55 * #include "USBMouseKeyboard.h"
KISScientific 0:f6b418db17d2 56 *
KISScientific 0:f6b418db17d2 57 * USBMouseKeyboard key_mouse(ABS_MOUSE);
KISScientific 0:f6b418db17d2 58 *
KISScientific 0:f6b418db17d2 59 * int main(void)
KISScientific 0:f6b418db17d2 60 * {
KISScientific 0:f6b418db17d2 61 * while(1)
KISScientific 0:f6b418db17d2 62 * {
KISScientific 0:f6b418db17d2 63 * key_mouse.move(X_MAX_ABS/2, Y_MAX_ABS/2);
KISScientific 0:f6b418db17d2 64 * key_mouse.printf("Hello from MBED\r\n");
KISScientific 0:f6b418db17d2 65 * wait(1);
KISScientific 0:f6b418db17d2 66 * }
KISScientific 0:f6b418db17d2 67 * }
KISScientific 0:f6b418db17d2 68 * @endcode
KISScientific 0:f6b418db17d2 69 */
KISScientific 0:f6b418db17d2 70 class USBMouseKeyboard: public USBHID, public Stream
KISScientific 0:f6b418db17d2 71 {
KISScientific 0:f6b418db17d2 72 public:
KISScientific 0:f6b418db17d2 73
KISScientific 0:f6b418db17d2 74 /**
KISScientific 0:f6b418db17d2 75 * Constructor
KISScientific 0:f6b418db17d2 76 *
KISScientific 0:f6b418db17d2 77 * @param mouse_type Mouse type: ABS_MOUSE (absolute mouse) or REL_MOUSE (relative mouse) (default: REL_MOUSE)
KISScientific 0:f6b418db17d2 78 * @param leds Leds bus: first: NUM_LOCK, second: CAPS_LOCK, third: SCROLL_LOCK
KISScientific 0:f6b418db17d2 79 * @param vendor_id Your vendor_id (default: 0x1234)
KISScientific 0:f6b418db17d2 80 * @param product_id Your product_id (default: 0x0001)
KISScientific 0:f6b418db17d2 81 * @param product_release Your preoduct_release (default: 0x0001)
KISScientific 0:f6b418db17d2 82 *
KISScientific 0:f6b418db17d2 83 */
KISScientific 0:f6b418db17d2 84 USBMouseKeyboard(MOUSE_TYPE mouse_type = REL_MOUSE, uint16_t vendor_id = 0x0021, uint16_t product_id = 0x0011, uint16_t product_release = 0x0001):
KISScientific 0:f6b418db17d2 85 USBHID(0, 0, vendor_id, product_id, product_release, false)
KISScientific 0:f6b418db17d2 86 {
KISScientific 0:f6b418db17d2 87 lock_status = 0;
KISScientific 0:f6b418db17d2 88 button = 0;
KISScientific 0:f6b418db17d2 89 this->mouse_type = mouse_type;
KISScientific 0:f6b418db17d2 90 connect();
KISScientific 0:f6b418db17d2 91 };
KISScientific 0:f6b418db17d2 92
KISScientific 0:f6b418db17d2 93 /**
KISScientific 0:f6b418db17d2 94 * Write a state of the mouse
KISScientific 0:f6b418db17d2 95 *
KISScientific 0:f6b418db17d2 96 * @param x x-axis position
KISScientific 0:f6b418db17d2 97 * @param y y-axis position
KISScientific 0:f6b418db17d2 98 * @param buttons buttons state (first bit represents MOUSE_LEFT, second bit MOUSE_RIGHT and third bit MOUSE_MIDDLE)
KISScientific 0:f6b418db17d2 99 * @param z wheel state (>0 to scroll down, <0 to scroll up)
KISScientific 0:f6b418db17d2 100 * @returns true if there is no error, false otherwise
KISScientific 0:f6b418db17d2 101 */
KISScientific 0:f6b418db17d2 102 bool update(int16_t x, int16_t y, uint8_t buttons, int8_t z);
KISScientific 0:f6b418db17d2 103
KISScientific 0:f6b418db17d2 104
KISScientific 0:f6b418db17d2 105 /**
KISScientific 0:f6b418db17d2 106 * Move the cursor to (x, y)
KISScientific 0:f6b418db17d2 107 *
KISScientific 0:f6b418db17d2 108 * @param x x-axis position
KISScientific 0:f6b418db17d2 109 * @param y y-axis position
KISScientific 0:f6b418db17d2 110 * @returns true if there is no error, false otherwise
KISScientific 0:f6b418db17d2 111 */
KISScientific 0:f6b418db17d2 112 bool move(int16_t x, int16_t y);
KISScientific 0:f6b418db17d2 113
KISScientific 0:f6b418db17d2 114 /**
KISScientific 0:f6b418db17d2 115 * Press one or several buttons
KISScientific 0:f6b418db17d2 116 *
KISScientific 0:f6b418db17d2 117 * @param button button state (ex: press(MOUSE_LEFT))
KISScientific 0:f6b418db17d2 118 * @returns true if there is no error, false otherwise
KISScientific 0:f6b418db17d2 119 */
KISScientific 0:f6b418db17d2 120 bool press(uint8_t button);
KISScientific 0:f6b418db17d2 121
KISScientific 0:f6b418db17d2 122 /**
KISScientific 0:f6b418db17d2 123 * Release one or several buttons
KISScientific 0:f6b418db17d2 124 *
KISScientific 0:f6b418db17d2 125 * @param button button state (ex: release(MOUSE_LEFT))
KISScientific 0:f6b418db17d2 126 * @returns true if there is no error, false otherwise
KISScientific 0:f6b418db17d2 127 */
KISScientific 0:f6b418db17d2 128 bool release(uint8_t button);
KISScientific 0:f6b418db17d2 129
KISScientific 0:f6b418db17d2 130 /**
KISScientific 0:f6b418db17d2 131 * Double click (MOUSE_LEFT)
KISScientific 0:f6b418db17d2 132 *
KISScientific 0:f6b418db17d2 133 * @returns true if there is no error, false otherwise
KISScientific 0:f6b418db17d2 134 */
KISScientific 0:f6b418db17d2 135 bool doubleClick();
KISScientific 0:f6b418db17d2 136
KISScientific 0:f6b418db17d2 137 /**
KISScientific 0:f6b418db17d2 138 * Click
KISScientific 0:f6b418db17d2 139 *
KISScientific 0:f6b418db17d2 140 * @param button state of the buttons ( ex: clic(MOUSE_LEFT))
KISScientific 0:f6b418db17d2 141 * @returns true if there is no error, false otherwise
KISScientific 0:f6b418db17d2 142 */
KISScientific 0:f6b418db17d2 143 bool click(uint8_t button);
KISScientific 0:f6b418db17d2 144
KISScientific 0:f6b418db17d2 145 /**
KISScientific 0:f6b418db17d2 146 * Scrolling
KISScientific 0:f6b418db17d2 147 *
KISScientific 0:f6b418db17d2 148 * @param z value of the wheel (>0 to go down, <0 to go up)
KISScientific 0:f6b418db17d2 149 * @returns true if there is no error, false otherwise
KISScientific 0:f6b418db17d2 150 */
KISScientific 0:f6b418db17d2 151 bool scroll(int8_t z);
KISScientific 0:f6b418db17d2 152
KISScientific 0:f6b418db17d2 153 /**
KISScientific 0:f6b418db17d2 154 * To send a character defined by a modifier(CTRL, SHIFT, ALT) and the key
KISScientific 0:f6b418db17d2 155 *
KISScientific 0:f6b418db17d2 156 * @code
KISScientific 0:f6b418db17d2 157 * //To send CTRL + s (save)
KISScientific 0:f6b418db17d2 158 * keyboard.keyCode('s', KEY_CTRL);
KISScientific 0:f6b418db17d2 159 * @endcode
KISScientific 0:f6b418db17d2 160 *
KISScientific 0:f6b418db17d2 161 * @param modifier bit 0: KEY_CTRL, bit 1: KEY_SHIFT, bit 2: KEY_ALT (default: 0)
KISScientific 0:f6b418db17d2 162 * @param key character to send
KISScientific 0:f6b418db17d2 163 * @returns true if there is no error, false otherwise
KISScientific 0:f6b418db17d2 164 */
KISScientific 0:f6b418db17d2 165 bool keyCode(uint8_t key, uint8_t modifier = 0);
KISScientific 0:f6b418db17d2 166
KISScientific 0:f6b418db17d2 167 /**
KISScientific 0:f6b418db17d2 168 * Send a character
KISScientific 0:f6b418db17d2 169 *
KISScientific 0:f6b418db17d2 170 * @param c character to be sent
KISScientific 0:f6b418db17d2 171 * @returns true if there is no error, false otherwise
KISScientific 0:f6b418db17d2 172 */
KISScientific 0:f6b418db17d2 173 virtual int _putc(int c);
KISScientific 0:f6b418db17d2 174
KISScientific 0:f6b418db17d2 175 /**
KISScientific 0:f6b418db17d2 176 * Control media keys
KISScientific 0:f6b418db17d2 177 *
KISScientific 0:f6b418db17d2 178 * @param key media key pressed (KEY_NEXT_TRACK, KEY_PREVIOUS_TRACK, KEY_STOP, KEY_PLAY_PAUSE, KEY_MUTE, KEY_VOLUME_UP, KEY_VOLUME_DOWN)
KISScientific 0:f6b418db17d2 179 * @returns true if there is no error, false otherwise
KISScientific 0:f6b418db17d2 180 */
KISScientific 0:f6b418db17d2 181 bool mediaControl(MEDIA_KEY key);
KISScientific 0:f6b418db17d2 182
KISScientific 0:f6b418db17d2 183 /**
KISScientific 0:f6b418db17d2 184 * Read status of lock keys. Useful to switch-on/off leds according to key pressed. Only the first three bits of the result is important:
KISScientific 0:f6b418db17d2 185 * - First bit: NUM_LOCK
KISScientific 0:f6b418db17d2 186 * - Second bit: CAPS_LOCK
KISScientific 0:f6b418db17d2 187 * - Third bit: SCROLL_LOCK
KISScientific 0:f6b418db17d2 188 *
KISScientific 0:f6b418db17d2 189 * @returns status of lock keys
KISScientific 0:f6b418db17d2 190 */
KISScientific 0:f6b418db17d2 191 uint8_t lockStatus();
KISScientific 0:f6b418db17d2 192
KISScientific 0:f6b418db17d2 193 /*
KISScientific 0:f6b418db17d2 194 * To define the report descriptor. Warning: this method has to store the length of the report descriptor in reportLength.
KISScientific 0:f6b418db17d2 195 *
KISScientific 0:f6b418db17d2 196 * @returns pointer to the report descriptor
KISScientific 0:f6b418db17d2 197 */
KISScientific 0:f6b418db17d2 198 virtual uint8_t * reportDesc();
KISScientific 0:f6b418db17d2 199
KISScientific 0:f6b418db17d2 200 /*
KISScientific 0:f6b418db17d2 201 * Called when a data is received on the OUT endpoint. Useful to switch on LED of LOCK keys
KISScientific 0:f6b418db17d2 202 *
KISScientific 0:f6b418db17d2 203 * @returns if handle by subclass, return true
KISScientific 0:f6b418db17d2 204 */
KISScientific 0:f6b418db17d2 205 virtual bool EP1_OUT_callback();
KISScientific 0:f6b418db17d2 206
KISScientific 0:f6b418db17d2 207
KISScientific 0:f6b418db17d2 208 private:
KISScientific 0:f6b418db17d2 209 bool mouseWrite(int8_t x, int8_t y, uint8_t buttons, int8_t z);
KISScientific 0:f6b418db17d2 210 MOUSE_TYPE mouse_type;
KISScientific 0:f6b418db17d2 211 uint8_t button;
KISScientific 0:f6b418db17d2 212 bool mouseSend(int8_t x, int8_t y, uint8_t buttons, int8_t z);
KISScientific 0:f6b418db17d2 213
KISScientific 0:f6b418db17d2 214 uint8_t lock_status;
KISScientific 0:f6b418db17d2 215
KISScientific 0:f6b418db17d2 216 //dummy otherwise it doesn't compile (we must define all methods of an abstract class)
KISScientific 0:f6b418db17d2 217 virtual int _getc() { return -1;}
KISScientific 0:f6b418db17d2 218 };
KISScientific 0:f6b418db17d2 219
KISScientific 0:f6b418db17d2 220 #endif