This file is indexed.

/usr/include/libindi/inditelescope.h is in libindi-dev 1.7.1-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
/*******************************************************************************
  Copyright(c) 2011 Gerry Rozema, Jasem Mutlaq. All rights reserved.

 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 "defaultdevice.h"

#include <libnova/julian_day.h>

#include <string>

/**
 * \class Telescope
 * \brief Class to provide general functionality of a telescope device.
 *
 * Developers need to subclass Telescope to implement any driver for telescopes within INDI.
 *
 * Implementing a basic telescope driver involves the child class performing the following steps:
 * <ul>
 * <li>The child class should define the telescope capabilities via the TelescopeCapability structure
 * and sets in the default constructor.</li>
 * <li>If the telescope has additional properties, the child class should override initProperties and
 * initialize the respective additional properties.</li>
 * <li>The child class can optionally set the connection mode in initProperties(). By default the driver
 * provide controls for both serial and TCP/IP connections.</li>
 * <li>Once the parent class calls Connect(), the child class attempts to connect to the telescope and
 * return either success of failure</li>
 * <li>Telescope calls updateProperties() to enable the child class to define which properties to
 * send to the client upon connection</li>
 * <li>Telescope calls ReadScopeStatus() to check the link to the telescope and update its state
 * and position. The child class should call newRaDec() whenever
 * a new value is read from the telescope.</li>
 * <li>The child class should implement Goto() and Sync(), and Park()/UnPark() if applicable.</li>
 * <li>Telescope calls disconnect() when the client request a disconnection. The child class
 * should remove any additional properties it defined in updateProperties() if applicable</li>
 * </ul>
 *
 * TrackState is used to monitor changes in Tracking state. There are three main tracking properties:
 * + TrackMode: Changes tracking mode or rate. Common modes are TRACK_SIDEREAL, TRACK_LUNAR, TRACK_SOLAR, and TRACK_CUSTOM
 * + TrackRate: If the mount supports custom tracking rates, it should set the capability flag TELESCOPE_HAS_TRACK_RATE. If the user
 *              changes the custom tracking rates while the mount is tracking, it it sent to the child class via SetTrackRate(...) function.
 *              The base class will reject any track rates that switch from positive to negative (reverse) tracking rates as the mount must be stopped before
 *              such change takes place.
 * + TrackState: Engages or Disengages tracking. When engaging tracking, the child class should take the necessary steps to set the appropiate TrackMode and TrackRate
 *               properties before or after engaging tracking as governed by the mount protocol.
 *
 * Ideally, the child class should avoid changing property states directly within a function call from the base class as such state changes take place in the base class
 * after checking the return values of such functions.
 * \author Jasem Mutlaq, Gerry Rozema
 * \see TelescopeSimulator and SynScan drivers for examples of implementations of Telescope.
 */
namespace INDI
{

class Telescope : public DefaultDevice
{
  public:
    enum TelescopeStatus
    {
        SCOPE_IDLE,
        SCOPE_SLEWING,
        SCOPE_TRACKING,
        SCOPE_PARKING,
        SCOPE_PARKED
    };
    enum TelescopeMotionCommand
    {
        MOTION_START = 0,
        MOTION_STOP
    };
    enum TelescopeSlewRate
    {
        SLEW_GUIDE,
        SLEW_CENTERING,
        SLEW_FIND,
        SLEW_MAX
    };
    enum TelescopeTrackMode
    {
        TRACK_SIDEREAL,
        TRACK_SOLAR,
        TRACK_LUNAR,
        TRACK_CUSTOM
    };
    enum TelescopeTrackState
    {
        TRACK_ON,
        TRACK_OFF,
        TRACK_UNKNOWN
    };
    enum TelescopeParkData
    {
        PARK_NONE,
        PARK_RA_DEC,
        PARK_HA_DEC,
        PARK_AZ_ALT,
        PARK_RA_DEC_ENCODER,
        PARK_AZ_ALT_ENCODER
    };
    enum TelescopeLocation
    {
        LOCATION_LATITUDE,
        LOCATION_LONGITUDE,
        LOCATION_ELEVATION
    };
    enum TelescopePierSide
    {
        PIER_UNKNOWN = -1,
        PIER_WEST    = 0,
        PIER_EAST    = 1
    };

    enum TelescopePECState
    {
        PEC_UNKNOWN = -1,
        PEC_OFF     = 0,
        PEC_ON      = 1
    };

    /**
     * \struct TelescopeConnection
     * \brief Holds the connection mode of the telescope.
     */
    enum
    {
        CONNECTION_NONE   = 1 << 0, /** Do not use any connection plugin */
        CONNECTION_SERIAL = 1 << 1, /** For regular serial and bluetooth connections */
        CONNECTION_TCP    = 1 << 2  /** For Wired and WiFI connections */
    } TelescopeConnection;

    /**
     * \struct TelescopeCapability
     * \brief Holds the capabilities of a telescope.
     */
    enum
    {
        TELESCOPE_CAN_GOTO          = 1 << 0, /** Can the telescope go to to specific coordinates? */
        TELESCOPE_CAN_SYNC          = 1 << 1, /** Can the telescope sync to specific coordinates? */
        TELESCOPE_CAN_PARK          = 1 << 2, /** Can the telescope park? */
        TELESCOPE_CAN_ABORT         = 1 << 3, /** Can the telescope abort motion? */
        TELESCOPE_HAS_TIME          = 1 << 4, /** Does the telescope have configurable date and time settings? */
        TELESCOPE_HAS_LOCATION      = 1 << 5, /** Does the telescope have configuration location settings? */
        TELESCOPE_HAS_PIER_SIDE     = 1 << 6, /** Does the telescope have pier side property? */
        TELESCOPE_HAS_PEC           = 1 << 7,  /** Does the telescope have PEC playback? */
        TELESCOPE_HAS_TRACK_MODE    = 1 << 8,  /** Does the telescope have track modes (sidereal, lunar, solar..etc)? */
        TELESCOPE_CAN_CONTROL_TRACK = 1 << 9,  /** Can the telescope engage and disengage tracking? */
        TELESCOPE_HAS_TRACK_RATE    = 1 << 10,  /** Does the telescope have custom track rates? */
    } TelescopeCapability;

    Telescope();
    virtual ~Telescope();

    virtual bool ISNewNumber(const char *dev, const char *name, double values[], char *names[], int n);
    virtual bool ISNewText(const char *dev, const char *name, char *texts[], char *names[], int n);
    virtual bool ISNewSwitch(const char *dev, const char *name, ISState *states, char *names[], int n);
    virtual void ISGetProperties(const char *dev);
    virtual bool ISSnoopDevice(XMLEle *root);

    /**
     * @brief GetTelescopeCapability returns the capability of the Telescope
     */
    uint32_t GetTelescopeCapability() const { return capability; }

    /**
     * @brief SetTelescopeCapability sets the Telescope capabilities. All capabilities must be initialized.
     * @param cap ORed list of telescope capabilities.
     * @param slewRateCount Number of slew rates supported by the telescope. If < 4 (default is 0),
     * no slew rate properties will be defined to the client. If >=4, the driver will construct the default
     * slew rate property TELESCOPE_SLEW_RATE with SLEW_GUIDE, SLEW_CENTERING, SLEW_FIND, and SLEW_MAX
     * members where SLEW_GUIDE is the at the lowest setting and SLEW_MAX is at the highest.
     */
    void SetTelescopeCapability(uint32_t cap, uint8_t slewRateCount = 0);

    /**
     * @return True if telescope support goto operations
     */
    bool CanGOTO() { return capability & TELESCOPE_CAN_GOTO; }

    /**
     * @return True if telescope support sync operations
     */
    bool CanSync() { return capability & TELESCOPE_CAN_SYNC; }

    /**
     * @return True if telescope can abort motion.
     */
    bool CanAbort() { return capability & TELESCOPE_CAN_ABORT; }

    /**
     * @return True if telescope can park.
     */
    bool CanPark() { return capability & TELESCOPE_CAN_PARK; }

    /**
     * @return True if telescope can enagle and disengage tracking.
     */
    bool CanControlTrack() { return capability & TELESCOPE_CAN_CONTROL_TRACK; }

    /**
     * @return True if telescope time can be updated.
     */
    bool HasTime() { return capability & TELESCOPE_HAS_TIME; }

    /**
     * @return True if telescope location can be updated.
     */
    bool HasLocation() { return capability & TELESCOPE_HAS_LOCATION; }

    /**
     * @return True if telescope supports pier side property
     */
    bool HasPierSide() { return capability & TELESCOPE_HAS_PIER_SIDE; }

    /**
     * @return True if telescope supports PEC playback property
     */
    bool HasPECState() { return capability & TELESCOPE_HAS_PEC; }

    /**
     * @return True if telescope supports track modes
     */
    bool HasTrackMode() { return capability & TELESCOPE_HAS_TRACK_MODE; }

    /**
     * @return True if telescope supports custom tracking rates.
     */
    bool HasTrackRate() { return capability & TELESCOPE_HAS_TRACK_RATE; }

    /** \brief Called to initialize basic properties required all the time */
    virtual bool initProperties();
    /** \brief Called when connected state changes, to add/remove properties */
    virtual bool updateProperties();

    /** \brief perform handshake with device to check communication */
    virtual bool Handshake();

    /** \brief Called when setTimer() time is up */
    virtual void TimerHit();

    /**
     * \brief setParkDataType Sets the type of parking data stored in the park data file and
     * presented to the user.
     * \param type parking data type. If PARK_NONE then no properties will be presented to the
     * user for custom parking position.
     */
    void SetParkDataType(TelescopeParkData type);

    /**
     * @brief InitPark Loads parking data (stored in ~/.indi/ParkData.xml) that contains parking status
     * and parking position.
     * @return True if loading is successful and data is read, false otherwise. On success, you must call
     * SetAxis1ParkDefault() and SetAxis2ParkDefault() to set the default parking values. On failure,
     * you must call SetAxis1ParkDefault() and SetAxis2ParkDefault() to set the default parking values
     * in addition to SetAxis1Park() and SetAxis2Park() to set the current parking position.
     */
    bool InitPark();

    /**
     * @brief isParked is mount currently parked?
     * @return True if parked, false otherwise.
     */
    bool isParked();

    /**
     * @brief SetParked Change the mount parking status. The data park file (stored in
     * ~/.indi/ParkData.xml) is updated in the process.
     * @param isparked set to true if parked, false otherwise.
     */
    void SetParked(bool isparked);

    /**
     * @return Get current RA/AZ parking position.
     */
    double GetAxis1Park() const;

    /**
     * @return Get default RA/AZ parking position.
     */
    double GetAxis1ParkDefault() const;

    /**
     * @return Get current DEC/ALT parking position.
     */
    double GetAxis2Park() const;

    /**
     * @return Get defailt DEC/ALT parking position.
     */
    double GetAxis2ParkDefault() const;

    /**
     * @brief SetRAPark Set current RA/AZ parking position. The data park file (stored in
     * ~/.indi/ParkData.xml) is updated in the process.
     * @param value current Axis 1 value (RA or AZ either in angles or encoder values as specified
     * by the TelescopeParkData type).
     */
    void SetAxis1Park(double value);

    /**
     * @brief SetRAPark Set default RA/AZ parking position.
     * @param value Default Axis 1 value (RA or AZ either in angles or encoder values as specified
     * by the TelescopeParkData type).
     */
    void SetAxis1ParkDefault(double steps);

    /**
     * @brief SetDEPark Set current DEC/ALT parking position. The data park file (stored in
     * ~/.indi/ParkData.xml) is updated in the process.
     * @param value current Axis 1 value (DEC or ALT either in angles or encoder values as specified
     * by the TelescopeParkData type).
     */
    void SetAxis2Park(double steps);

    /**
     * @brief SetDEParkDefault Set default DEC/ALT parking position.
     * @param value Default Axis 2 value (DEC or ALT either in angles or encoder values as specified
     * by the TelescopeParkData type).
     */
    void SetAxis2ParkDefault(double steps);

    /**
     * @brief isLocked is mount currently locked?
     * @return true if lock status equals true and DomeClosedLockTP is Dome Locks or Dome Locks and
     * Dome Parks (both).
     */
    bool isLocked() const;

    // Joystick helpers
    static void joystickHelper(const char *joystick_n, double mag, double angle, void *context);
    static void buttonHelper(const char *button_n, ISState state, void *context);

    /**
     * @brief setTelescopeConnection Set telescope connection mode. Child class should call this
     * in the constructor before Telescope registers any connection interfaces
     * @param value ORed combination of TelescopeConnection values.
     */
    void setTelescopeConnection(const uint8_t &value);

    /**
     * @return Get current telescope connection mode
     */
    uint8_t getTelescopeConnection() const;

    void setPierSide(TelescopePierSide side);
    TelescopePierSide getPierSide() { return currentPierSide; }

    void setPECState(TelescopePECState state);
    TelescopePECState getPECState() { return currentPECState; }

  protected:
    virtual bool saveConfigItems(FILE *fp);

    /** \brief The child class calls this function when it has updates */
    void NewRaDec(double ra, double dec);

    /**
     * \brief Read telescope status.
     *
     * This function checks the following:
     * <ol>
     *   <li>Check if the link to the telescope is alive.</li>
     *   <li>Update telescope status: Idle, Slewing, Parking..etc.</li>
     *   <li>Read coordinates</li>
     * </ol>
     * \return True if reading scope status is OK, false if an error is encounterd.
     * \note This function is not implemented in Telescope, it must be implemented in the
     * child class
     */
    virtual bool ReadScopeStatus() = 0;

    /**
     * \brief Move the scope to the supplied RA and DEC coordinates
     * \return True if successful, false otherwise
     * \note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool Goto(double ra, double dec);

    /**
     * \brief Set the telescope current RA and DEC coordinates to the supplied RA and DEC coordinates
     * \return True if successful, false otherwise
     * \note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool Sync(double ra, double dec);

    /**
     * \brief Start or Stop the telescope motion in the direction dir.
     * \param dir direction of motion
     * \param command Start or Stop command
     * \return True if successful, false otherwise
     * \note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool MoveNS(INDI_DIR_NS dir, TelescopeMotionCommand command);

    /**
     * \brief Move the telescope in the direction dir.
     * \param dir direction of motion
     * \param command Start or Stop command
     * \return True if successful, false otherwise
     * \note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool MoveWE(INDI_DIR_WE dir, TelescopeMotionCommand command);

    /**
     * \brief Park the telescope to its home position.
     * \return True if successful, false otherwise
     * \note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool Park();

    /**
     * \brief Unpark the telescope if already parked.
     * \return True if successful, false otherwise
     * \note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool UnPark();

    /**
     * \brief Abort any telescope motion including tracking if possible.
     * \return True if successful, false otherwise
     * \note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool Abort();

    /**
     * @brief SetTrackMode Set active tracking mode. Do not change track state.
     * @param mode Index of track mode.
     * @return True if successful, false otherwise
     * @note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool SetTrackMode(uint8_t mode);

    /**
     * @brief SetTrackRate Set custom tracking rates.
     * @param raRate RA tracking rate in arcsecs/s
     * @param deRate DEC tracking rate in arcsecs/s
     * @return True if successful, false otherwise
     * @note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool SetTrackRate(double raRate, double deRate);

    /**
     * @brief AddTrackMode
     * @param name Name of track mode. It is recommended to use standard properties names such as TRACK_SIDEREAL..etc.
     * @param label Label of track mode that appears at the client side.
     * @param isDefault Set to true to mark the track mode as the default. Only one mode should be marked as default.
     * @return Index of added track mode
     * @note Child class should add all track modes be
     */
    virtual int AddTrackMode(const char *name, const char *label, bool isDefault=false);

    /**
     * @brief SetTrackEnabled Engages or disengages mount tracking. If there are no tracking modes available, it is assumed sidereal. Otherwise,
     * whatever tracking mode should be activated or deactivated accordingly.
     * @param enabled True to engage tracking, false to stop tracking completely.
     * @return True if successful, false otherwise
     * @note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool SetTrackEnabled(bool enabled);

    /**
     * \brief Update telescope time, date, and UTC offset.
     * \param utc UTC time.
     * \param utc_offset UTC offset in hours.
     * \return True if successful, false otherwise
     * \note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool updateTime(ln_date *utc, double utc_offset);

    /**
     * \brief Update telescope location settings
     * \param latitude Site latitude in degrees.
     * \param longitude Site latitude in degrees increasing eastward from Greenwich (0 to 360).
     * \param elevation Site elevation in meters.
     * \return True if successful, false otherwise
     * \note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool updateLocation(double latitude, double longitude, double elevation);

    /**
     * \brief SetParkPosition Set desired parking position to the supplied value. This ONLY sets the
     * desired park position value and does not perform parking.
     * \param Axis1Value First axis value
     * \param Axis2Value Second axis value
     * \return True if desired parking position is accepted and set. False otherwise.
     * \note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool SetParkPosition(double Axis1Value, double Axis2Value);

    /**
     * @brief SetCurrentPark Set current coordinates/encoders value as the desired parking position
     * @return True if current mount coordinates are set as parking position, false on error.
     * \note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool SetCurrentPark();

    /**
     * @brief SetDefaultPark Set default coordinates/encoders value as the desired parking position
     * @return True if default park coordinates are set as parking position, false on error.
     * \note If not implemented by the child class, this function by default returns false with a
     * warning message.
     */
    virtual bool SetDefaultPark();

    /**
     * @brief SetSlewRate Set desired slew rate index.
     * @param index Index of slew rate where 0 is slowest rate and capability.nSlewRate-1 is maximum rate.
     * @return True is operation successful, false otherwise.
     *
     * \note This function as implemented in Telescope performs no function and always return
     * true. Only reimplement it if you need to issue a command to change the slew rate at the hardware
     * level. Most telescope drivers only utilize slew rate when issuing a motion command.
     */
    virtual bool SetSlewRate(int index);

    /**
     * @brief callHandshake Helper function that sets the port file descriptor before calling the
     * actual Handshake function implenented in drivers
     * @return Result of actual device Handshake()
     */
    bool callHandshake();

    // Joystick
    void processNSWE(double mag, double angle);
    void processJoystick(const char *joystick_n, double mag, double angle);
    void processSlewPresets(double mag, double angle);
    void processButton(const char *button_n, ISState state);

    /**
     * @brief Load scope settings from XML files.
     * @return True if all config values were loaded otherwise false.
     */
    bool LoadScopeConfig();

    /**
     * @brief Load scope settings from XML files.
     * @return True if Config #1 exists otherwise false.
     */
    bool HasDefaultScopeConfig();

    /**
     * \brief Save scope settings to XML files.
     */
    bool UpdateScopeConfig();

    /**
     * @brief Validate a file name
     * @param file_name File name
     * @return True if the file name is valid otherwise false.
     */
    std::string GetHomeDirectory() const;

    /**
     * @brief Get the scope config index
     * @return The scope config index
     */
    int GetScopeConfigIndex() const;

    /**
     * @brief Check if a file exists and it is readable
     * @param file_name File name
     * @param writable Additional check if the file is writable
     * @return True if the checks are successful otherwise false.
     */
    bool CheckFile(const std::string &file_name, bool writable) const;

    /**
     * This is a variable filled in by the ReadStatus telescope
     * low level code, used to report current state
     * are we slewing, tracking, or parked.
     */
    TelescopeStatus TrackState;

    /**
     * @brief RememberTrackState Remember last state of Track State to fall back to in case of errors or aborts.
     */
    TelescopeStatus RememberTrackState;

    // All telescopes should produce equatorial co-ordinates
    INumberVectorProperty EqNP;
    INumber EqN[2];

    // When a goto is issued, domes will snoop the target property
    // to start moving the dome when a telescope moves
    INumberVectorProperty TargetNP;
    INumber TargetN[2];

    // Abort motion
    ISwitchVectorProperty AbortSP;
    ISwitch AbortS[1];

    // On a coord_set message, sync, or slew
    ISwitchVectorProperty CoordSP;
    ISwitch CoordS[3];

    // A number vector that stores lattitude and longitude
    INumberVectorProperty LocationNP;
    INumber LocationN[3];

    // A Switch in the client interface to park the scope
    ISwitchVectorProperty ParkSP;
    ISwitch ParkS[2];

    // Custom parking position
    INumber ParkPositionN[2];
    INumberVectorProperty ParkPositionNP;

    // Custom parking options
    ISwitch ParkOptionS[3];
    ISwitchVectorProperty ParkOptionSP;

    // A switch for North/South motion
    ISwitch MovementNSS[2];
    ISwitchVectorProperty MovementNSSP;

    // A switch for West/East motion
    ISwitch MovementWES[2];
    ISwitchVectorProperty MovementWESP;

    // Slew Rate
    ISwitchVectorProperty SlewRateSP;
    ISwitch *SlewRateS;

    // Telescope & guider aperture and focal length
    INumber ScopeParametersN[4];
    INumberVectorProperty ScopeParametersNP;

    // UTC and UTC Offset
    IText TimeT[2] {};
    ITextVectorProperty TimeTP;
    void sendTimeFromSystem();

    // Active GPS/Dome device to snoop
    ITextVectorProperty ActiveDeviceTP;
    IText ActiveDeviceT[2] {};

    // Switch to lock if dome is closed, and or force parking if dome parks
    ISwitchVectorProperty DomeClosedLockTP;
    ISwitch DomeClosedLockT[4];

    // Lock Joystick Axis to one direciton only
    ISwitch LockAxisS[2];
    ISwitchVectorProperty LockAxisSP;

    // Pier Side
    ISwitch PierSideS[2];
    ISwitchVectorProperty PierSideSP;

    // Pier Side
    TelescopePierSide lastPierSide, currentPierSide;

    // PEC State
    ISwitch PECStateS[2];
    ISwitchVectorProperty PECStateSP;

    // Track Mode
    ISwitchVectorProperty TrackModeSP;
    ISwitch *TrackModeS { nullptr };

    // Track State
    ISwitchVectorProperty TrackStateSP;
    ISwitch TrackStateS[2];

    // Track Rate
    INumberVectorProperty TrackRateNP;
    INumber TrackRateN[2];

    // PEC State
    TelescopePECState lastPECState, currentPECState;


    uint32_t capability;
    int last_we_motion, last_ns_motion;

    //Park
    char *LoadParkData();
    bool WriteParkData();

    int PortFD                           = -1;
    Connection::Serial *serialConnection = NULL;
    Connection::TCP *tcpConnection       = NULL;

  // XML node names for scope config
  const std::string ScopeConfigRootXmlNode { "scopeconfig" };
  const std::string ScopeConfigDeviceXmlNode { "device" };
  const std::string ScopeConfigNameXmlNode { "name" };
  const std::string ScopeConfigScopeFocXmlNode { "scopefoc" };
  const std::string ScopeConfigScopeApXmlNode { "scopeap" };
  const std::string ScopeConfigGScopeFocXmlNode { "gscopefoc" };
  const std::string ScopeConfigGScopeApXmlNode { "gscopeap" };
  const std::string ScopeConfigLabelApXmlNode { "label" };

  // A switch to apply custom aperture/focal length config
    enum
    {
        SCOPE_CONFIG1,
        SCOPE_CONFIG2,
        SCOPE_CONFIG3,
        SCOPE_CONFIG4,
        SCOPE_CONFIG5,
        SCOPE_CONFIG6
    };
    ISwitch ScopeConfigs[6];
    ISwitchVectorProperty ScopeConfigsSP;

    // Scope config name
    ITextVectorProperty ScopeConfigNameTP;
    IText ScopeConfigNameT[1] {};

    /// The telescope/guide scope configuration file name
    const std::string ScopeConfigFileName;

private:
    bool processTimeInfo(const char *utc, const char *offset);
    bool processLocationInfo(double latitude, double longitude, double elevation);

    void triggerSnoop(const char *driverName, const char *propertyName);

    TelescopeParkData parkDataType;
    bool IsLocked;
    bool IsParked;
    const char *ParkDeviceName;
    const std::string ParkDataFileName;
    XMLEle *ParkdataXmlRoot, *ParkdeviceXml, *ParkstatusXml, *ParkpositionXml, *ParkpositionAxis1Xml,
           *ParkpositionAxis2Xml;

    double Axis1ParkPosition;
    double Axis1DefaultParkPosition;
    double Axis2ParkPosition;
    double Axis2DefaultParkPosition;

    uint8_t nSlewRate;

    IPState lastEqState;

    uint8_t telescopeConnection = CONNECTION_SERIAL | CONNECTION_TCP;
    Controller *controller;
};

}