connectionserial.h

Go to the documentation of this file.

/*******************************************************************************
  Copyright(c) 2017 Jasem Mutlaq. All rights reserved.
 
 Connection Plugin Interface
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Library General Public
 License version 2 as published by the Free Software Foundation.
 
 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
 Library General Public License for more details.
 
 You should have received a copy of the GNU Library General Public License
 along with this library; see the file COPYING.LIB.  If not, write to
 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 Boston, MA 02110-1301, USA.
*******************************************************************************/
 
#pragma once
 
#include "connectioninterface.h"
#include "indipropertytext.h"
#include "indipropertyswitch.h"
 
#include <string>
#include <vector>
#include <cstdint>
 
namespace Connection
{
class Serial : public Interface
{
    public:
        typedef enum { B_1200, B_2400, B_4800, B_9600, B_19200, B_38400, B_57600, B_115200, B_230400, B_COUNT } BaudRate;
 
        Serial(INDI::DefaultDevice *dev, IPerm permission = IP_RW);
        virtual ~Serial();
 
        virtual bool Connect() override;
 
        virtual bool Disconnect() override;
 
        virtual void Activated() override;
 
        virtual void Deactivated() override;
 
        virtual std::string name() override
        {
            return "CONNECTION_SERIAL";
        }
 
        virtual std::string label() override
        {
            return "Serial";
        }
 
        virtual const char *port()
        {
            return PortTP[0].getText();
        }
 
        virtual uint32_t baud();
 
        void setDefaultPort(const char *port);
 
        void setDefaultBaudRate(BaudRate newRate);
 
        void setPortMatchPattern(const std::string &pattern);
 
        int getPortFD() const
        {
            return PortFD;
        }
 
        virtual bool ISNewText(const char *dev, const char *name, char *texts[], char *names[], int n) override;
        virtual bool ISNewSwitch(const char *dev, const char *name, ISState *states, char *names[], int n) override;
        virtual bool saveConfigItems(FILE *fp) override;
 
        bool Refresh(bool silent = false);
 
        uint8_t getWordSize() const
        {
            return wordSize;
        }
        void setWordSize(const uint8_t &value)
        {
            wordSize = value;
        }
 
        uint8_t getParity() const
        {
            return parity ;
        }
        void setParity(const uint8_t &value)
        {
            parity = value;
        }
 
        uint8_t getStopBits() const
        {
            return stopBits;
        }
        void setStopBits(const uint8_t &value)
        {
            stopBits = value ;
        }
 
    protected:
        virtual bool Connect(const char *port, uint32_t baud);
 
        virtual bool processHandshake();
 
        enum
        {
            SERIAL_DEV,
            USB_ID_DEV,
            BLUETOOTH_DEV
        };
 
        // Device physical port
        INDI::PropertyText PortTP {1};
 
        INDI::PropertySwitch BaudRateSP {B_COUNT};
 
        INDI::PropertySwitch AutoSearchSP {2};
 
        // Dynamically populated from the ports detected on the system
        INDI::PropertySwitch SystemPortSP {0};
 
        INDI::PropertySwitch RefreshSP {1};
 
        int PortFD = -1;
 
        // Default 8N1 parameters
        uint8_t wordSize = 8;
        uint8_t parity = 0;
        uint8_t stopBits = 1;
 
        IPerm m_Permission = IP_RW;
 
        std::string m_ConfigPort;
        int m_ConfigBaudRate {-1};
        std::vector<std::string> m_SystemPorts;
        // Optional regex pattern for auto-selecting a port by device name (e.g. Pegasus devices)
        std::string m_PortMatchPattern;
};
}