indigpsinterface.h

Go to the documentation of this file.

/*
    GPS Interface
    Copyright (C) 2023 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 "indipropertytext.h"
#include "inditimer.h"
 
#include <stdint.h>
#include <string>
#include <vector>
 
// Alias
using GPSI = INDI::GPSInterface;
 
namespace INDI
{
 
class GPSInterface
{
    public:
        enum GPSLocation
        {
            LOCATION_LATITUDE,
            LOCATION_LONGITUDE,
            LOCATION_ELEVATION
        };
 
    protected:
        explicit GPSInterface(DefaultDevice * defaultDevice);
        virtual ~GPSInterface() = default;
 
        void initProperties(const char * groupName);
 
        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);
 
        virtual bool saveConfigItems(FILE * fp);
 
        void checkGPSState();
 
        bool setSystemTime(time_t &raw_time);
 
#ifdef __linux__
        bool runCommand(const std::vector<std::string> &args, std::string *output = nullptr);
 
        bool timedateCall(const std::vector<std::string> &busctlArgs, const std::vector<std::string> &gdbusArgs,
                          std::string *output = nullptr);
 
        bool isNTPActive();
 
        bool setNTPEnabled(bool enabled);
 
        void disableNTPForGPSTime();
 
        void restoreNTPOnDisconnect();
#endif
 
        virtual IPState updateGPS();
 
 
        //  A number vector that stores latitude, longitude and altitude.
        INDI::PropertyNumber LocationNP {3};
 
        // UTC and UTC Offset
        INDI::PropertyText TimeTP {2};
 
        // Refresh data
        INDI::PropertySwitch RefreshSP {1};
 
        // Refresh Period
        INDI::PropertyNumber PeriodNP {1};
 
        // System Time
        INDI::PropertySwitch SystemTimeUpdateSP {3};
        enum
        {
            UPDATE_NEVER,
            UPDATE_ON_STARTUP,
            UPDATE_ON_REFRESH
        };
 
        INDI::Timer m_UpdateTimer;
 
        // # of seconds since 1970 UTC
        std::time_t m_GPSTime;
 
        // Track whether system time was updated
        bool m_SystemTimeUpdated {false};
 
        // Track whether this GPS interface disabled NTP (so we can restore on disconnect)
        bool m_NTPDisabledByGPS { false };
 
        DefaultDevice * m_DefaultDevice { nullptr };
};
}