2014-12-28 06:29:08 -08:00
|
|
|
/******************************************************************************
|
|
|
|
* The MIT License
|
|
|
|
*
|
|
|
|
* Copyright (c) 2010 Perry Hung.
|
|
|
|
*
|
|
|
|
* Permission is hereby granted, free of charge, to any person
|
|
|
|
* obtaining a copy of this software and associated documentation
|
|
|
|
* files (the "Software"), to deal in the Software without
|
|
|
|
* restriction, including without limitation the rights to use, copy,
|
|
|
|
* modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
|
|
* of the Software, and to permit persons to whom the Software is
|
|
|
|
* furnished to do so, subject to the following conditions:
|
|
|
|
*
|
|
|
|
* The above copyright notice and this permission notice shall be
|
|
|
|
* included in all copies or substantial portions of the Software.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
|
|
|
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
|
|
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
|
* SOFTWARE.
|
|
|
|
*****************************************************************************/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Wirish virtual serial port
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _USB_SERIAL_H_
|
|
|
|
#define _USB_SERIAL_H_
|
|
|
|
|
2015-08-11 15:50:38 -07:00
|
|
|
#include "Stream.h"
|
2014-12-28 06:29:08 -08:00
|
|
|
|
2017-05-10 15:57:08 -07:00
|
|
|
#ifdef SERIAL_USB
|
|
|
|
|
2014-12-28 06:29:08 -08:00
|
|
|
/**
|
|
|
|
* @brief Virtual serial terminal.
|
|
|
|
*/
|
2015-08-11 15:50:38 -07:00
|
|
|
class USBSerial : public Stream {
|
2014-12-28 06:29:08 -08:00
|
|
|
public:
|
|
|
|
USBSerial(void);
|
|
|
|
|
|
|
|
void begin(void);
|
|
|
|
void begin(int);
|
|
|
|
void end(void);
|
|
|
|
|
2015-08-11 15:50:38 -07:00
|
|
|
virtual int available(void);
|
|
|
|
virtual int peek(void);
|
|
|
|
virtual void flush(void);
|
2014-12-28 06:29:08 -08:00
|
|
|
|
2015-08-11 15:50:38 -07:00
|
|
|
virtual int read(void *buf, uint32 len);
|
|
|
|
virtual int read(void);
|
2014-12-28 06:29:08 -08:00
|
|
|
|
2015-06-14 07:37:05 -07:00
|
|
|
size_t write(uint8);
|
|
|
|
size_t write(const char *str);
|
|
|
|
size_t write(const void*, uint32);
|
2014-12-28 06:29:08 -08:00
|
|
|
|
|
|
|
uint8 getRTS();
|
|
|
|
uint8 getDTR();
|
2017-05-10 15:57:08 -07:00
|
|
|
operator bool();
|
|
|
|
uint8 isConnected() { return (bool) *this; }
|
2014-12-28 06:29:08 -08:00
|
|
|
uint8 pending();
|
|
|
|
|
|
|
|
void enableBlockingTx(void);
|
|
|
|
void disableBlockingTx(void);
|
|
|
|
};
|
|
|
|
|
|
|
|
extern USBSerial SerialUSB;
|
2017-05-10 15:57:08 -07:00
|
|
|
#define Serial SerialUSB
|
|
|
|
|
|
|
|
#else // _USB_SERIAL_H_
|
|
|
|
|
|
|
|
#define Serial Serial1
|
|
|
|
|
|
|
|
#endif // SERIAL_USB
|
|
|
|
|
2014-12-28 06:29:08 -08:00
|
|
|
|
2017-05-10 15:57:08 -07:00
|
|
|
#endif // _USB_SERIAL_H_
|
2014-12-28 06:29:08 -08:00
|
|
|
|