indidustcapinterface.h

Go to the documentation of this file.

/*
    Dust Cap Interface
    Copyright (C) 2015-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 "indibase.h"
#include "indidriver.h"
#include "indipropertyswitch.h"
#include <cstdint>
 
// Alias
using DI = INDI::DustCapInterface;
namespace INDI
{
 
class DustCapInterface
{
    public:
        enum
        {
            CAP_PARK,
            CAP_UNPARK
        };
 
        enum
        {
            CAN_ABORT           = 1 << 0,   
            CAN_SET_POSITION    = 1 << 1,   
            CAN_SET_LIMITS      = 1 << 2,   
        } DustCapCapability;
 
    protected:
        DustCapInterface(DefaultDevice *device);
        virtual ~DustCapInterface() = default;
 
        virtual IPState ParkCap();
 
        virtual IPState UnParkCap();
 
        virtual IPState AbortCap();
 
        void initProperties(const char *group, uint32_t capabilities = 0);
 
        bool updateProperties();
 
        bool processSwitch(const char *dev, const char *name, ISState *states, char *names[], int n);
 
        // Open/Close cover
        INDI::PropertySwitch ParkCapSP {2};
        // Abort Motion
        INDI::PropertySwitch AbortCapSP {1};
 
    private:
        DefaultDevice *m_DefaultDevice { nullptr };
        uint32_t m_Capabilities {0};
};
}