Taylor Gy / ESP8266

ESP8266 driver from ARM

Dependents:   8-0_OneNet_IoT_demo STM32F103C8T6_OneNet_IoT

ATParser/BufferedSerial/BufferedSerial.h@0:dfb22bd0e039, 2017-03-29 (annotated)

Committer:
TaylorGy
Date:
Wed Mar 29 03:09:15 2017 +0000
Revision:
0:dfb22bd0e039
ESP8266 driver from ARM

Who changed what in which revision?

UserRevisionLine numberNew contents of line
TaylorGy 0:dfb22bd0e039 1
TaylorGy 0:dfb22bd0e039 2 /**
TaylorGy 0:dfb22bd0e039 3 * @file BufferedSerial.h
TaylorGy 0:dfb22bd0e039 4 * @brief Software Buffer - Extends mbed Serial functionallity adding irq driven TX and RX
TaylorGy 0:dfb22bd0e039 5 * @author sam grove
TaylorGy 0:dfb22bd0e039 6 * @version 1.0
TaylorGy 0:dfb22bd0e039 7 * @see
TaylorGy 0:dfb22bd0e039 8 *
TaylorGy 0:dfb22bd0e039 9 * Copyright (c) 2013
TaylorGy 0:dfb22bd0e039 10 *
TaylorGy 0:dfb22bd0e039 11 * Licensed under the Apache License, Version 2.0 (the "License");
TaylorGy 0:dfb22bd0e039 12 * you may not use this file except in compliance with the License.
TaylorGy 0:dfb22bd0e039 13 * You may obtain a copy of the License at
TaylorGy 0:dfb22bd0e039 14 *
TaylorGy 0:dfb22bd0e039 15 * http://www.apache.org/licenses/LICENSE-2.0
TaylorGy 0:dfb22bd0e039 16 *
TaylorGy 0:dfb22bd0e039 17 * Unless required by applicable law or agreed to in writing, software
TaylorGy 0:dfb22bd0e039 18 * distributed under the License is distributed on an "AS IS" BASIS,
TaylorGy 0:dfb22bd0e039 19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
TaylorGy 0:dfb22bd0e039 20 * See the License for the specific language governing permissions and
TaylorGy 0:dfb22bd0e039 21 * limitations under the License.
TaylorGy 0:dfb22bd0e039 22 */
TaylorGy 0:dfb22bd0e039 23
TaylorGy 0:dfb22bd0e039 24 #ifndef BUFFEREDSERIAL_H
TaylorGy 0:dfb22bd0e039 25 #define BUFFEREDSERIAL_H
TaylorGy 0:dfb22bd0e039 26
TaylorGy 0:dfb22bd0e039 27 #include "mbed.h"
TaylorGy 0:dfb22bd0e039 28 #include "MyBuffer.h"
TaylorGy 0:dfb22bd0e039 29
TaylorGy 0:dfb22bd0e039 30 /** A serial port (UART) for communication with other serial devices
TaylorGy 0:dfb22bd0e039 31 *
TaylorGy 0:dfb22bd0e039 32 * Can be used for Full Duplex communication, or Simplex by specifying
TaylorGy 0:dfb22bd0e039 33 * one pin as NC (Not Connected)
TaylorGy 0:dfb22bd0e039 34 *
TaylorGy 0:dfb22bd0e039 35 * Example:
TaylorGy 0:dfb22bd0e039 36 * @code
TaylorGy 0:dfb22bd0e039 37 * #include "mbed.h"
TaylorGy 0:dfb22bd0e039 38 * #include "BufferedSerial.h"
TaylorGy 0:dfb22bd0e039 39 *
TaylorGy 0:dfb22bd0e039 40 * BufferedSerial pc(USBTX, USBRX);
TaylorGy 0:dfb22bd0e039 41 *
TaylorGy 0:dfb22bd0e039 42 * int main()
TaylorGy 0:dfb22bd0e039 43 * {
TaylorGy 0:dfb22bd0e039 44 * while(1)
TaylorGy 0:dfb22bd0e039 45 * {
TaylorGy 0:dfb22bd0e039 46 * Timer s;
TaylorGy 0:dfb22bd0e039 47 *
TaylorGy 0:dfb22bd0e039 48 * s.start();
TaylorGy 0:dfb22bd0e039 49 * pc.printf("Hello World - buffered\n");
TaylorGy 0:dfb22bd0e039 50 * int buffered_time = s.read_us();
TaylorGy 0:dfb22bd0e039 51 * wait(0.1f); // give time for the buffer to empty
TaylorGy 0:dfb22bd0e039 52 *
TaylorGy 0:dfb22bd0e039 53 * s.reset();
TaylorGy 0:dfb22bd0e039 54 * printf("Hello World - blocking\n");
TaylorGy 0:dfb22bd0e039 55 * int polled_time = s.read_us();
TaylorGy 0:dfb22bd0e039 56 * s.stop();
TaylorGy 0:dfb22bd0e039 57 * wait(0.1f); // give time for the buffer to empty
TaylorGy 0:dfb22bd0e039 58 *
TaylorGy 0:dfb22bd0e039 59 * pc.printf("printf buffered took %d us\n", buffered_time);
TaylorGy 0:dfb22bd0e039 60 * pc.printf("printf blocking took %d us\n", polled_time);
TaylorGy 0:dfb22bd0e039 61 * wait(0.5f);
TaylorGy 0:dfb22bd0e039 62 * }
TaylorGy 0:dfb22bd0e039 63 * }
TaylorGy 0:dfb22bd0e039 64 * @endcode
TaylorGy 0:dfb22bd0e039 65 */
TaylorGy 0:dfb22bd0e039 66
TaylorGy 0:dfb22bd0e039 67 /**
TaylorGy 0:dfb22bd0e039 68 * @class BufferedSerial
TaylorGy 0:dfb22bd0e039 69 * @brief Software buffers and interrupt driven tx and rx for Serial
TaylorGy 0:dfb22bd0e039 70 */
TaylorGy 0:dfb22bd0e039 71 class BufferedSerial : public RawSerial
TaylorGy 0:dfb22bd0e039 72 {
TaylorGy 0:dfb22bd0e039 73 private:
TaylorGy 0:dfb22bd0e039 74 MyBuffer <char> _rxbuf;
TaylorGy 0:dfb22bd0e039 75 MyBuffer <char> _txbuf;
TaylorGy 0:dfb22bd0e039 76 uint32_t _buf_size;
TaylorGy 0:dfb22bd0e039 77 uint32_t _tx_multiple;
TaylorGy 0:dfb22bd0e039 78
TaylorGy 0:dfb22bd0e039 79 void rxIrq(void);
TaylorGy 0:dfb22bd0e039 80 void txIrq(void);
TaylorGy 0:dfb22bd0e039 81 void prime(void);
TaylorGy 0:dfb22bd0e039 82
TaylorGy 0:dfb22bd0e039 83 Callback<void()> _cbs[2];
TaylorGy 0:dfb22bd0e039 84
TaylorGy 0:dfb22bd0e039 85 public:
TaylorGy 0:dfb22bd0e039 86 /** Create a BufferedSerial port, connected to the specified transmit and receive pins
TaylorGy 0:dfb22bd0e039 87 * @param tx Transmit pin
TaylorGy 0:dfb22bd0e039 88 * @param rx Receive pin
TaylorGy 0:dfb22bd0e039 89 * @param buf_size printf() buffer size
TaylorGy 0:dfb22bd0e039 90 * @param tx_multiple amount of max printf() present in the internal ring buffer at one time
TaylorGy 0:dfb22bd0e039 91 * @param name optional name
TaylorGy 0:dfb22bd0e039 92 * @note Either tx or rx may be specified as NC if unused
TaylorGy 0:dfb22bd0e039 93 */
TaylorGy 0:dfb22bd0e039 94 BufferedSerial(PinName tx, PinName rx, uint32_t buf_size = 256, uint32_t tx_multiple = 4,const char* name=NULL);
TaylorGy 0:dfb22bd0e039 95
TaylorGy 0:dfb22bd0e039 96 /** Destroy a BufferedSerial port
TaylorGy 0:dfb22bd0e039 97 */
TaylorGy 0:dfb22bd0e039 98 virtual ~BufferedSerial(void);
TaylorGy 0:dfb22bd0e039 99
TaylorGy 0:dfb22bd0e039 100 /** Check on how many bytes are in the rx buffer
TaylorGy 0:dfb22bd0e039 101 * @return 1 if something exists, 0 otherwise
TaylorGy 0:dfb22bd0e039 102 */
TaylorGy 0:dfb22bd0e039 103 virtual int readable(void);
TaylorGy 0:dfb22bd0e039 104
TaylorGy 0:dfb22bd0e039 105 /** Check to see if the tx buffer has room
TaylorGy 0:dfb22bd0e039 106 * @return 1 always has room and can overwrite previous content if too small / slow
TaylorGy 0:dfb22bd0e039 107 */
TaylorGy 0:dfb22bd0e039 108 virtual int writeable(void);
TaylorGy 0:dfb22bd0e039 109
TaylorGy 0:dfb22bd0e039 110 /** Get a single byte from the BufferedSerial Port.
TaylorGy 0:dfb22bd0e039 111 * Should check readable() before calling this.
TaylorGy 0:dfb22bd0e039 112 * @return A byte that came in on the Serial Port
TaylorGy 0:dfb22bd0e039 113 */
TaylorGy 0:dfb22bd0e039 114 virtual int getc(void);
TaylorGy 0:dfb22bd0e039 115
TaylorGy 0:dfb22bd0e039 116 /** Write a single byte to the BufferedSerial Port.
TaylorGy 0:dfb22bd0e039 117 * @param c The byte to write to the Serial Port
TaylorGy 0:dfb22bd0e039 118 * @return The byte that was written to the Serial Port Buffer
TaylorGy 0:dfb22bd0e039 119 */
TaylorGy 0:dfb22bd0e039 120 virtual int putc(int c);
TaylorGy 0:dfb22bd0e039 121
TaylorGy 0:dfb22bd0e039 122 /** Write a string to the BufferedSerial Port. Must be NULL terminated
TaylorGy 0:dfb22bd0e039 123 * @param s The string to write to the Serial Port
TaylorGy 0:dfb22bd0e039 124 * @return The number of bytes written to the Serial Port Buffer
TaylorGy 0:dfb22bd0e039 125 */
TaylorGy 0:dfb22bd0e039 126 virtual int puts(const char *s);
TaylorGy 0:dfb22bd0e039 127
TaylorGy 0:dfb22bd0e039 128 /** Write a formatted string to the BufferedSerial Port.
TaylorGy 0:dfb22bd0e039 129 * @param format The string + format specifiers to write to the Serial Port
TaylorGy 0:dfb22bd0e039 130 * @return The number of bytes written to the Serial Port Buffer
TaylorGy 0:dfb22bd0e039 131 */
TaylorGy 0:dfb22bd0e039 132 virtual int printf(const char* format, ...);
TaylorGy 0:dfb22bd0e039 133
TaylorGy 0:dfb22bd0e039 134 /** Write data to the Buffered Serial Port
TaylorGy 0:dfb22bd0e039 135 * @param s A pointer to data to send
TaylorGy 0:dfb22bd0e039 136 * @param length The amount of data being pointed to
TaylorGy 0:dfb22bd0e039 137 * @return The number of bytes written to the Serial Port Buffer
TaylorGy 0:dfb22bd0e039 138 */
TaylorGy 0:dfb22bd0e039 139 virtual ssize_t write(const void *s, std::size_t length);
TaylorGy 0:dfb22bd0e039 140
TaylorGy 0:dfb22bd0e039 141 /** Attach a function to call whenever a serial interrupt is generated
TaylorGy 0:dfb22bd0e039 142 * @param func A pointer to a void function, or 0 to set as none
TaylorGy 0:dfb22bd0e039 143 * @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)
TaylorGy 0:dfb22bd0e039 144 */
TaylorGy 0:dfb22bd0e039 145 virtual void attach(Callback<void()> func, IrqType type=RxIrq);
TaylorGy 0:dfb22bd0e039 146
TaylorGy 0:dfb22bd0e039 147 /** Attach a member function to call whenever a serial interrupt is generated
TaylorGy 0:dfb22bd0e039 148 * @param obj pointer to the object to call the member function on
TaylorGy 0:dfb22bd0e039 149 * @param method pointer to the member function to call
TaylorGy 0:dfb22bd0e039 150 * @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)
TaylorGy 0:dfb22bd0e039 151 */
TaylorGy 0:dfb22bd0e039 152 template <typename T>
TaylorGy 0:dfb22bd0e039 153 void attach(T *obj, void (T::*method)(), IrqType type=RxIrq) {
TaylorGy 0:dfb22bd0e039 154 attach(Callback<void()>(obj, method), type);
TaylorGy 0:dfb22bd0e039 155 }
TaylorGy 0:dfb22bd0e039 156
TaylorGy 0:dfb22bd0e039 157 /** Attach a member function to call whenever a serial interrupt is generated
TaylorGy 0:dfb22bd0e039 158 * @param obj pointer to the object to call the member function on
TaylorGy 0:dfb22bd0e039 159 * @param method pointer to the member function to call
TaylorGy 0:dfb22bd0e039 160 * @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)
TaylorGy 0:dfb22bd0e039 161 */
TaylorGy 0:dfb22bd0e039 162 template <typename T>
TaylorGy 0:dfb22bd0e039 163 void attach(T *obj, void (*method)(T*), IrqType type=RxIrq) {
TaylorGy 0:dfb22bd0e039 164 attach(Callback<void()>(obj, method), type);
TaylorGy 0:dfb22bd0e039 165 }
TaylorGy 0:dfb22bd0e039 166 };
TaylorGy 0:dfb22bd0e039 167
TaylorGy 0:dfb22bd0e039 168 #endif