serial_service.h

Go to the documentation of this file.

/*
  serial_service.h -  serial services functions class
 
  Copyright (c) 2014 Luc Lebosse. All rights reserved.
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
 
#ifndef _SERIAL_SERVICES_H
#define _SERIAL_SERVICES_H
 
#include "Print.h"
 
#define ESP3D_SERIAL_BUFFER_SIZE 1024
 
class SerialService : public Print
{
public:
    SerialService();
    ~SerialService();
    bool begin();
    bool end();
    void handle();
    bool reset();
    long baudRate();
    const long * get_baudratelist(uint8_t * count);
    void flush();
    void swap();
    uint availableForWrite();
    int available();
    bool is_valid_baudrate(long br);
    size_t write(uint8_t c);
    size_t write(const uint8_t *buffer, size_t size);
    inline size_t write(const char * s)
    {
        return write((uint8_t*) s, strlen(s));
    }
    inline size_t write(unsigned long n)
    {
        return write((uint8_t) n);
    }
    inline size_t write(long n)
    {
        return write((uint8_t) n);
    }
    inline size_t write(unsigned int n)
    {
        return write((uint8_t) n);
    }
    inline size_t write(int n)
    {
        return write((uint8_t) n);
    }
    int read();
    size_t readBytes (uint8_t * sbuf, size_t len);
    inline bool started()
    {
        return _started;
    }
private:
    bool _started;
    uint32_t _lastflush;
    uint8_t _buffer[ESP3D_SERIAL_BUFFER_SIZE + 1]; //keep space of 0x0 terminal
    size_t _buffer_size;
    void push2buffer(uint8_t * sbuf, size_t len);
    void flushbuffer();
};
 
extern SerialService serial_service;
 
#endif //_SERIAL_SERVICES_H