indioutputinterface.cpp

Go to the documentation of this file.

/*
    Output Interface
    Copyright (C) 2024 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 "indioutputinterface.h"
#include <cstring>
#include "indilogger.h"
 
namespace INDI
{
 
OutputInterface::OutputInterface(DefaultDevice *defaultDevice) : m_defaultDevice(defaultDevice)
{
}
 
OutputInterface::~OutputInterface()
{
}
 
void OutputInterface::initProperties(const char *groupName, uint8_t Outputs, const std::string &prefix)
{
    m_DigitalOutputLabelsConfig = false;
    DigitalOutputLabelsTP.resize(0);
 
    // Initialize pulse duration properties
    PulseDurationNP.clear();
    PulseDurationNP.reserve(Outputs);
    for (size_t i = 0; i < Outputs; i++)
    {
        auto label = prefix + " #" + std::to_string(i + 1);
        INDI::PropertyNumber oneDuration {1};
        oneDuration[0].fill("DURATION", "Duration (ms)", "%.0f", 0, 60000, 100, 0);
        oneDuration.fill(m_defaultDevice->getDeviceName(), ("PULSE_" + std::to_string(i)).c_str(),
                         label.c_str(), "Pulse Mode", IP_RW, 60, IPS_IDLE);
        oneDuration.load();
        PulseDurationNP.push_back(std::move(oneDuration));
    }
    PulseDurationNP.shrink_to_fit();
 
    // Initialize labels
    for (auto i = 0; i < Outputs; i++)
    {
        auto name = "DIGITAL_OUTPUT_" + std::to_string(i + 1);
        auto label = prefix + " #" + std::to_string(i + 1);
 
        INDI::WidgetText oneLabel;
        oneLabel.fill(name, label, label);
        DigitalOutputLabelsTP.push(std::move(oneLabel));
    }
 
    DigitalOutputLabelsTP.fill(m_defaultDevice->getDeviceName(), "DIGITAL_OUTPUT_LABELS", "Labels", groupName, IP_RW, 60,
                               IPS_IDLE);
    DigitalOutputLabelsTP.shrink_to_fit();
    if (Outputs > 0)
        m_DigitalOutputLabelsConfig = DigitalOutputLabelsTP.load();
 
    DigitalOutputsSP.reserve(Outputs);
    // Initialize switches, use labels if loaded.
    for (size_t i = 0; i < Outputs; i++)
    {
        auto name = "DIGITAL_OUTPUT_" + std::to_string(i + 1);
        auto label = prefix + " #" + std::to_string(i + 1);
 
        INDI::PropertySwitch oneOutput {2};
        oneOutput[Off].fill("OFF", "Off", ISS_OFF);
        oneOutput[On].fill("ON", "On", ISS_OFF);
 
        if (i < DigitalOutputLabelsTP.count())
            label = DigitalOutputLabelsTP[i].getText();
        oneOutput.fill(m_defaultDevice->getDeviceName(), name.c_str(), label.c_str(), groupName, IP_RW, ISR_ATMOST1, 60, IPS_IDLE);
        DigitalOutputsSP.push_back(std::move(oneOutput));
    }
}
 
bool OutputInterface::updateProperties()
{
    if (m_defaultDevice->isConnected())
    {
        for (auto &oneOutput : DigitalOutputsSP)
            m_defaultDevice->defineProperty(oneOutput);
        if (DigitalOutputsSP.size() > 0)
            m_defaultDevice->defineProperty(DigitalOutputLabelsTP);
        for (auto &oneDuration : PulseDurationNP)
            m_defaultDevice->defineProperty(oneDuration);
    }
    else
    {
        for (auto &oneOutput : DigitalOutputsSP)
            m_defaultDevice->deleteProperty(oneOutput);
        if (DigitalOutputsSP.size() > 0)
            m_defaultDevice->deleteProperty(DigitalOutputLabelsTP);
        for (auto &oneDuration : PulseDurationNP)
            m_defaultDevice->deleteProperty(oneDuration);
    }
 
    return true;
}
 
bool OutputInterface::processSwitch(const char *dev, const char *name, ISState states[], char *names[], int n)
{
    if (dev && !strcmp(dev, m_defaultDevice->getDeviceName()))
    {
        for (size_t i = 0; i < DigitalOutputsSP.size(); i++)
        {
            if (DigitalOutputsSP[i].isNameMatch(name))
            {
                auto oldState = DigitalOutputsSP[i].findOnSwitchIndex();
                DigitalOutputsSP[i].update(states, names, n);
                auto newState = DigitalOutputsSP[i].findOnSwitchIndex();
                if (oldState != newState)
                {
                    // Cast to Command and send
                    if (CommandOutput(i, static_cast<OutputState>(newState)))
                    {
                        DigitalOutputsSP[i].setState(IPS_OK);
 
                        // If turning on and pulse duration is set, start the pulse
                        if (newState == On && i < PulseDurationNP.size() && PulseDurationNP[i][0].getValue() > 0)
                        {
                            INDI::Timer::singleShot(static_cast<uint32_t>(PulseDurationNP[i][0].getValue()),
                                                    [this, i]()
                            {
                                CommandOutput(i, Off);
                                DigitalOutputsSP[i].reset();
                                DigitalOutputsSP[i][Off].setState(ISS_ON);
                                DigitalOutputsSP[i].setState(IPS_OK);
                                DigitalOutputsSP[i].apply();
                                PulseDurationNP[i].setState(IPS_OK);
                                PulseDurationNP[i].apply();
                            });
                            PulseDurationNP[i].setState(IPS_BUSY);
                            PulseDurationNP[i].apply();
                        }
                    }
                    else
                    {
                        DigitalOutputsSP[i].setState(IPS_ALERT);
                        DigitalOutputsSP[i].reset();
                        DigitalOutputsSP[i][oldState].setState(ISS_ON);
                    }
 
                    // Apply and return
                    DigitalOutputsSP[i].apply();
                    return true;
                }
                // No state change
                else
                {
                    DigitalOutputsSP[i].setState(IPS_OK);
                    DigitalOutputsSP[i].apply();
                    return true;
                }
            }
        }
    }
 
    return false;
}
 
bool OutputInterface::processNumber(const char *dev, const char *name, double values[], char *names[], int n)
{
    if (dev && !strcmp(dev, m_defaultDevice->getDeviceName()))
    {
        for (size_t i = 0; i < PulseDurationNP.size(); i++)
        {
            if (PulseDurationNP[i].isNameMatch(name))
            {
                PulseDurationNP[i].update(values, names, n);
                PulseDurationNP[i].setState(IPS_OK);
                PulseDurationNP[i].apply();
                m_defaultDevice->saveConfig(PulseDurationNP[i]);
                return true;
            }
        }
    }
 
    return false;
}
 
bool OutputInterface::processText(const char *dev, const char *name, char *texts[], char *names[], int n)
{
    if (dev && !strcmp(dev, m_defaultDevice->getDeviceName()))
    {
        // If this call due to config loading, let's delete existing dummy property and define the full one
        if (DigitalOutputLabelsTP.isNameMatch(name))
        {
            DigitalOutputLabelsTP.update(texts, names, n);
            DigitalOutputLabelsTP.setState(IPS_OK);
            DigitalOutputLabelsTP.apply();
            m_defaultDevice->saveConfig(DigitalOutputLabelsTP);
            return true;
        }
    }
 
    return false;
}
 
bool OutputInterface::saveConfigItems(FILE *fp)
{
    DigitalOutputLabelsTP.save(fp);
    for (auto &oneDuration : PulseDurationNP)
        oneDuration.save(fp);
    return true;
}
 
}