alpaca_dome.h

Go to the documentation of this file.

/*******************************************************************************
  Copyright(c) 2026 Philippe Bazart, Jérémie Klein. All rights reserved.
 
  ASCOM Alpaca Dome INDI Driver
 
  Based on Protocol extracted from https://github.com/rpineau/RigelDome
 
  This program is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by the Free
  Software Foundation; either version 2 of the License, or (at your option)
  any later version.
 
  This program 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 General Public License for
  more details.
 
  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
 
  The full GNU General Public License is included in this distribution in the
  file called LICENSE.
*******************************************************************************/
 
#pragma once
 
#include "indidome.h"
 
#include <httplib.h>
#include <string>
#include <functional>
 
// Add these includes
#ifdef _USE_SYSTEM_JSONLIB
#include <nlohmann/json.hpp>
#else
#include <indijson.hpp>
#endif
 
class AlpacaDome : public INDI::Dome
{
    public:
        AlpacaDome();
        virtual ~AlpacaDome() = default;
 
        virtual void TimerHit() override;
 
        virtual void ISGetProperties(const char *dev) override;
 
        virtual bool ISNewSwitch(const char *dev, const char *name, ISState *states, char *names[], int n) override;
 
        virtual bool ISNewNumber(const char *dev, const char *name, double values[], char *names[], int n) override;
 
        virtual bool ISNewText(const char * dev, const char * name, char * texts[], char * names[], int n) override;
 
        bool CanFindHome()
        {
            return m_CanFindHome;
        }
 
        bool CanCalibrate()
        {
            return m_CanCalibrate;
        }
 
        bool CanPark()
        {
            return m_CanPark;
        }
 
        bool CanSetAltitude()
        {
            return m_CanSetAltitude;
        }
 
        bool CanSetAzimuth()
        {
            return m_CanSetAzimuth;
        }
 
        bool CanSetPark()
        {
            return m_CanSetPark;
        }
 
        bool CanSetShutter()
        {
            return m_CanSetShutter;
        }
 
        bool CanSlave()
        {
            return m_CanSlave;
        }
 
        bool CanSyncAzimuth()
        {
            return m_CanSyncAzimuth;
        }
 
    protected:
        virtual const char *getDefaultName() override;
 
        virtual bool initProperties() override;
 
        virtual bool updateProperties() override;
 
        virtual bool saveConfigItems(FILE *fp) override;
 
        virtual bool Connect() override;
 
        virtual bool Disconnect() override;
 
        virtual bool SetSpeed(double rpm) override;
 
        virtual IPState MoveRel(double azDiff) override;
 
        virtual IPState MoveAbs(double az) override;
 
        virtual IPState Move(DomeDirection dir, DomeMotionCommand operation) override;
 
        virtual bool Sync(double az) override;
 
        virtual bool Abort() override;
 
        virtual IPState Park() override;
 
        virtual IPState UnPark() override;
 
        virtual IPState ControlShutter(ShutterOperation operation) override;
 
        virtual bool SetCurrentPark() override;
 
        virtual bool SetDefaultPark() override;
 
        virtual IPState FindHome();
 
        virtual IPState Calibrate();
 
        // Alpaca customization hooks for derived drivers.
        virtual std::string getAlpacaURL(const std::string &endpoint);
        virtual std::string buildAlpacaFormData(const nlohmann::json &request);
        virtual void setDefaultServerAddress(const char *host, const char *port, bool force = false);
        virtual uint32_t getTransactionId();
 
        INDI::PropertyText ServerAddressTP {2};  // Host and port
        enum
        {
            HOST,
            PORT
        };
 
        INDI::PropertyNumber DeviceNumberNP {1};  // Alpaca device number (remplace l'ancien int)
 
        INDI::PropertyNumber ConnectionSettingsNP {2};
        enum
        {
            TIMEOUT,
            RW_TIMEOUT
        };
 
        INDI::PropertySwitch OperationSP {2};
        enum
        {
            OPERATION_FIND_HOME,
            OPERATION_CALIBRATE
        };
 
        // Info
        INDI::PropertyText InfoTP {5};
        enum
        {
            INFO_DEVICE_NAME,
            INFO_DESCRIPTION,
            INFO_DRIVER_INFO,
            INFO_DRIVER_VERSION,
            INFO_INTERFACE_VERSION
        };
 
    private:
        struct AlapacaDomeState
        {
            double altitude;
            double azimuth;
            int shutterStatus;
            bool slewing;
            bool atHome;
            bool atPark;
        };
 
        void updateStatus();
        void updateDomeStatus(AlapacaDomeState &state);
        void updateShutterStatus(AlapacaDomeState &state);
 
        bool sendAlpacaGET(const std::string &endpoint, nlohmann::json &response);
        bool sendAlpacaPUT(const std::string &endpoint, const nlohmann::json &request, nlohmann::json &response);
 
        bool alpacaConnect();
        bool alpacaDisconnect();
 
        bool alpacaGetBool(const std::string &endpoint, bool& value, bool defaultValue = false);
        bool alpacaGetInt(const std::string &endpoint, int& value, int defaultValue = 0);
        bool alpacaGetDouble(const std::string &endpoint, double& value, double defaultValue = 0.0);
        bool alpacaGetString(const std::string &endpoint, std::string& value, const std::string& defaultValue = "");
        bool alpacaGetDeviceState(AlapacaDomeState &value, double defaultAz = 0.0, double defaultAlt = 0.0);
 
        // bool alpacaDomeSetSlaved(bool slaved);
        bool alpacaDomeAbortSlew();
        bool alpacaDomeCloseShutter();
        bool alpacaDomeFindHome();
        bool alpacaDomeOpenShutter();
        bool alpacaDomePark();
        bool alpacaDomeSetPark();
        bool alpacaDomeSlewToAltitude(double alt);
        bool alpacaDomeSlewToAzimuth(double az);
        bool alpacaDomeSyncToAzimuth(double az);
 
        bool m_CanFindHome {false};
        bool m_CanCalibrate {false};
        bool m_CanPark {false};
        bool m_CanSetAltitude {false};
        bool m_CanSetAzimuth {false};
        bool m_CanSetPark {false};
        bool m_CanSetShutter {true};
        bool m_CanSlave {false};
        bool m_CanSyncAzimuth {false};
 
        // Internal state variables
        std::string m_DeviceName, m_Description, m_DriverInfo, m_DriverVersion;
        int m_InterfaceVersion {1};
 
        std::unique_ptr<httplib::Client> httpClient;
        uint32_t m_ClientTransactionID {1};
 
        // Config-loaded values (empty = no saved config, mirrors TCP plugin pattern)
        std::string m_ConfigHost;
        std::string m_ConfigPort;
};