Brandon Yee / Mbed 2 deprecated Slingshot

Slingshot Controller

Dependencies:   ADXL345 DebounceIn USBDevice mbed

USBDevice/USBSerial/USBSerial.h@1:2721dc2acc2c, 2012-10-17 (annotated)

Committer:
Brandon
Date:
Wed Oct 17 16:33:04 2012 +0000
Revision:
1:2721dc2acc2c
Parent:
0:cf17ea89fd09 
Updated comments, added names, cleaned old code.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Brandon 0:cf17ea89fd09 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
Brandon 0:cf17ea89fd09 2 *
Brandon 0:cf17ea89fd09 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Brandon 0:cf17ea89fd09 4 * and associated documentation files (the "Software"), to deal in the Software without
Brandon 0:cf17ea89fd09 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
Brandon 0:cf17ea89fd09 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
Brandon 0:cf17ea89fd09 7 * Software is furnished to do so, subject to the following conditions:
Brandon 0:cf17ea89fd09 8 *
Brandon 0:cf17ea89fd09 9 * The above copyright notice and this permission notice shall be included in all copies or
Brandon 0:cf17ea89fd09 10 * substantial portions of the Software.
Brandon 0:cf17ea89fd09 11 *
Brandon 0:cf17ea89fd09 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Brandon 0:cf17ea89fd09 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Brandon 0:cf17ea89fd09 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Brandon 0:cf17ea89fd09 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Brandon 0:cf17ea89fd09 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Brandon 0:cf17ea89fd09 17 */
Brandon 0:cf17ea89fd09 18
Brandon 0:cf17ea89fd09 19 #ifndef USBSERIAL_H
Brandon 0:cf17ea89fd09 20 #define USBSERIAL_H
Brandon 0:cf17ea89fd09 21
Brandon 0:cf17ea89fd09 22 #include "USBCDC.h"
Brandon 0:cf17ea89fd09 23 #include "Stream.h"
Brandon 0:cf17ea89fd09 24 #include "CircBuffer.h"
Brandon 0:cf17ea89fd09 25
Brandon 0:cf17ea89fd09 26
Brandon 0:cf17ea89fd09 27 /**
Brandon 0:cf17ea89fd09 28 * USBSerial example
Brandon 0:cf17ea89fd09 29 *
Brandon 0:cf17ea89fd09 30 * @code
Brandon 0:cf17ea89fd09 31 * #include "mbed.h"
Brandon 0:cf17ea89fd09 32 * #include "USBSerial.h"
Brandon 0:cf17ea89fd09 33 *
Brandon 0:cf17ea89fd09 34 * //Virtual serial port over USB
Brandon 0:cf17ea89fd09 35 * USBSerial serial;
Brandon 0:cf17ea89fd09 36 *
Brandon 0:cf17ea89fd09 37 * int main(void) {
Brandon 0:cf17ea89fd09 38 *
Brandon 0:cf17ea89fd09 39 * while(1)
Brandon 0:cf17ea89fd09 40 * {
Brandon 0:cf17ea89fd09 41 * serial.printf("I am a virtual serial port\n");
Brandon 0:cf17ea89fd09 42 * wait(1);
Brandon 0:cf17ea89fd09 43 * }
Brandon 0:cf17ea89fd09 44 * }
Brandon 0:cf17ea89fd09 45 * @endcode
Brandon 0:cf17ea89fd09 46 */
Brandon 0:cf17ea89fd09 47 class USBSerial: public USBCDC, public Stream {
Brandon 0:cf17ea89fd09 48 public:
Brandon 0:cf17ea89fd09 49
Brandon 0:cf17ea89fd09 50 /**
Brandon 0:cf17ea89fd09 51 * Constructor
Brandon 0:cf17ea89fd09 52 *
Brandon 0:cf17ea89fd09 53 * @param vendor_id Your vendor_id (default: 0x1f00)
Brandon 0:cf17ea89fd09 54 * @param product_id Your product_id (default: 0x2012)
Brandon 0:cf17ea89fd09 55 * @param product_release Your preoduct_release (default: 0x0001)
Brandon 0:cf17ea89fd09 56 *
Brandon 0:cf17ea89fd09 57 */
Brandon 0:cf17ea89fd09 58 USBSerial(uint16_t vendor_id = 0x1f00, uint16_t product_id = 0x2012, uint16_t product_release = 0x0001): USBCDC(vendor_id, product_id, product_release), buf(128){ };
Brandon 0:cf17ea89fd09 59
Brandon 0:cf17ea89fd09 60
Brandon 0:cf17ea89fd09 61 /**
Brandon 0:cf17ea89fd09 62 * Send a character. You can use puts, printf.
Brandon 0:cf17ea89fd09 63 *
Brandon 0:cf17ea89fd09 64 * @param c character to be sent
Brandon 0:cf17ea89fd09 65 * @returns true if there is no error, false otherwise
Brandon 0:cf17ea89fd09 66 */
Brandon 0:cf17ea89fd09 67 virtual int _putc(int c);
Brandon 0:cf17ea89fd09 68
Brandon 0:cf17ea89fd09 69 /**
Brandon 0:cf17ea89fd09 70 * Read a character: blocking
Brandon 0:cf17ea89fd09 71 *
Brandon 0:cf17ea89fd09 72 * @returns character read
Brandon 0:cf17ea89fd09 73 */
Brandon 0:cf17ea89fd09 74 virtual int _getc();
Brandon 0:cf17ea89fd09 75
Brandon 0:cf17ea89fd09 76 /**
Brandon 0:cf17ea89fd09 77 * Check the number of bytes available.
Brandon 0:cf17ea89fd09 78 *
Brandon 0:cf17ea89fd09 79 * @returns the number of bytes available
Brandon 0:cf17ea89fd09 80 */
Brandon 0:cf17ea89fd09 81 uint8_t available();
Brandon 0:cf17ea89fd09 82
Brandon 0:cf17ea89fd09 83 /**
Brandon 0:cf17ea89fd09 84 * Write a block of data.
Brandon 0:cf17ea89fd09 85 *
Brandon 0:cf17ea89fd09 86 * For more efficiency, a block of size 64 (maximum size of a bulk endpoint) has to be written.
Brandon 0:cf17ea89fd09 87 *
Brandon 0:cf17ea89fd09 88 * @param buf pointer on data which will be written
Brandon 0:cf17ea89fd09 89 * @param size size of the buffer. The maximum size of a block is limited by the size of the endpoint (64 bytes)
Brandon 0:cf17ea89fd09 90 *
Brandon 0:cf17ea89fd09 91 * @returns true if successfull
Brandon 0:cf17ea89fd09 92 */
Brandon 0:cf17ea89fd09 93 bool writeBlock(uint8_t * buf, uint16_t size);
Brandon 0:cf17ea89fd09 94
Brandon 0:cf17ea89fd09 95 /**
Brandon 0:cf17ea89fd09 96 * Attach a member function to call when a packet is received.
Brandon 0:cf17ea89fd09 97 *
Brandon 0:cf17ea89fd09 98 * @param tptr pointer to the object to call the member function on
Brandon 0:cf17ea89fd09 99 * @param mptr pointer to the member function to be called
Brandon 0:cf17ea89fd09 100 */
Brandon 0:cf17ea89fd09 101 template<typename T>
Brandon 0:cf17ea89fd09 102 void attach(T* tptr, void (T::*mptr)(void)) {
Brandon 0:cf17ea89fd09 103 if((mptr != NULL) && (tptr != NULL)) {
Brandon 0:cf17ea89fd09 104 rx.attach(tptr, mptr);
Brandon 0:cf17ea89fd09 105 }
Brandon 0:cf17ea89fd09 106 }
Brandon 0:cf17ea89fd09 107
Brandon 0:cf17ea89fd09 108 /**
Brandon 0:cf17ea89fd09 109 * Attach a callback called when a packet is received
Brandon 0:cf17ea89fd09 110 *
Brandon 0:cf17ea89fd09 111 * @param fptr function pointer
Brandon 0:cf17ea89fd09 112 */
Brandon 0:cf17ea89fd09 113 void attach(void (*fn)(void)) {
Brandon 0:cf17ea89fd09 114 if(fn != NULL) {
Brandon 0:cf17ea89fd09 115 rx.attach(fn);
Brandon 0:cf17ea89fd09 116 }
Brandon 0:cf17ea89fd09 117 }
Brandon 0:cf17ea89fd09 118
Brandon 0:cf17ea89fd09 119
Brandon 0:cf17ea89fd09 120 protected:
Brandon 0:cf17ea89fd09 121 virtual bool EP2_OUT_callback();
Brandon 0:cf17ea89fd09 122
Brandon 0:cf17ea89fd09 123 private:
Brandon 0:cf17ea89fd09 124 FunctionPointer rx;
Brandon 0:cf17ea89fd09 125 CircBuffer<uint8_t> buf;
Brandon 0:cf17ea89fd09 126 };
Brandon 0:cf17ea89fd09 127
Brandon 0:cf17ea89fd09 128 #endif