GrblDeviceBase.hpp

/*
** Copyright (C) 2020 Sylvain Fargier
**
** This software is provided 'as-is', without any express or implied
** warranty.  In no event will the authors be held liable for any damages
** arising from the use of this software.
**
** Permission is granted to anyone to use this software for any purpose,
** including commercial applications, and to alter it and redistribute it
** freely, subject to the following restrictions:
**
** 1. The origin of this software must not be misrepresented; you must not
**    claim that you wrote the original software. If you use this software
**    in a product, an acknowledgment in the product documentation would be
**    appreciated but is not required.
** 2. Altered source versions must be plainly marked as such, and must not be
**    misrepresented as being the original software.
** 3. This notice may not be removed or altered from any source distribution.
**
** Created on: 2022-02-13T21:09:57+01:00
**     Author: Sylvain Fargier <fargie_s> <sylvain.fargier@cern.ch>
**
*/
 
#ifndef GRBLDEVICEBASE_HPP__
#define GRBLDEVICEBASE_HPP__
 
#include <chrono>
#include <functional>
#include <string>
 
#include <ccut/LineBuffer.hpp>
#include <ccut/Signal.hpp>
 
#include "GrblTypes.hpp"
 
namespace grbl {
class GrblDeviceBase
{
public:
    virtual ~GrblDeviceBase() = default;
 
    void fetch(const std::chrono::milliseconds &timeout);
 
    virtual void write(const std::string &data) = 0;
 
    virtual grbl::ErrorCode send(
        const std::string &cmd,
        std::function<bool(const std::string &)> msg = {},
        const std::chrono::milliseconds &timeout = defaultSendTimeout);
 
    virtual grbl::ErrorCode sendRealtime(
        const std::string &cmd,
        std::function<bool(const std::string &)> msg = {},
        const std::chrono::milliseconds &timeout = defaultSendTimeout);
 
    virtual void wake() = 0;
 
    virtual void read() = 0;
 
    virtual bool wait(const std::chrono::milliseconds &timeout) = 0;
 
    virtual bool takeLine(std::string &line);
 
    ccut::Signal<std::string> dataSignal;
 
    static const std::chrono::milliseconds defaultSendTimeout;
 
protected:
    ccut::LineBuffer m_buffer;
};
 
} // namespace grbl
 
#endif