indidustcapinterface.cpp

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
 
*/
 
#include "indidustcapinterface.h"
#include "defaultdevice.h"
 
#include <cstring>
 
namespace INDI
{
 
DustCapInterface::DustCapInterface(DefaultDevice *defaultDevice) : m_DefaultDevice(defaultDevice)
{
}
 
void DustCapInterface::initProperties(const char *group, uint32_t capabilities)
{
    m_Capabilities = capabilities;
 
    // Open/Close cover
    ParkCapSP[CAP_PARK].fill("PARK", "Park", ISS_OFF);
    ParkCapSP[CAP_UNPARK].fill("UNPARK", "Unpark", ISS_OFF);
    ParkCapSP.fill(m_DefaultDevice->getDeviceName(), "CAP_PARK", "Dust Cover", group, IP_RW, ISR_1OFMANY, 0, IPS_IDLE);
 
    // Abort motion
    AbortCapSP[0].fill("ABORT", "Abort", ISS_OFF);
    AbortCapSP.fill(m_DefaultDevice->getDeviceName(), "CAP_ABORT", "Motion", group, IP_RW, ISR_ATMOST1, 60, IPS_IDLE);
}
 
bool DustCapInterface::updateProperties()
{
    if (m_DefaultDevice->isConnected())
    {
        m_DefaultDevice->defineProperty(ParkCapSP);
        if (m_Capabilities & CAN_ABORT)
            m_DefaultDevice->defineProperty(AbortCapSP);
    }
    else
    {
        m_DefaultDevice->deleteProperty(ParkCapSP);
        if (m_Capabilities & CAN_ABORT)
            m_DefaultDevice->deleteProperty(AbortCapSP);
    }
 
    return true;
}
 
bool DustCapInterface::processSwitch(const char *dev, const char *name, ISState *states, char *names[], int n)
{
    INDI_UNUSED(dev);
    // Park/UnPark Dust Cover
    if (ParkCapSP.isNameMatch(name))
    {
        auto prevSwitch = ParkCapSP.findOnSwitchIndex();
        ParkCapSP.update(states, names, n);
        ParkCapSP.setState((ParkCapSP[CAP_PARK].getState() == ISS_ON) ? ParkCap() : UnParkCap());
 
        if (ParkCapSP.getState() == IPS_ALERT)
        {
            ParkCapSP.reset();
            ParkCapSP[prevSwitch].setState(ISS_ON);
        }
        ParkCapSP.apply();
        return true;
    }
    else if (AbortCapSP.isNameMatch(name))
    {
        auto state = AbortCap();
        AbortCapSP.setState(state);
        AbortCapSP.apply();
        // In case cap was in motion, and was aborted, we update its state to ABORT
        // We reset all switches as well.
        if (state == IPS_OK && ParkCapSP.getState() == IPS_BUSY)
        {
            ParkCapSP.reset();
            ParkCapSP.setState(IPS_ALERT);
            ParkCapSP.apply();
        }
        return true;
    }
 
    return false;
}
 
IPState DustCapInterface::ParkCap()
{
    // Must be implemented by child class
    return IPS_ALERT;
}
 
IPState DustCapInterface::UnParkCap()
{
    // Must be implemented by child class
    return IPS_ALERT;
}
 
IPState DustCapInterface::AbortCap()
{
    // Must be implemented by child class
    return IPS_ALERT;
}
}