Instrument Neutral Distributed Interface INDI  2.0.2
deepskydad_af3.h
Go to the documentation of this file.
1 /*
2  Deep Sky Dad AF3
3 
4  Copyright (C) 2019 Pavle Gartner
5 
6  Based on Moonline driver.
7  Copyright (C) 2013-2019 Jasem Mutlaq (mutlaqja@ikarustech.com)
8 
9  This library is free software; you can redistribute it and/or
10  modify it under the terms of the GNU Lesser General Public
11  License as published by the Free Software Foundation; either
12  version 2.1 of the License, or (at your option) any later version.
13 
14  This library is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  Lesser General Public License for more details.
18 
19  You should have received a copy of the GNU Lesser General Public
20  License along with this library; if not, write to the Free Software
21  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 
23 */
24 
25 #pragma once
26 
27 #include "indifocuser.h"
28 
29 #include <chrono>
30 
32 {
33  public:
34  DeepSkyDadAF3();
35  virtual ~DeepSkyDadAF3() override = default;
36 
37  typedef enum { S1, S2, S4, S8, S16, S32, S64, S128, S256 } FocusStepMode;
39 
40  const char * getDefaultName() override;
41  virtual bool initProperties() override;
42  virtual bool updateProperties() override;
43  virtual bool ISNewSwitch(const char * dev, const char * name, ISState * states, char * names[], int n) override;
44  virtual bool ISNewNumber(const char * dev, const char * name, double values[], char * names[], int n) override;
45 
46  static void timedMoveHelper(void * context);
47  protected:
48  /*
49  * @brief Handshake Try to communicate with Focuser and see if there is a valid response.
50  * @return True if communication is successful, false otherwise.
51  */
52  virtual bool Handshake() override;
53 
61  virtual IPState MoveFocuser(FocusDirection dir, int speed, uint16_t duration) override;
62 
68  virtual IPState MoveAbsFocuser(uint32_t targetTicks) override;
69 
76  virtual IPState MoveRelFocuser(FocusDirection dir, uint32_t ticks) override;
77 
78  virtual bool SyncFocuser(uint32_t ticks) override;
79  virtual bool ReverseFocuser(bool enabled) override;
80  virtual bool AbortFocuser() override;
81  virtual void TimerHit() override;
82  virtual bool saveConfigItems(FILE * fp) override;
83  virtual bool SetFocuserBacklash(int32_t steps) override;
84  virtual bool SetFocuserMaxPosition(uint32_t ticks) override;
85 
86  private:
87  bool Ack();
95  bool sendCommand(const char * cmd, char * res = nullptr);
96  bool sendCommandSet(const char * cmd);
97 
98  // Get initial focuser parameter when we first connect
99  void GetFocusParams();
100  bool readStepMode();
101  bool readSpeedMode();
102  bool readPosition();
103  bool readMaxPosition();
104  bool readMaxMovement();
105  bool readSettleBuffer();
106  bool readMoveCurrentMultiplier();
107  bool readHoldCurrentMultiplier();
108  bool isMoving();
109  bool readTemperature();
110 
111  void timedMoveCallback();
112 
113  bool MoveFocuser(uint32_t position);
114 
115  double targetPos { 0 }, lastPos { 0 }, lastTemperature { 0 }, backlashComp {0};
116 
117  bool moveAborted = false;
118 
119  // Step mode
120  ISwitch StepModeS[9];
121  ISwitchVectorProperty StepModeSP;
122 
123  // Speed mode
124  ISwitch SpeedModeS[5];
125  ISwitchVectorProperty SpeedModeSP;
126 
127  //Current move
128  INumber MoveCurrentMultiplierN[1];
129  INumberVectorProperty MoveCurrentMultiplierNP;
130 
131  //Current hold
132  INumber HoldCurrentMultiplierN[1];
133  INumberVectorProperty HoldCurrentMultiplierNP;
134 
135  // Max movement
136  INumber FocusMaxMoveN[1];
137  INumberVectorProperty FocusMaxMoveNP;
138 
139  // Settle buffer
140  INumber SettleBufferN[1];
141  INumberVectorProperty SettleBufferNP;
142 
143  INumber TemperatureN[1];
144  INumberVectorProperty TemperatureNP;
145 
146  // Response Buffer
147 
148  static const uint8_t DSD_RES { 32 };
149  static const char DSD_DEL { ')' };
150  static const uint8_t DSD_TIMEOUT { 3 };
151 };
virtual IPState MoveRelFocuser(FocusDirection dir, uint32_t ticks) override
MoveRelFocuser Move focuser for a relative amount of ticks in a specific direction.
virtual bool saveConfigItems(FILE *fp) override
saveConfigItems Saves the Device Port and Focuser Presets in the configuration file
virtual bool updateProperties() override
updateProperties is called whenever there is a change in the CONNECTION status of the driver....
virtual bool SetFocuserMaxPosition(uint32_t ticks) override
SetFocuserMaxPosition Update focuser maximum position. It only updates the PresetNP property limits.
virtual bool SyncFocuser(uint32_t ticks) override
SyncFocuser Set current position to ticks without moving the focuser.
virtual ~DeepSkyDadAF3() override=default
virtual bool Handshake() override
perform handshake with device to check communication
static void timedMoveHelper(void *context)
virtual IPState MoveFocuser(FocusDirection dir, int speed, uint16_t duration) override
MoveFocuser Move focuser in a specific direction and speed for period of time.
virtual bool ReverseFocuser(bool enabled) override
ReverseFocuser Reverse focuser motion direction.
virtual bool AbortFocuser() override
AbortFocuser all focus motion.
virtual bool SetFocuserBacklash(int32_t steps) override
SetFocuserBacklash Set the focuser backlash compensation value.
virtual bool ISNewSwitch(const char *dev, const char *name, ISState *states, char *names[], int n) override
Process the client newSwitch command.
virtual void TimerHit() override
Callback function to be called once SetTimer duration elapses.
virtual bool initProperties() override
Initilize properties initial state and value. The child class must implement this function.
const char * getDefaultName() override
virtual bool ISNewNumber(const char *dev, const char *name, double values[], char *names[], int n) override
Process the client newNumber command.
virtual IPState MoveAbsFocuser(uint32_t targetTicks) override
MoveAbsFocuser Move to an absolute target position.
ISState
Switch state.
Definition: indiapi.h:150
IPState
Property state.
Definition: indiapi.h:160
__u8 cmd[4]
Definition: pwc-ioctl.h:2
One number descriptor.
One switch descriptor.
Number vector property descriptor.
Definition: indiapi.h:319
Switch vector property descriptor.
Definition: indiapi.h:367