serial_service.cpp

Go to the documentation of this file.

/*
  serial_service.cpp -  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
*/
 
#include "../../include/esp3d_config.h"
#include "serial_service.h"
#include "../../core/settings_esp3d.h"
#include "../../core/esp3doutput.h"
#include "../../core/commands.h"
 
//Serial Parameters
#define ESP_SERIAL_PARAM SERIAL_8N1
 
#if ESP_SERIAL_OUTPUT == USE_SERIAL_0
#define ESP3D_SERIAL Serial
#endif //USE_SERIAL_0
 
#if ESP_SERIAL_OUTPUT == USE_SERIAL_1
#define ESP3D_SERIAL Serial1
#endif //USE_SERIAL_1
 
#if ESP_SERIAL_OUTPUT == USE_SERIAL_2
#define ESP3D_SERIAL Serial2
#endif //USE_SERIAL_2
 
SerialService serial_service;
 
const long SupportedBaudList[] = {9600, 19200, 38400, 57600, 74880, 115200, 230400, 250000, 500000, 921600};
 
#define TIMEOUT_SERIAL_FLUSH 1500
//Constructor
SerialService::SerialService()
{
    _buffer_size = 0;
    _started = false;
}
 
//Destructor
SerialService::~SerialService()
{
    end();
}
 
//Setup Serial
bool SerialService::begin()
{
    _lastflush = millis();
    //read from settings
    long br = Settings_ESP3D::read_uint32(ESP_BAUD_RATE);
    _buffer_size = 0;
    //change only if different from current
    if (br != baudRate() || (ESP_RX_PIN != -1) || (ESP_TX_PIN != -1)) {
        if ( !is_valid_baudrate(br)) {
            br = Settings_ESP3D::get_default_int32_value(ESP_BAUD_RATE);
        }
#ifdef ARDUINO_ARCH_ESP8266
        ESP3D_SERIAL.begin(br, SERIAL_8N1, SERIAL_FULL, (ESP_TX_PIN == -1)?1:ESP_TX_PIN);
#if ESP_RX_PIN != -1
        ESP3D_SERIAL.pins((ESP_TX_PIN == -1)?1:ESP_TX_PIN, ESP_RX_PIN)
#endif //ESP_RX_PIN != -1
#endif //ARDUINO_ARCH_ESP8266
#ifdef ARDUINO_ARCH_ESP32
        ESP3D_SERIAL.begin (br, ESP_SERIAL_PARAM, ESP_RX_PIN, ESP_TX_PIN);
#endif //ARDUINO_ARCH_ESP32
    }
    ESP3D_SERIAL.setRxBufferSize (SERIAL_RX_BUFFER_SIZE);
    _started = true;
    return true;
}
//End serial
bool SerialService::end()
{
    flush();
    delay (100);
    swap();
    ESP3D_SERIAL.end();
    _buffer_size = 0;
    _started = false;
    return true;
}
 
//return the array of long and array size
const long * SerialService::get_baudratelist(uint8_t * count)
{
    if (count) {
        *count = sizeof(SupportedBaudList)/sizeof(long);
    }
    return SupportedBaudList;
}
 
//check if value is in baudrate list
bool SerialService::is_valid_baudrate(long br)
{
    uint8_t listesize = sizeof(SupportedBaudList)/sizeof(long);
    for (uint8_t i = 0; i < listesize ; i++) {
        if (SupportedBaudList[i] == br) {
            return true;
        }
    }
    return false;
}
 
//Function which could be called in other loop
void SerialService::handle()
{
    //Do we have some data waiting
    size_t len = available();
    if (len > 0) {
        //if yes read them
        uint8_t * sbuf = (uint8_t *)malloc(len);
        if(sbuf) {
            size_t count = readBytes(sbuf, len);
            //push to buffer
            if (count > 0) {
                push2buffer(sbuf, count);
            }
            //freen buffer
            free(sbuf);
        }
    }
    //we cannot left data in buffer too long
    //in case some commands "forget" to add \n
    if (((millis() - _lastflush) > TIMEOUT_SERIAL_FLUSH) && (_buffer_size > 0)) {
        flushbuffer();
    }
}
 
void SerialService::flushbuffer()
{
    ESP3DOutput output(ESP_SERIAL_CLIENT);
    _buffer[_buffer_size] = 0x0;
    //dispatch command
    esp3d_commands.process(_buffer, _buffer_size, &output);
    _lastflush = millis();
    _buffer_size = 0;
}
 
//push collected data to buffer and proceed accordingly
void SerialService::push2buffer(uint8_t * sbuf, size_t len)
{
    for (size_t i = 0; i < len; i++) {
        _lastflush = millis();
        //command is defined
        if (char(sbuf[i]) == '\n') {
            if (_buffer_size < ESP3D_SERIAL_BUFFER_SIZE) {
                _buffer[_buffer_size] = sbuf[i];
                _buffer_size++;
            }
            flushbuffer();
        } else if (isPrintable (char(sbuf[i]) ) || char(sbuf[i]) == '\r') {
            if (_buffer_size < ESP3D_SERIAL_BUFFER_SIZE) {
                _buffer[_buffer_size] = sbuf[i];
                _buffer_size++;
            } else {
                flushbuffer();
                _buffer[_buffer_size] = sbuf[i];
                _buffer_size++;
            }
        } else { //it is not printable char
            //clean buffer first
            if (_buffer_size > 0) {
                flushbuffer();
            }
            //process char
            _buffer[_buffer_size] = sbuf[i];
            _buffer_size++;
            flushbuffer();
        }
    }
}
 
//Reset Serial Setting (baud rate)
bool SerialService::reset()
{
    log_esp3d("Reset serial");
    return Settings_ESP3D::write_uint32 (ESP_BAUD_RATE, Settings_ESP3D::get_default_int32_value(ESP_BAUD_RATE));
}
 
//Get current baud rate
long SerialService::baudRate()
{
    long br = 0;
    br = ESP3D_SERIAL.baudRate();
#ifdef ARDUINO_ARCH_ESP32
    //workaround for ESP32
    if (br == 115201) {
        br = 115200;
    }
    if (br == 230423) {
        br = 230400;
    }
#endif //ARDUINO_ARCH_ESP32
    return br;
}
 
size_t SerialService::write(uint8_t c)
{
    return ESP3D_SERIAL.write(c);
}
 
size_t SerialService::write(const uint8_t *buffer, size_t size)
{
    if ((uint)ESP3D_SERIAL.availableForWrite() >= size) {
        return ESP3D_SERIAL.write(buffer, size);
    } else {
        size_t sizetosend = size;
        size_t sizesent = 0;
        uint8_t *buffertmp=(uint8_t *)buffer;
        uint32_t starttime = millis();
        //loop until all is sent or timeout
        while (sizetosend>0 && ((millis() - starttime) < 100)) {
            size_t available = ESP3D_SERIAL.availableForWrite();
            if(available>0) {
                //in case less is sent
                available = ESP3D_SERIAL.write(&buffertmp[sizesent], (available >= sizetosend)?sizetosend:available);
                sizetosend-=available;
                sizesent+=available;
                starttime=millis();
            } else {
                Hal::wait(5);
            }
        }
        return sizesent;
    }
}
 
uint SerialService::availableForWrite()
{
    return ESP3D_SERIAL.availableForWrite();
}
 
int SerialService::available()
{
    return ESP3D_SERIAL.available();
}
 
int SerialService::read()
{
    return ESP3D_SERIAL.read();
}
 
size_t SerialService::readBytes(uint8_t * sbuf, size_t len)
{
    return ESP3D_SERIAL.readBytes(sbuf, len);
}
 
void SerialService::flush()
{
    ESP3D_SERIAL.flush();
}
 
void SerialService::swap()
{
#ifdef ARDUINO_ARCH_ESP8266
    ESP3D_SERIAL.swap();
#endif //ARDUINO_ARCH_ESP8266
}