ttybase.h

Go to the documentation of this file.

/*
    TTY Base
 
    Base class for TTY Serial Connections.
 
    Copyright (C) 2018 Jasem Mutlaq
    Copyright (C) 2011 Wildi Markus
 
    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 Street, Fifth Floor, Boston, MA  02110-1301  USA
 
*/
 
#pragma once
 
#include <string>
#include <indilogger.h>
 
class TTYBase
{
    public:
        typedef enum
        {
            TTY_OK           = 0,
            TTY_READ_ERROR   = -1,
            TTY_WRITE_ERROR  = -2,
            TTY_SELECT_ERROR = -3,
            TTY_TIME_OUT     = -4,
            TTY_PORT_FAILURE = -5,
            TTY_PARAM_ERROR  = -6,
            TTY_ERRNO        = -7,
            TTY_OVERFLOW     = -8
        } TTY_RESPONSE;
 
        TTYBase(const char *driverName);
        virtual ~TTYBase();
 
        TTY_RESPONSE read(uint8_t *buffer, uint32_t nbytes, uint8_t timeout, uint32_t *nbytes_read);
 
        TTY_RESPONSE readSection(uint8_t *buffer, uint32_t nsize, uint8_t stop_byte, uint8_t timeout, uint32_t *nbytes_read);
 
        TTY_RESPONSE write(const uint8_t *buffer, uint32_t nbytes, uint32_t *nbytes_written);
 
        TTY_RESPONSE writeString(const char *string, uint32_t *nbytes_written);
 
        TTY_RESPONSE connect(const char *device, uint32_t bit_rate, uint8_t word_size, uint8_t parity, uint8_t stop_bits);
 
        TTY_RESPONSE disconnect();
 
        void setDebug(INDI::Logger::VerbosityLevel channel);
 
        const std::string error(TTY_RESPONSE code) const;
 
        int getPortFD() const
        {
            return m_PortFD;
        }
 
    private:
 
        TTY_RESPONSE checkTimeout(uint8_t timeout);
 
        int m_PortFD { -1 };
        bool m_Debug { false };
        INDI::Logger::VerbosityLevel m_DebugChannel { INDI::Logger::DBG_IGNORE };
        const char *m_DriverName;
};