astrotrac.h

Go to the documentation of this file.

/*******************************************************************************
 Copyright(c) 2021 Jasem Mutlaq. All rights reserved.
 
 AstroTrac Mount Driver.
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Library General Public
 License version 2 as published by the Free Software Foundation.
 .
 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
 Library 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.
*******************************************************************************/
 
#pragma once
 
#include "inditelescope.h"
#include "indiguiderinterface.h"
 
#include "alignment/AlignmentSubsystemForDrivers.h"
 
#include "indipropertynumber.h"
#include "indipropertytext.h"
#include "indipropertyswitch.h"
#include "indielapsedtimer.h"
 
class AstroTrac :
    public INDI::Telescope,
    public INDI::GuiderInterface,
    public INDI::AlignmentSubsystem::AlignmentSubsystemForDrivers
{
    public:
        AstroTrac();
        virtual ~AstroTrac() = default;
 
        virtual const char *getDefaultName() override;
        virtual bool Handshake() override;
        virtual bool ReadScopeStatus() override;
        virtual void ISGetProperties(const char *dev) override;
        virtual bool initProperties() override;
        virtual bool updateProperties() override;
 
        virtual bool ISNewText(const char *dev, const char *name, char *texts[], char *names[], int n) override;
        virtual bool ISNewNumber(const char *dev, const char *name, double values[], char *names[], int n) override;
        virtual bool ISNewSwitch(const char *dev, const char *name, ISState *states, char *names[], int n) override;
        virtual bool ISNewBLOB(const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[],
                               char *formats[], char *names[], int n) override;
 
    protected:
        // Motion
        virtual bool MoveNS(INDI_DIR_NS dir, TelescopeMotionCommand command) override;
        virtual bool MoveWE(INDI_DIR_WE dir, TelescopeMotionCommand command) override;
        virtual bool Abort() override;
 
        // Time & Location
        virtual bool updateLocation(double latitude, double longitude, double elevation) override;
        virtual bool updateTime(ln_date *utc, double utc_offset) override;
 
        // GOTO & SYNC
        virtual bool Goto(double ra, double dec) override;
        virtual bool Sync(double ra, double dec) override;
 
        // Tracking
        virtual bool SetTrackMode(uint8_t mode) override;
        virtual bool SetTrackRate(double raRate, double deRate) override;
        virtual bool SetTrackEnabled(bool enabled) override;
 
        // Parking
        virtual bool SetCurrentPark() override;
        virtual bool SetDefaultPark() override;
        virtual bool Park() override;
        virtual bool UnPark() override;
 
        // Guiding
        virtual IPState GuideNorth(uint32_t ms) override;
        virtual IPState GuideSouth(uint32_t ms) override;
        virtual IPState GuideEast(uint32_t ms) override;
        virtual IPState GuideWest(uint32_t ms) override;
 
        // Simulation
        virtual void simulationTriggered(bool enable) override;
 
        // Config items
        virtual bool saveConfigItems(FILE *fp) override;
 
    private:
        bool getVersion();
        void getRADEFromEncoders(double haEncoder, double deEncoder, double &ra, double &de, TelescopePierSide &pierSide);
        void getEncodersFromRADE(double ra, double de, double &raEncoder, double &deEncoder);
        double calculateSlewTime(double distance);
        bool getTelescopeFromSkyCoordinates(double ra, double de, INDI::IEquatorialCoordinates &telescopeCoordinates);
 
        bool getAcceleration(INDI_EQ_AXIS axis);
        bool setAcceleration(INDI_EQ_AXIS axis, uint32_t a);
 
        bool getVelocity(INDI_EQ_AXIS axis);
        bool getVelocity(INDI_EQ_AXIS axis, double &value);
 
        bool setVelocity(INDI_EQ_AXIS axis, double value);
 
        bool getMaximumSlewVelocity();
 
 
        bool isSlewComplete();
        bool syncEncoder(INDI_EQ_AXIS axis, double value);
        bool slewEncoder(INDI_EQ_AXIS axis, double value);
        bool getEncoderPosition(INDI_EQ_AXIS axis);
        bool stopMotion(INDI_EQ_AXIS axis);
 
 
        bool sendCommand(const char * cmd, char * res = nullptr, int cmd_len = -1, int res_len = -1);
        void hexDump(char * buf, const char * data, int size);
        std::vector<std::string> split(const std::string &input, const std::string &regex);
 
        // Mount Type
        INDI::PropertySwitch MountTypeSP {2};
        enum
        {
            MOUNT_GEM,
            MOUNT_SINGLE_ARM
        };
 
        // Guide Rate
        INDI::PropertyNumber GuideRateNP {2};
        // Firmware Version
        INDI::PropertyText FirmwareTP {1};
        // Acceleration
        INDI::PropertyNumber AccelerationNP {2};
        // Encoders
        INDI::PropertyNumber EncoderNP {2};
 
        struct
        {
            // -90 to + 90 degrees.
            double currentMechanicalHA {0}, targetMechanicalHA {0};
            // -180 to +180 degrees.
            double currentMechanicalDE {0}, targetMechanicalDE {0};
            // arcsec/sec
            double velocity[2] = {TRACKRATE_SIDEREAL, 0};
            // arcsec/sec^2
            uint32_t acceleration[2] = {3600, 3600};
            // 1 Slewing, 0 Stopped
            uint8_t status[2] = {0, 0};
        } SimData;
 
        INDI::ElapsedTimer m_SimulationTimer;
        // Process very simply mount simulation. No meridian flips.
        void simulateMount();
        // Process basic commands.
        bool handleSimulationCommand(const char * cmd, char * res, int cmd_len, int res_len);
 
        INDI::IEquatorialCoordinates m_MountInternalCoordinates;
 
        // > is the stop char
        static const char DRIVER_STOP_CHAR { 0x3E };
        // Wait up to a maximum of 3 seconds for serial input
        static constexpr const uint8_t DRIVER_TIMEOUT {3};
        // Maximum buffer for sending/receiving.
        static constexpr const uint8_t DRIVER_LEN {64};
        // Slew Modes
        static constexpr const uint8_t SLEW_MODES {10};
        // Slew Speeds
        static const std::array<uint32_t, SLEW_MODES> SLEW_SPEEDS;
        // Maximum Slew Velocity. This cannot be set now so it's considered constant until until it can be altered.
        // arcsec/sec
        static constexpr double MAX_SLEW_VELOCITY {10800.0};
        // Target threshold in degrees between mechanical target and current coordinates
        // If they are within 0.1 degrees, then we consider motion complete
        static constexpr double DIFF_THRESHOLD {0.1};
};