indiweatherinterface.h

Go to the documentation of this file.

/*
    Weather Interface
    Copyright (C) 2018 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 "indipropertynumber.h"
#include "indipropertyswitch.h"
#include "indipropertylight.h"
#include "inditimer.h"
 
#include <stdint.h>
#include <string>
#include <vector>
 
// Alias
using WI = INDI::WeatherInterface;
 
namespace INDI
{
 
class WeatherInterface
{
    public:
 
    protected:
        explicit WeatherInterface(DefaultDevice *defaultDevice);
        virtual ~WeatherInterface();
 
        void initProperties(const char *statusGroup, const char *paramsGroup);
 
        bool updateProperties();
 
        bool processNumber(const char *dev, const char *name, double values[], char *names[], int n);
 
        bool processSwitch(const char *dev, const char *name, ISState *states, char *names[], int n);
 
        void checkWeatherUpdate();
 
        virtual IPState updateWeather();
 
        virtual bool saveConfigItems(FILE *fp);
 
        void addParameter(std::string name, std::string label, double numMinOk, double numMaxOk, double percWarning, bool flipWarning = false);
 
        bool setCriticalParameter(std::string name);
 
        void setParameterValue(std::string name, double value);
 
        IPState checkParameterState(const std::string &param) const;
 
        bool syncCriticalParameters();
 
        // Parameters
        INDI::PropertyNumber ParametersNP {0};
 
        // Parameter Ranges
        std::vector<INDI::PropertyNumber> ParametersRangeNP;
        enum
        {
            MIN_OK,
            MAX_OK,
            PERCENT_WARNING,
            FLIP_RANGE_TEST,
        };
 
        // Weather status
        INDI::PropertyLight critialParametersLP {0};
 
        // Safety status (standard property for safety monitoring)
        INDI::PropertyLight SafetyStatusLP {1};
 
        // Update Period
        INDI::PropertyNumber UpdatePeriodNP {1};
        // Refresh data
        INDI::PropertySwitch RefreshSP {1};
 
        // Override
        INDI::PropertySwitch OverrideSP {1};
 
 
    private:
        void createParameterRange(std::string name, std::string label, double numMinOk, double numMaxOk, double percWarning, bool flipWarning);
        DefaultDevice *m_defaultDevice { nullptr };
        std::string m_ParametersGroup;
        INDI::Timer m_UpdateTimer;
};
}