connectioni2c.h

Go to the documentation of this file.

/*
    I2C Connection Plugin
    Copyright (C) 2025 Jasem Mutlaq ([email protected])
 
    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 "connectioninterface.h"
#include "indipropertytext.h"
#include <string>
#include <stdint.h>
 
namespace Connection
{
 
class I2C : public Interface
{
    public:
        enum I2CConnectionText
        {
            I2C_BUS = 0,
            I2C_ADDRESS,
        };
 
 
        I2C(INDI::DefaultDevice *dev, IPerm permission = IP_RW);
        virtual ~I2C();
 
        virtual bool Connect() override;
        virtual bool Disconnect() override;
 
        virtual void Activated() override;
        virtual void Deactivated() override;
 
        virtual std::string name() override
        {
            return "CONNECTION_I2C";
        }
 
        virtual std::string label() override
        {
            return "I2C";
        }
 
        virtual const char *busPath();
 
        virtual uint8_t address();
 
        void setDefaultBusPath(const char *path);
 
        void setDefaultAddress(uint8_t addr);
 
        int getPortFD() const
        {
            return PortFD;
        }
 
        virtual bool ISNewText(const char *dev, const char *name, char *texts[], char *names[], int n) override;
        virtual bool saveConfigItems(FILE *fp) override;
 
    protected:
        virtual bool Connect(const char *busPath, uint8_t address);
 
        virtual bool processHandshake();
 
        INDI::PropertyText I2CConnectionTP {2};
 
        int PortFD = -1;
 
        IPerm m_Permission = IP_RW;
 
        std::string m_ConfigBusPath;
        int m_ConfigAddress {-1};
};
 
}